/[gentoo]/xml/htdocs/doc/en/index.xml
Gentoo

Contents of /xml/htdocs/doc/en/index.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.1 - (show annotations) (download) (as text)
Mon Oct 6 16:40:31 2003 UTC (10 years, 10 months ago) by swift
Branch: MAIN
File MIME type: application/xml
New English Documentation Index

1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
3 <mainpage id="docs">
4 <title>Gentoo Documentation Resources</title>
5 <author title="Author">
6 <mail link="drobbins@gentoo.org">Daniel Robbins</mail>
7 </author>
8 <author title="Editor">
9 <mail link="zhen@gentoo.org">John P. Davis</mail>
10 </author>
11 <author title="Editor">Colin Morey</author>
12 <author title="Editor">
13 <mail link="peesh@gentoo.org">Jorge Paulo</mail>
14 </author>
15 <author title="Editor">
16 <mail link="swift@gentoo.org">Sven Vermeulen</mail>
17 </author>
18 <version>1.0.91</version>
19 <date>October 6, 2003</date>
20
21 <chapter>
22 <title>Gentoo Documentation Resources</title>
23 <section>
24 <title>Contents</title>
25 <body>
26
27 <ul>
28 <li><uri link="#doc_chap1">Introduction</uri></li>
29 <li><uri link="#doc_chap2">Installation Related Resources</uri></li>
30 <li><uri link="#doc_chap3">Gentoo System Documentation</uri></li>
31 <li><uri link="#doc_chap4">System Administration Documentation</uri></li>
32 <li><uri link="#doc_chap5">Desktop Related Documentation</uri></li>
33 <li><uri link="#doc_chap6">Gentoo Development Documentation</uri></li>
34 <li><uri link="#doc_chap7">Other Documentation</uri></li>
35 </ul>
36
37 </body>
38 </section>
39 <section>
40 <title>Introduction</title>
41 <body>
42
43 <p>
44 Welcome to the Gentoo Documentation Resources. This page will give you a
45 quick overview on the documentation we provide. Most documentation is
46 released under the <uri
47 link="http://creativecommons.org/licenses/by-sa/1.0">Creative Commons -
48 Attribution / Share Alike</uri> license, an open documentation license. All
49 documentation should also be available in a printer-friendly format. To view
50 this document, append <path>?style=printable</path> to the URL.
51 </p>
52
53 <p>
54 If you find bugs in our documentation or have proposals, please use our
55 <uri link="http://bugs.gentoo.org">Bugtracking System</uri> and fill in
56 a bug report for "Docs-developer" or "Docs-user". These bugreports will
57 then be handled by the <uri
58 link="http://www.gentoo.org/proj/en/gdp">Gentoo Documentation
59 Project</uri>.
60 </p>
61
62 </body>
63 </section>
64 <section>
65 <title>Internationalisation Effort</title>
66 <body>
67
68 <p>
69 Our documentation is available in several languages. Although not all
70 documents are translated, we do our best to keep them all up to date and
71 provide our users with as much translated documentation as possible. If
72 you want to help with our translation efforts, please contact <mail
73 link="svyatogor@gentoo.org">Sergey Kuleshov</mail> who is in charge of
74 the internationalisation efforts.
75 </p>
76
77 <p>
78 We currently provide documentation for the following languages:
79 </p>
80
81 <p>
82 <uri link="http://www.gentoo.org/doc/nl/index.xml">Dutch</uri> |
83 <uri link="http://www.gentoo.org/doc/en/index.xml">English</uri> |
84 <uri link="http://www.gentoo.org/doc/fr/index.xml">French</uri> |
85 <uri link="http://www.gentoo.org/doc/de/index.xml">German</uri> |
86 <uri link="http://www.gentoo.org/doc/hu/index.xml">Hungarian</uri> |
87 <uri link="http://www.gentoo.org/doc/id/index.xml">Indonesian</uri> |
88 <uri link="http://www.gentoo.org/doc/it/index.xml">Italian</uri> |
89 <uri link="http://www.gentoo.org/doc/ja/index.xml">Japanese</uri> |
90 <uri link="http://www.gentoo.org/doc/kr/index.xml">Korean</uri> |
91 <uri link="http://www.gentoo.org/doc/ru/index.xml">Russian</uri> |
92 <uri link="http://www.gentoo.org/doc/es/index.xml">Spanish</uri> |
93 <uri link="http://www.gentoo.org/doc/tw/index.xml">Traditional Chinese</uri>
94 </p>
95
96 </body>
97 </section>
98 <section>
99 <title>Frequently Asked Questions</title>
100 <body>
101
102 <p>
103 As with every major project Gentoo has a FAQ too. We have first and foremost
104 two official FAQs maintained by the Gentoo Documentation Project:
105 </p>
106
107 <ul>
108 <li>The <b><uri link="faq.xml">Gentoo FAQ</uri></b> answers Frequently Asked Questions
109 about Gentoo Linux with focus on x86 platforms.</li>
110 <li>The <b><uri link="gentoo-ppc-faq.xml">Gentoo PPC FAQ</uri></b> answers Frequently
111 Asked Questions about Gentoo Linux on the PowerPC platform.</li>
112 </ul>
113
114 <p>
115 Furthermore we have a very extensive collection of FAQs on our <uri
116 link="http://forums.gentoo.org">forums</uri>. To view those, go to
117 <uri>http://forums.gentoo.org/viewforum.php?f=40</uri>.
118 </p>
119
120 </body>
121 </section>
122 </chapter>
123
124 <chapter>
125 <title>Installation Related Resources</title>
126 <section>
127 <title>Introduction</title>
128 <body>
129
130 <p>
131 The installation related documentation provide information that can be usefull
132 during the installation of Gentoo Linux. This includes architecture-related
133 installation resources and tutorials that are to be followed during the
134 installation (such as LVM).
135 </p>
136
137 </body>
138 </section>
139 <section>
140 <title>Installation Guides</title>
141 <body>
142
143 <p>
144 The installation guides step you through the process of installing Gentoo
145 Linux 1.4. We support various installation approaches, depending on how much
146 of the system you want to custom-build from scratch.
147 </p>
148
149 <p>
150 The installation guides are available for the following architectures:
151 </p>
152
153 <table>
154 <tr>
155 <ti>x86</ti>
156 <ti><b><uri link="gentoo-x86-install.xml">Online</uri></b></ti>
157 <ti><b><uri link="gentoo-x86-install.xml?style=printable">Printer Friendly</uri></b></ti>
158 </tr>
159 <tr>
160 <ti>Alpha</ti>
161 <ti><b><uri link="gentoo-alpha-install.xml">Online</uri></b></ti>
162 <ti><b><uri link="gentoo-alpha-install.xml?style=printable">Printer Friendly</uri></b></ti>
163 </tr>
164 <tr>
165 <ti>HPPA</ti>
166 <ti><b><uri link="gentoo-hppa-install.xml">Online</uri></b></ti>
167 <ti><b><uri link="gentoo-hppa-install.xml?style=printable">Printer Friendly</uri></b></ti>
168 </tr>
169 <tr>
170 <ti>PPC</ti>
171 <ti><b><uri link="gentoo-ppc-install.xml">Online</uri></b></ti>
172 <ti><b><uri link="gentoo-ppc-install.xml?style=printable">Printer Friendly</uri></b></ti>
173 </tr>
174 <tr>
175 <ti>Sparc</ti>
176 <ti><b><uri link="gentoo-sparc-install.xml">Online</uri></b></ti>
177 <ti><b><uri link="gentoo-sparc-install.xml?style=printable">Printer Friendly</uri></b></ti>
178 </tr>
179 </table>
180
181 <p>
182 Most users will probably need the <b><uri link="gentoo-x86-install.xml">x86
183 Installation Guide</uri></b>.
184 </p>
185
186 <p>
187 Alpha-users are probably also interested in our <b><uri
188 link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></b>, which
189 explains how to set up the Compaq Tools package for Gentoo Alpha users.
190 </p>
191
192 </body>
193 </section>
194 <section>
195 <title>Other Installation Related Documentation</title>
196 <body>
197
198 <p>
199 For some people, the installation guide above doesn't suffice since their
200 environment doesn't permit them to boot from a LiveCD. To anticipate their
201 environments we provide the <b><uri link="altinstall.xml">Alternative
202 Installation Guide</uri></b> which lists the installation steps needed to install
203 Gentoo from another medium (distribution, bootable CD, network boot, etc.).
204 </p>
205
206 <p>
207 Users interested in using LVM should read up our <b><uri link="lvm.xml">LVM
208 Guide</uri></b> which explains what steps you have to go through to get your
209 LVM scheme up and running.
210 </p>
211
212 <p>
213 The <b><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade
214 Guide</uri></b> explains how to upgrade your Gentoo Linux 1.x systems to
215 Gentoo Linux 1.4.
216 </p>
217
218 </body>
219 </section>
220 </chapter>
221
222 <chapter>
223 <title>Gentoo System Documentation</title>
224 <section>
225 <title>Introduction</title>
226 <body>
227
228 <p>
229 The Gentoo System Documentation contains several guides about what makes
230 Gentoo Gentoo. This includes our init-system, Portage, USE-flags etc.
231 </p>
232
233 </body>
234 </section>
235 <section>
236 <title>Portage and Related Documentation</title>
237 <body>
238
239 <p>
240 The <b><uri link="portage-user.xml">Portage User Guide</uri></b> briefly covers how
241 to keep your packages up to date and how to maintain your installed software.
242 In other words: this guide tells you how to use <c>emerge</c>.
243 </p>
244
245 <p>
246 The <b><uri link="portage-manual.xml">Portage Manual</uri></b> provides a general
247 overview of Portage, detailed configuration information and an end user guide
248 to installing and maintaining packages using the Portage system. It is
249 far more extended than the Portage User Guide.
250 </p>
251
252 <p>
253 The <b><uri link="use-howto.xml">USE Howto</uri></b> introduces you to the ultimate
254 tool for customizing Gentoo -- USE flags. This howto helps you decide which
255 USE flags you need. It also describes the use of <c>etcat</c> to receive
256 more verbatim information regarding USE-flags on a package.
257 </p>
258
259 </body>
260 </section>
261 <section>
262 <title>Configuring Gentoo</title>
263 <body>
264
265 <p>
266 The <b><uri link="env.d-howto.xml">ENV.D Howto</uri></b> explains how to manage
267 environment variables (such as <path>$PATH</path>) and the dynamic linker
268 cache easily.
269 </p>
270
271 <p>
272 The <b><uri link="rc-scripts.xml">RC-Script Guide</uri></b> details our system
273 startup and service management scripts. Besides the regular
274 initscript-related items it also covers initscript dependencies and
275 support for virtuals.
276 </p>
277
278 </body>
279 </section>
280 <section>
281 <title>Gentoo Choices</title>
282 <body>
283
284 <p>
285 The <b><uri link="gentoo-kernel.xml">Kernel Guide</uri></b> lists the various
286 kernel sources Gentoo provides. Most of these kernels are maintained by
287 the <uri link="http://www.gentoo.org/proj/en/kernel">Gentoo Kernel
288 Project</uri>.
289 </p>
290
291 </body>
292 </section>
293 </chapter>
294
295 <chapter>
296 <title>System Administration Documentation</title>
297 <section>
298 <title>Introduction</title>
299 <body>
300
301 <p>
302 The System Administration Documentation contains tutorials and guides on how to
303 install, configure and/or manage certain aspects of system administration.
304 Although the focus is on Gentoo systems, several of these guides can very well
305 be used by non-Gentoo users.
306 </p>
307
308 </body>
309 </section>
310 <section>
311 <title>General System Administration</title>
312 <body>
313
314 <p>
315 The <b><uri link="gentoo-security.xml">Gentoo Security Guide</uri></b> explains how
316 to harden a Gentoo Linux system against intruders and attacks. It
317 contains general security information (securing services, designing firewalls,
318 using IDS, kernel security etc.). For even tighter hardening please
319 visit the <uri link="http://www.gentoo.org/proj/en/hardened">Gentoo
320 Hardened</uri> website.
321 </p>
322
323 <p>
324 The <b><uri link="prelink-howto.xml">Prelinking Guide</uri></b> explains how to
325 enhance your system using prelink. With prelinking, bigger applications
326 start up faster.
327 </p>
328
329 <p>
330 The <b><uri link="ipv6.xml">IPv6 Guide</uri></b> shows how to setup IPv6 under
331 Gentoo Linux. IPv6 is the next Internet Protocol and is gaining
332 popularity widely.
333 </p>
334
335 <p>
336 The <b><uri link="uml.xml">User Mode Linux Guide</uri></b> shows how to use User-Mode
337 Linux under Gentoo Linux. User Mode Linux (UML) provides a nice feature
338 for Linux: Running Linux inside Linux (inside Linux inside Linux ...).
339 With UML, you can easily create virtual setups.
340 </p>
341
342 </body>
343 </section>
344 <section>
345 <title>Specific Administration Guides</title>
346 <body>
347
348 <p>
349 The <b><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></b> explains how
350 to administer user accounts centralised using OpenLDAP.
351 </p>
352
353 <p>
354 The <b><uri link="openmosix-howto.xml">OpenMosix Howto</uri></b> describes step by
355 step how you can create a farm full of diskless openmosix nodes (a
356 cluster of several PCs).
357 </p>
358
359 <p>
360 The <b><uri link="ltsp.xml">LTSP Guide</uri></b> explains how to setup a Linux
361 Terminal Server with Gentoo.
362 </p>
363
364 <p>
365 The <b><uri link="distcc.xml">Distcc Guide</uri></b> informs you how to use distcc
366 for distributed compilations with Gentoo Linux.
367 </p>
368
369 <p>
370 The <b><uri link="devfs-guide.xml">DevFS Guide</uri></b> describes how DevFS works
371 and how to administer it.
372 </p>
373
374 <p>
375 The <b><uri link="printing-howto.xml">Printing Howto</uri></b> is a comprehensive
376 guide to Gentoo and printing.
377 </p>
378
379 <p>
380 The <b><uri link="openafs.xml">OpenAFS Guide</uri></b> documents the use and
381 installation of OpenAFS, a distributed network-based file sharing technology.
382 </p>
383
384 <p>
385 The <b><uri link="virt-mail-howto.xml">Virtual/Mailhost Howto</uri></b> is the
386 essential guide for any mail administrator. It covers the use of MySQL for
387 virtual users, webbased e-mail software, mailinglist software etc.
388 </p>
389
390 </body>
391 </section>
392 </chapter>
393
394 <chapter>
395 <title>Desktop Related Documentation</title>
396 <section>
397 <title>Introduction</title>
398 <body>
399
400 <p>
401 The Desktop Related Documentation contains our Desktop Configuration Guide
402 with several other desktop related documents, including several
403 application-specific guides.
404 </p>
405
406 </body>
407 </section>
408 <section>
409 <title>Desktop Configuration</title>
410 <body>
411
412 <p>
413 The <b><uri link="desktop.xml">Desktop Configuration Guide</uri></b> explains how to
414 set up a fully-functional Gentoo Linux desktop machine. This includes
415 configuring KDE/GNOME, Using e-mail, File Sharing (using Samba), etc.
416 </p>
417
418 <p>
419 The <b><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></b> is a
420 comprehensive guide on how to install and use ALSA (Advanced Linux Sound
421 Architecture).
422 </p>
423
424 <p>
425 The <b><uri link="java.xml">Java Guide</uri></b> explains how Java is handled under
426 Gentoo Linux.
427 </p>
428
429 <p>
430 The <b><uri link="guide-localization.xml">Localisation Guide</uri></b> explains how
431 to localise Gentoo Linux for non-English users.
432 </p>
433
434 <p>
435 The <b><uri link="dri-howto.xml">Direct Rendering Howto</uri></b> explains how to get
436 3D acceleration working using XFree-DRM.
437 </p>
438
439 <p>
440 The <b><uri link="ati-faq.xml">ATI FAQ</uri></b> provides the answers to frequently
441 asked questions regarding ATI graphical cards.
442 </p>
443
444 </body>
445 </section>
446 <section>
447 <title>Application Specific Documentation</title>
448 <body>
449
450 <p>
451 The <b><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></b> leads by example
452 to explain the basics of Nano.
453 </p>
454
455 <p>
456 The <b><uri link="vi-guide.xml">Vi Guide</uri></b> uses the cheatsheet method to
457 teach the basics of vi.
458 </p>
459
460 <p>
461 The <b><uri link="gnupg-user.xml">GnuPG User Guide</uri></b> is the definitive guide
462 on GnuPG.
463 </p>
464
465 <p>
466 The <b><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></b>
467 explains how to use fetchmail, procmail, mutt, and nbsmtp.
468 </p>
469
470 <p>
471 The <b><uri link="cvs-tutorial.xml">CVS Tutorial</uri></b> documents the basics of
472 using CVS, the Concurrent Versioning System.
473 </p>
474
475 </body>
476 </section>
477 </chapter>
478
479 <chapter>
480 <title>Gentoo Development Documentation</title>
481 <section>
482 <title>Introduction</title>
483 <body>
484
485 <p>
486 Gentoo is a volunteer-driven distribution. It is therefor vital to have
487 high-quality development-related documentation available so that interested
488 users can easily learn how to help in the development of their favorite
489 distribution.
490 </p>
491
492 </body>
493 </section>
494 <section>
495 <title>Gentoo Development Policies</title>
496 <body>
497
498 <p>
499 The <b><uri link="policy.xml">Gentoo Linux Development Policy</uri></b> details
500 current policy for the creation of ebuilds.
501 </p>
502
503 <p>
504 The <b><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></b>
505 details current policy for Gentoo Linux releases.
506 </p>
507
508 <p>
509 The <b><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></b> details
510 current policy for the creation and editing of documentation.
511 </p>
512
513 </body>
514 </section>
515 <section>
516 <title>Development Related Documentation</title>
517 <body>
518
519 <p>
520 The <b><uri link="gentoo-howto.xml">Ebuild HOWTO</uri></b> explains how to create
521 ebuilds.
522 </p>
523
524 <p>
525 The <b><uri link="eclass-howto.xml">Eclass HOWTO</uri></b> shows how to create
526 ebuilds that support OOP-like inheritance features.
527 </p>
528
529 <p>
530 The <b><uri link="stage-building-guide.xml">Stage Building Guide</uri></b> details
531 the stage tarball creation process.
532 </p>
533
534 <p>
535 The <b><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></b> explains
536 how to submit user-authored ebuilds.
537 </p>
538
539 <p>
540 The <b><uri link="xml-guide.xml">GuideXML Guide</uri></b> documents the XML format
541 used in Gentoo Linux's web-based documentation.
542 </p>
543
544 </body>
545 </section>
546 </chapter>
547
548 <chapter>
549 <title>Other Documentation</title>
550 <section>
551 <body>
552
553 <ul>
554 <li>View our <uri link="http://www.gentoo.org/cgi-bin/viewcvs.cgi">CVS repository</uri> if you need to look at our code and ebuilds.</li>
555 <li><b><uri link="http://www.gentoo.org/main/en/about.xml">About</uri></b> the Gentoo Project.</li>
556 <li>Gentoo's <b><uri link="http://www.gentoo.org/main/en/contract.xml">Social Contract</uri></b>.</li>
557 <li>More on the <b><uri link="http://www.gentoo.org/proj/en/site.xml">XML projects</uri></b> Gentoo has gone through.</li>
558 <li>How to <b><uri link="rsync.xml">Mirror Gentoo : Rsync</uri></b>.</li>
559 <li>How to <b><uri link="source_mirrors.xml">Mirror Gentoo : Distfiles</uri></b>.</li>
560 <li>Gentoo Linux News (<uri link="http://www.gentoo.org/rdf/en/gentoo-news.rdf">RDF</uri>, <uri
561 link="http://purl.org/net/syndication/subscribe/?rss=http://www.gentoo.org/rdf/en/gentoo-news.rdf">Subscribe</uri>).</li>
562 </ul>
563
564 </body>
565 </section>
566 </chapter>
567 </mainpage>

  ViewVC Help
Powered by ViewVC 1.1.20