/[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.1 Revision 1.51
1<?xml version="1.0" encoding="UTF-8"?> 1<?xml version="1.0" encoding="UTF-8"?>
2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/index.xml,v 1.51 2004/04/11 15:39:24 swift Exp $ -->
2<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE mainpage SYSTEM "/dtd/guide.dtd">
3<mainpage id="docs"> 4<mainpage id="docs">
4 <title>Gentoo Documentation Resources</title> 5 <title>Gentoo Documentation Resources</title>
5 <author title="Author"> 6 <author title="Author">
6 <mail link="drobbins@gentoo.org">Daniel Robbins</mail> 7 <mail link="drobbins@gentoo.org">Daniel Robbins</mail>
7 </author> 8 </author>
8 <author title="Editor"> 9 <author title="Editor"><!-- zhen@gentoo.org -->
9 <mail link="zhen@gentoo.org">John P. Davis</mail> 10 John P. Davis
10 </author> 11 </author>
11 <author title="Editor">Colin Morey</author> 12 <author title="Editor">Colin Morey</author>
12 <author title="Editor"> 13 <author title="Editor">
13 <mail link="peesh@gentoo.org">Jorge Paulo</mail> 14 <mail link="peesh@gentoo.org">Jorge Paulo</mail>
14 </author> 15 </author>
15 <author title="Editor"> 16 <author title="Editor">
16 <mail link="swift@gentoo.org">Sven Vermeulen</mail> 17 <mail link="swift@gentoo.org">Sven Vermeulen</mail>
17 </author> 18 </author>
18 <version>1.0.91</version> 19 <version>2.21</version>
19 <date>October 6, 2003</date> 20 <date>April 11, 2004</date>
20 21
21<chapter> 22<chapter>
22<title>Gentoo Documentation Resources</title> 23<title>Gentoo Documentation Resources</title>
24<section>
25<title>Available Languages</title>
26<body>
27
28<p>
29This page (and documentation) is available in the following languages:
30</p>
31
32<p>
33<uri link="http://www.gentoo.org/doc/da/index.xml">Danish</uri> |
34<uri link="http://www.gentoo.org/doc/nl/index.xml">Dutch</uri> |
35<uri link="http://www.gentoo.org/doc/en/index.xml">English</uri> |
36<uri link="http://www.gentoo.org/doc/fr/index.xml">French</uri> |
37<uri link="http://www.gentoo.org/doc/de/index.xml">German</uri> |
38<uri link="http://www.gentoo.org/doc/hu/index.xml">Hungarian</uri> |
39<uri link="http://www.gentoo.org/doc/id/index.xml">Indonesian</uri> |
40<uri link="http://www.gentoo.org/doc/it/index.xml">Italian</uri> |
41<uri link="http://www.gentoo.org/doc/ja/index.xml">Japanese</uri> |
42<!-- <uri link="http://www.gentoo.org/doc/kr/index.xml">Korean</uri> | -->
43<uri link="http://www.gentoo.org/doc/ru/index.xml">Russian</uri> |
44<uri link="http://www.gentoo.org/doc/es/index.xml">Spanish</uri> |
45<uri link="http://www.gentoo.org/doc/tw/index.xml">Traditional Chinese</uri>
46</p>
47
48</body>
49</section>
23<section> 50<section>
24<title>Contents</title> 51<title>Contents</title>
25<body> 52<body>
26 53
27<ul> 54<ul>
30<li><uri link="#doc_chap3">Gentoo System Documentation</uri></li> 57<li><uri link="#doc_chap3">Gentoo System Documentation</uri></li>
31<li><uri link="#doc_chap4">System Administration Documentation</uri></li> 58<li><uri link="#doc_chap4">System Administration Documentation</uri></li>
32<li><uri link="#doc_chap5">Desktop Related Documentation</uri></li> 59<li><uri link="#doc_chap5">Desktop Related Documentation</uri></li>
33<li><uri link="#doc_chap6">Gentoo Development Documentation</uri></li> 60<li><uri link="#doc_chap6">Gentoo Development Documentation</uri></li>
34<li><uri link="#doc_chap7">Other Documentation</uri></li> 61<li><uri link="#doc_chap7">Other Documentation</uri></li>
62<li><uri link="#doc_chap8">Overview of Available Documentation</uri></li>
35</ul> 63</ul>
36 64
37</body> 65</body>
38</section> 66</section>
39<section> 67<section>
51</p> 79</p>
52 80
53<p> 81<p>
54If you find bugs in our documentation or have proposals, please use our 82If 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 83<uri link="http://bugs.gentoo.org">Bugtracking System</uri> and fill in
56a bug report for "Docs-developer" or "Docs-user". These bugreports will 84a bug report for "Docs-developer" or "Docs-user". These bug reports will
57then be handled by the <uri 85then be handled by the <uri
58link="http://www.gentoo.org/proj/en/gdp">Gentoo Documentation 86link="http://www.gentoo.org/proj/en/gdp">Gentoo Documentation
59Project</uri>. 87Project</uri>.
60</p> 88</p>
61 89
68<p> 96<p>
69Our documentation is available in several languages. Although not all 97Our documentation is available in several languages. Although not all
70documents are translated, we do our best to keep them all up to date and 98documents are translated, we do our best to keep them all up to date and
71provide our users with as much translated documentation as possible. If 99provide our users with as much translated documentation as possible. If
72you want to help with our translation efforts, please contact <mail 100you want to help with our translation efforts, please contact <mail
73link="svyatogor@gentoo.org">Sergey Kuleshov</mail> who is in charge of 101link="neysx@gentoo.org">Xavier Neys</mail> who is in charge of
74the internationalisation efforts. 102the internationalisation efforts.
75</p>
76
77<p>
78We 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> 103</p>
95 104
96</body> 105</body>
97</section> 106</section>
98<section> 107<section>
117<uri>http://forums.gentoo.org/viewforum.php?f=40</uri>. 126<uri>http://forums.gentoo.org/viewforum.php?f=40</uri>.
118</p> 127</p>
119 128
120</body> 129</body>
121</section> 130</section>
131<section>
132<title>Gentoo Handbook</title>
133<body>
134
135<p>
136The Gentoo Documentation Project has started with the <uri
137link="handbook/">Gentoo Handbook</uri> development. Currently, the
138first two parts (<uri link="handbook/handbook-x86.xml?part=1">Installing
139Gentoo</uri> and <uri link="handbook/handbook-x86.xml?part=2">Working with
140Gentoo</uri>) are finished and have reached the "official" stage. Users are
141encouraged to use the installation instructions from the Handbook and <uri
142link="http://bugs.gentoo.org/enter_bug.cgi?product=Docs-user">bug</uri> us with
143their experience (please use the <e>Handbook</e> component).
144</p>
145
146<p>
147More information can be found on the <uri link="handbook/">Gentoo
148Handbook Effort</uri> homepage.
149</p>
150
151</body>
152</section>
122</chapter> 153</chapter>
123 154
124<chapter> 155<chapter>
125<title>Installation Related Resources</title> 156<title>Installation Related Resources</title>
126<section> 157<section>
127<title>Introduction</title> 158<title>Introduction</title>
128<body> 159<body>
129 160
130<p> 161<p>
131The installation related documentation provide information that can be usefull 162The installation related documentation provides information that can be usefull
132during the installation of Gentoo Linux. This includes architecture-related 163during the installation of Gentoo Linux. This includes the part on "Installing
133installation resources and tutorials that are to be followed during the 164Gentoo" in our Gentoo Handbook, as well as the older but still maintained
134installation (such as LVM). 165architecture-related installation resources and tutorials that are to be
166followed during the installation.
135</p> 167</p>
136 168
137</body> 169</body>
138</section> 170</section>
139<section> 171<section>
140<title>Installation Guides</title> 172<title>Installation Guides</title>
141<body> 173<body>
142 174
143<p> 175<p>
144The installation guides step you through the process of installing Gentoo 176The first part of our <b><uri link="/doc/en/handbook/index.xml">Gentoo
145Linux 1.4. We support various installation approaches, depending on how much 177Handbook</uri></b> explains how to install Gentoo on your system. Each
146of the system you want to custom-build from scratch. 178architecture-specific version contains instructions for all users.
147</p>
148
149<p> 179</p>
150The installation guides are available for the following architectures: 180
151</p> 181<p>
152 182For experienced users we also have Quick Installation Reference documents:
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> 183</p>
182Most users will probably need the <b><uri link="gentoo-x86-install.xml">x86 184
183Installation Guide</uri></b>. 185<ul>
184</p> 186 <li><b><uri link="gentoo-x86-quickinstall.xml">x86 Quick Installation Reference</uri></b></li>
187 <li><b><uri link="gentoo-sparc-quickinstall.xml">Sparc Quick Installation Reference</uri></b></li>
188</ul>
185 189
186<p> 190<p>
187Alpha-users are probably also interested in our <b><uri 191Alpha-users are probably also interested in our <b><uri
188link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></b>, which 192link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></b>, which
189explains how to set up the Compaq Tools package for Gentoo Alpha users. 193explains how to set up the Compaq Tools package for Gentoo Alpha users.
202Installation Guide</uri></b> which lists the installation steps needed to install 206Installation Guide</uri></b> which lists the installation steps needed to install
203Gentoo from another medium (distribution, bootable CD, network boot, etc.). 207Gentoo from another medium (distribution, bootable CD, network boot, etc.).
204</p> 208</p>
205 209
206<p> 210<p>
207Users interested in using LVM should read up our <b><uri link="lvm.xml">LVM 211Users interested in using LVM2 should read up our <b><uri link="lvm2.xml">LVM2
208Guide</uri></b> which explains what steps you have to go through to get your 212Guide</uri></b> which explains the steps required to get your LVM2 scheme up
209LVM scheme up and running. 213and running.
214</p>
215
216<p>
217As our installation instructions allow for great flexibility, there are many
218tips and tricks that can be persued during the installation. We have a <b><uri
219link="gentoo-x86-tipsntricks.xml">Gentoo/x86 Installation Tips 'n
220Tricks</uri></b> document online (which also contains interesting Tips 'n Tricks
221for other architectures).
210</p> 222</p>
211 223
212<p> 224<p>
213The <b><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade 225The <b><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade
214Guide</uri></b> explains how to upgrade your Gentoo Linux 1.x systems to 226Guide</uri></b> explains how to upgrade your Gentoo Linux 1.x systems to
215Gentoo Linux 1.4. 227Gentoo Linux 1.4.
216</p> 228</p>
217 229
230<p>
231The <b><uri link="genkernel.xml">Genkernel Guide</uri></b> intends to provide a
232reference of all the functions provided by genkernel.
233</p>
234
218</body> 235</body>
219</section> 236</section>
220</chapter> 237</chapter>
221 238
222<chapter> 239<chapter>
228<p> 245<p>
229The Gentoo System Documentation contains several guides about what makes 246The Gentoo System Documentation contains several guides about what makes
230Gentoo Gentoo. This includes our init-system, Portage, USE-flags etc. 247Gentoo Gentoo. This includes our init-system, Portage, USE-flags etc.
231</p> 248</p>
232 249
250<p>
251The Gentoo Handbook has a part on <uri
252link="handbook/handbook-x86.xml?part=2">Working with Gentoo</uri> which contains
253information on Portage, USE flags, the Gentoo Init system and environment
254variables.
255</p>
256
233</body> 257</body>
234</section> 258</section>
235<section> 259<section>
236<title>Portage and Related Documentation</title> 260<title>Portage and Related Documentation</title>
237<body> 261<body>
238 262
239<p> 263<p>
240The <b><uri link="portage-user.xml">Portage User Guide</uri></b> briefly covers how 264The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=2">Portage and
265Software</uri></b> chapter in the Gentoo Handbook briefly covers how to keep
241to keep your packages up to date and how to maintain your installed software. 266your packages up to date and how to maintain your installed software. In other
242In other words: this guide tells you how to use <c>emerge</c>. 267words, this chapter tells you how to use <c>emerge</c>.
243</p> 268</p>
269
244 270
245<p> 271<p>
246The <b><uri link="portage-manual.xml">Portage Manual</uri></b> provides a general 272The <b><uri link="portage-manual.xml">Portage Manual</uri></b> provides a general
247overview of Portage, detailed configuration information and an end user guide 273overview of Portage, detailed configuration information and an end user guide
248to installing and maintaining packages using the Portage system. It is 274to installing and maintaining packages using the Portage system. It is
249far more extended than the Portage User Guide. 275far more extended than the Portage User Guide.
250</p> 276</p>
251 277
252<p> 278<p>
253The <b><uri link="use-howto.xml">USE Howto</uri></b> introduces you to the ultimate 279The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=1">USE Flags</uri></b>
280chapter in the Gentoo Handbook introduces you to the ultimate
254tool for customizing Gentoo -- USE flags. This howto helps you decide which 281tool for customizing Gentoo -- USE flags. This howto helps you decide which
255USE flags you need. It also describes the use of <c>etcat</c> to receive 282USE flags you need. It also describes the use of <c>etcat</c> to receive
256more verbatim information regarding USE-flags on a package. 283more verbose information regarding USE-flags on a package.
257</p> 284</p>
258 285
259</body> 286</body>
260</section> 287</section>
261<section> 288<section>
262<title>Configuring Gentoo</title> 289<title>Configuring Gentoo</title>
263<body> 290<body>
264 291
265<p> 292<p>
266The <b><uri link="env.d-howto.xml">ENV.D Howto</uri></b> explains how to manage 293The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=6">Environment
294Variables</uri></b> chapter in the Gentoo Handbook explains how to manage
267environment variables (such as <path>$PATH</path>) and the dynamic linker 295environment variables (such as <path>$PATH</path>) and the dynamic linker
268cache easily. 296cache easily.
269</p> 297</p>
270 298
271<p> 299<p>
272The <b><uri link="rc-scripts.xml">RC-Script Guide</uri></b> details our system 300The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=5">Initscripts</uri></b>
301chapter in the Gentoo Handbook details our system
273startup and service management scripts. Besides the regular 302startup and service management scripts. Besides the regular
274initscript-related items it also covers initscript dependencies and 303initscript-related items it also covers initscript dependencies and
275support for virtuals. 304support for virtuals.
276</p> 305</p>
277 306
331Gentoo Linux. IPv6 is the next Internet Protocol and is gaining 360Gentoo Linux. IPv6 is the next Internet Protocol and is gaining
332popularity widely. 361popularity widely.
333</p> 362</p>
334 363
335<p> 364<p>
336The <b><uri link="uml.xml">User Mode Linux Guide</uri></b> shows how to use User-Mode 365The <b><uri link="uml.xml">User Mode Linux Guide</uri></b> shows how to use
337Linux under Gentoo Linux. User Mode Linux (UML) provides a nice feature 366User-Mode Linux under Gentoo Linux. User Mode Linux (UML) provides a nice
338for Linux: Running Linux inside Linux (inside Linux inside Linux ...). 367feature for Linux: Running Linux inside Linux (inside Linux inside Linux ...).
339With UML, you can easily create virtual setups. 368With UML, you can easily create virtual setups.
340</p> 369</p>
341 370
371<p>
372The <b><uri link="selinux-uml-guide.xml">SELinux UML Guide</uri></b> show you
373how to set up a UML installation with SELinux support.
374</p>
375
342</body> 376</body>
343</section> 377</section>
344<section> 378<section>
345<title>Specific Administration Guides</title> 379<title>Specific Administration Guides</title>
346<body> 380<body>
347 381
382<!-- Some possible security issues, see #39718
348<p> 383<p>
349The <b><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></b> explains how 384The <b><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></b> explains how
350to administer user accounts centralised using OpenLDAP. 385to administer user accounts centralised using OpenLDAP.
351</p> 386</p>
387-->
352 388
353<p> 389<p>
354The <b><uri link="openmosix-howto.xml">OpenMosix Howto</uri></b> describes step by 390The <b><uri link="openmosix-howto.xml">OpenMosix Howto</uri></b> describes step by
355step how you can create a farm full of diskless openmosix nodes (a 391step how you can create a farm of openmosix nodes (a cluster of several PCs).
356cluster of several PCs). 392</p>
393
394<p>
395The <b><uri link="diskless-howto.xml">Diskless Howto</uri></b> describes step by
396step how you can set up diskless nodes with Gentoo.
357</p> 397</p>
358 398
359<p> 399<p>
360The <b><uri link="ltsp.xml">LTSP Guide</uri></b> explains how to setup a Linux 400The <b><uri link="ltsp.xml">LTSP Guide</uri></b> explains how to setup a Linux
361Terminal Server with Gentoo. 401Terminal Server with Gentoo.
370The <b><uri link="devfs-guide.xml">DevFS Guide</uri></b> describes how DevFS works 410The <b><uri link="devfs-guide.xml">DevFS Guide</uri></b> describes how DevFS works
371and how to administer it. 411and how to administer it.
372</p> 412</p>
373 413
374<p> 414<p>
415The <b><uri link="udev-guide.xml">Gentoo udev Guide</uri></b> describes the new
416device file management (using udev) which replaces DevFS and informs the reader
417how udev is integrated in Gentoo.
418</p>
419
420<p>
375The <b><uri link="printing-howto.xml">Printing Howto</uri></b> is a comprehensive 421The <b><uri link="printing-howto.xml">Printing Howto</uri></b> is a comprehensive
376guide to Gentoo and printing. 422guide to Gentoo and printing.
377</p> 423</p>
378 424
379<p> 425<p>
380The <b><uri link="openafs.xml">OpenAFS Guide</uri></b> documents the use and 426The <b><uri link="openafs.xml">OpenAFS Guide</uri></b> documents the use and
381installation of OpenAFS, a distributed network-based file sharing technology. 427installation of OpenAFS, a distributed network-based file sharing technology.
382</p> 428</p>
383 429
384<p> 430<p>
385The <b><uri link="virt-mail-howto.xml">Virtual/Mailhost Howto</uri></b> is the 431The <b><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></b> is
386essential guide for any mail administrator. It covers the use of MySQL for 432the essential guide for any postfix mail administrator. It covers the use of MySQL
387virtual users, webbased e-mail software, mailinglist software etc. 433for virtual users, webbased e-mail software, mailinglist software etc.
434</p>
435
436<p>
437The <b><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></b> is a pretty
438useful guide for running a qmail based mail system. It focuses on remote
439access and encrypted communication.
388</p> 440</p>
389 441
390</body> 442</body>
391</section> 443</section>
392</chapter> 444</chapter>
498<p> 550<p>
499The <b><uri link="policy.xml">Gentoo Linux Development Policy</uri></b> details 551The <b><uri link="policy.xml">Gentoo Linux Development Policy</uri></b> details
500current policy for the creation of ebuilds. 552current policy for the creation of ebuilds.
501</p> 553</p>
502 554
555<!--
503<p> 556<p>
504The <b><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></b> 557The <b><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></b>
505details current policy for Gentoo Linux releases. 558details current policy for Gentoo Linux releases.
506</p> 559</p>
560-->
507 561
508<p> 562<p>
509The <b><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></b> details 563The <b><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></b>
510current policy for the creation and editing of documentation. 564details current policy for the creation and editing of documentation.
511</p> 565</p>
512 566
513</body> 567</body>
514</section> 568</section>
515<section> 569<section>
516<title>Development Related Documentation</title> 570<title>Development Related Documentation</title>
517<body> 571<body>
518 572
519<p> 573<p>
520The <b><uri link="gentoo-howto.xml">Ebuild HOWTO</uri></b> explains how to create 574The <b><uri link="gentoo-howto.xml">Ebuild HOWTO</uri></b> explains how to
521ebuilds. 575create ebuilds.
522</p> 576</p>
523 577
524<p> 578<p>
525The <b><uri link="eclass-howto.xml">Eclass HOWTO</uri></b> shows how to create 579The <b><uri link="eclass-howto.xml">Eclass HOWTO</uri></b> shows how to create
526ebuilds that support OOP-like inheritance features. 580ebuilds that support OOP-like inheritance features.
527</p> 581</p>
528 582
529<p> 583<p>
530The <b><uri link="stage-building-guide.xml">Stage Building Guide</uri></b> details
531the stage tarball creation process.
532</p>
533
534<p>
535The <b><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></b> explains 584The <b><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></b>
536how to submit user-authored ebuilds. 585explains how to submit user-authored ebuilds.
537</p>
538
539<p> 586</p>
587
588<p>
589The <b><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></b>
590lists the common mistakes contributors/developers make when trying to submit an
591ebuild.
592</p>
593
594<p>
595The <b><uri link="metadata.xml">Metadata document</uri></b> explains how to
596write up a <path>metadata.xml</path> file for a package.
597</p>
598
599<p>
540The <b><uri link="xml-guide.xml">GuideXML Guide</uri></b> documents the XML format 600The <b><uri link="xml-guide.xml">GuideXML Guide</uri></b> documents the XML
541used in Gentoo Linux's web-based documentation. 601format used in Gentoo Linux's web-based documentation.
602</p>
603
604<p>
605The <b><uri link="doc-tipsntricks.xml">Doc Developers' Tips &amp;
606Tricks</uri></b> contains some pointers for documentation developers.
542</p> 607</p>
543 608
544</body> 609</body>
545</section> 610</section>
546</chapter> 611</chapter>
562</ul> 627</ul>
563 628
564</body> 629</body>
565</section> 630</section>
566</chapter> 631</chapter>
632<chapter>
633<title>Document Listing</title>
634<section>
635<body>
636
637<p>
638For people who like to get a short overview on available documentation, here it
639is :)
640</p>
641
642<table>
643<tr><th>Frequently Asked Questions</th></tr>
644<tr><ti><uri link="faq.xml">Gentoo FAQ</uri></ti></tr>
645<tr><ti><uri link="gentoo-ppc-faq.xml">Gentoo PPC FAQ</uri></ti></tr>
646<tr><th>Installation Related Documentation</th></tr>
647<tr><ti><uri link="handbook/">Gentoo Handbook</uri></ti></tr>
648<tr><ti><uri link="gentoo-x86-quickinstall.xml">Gentoo x86 Quick Installation Rerefence</uri></ti></tr>
649<tr><ti><uri link="gentoo-sparc-quickinstall.xml">Gentoo sparc Quick Installation Rerefence</uri></ti></tr>
650<tr><ti><uri link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></ti></tr>
651<tr><ti><uri link="altinstall.xml">Alternative Installation Guide</uri></ti></tr>
652<tr><ti><uri link="lvm2.xml">LVM2 Guide</uri></ti></tr>
653<tr><ti><uri link="gentoo-x86-tipsntricks.xml">Gentoo/x86 Tips 'n Tricks Document</uri></ti></tr>
654<tr><ti><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade Guide</uri></ti></tr>
655<tr><ti><uri link="genkernel.xml">Genkernel Guide</uri></ti></tr>
656<tr><th>Gentoo System Documentation</th></tr>
657<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=2">Portage and Software</uri></ti></tr>
658<tr><ti><uri link="portage-manual.xml">Portage Manual Guide</uri></ti></tr>
659<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=1">USE Flags</uri></ti></tr>
660<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=6">Environment Variables</uri></ti></tr>
661<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=5">Initscripts</uri></ti></tr>
662<tr><ti><uri link="gentoo-kernel.xml">Gentoo Kernel Guide</uri></ti></tr>
663<tr><th>System Administration Documentation</th></tr>
664<tr><ti><uri link="gentoo-security.xml">Gentoo Security Guide</uri></ti></tr>
665<tr><ti><uri link="prelink-howto.xml">Prelinking Howto</uri></ti></tr>
666<tr><ti><uri link="ipv6.xml">IPv6 Guide</uri></ti></tr>
667<tr><ti><uri link="uml.xml">User Mode Linux Guide</uri></ti></tr>
668<tr><ti><uri link="selinux-uml-guide.xml">SELinux UML Guide</uri></ti></tr>
669<!-- <tr><ti><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></ti></tr> -->
670<tr><ti><uri link="openmosix-howto.xml">OpenMosix Guide</uri></ti></tr>
671<tr><ti><uri link="diskless-howto.xml">Diskless Guide</uri></ti></tr>
672<tr><ti><uri link="ltsp.xml">LTSP Guide</uri></ti></tr>
673<tr><ti><uri link="distcc.xml">DistCC Guide</uri></ti></tr>
674<tr><ti><uri link="devfs-guide.xml">DevFS Guide</uri></ti></tr>
675<tr><ti><uri link="udev-guide.xml">Gentoo udev Guide</uri></ti></tr>
676<tr><ti><uri link="printing-howto.xml">Printing Guide</uri></ti></tr>
677<tr><ti><uri link="openafs.xml">OpenAFS Guide</uri></ti></tr>
678<tr><ti><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></ti></tr>
679<tr><ti><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></ti></tr>
680<tr><th>Desktop Related Documentation</th></tr>
681<tr><ti><uri link="desktop.xml">Desktop Configuration Guide</uri></ti></tr>
682<tr><ti><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></ti></tr>
683<tr><ti><uri link="java.xml">Java Guide</uri></ti></tr>
684<tr><ti><uri link="guide-localization.xml">Localisation Guide</uri></ti></tr>
685<tr><ti><uri link="dri-howto.xml">Direct Rendering Howto</uri></ti></tr>
686<tr><ti><uri link="ati-faq.xml">ATI FAQ</uri></ti></tr>
687<tr><ti><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></ti></tr>
688<tr><ti><uri link="vi-guide.xml">Vi Guide</uri></ti></tr>
689<tr><ti><uri link="gnupg-user.xml">GnuPG User Guide</uri></ti></tr>
690<tr><ti><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></ti></tr>
691<tr><ti><uri link="cvs-tutorial.xml">CVS Tutorial</uri></ti></tr>
692<tr><th>Gentoo Development Documentation</th></tr>
693<tr><ti><uri link="policy.xml">Gentoo Linux Development Policy</uri></ti></tr>
694<!-- <tr><ti><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></ti></tr> -->
695<tr><ti><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></ti></tr>
696<tr><ti><uri link="gentoo-howto.xml">Ebuild Howto</uri></ti></tr>
697<tr><ti><uri link="eclass-howto.xml">Eclass Howto</uri></ti></tr>
698<tr><ti><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></ti></tr>
699<tr><ti><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></ti></tr>
700<tr><ti><uri link="metadata.xml">Metadata document</uri></ti></tr>
701<tr><ti><uri link="xml-guide.xml">GuideXML Guide</uri></ti></tr>
702<tr><ti><uri link="doc-tipsntricks.xml">Doc Developers' Tips &amp; Tricks</uri></ti></tr>
703<tr><th>Other Documentation</th></tr>
704<tr><ti><uri link="rsync.xml">Gentoo RSync Mirror</uri></ti></tr>
705<tr><ti><uri link="source_mirrors.xml">Gentoo Distfiles Mirror</uri></ti></tr>
706</table>
707
708</body>
709</section>
710</chapter>
567</mainpage> 711</mainpage>

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.51

  ViewVC Help
Powered by ViewVC 1.1.20