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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

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

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.104

  ViewVC Help
Powered by ViewVC 1.1.20