/[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.24 Revision 1.68
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.24 2004/02/10 19:47:26 swift Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/index.xml,v 1.68 2004/07/31 10:30:51 swift Exp $ -->
3<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 3<!DOCTYPE mainpage SYSTEM "/dtd/guide.dtd">
4<mainpage id="docs"> 4<mainpage id="docs">
5 <title>Gentoo Documentation Resources</title> 5 <title>Gentoo Documentation Resources</title>
6 <author title="Author"> 6 <author title="Author">
7 <mail link="drobbins@gentoo.org">Daniel Robbins</mail> 7 <mail link="drobbins@gentoo.org">Daniel Robbins</mail>
8 </author> 8 </author>
14 <mail link="peesh@gentoo.org">Jorge Paulo</mail> 14 <mail link="peesh@gentoo.org">Jorge Paulo</mail>
15 </author> 15 </author>
16 <author title="Editor"> 16 <author title="Editor">
17 <mail link="swift@gentoo.org">Sven Vermeulen</mail> 17 <mail link="swift@gentoo.org">Sven Vermeulen</mail>
18 </author> 18 </author>
19 <version>2.9</version> 19<version>2.32</version>
20 <date>January 23, 2004</date> 20<date>July 31, 2004</date>
21 21
22<chapter> 22<chapter>
23<title>Gentoo Documentation Resources</title> 23<title>Gentoo Documentation Resources</title>
24<section> 24<section>
25<title>Available Languages</title> 25<title>Available Languages</title>
54<ul> 54<ul>
55<li><uri link="#doc_chap1">Introduction</uri></li> 55<li><uri link="#doc_chap1">Introduction</uri></li>
56<li><uri link="#doc_chap2">Installation Related Resources</uri></li> 56<li><uri link="#doc_chap2">Installation Related Resources</uri></li>
57<li><uri link="#doc_chap3">Gentoo System Documentation</uri></li> 57<li><uri link="#doc_chap3">Gentoo System Documentation</uri></li>
58<li><uri link="#doc_chap4">System Administration Documentation</uri></li> 58<li><uri link="#doc_chap4">System Administration Documentation</uri></li>
59<li><uri link="#doc_chap5">Desktop Related Documentation</uri></li> 59<li><uri link="desktop.xml">Gentoo Desktop Documentation Repository</uri></li>
60<li><uri link="#doc_chap6">Gentoo Development Documentation</uri></li> 60<li><uri link="#doc_chap5">Gentoo Development Documentation</uri></li>
61<li><uri link="#doc_chap7">Other Documentation</uri></li> 61<li><uri link="#doc_chap6">Other Documentation</uri></li>
62<li><uri link="#doc_chap8">Overview of Available Documentation</uri></li> 62<li><uri link="#doc_chap7">Overview of Available Documentation</uri></li>
63</ul> 63</ul>
64 64
65</body> 65</body>
66</section> 66</section>
67<section> 67<section>
96<p> 96<p>
97Our documentation is available in several languages. Although not all 97Our documentation is available in several languages. Although not all
98documents 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
99provide our users with as much translated documentation as possible. If 99provide our users with as much translated documentation as possible. If
100you want to help with our translation efforts, please contact <mail 100you want to help with our translation efforts, please contact <mail
101link="svyatogor@gentoo.org">Sergey Kuleshov</mail> who is in charge of 101link="neysx@gentoo.org">Xavier Neys</mail> who is in charge of
102the internationalisation efforts. 102the internationalisation efforts.
103</p> 103</p>
104 104
105</body> 105</body>
106</section> 106</section>
108<title>Frequently Asked Questions</title> 108<title>Frequently Asked Questions</title>
109<body> 109<body>
110 110
111<p> 111<p>
112As with every major project Gentoo has a FAQ too. We have first and foremost 112As with every major project Gentoo has a FAQ too. We have first and foremost
113two official FAQs maintained by the Gentoo Documentation Project: 113a couple of official FAQs maintained by the Gentoo Documentation Project:
114</p> 114</p>
115 115
116<ul> 116<ul>
117<li>The <b><uri link="faq.xml">Gentoo FAQ</uri></b> answers Frequently Asked Questions 117<li>The <b><uri link="faq.xml">Gentoo FAQ</uri></b> answers Frequently Asked Questions
118about Gentoo Linux with focus on x86 platforms.</li> 118about Gentoo Linux with focus on x86 platforms.</li>
119<li>The <b><uri link="gentoo-ppc-faq.xml">Gentoo PPC FAQ</uri></b> answers Frequently 119<li>The <b><uri link="gentoo-ppc-faq.xml">Gentoo PPC FAQ</uri></b> answers Frequently
120Asked Questions about Gentoo Linux on the PowerPC platform.</li> 120Asked Questions about Gentoo Linux on the PowerPC platform.</li>
121<li>The <b><uri link="gentoo-sparc-faq.xml">Gentoo SPARC FAQ</uri></b> answers
122Frequently Asked Questions about Gentoo Linux on the SPARC platform.</li>
121</ul> 123</ul>
122 124
123<p> 125<p>
124Furthermore we have a very extensive collection of FAQs on our <uri 126Furthermore we have a very extensive collection of FAQs on our <uri
125link="http://forums.gentoo.org">forums</uri>. To view those, go to 127link="http://forums.gentoo.org">forums</uri>. To view those, go to
132<title>Gentoo Handbook</title> 134<title>Gentoo Handbook</title>
133<body> 135<body>
134 136
135<p> 137<p>
136The Gentoo Documentation Project has started with the <uri 138The Gentoo Documentation Project has started with the <uri
137link="handbook/handbook.xml">Gentoo Handbook</uri> development. Currently, the 139link="handbook/">Gentoo Handbook</uri> development. Currently, the
138first two parts (<uri link="handbook/handbook.xml?part=1">Installing 140first two parts (<uri link="handbook/handbook-x86.xml?part=1">Installing
139Gentoo</uri> and <uri link="handbook/handbook.xml?part=2">Working with 141Gentoo</uri> and <uri link="handbook/handbook-x86.xml?part=2">Working with
140Gentoo</uri>) are finished and have reached the "official" stage. Users are 142Gentoo</uri>) are finished and have reached the "official" stage. Users are
141encouraged to use the installation instructions from the Handbook and <uri 143encouraged 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 144link="http://bugs.gentoo.org/enter_bug.cgi?product=Docs-user">bug</uri> us with
143their experience (please use the <e>Handbook</e> component). 145their experience (please use the <e>Handbook</e> component).
144</p> 146</p>
145 147
146<p> 148<p>
147More information can be found on the <uri link="handbook/index.xml">Gentoo 149More information can be found on the <uri link="handbook/">Gentoo
148Handbook Effort</uri> homepage. 150Handbook Effort</uri> homepage.
149</p> 151</p>
150 152
151</body> 153</body>
152</section> 154</section>
157<section> 159<section>
158<title>Introduction</title> 160<title>Introduction</title>
159<body> 161<body>
160 162
161<p> 163<p>
162The installation related documentation provides information that can be usefull 164The installation related documentation provides information that can be useful
163during the installation of Gentoo Linux. This includes the part on "Installing 165during the installation of Gentoo Linux. This includes the part on "Installing
164Gentoo" in our Gentoo Handbook, as well as the older but still maintained 166Gentoo" in our Gentoo Handbook, as well as the older but still maintained
165architecture-related installation resources and tutorials that are to be 167architecture-related installation resources and tutorials that are to be
166followed during the installation (such as LVM). 168followed during the installation.
167</p> 169</p>
168 170
169</body> 171</body>
170</section> 172</section>
171<section> 173<section>
172<title>Installation Guides</title> 174<title>Installation Guides</title>
173<body> 175<body>
174 176
175<p> 177<p>
176The part on <uri link="/doc/en/handbook/handbook.xml?part=1">Installing 178The first part of our <b><uri link="/doc/en/handbook/index.xml">Gentoo
177Gentoo</uri> in our <uri link="/doc/en/handbook/index.xml">Gentoo Handbook</uri> 179Handbook</uri></b> explains how to install Gentoo on your system. Each
178explains how to install Gentoo on your system. It contains instructions for all 180architecture-specific version contains instructions for all users.
179users, all architectures.
180</p>
181
182<p> 181</p>
183The installation guides are superseded by the Gentoo Handbook instructions, but 182
184are kept online and maintained until the new Gentoo Linux comes out. They are
185available for the following architectures:
186</p> 183<p>
187 184For experienced users we also have Quick Installation Reference documents:
188<table>
189<tr>
190 <ti>x86</ti>
191 <ti><b><uri link="gentoo-x86-install.xml">Online</uri></b></ti>
192 <ti><b><uri link="gentoo-x86-install.xml?style=printable">Printer Friendly</uri></b></ti>
193</tr>
194<tr>
195 <ti>Alpha</ti>
196 <ti><b><uri link="gentoo-alpha-install.xml">Online</uri></b></ti>
197 <ti><b><uri link="gentoo-alpha-install.xml?style=printable">Printer Friendly</uri></b></ti>
198</tr>
199<tr>
200 <ti>HPPA</ti>
201 <ti><b><uri link="gentoo-hppa-install.xml">Online</uri></b></ti>
202 <ti><b><uri link="gentoo-hppa-install.xml?style=printable">Printer Friendly</uri></b></ti>
203</tr>
204<tr>
205 <ti>PPC</ti>
206 <ti><b><uri link="gentoo-ppc-install.xml">Online</uri></b></ti>
207 <ti><b><uri link="gentoo-ppc-install.xml?style=printable">Printer Friendly</uri></b></ti>
208</tr>
209<tr>
210 <ti>Sparc</ti>
211 <ti><b><uri link="gentoo-sparc-install.xml">Online</uri></b></ti>
212 <ti><b><uri link="gentoo-sparc-install.xml?style=printable">Printer Friendly</uri></b></ti>
213</tr>
214<tr>
215 <ti>Mips</ti>
216 <ti><b><uri link="gentoo-mips-install.xml">Online</uri></b></ti>
217 <ti><b><uri link="gentoo-mips-install.xml?style=printable">Printer Friendly</uri></b></ti>
218</tr>
219</table>
220<!-- unlinked until updated
221<p> 185</p>
222For experienced users we also have a <b><uri 186
187<ul>
223link="gentoo-x86-quickinstall.xml">x86 Quick Installation Reference</uri></b>. 188 <li><b><uri link="gentoo-x86-quickinstall.xml">x86 Quick Installation Reference</uri></b></li>
224</p> 189 <li><b><uri link="gentoo-sparc-quickinstall.xml">Sparc Quick Installation Reference</uri></b></li>
225--> 190</ul>
191
226<p> 192<p>
227Alpha-users are probably also interested in our <b><uri 193Alpha-users are probably also interested in our <b><uri
228link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></b>, which 194link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></b>, which
229explains how to set up the Compaq Tools package for Gentoo Alpha users. 195explains how to set up the Compaq Tools package for Gentoo Alpha users.
230</p> 196</p>
240environment doesn't permit them to boot from a LiveCD. To anticipate their 206environment doesn't permit them to boot from a LiveCD. To anticipate their
241environments we provide the <b><uri link="altinstall.xml">Alternative 207environments we provide the <b><uri link="altinstall.xml">Alternative
242Installation Guide</uri></b> which lists the installation steps needed to install 208Installation Guide</uri></b> which lists the installation steps needed to install
243Gentoo from another medium (distribution, bootable CD, network boot, etc.). 209Gentoo from another medium (distribution, bootable CD, network boot, etc.).
244</p> 210</p>
245<!-- Doc needs updating for LVM2 and 2.6 kernels (also 2.4 <-> 2.6 coop) 211
246<p> 212<p>
247Users interested in using LVM should read up our <b><uri link="lvm.xml">LVM 213Users interested in using LVM2 should read up our <b><uri link="lvm2.xml">LVM2
248Guide</uri></b> (implemented in the Gentoo Handbook) which explains what steps 214Guide</uri></b> which explains the steps required to get your LVM2 scheme up
249you have to go through to get your LVM scheme up and running. 215and running.
216</p>
217
250</p> 218<p>
251--> 219As our installation instructions allow for great flexibility, there are many
220tips and tricks that can be persued during the installation. We have a <b><uri
221link="gentoo-x86-tipsntricks.xml">Gentoo/x86 Installation Tips 'n
222Tricks</uri></b> document online (which also contains interesting Tips 'n Tricks
223for other architectures).
224</p>
225
252<p> 226<p>
253The <b><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade 227The <b><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade
254Guide</uri></b> explains how to upgrade your Gentoo Linux 1.x systems to 228Guide</uri></b> explains how to upgrade your Gentoo Linux 1.x systems to
255Gentoo Linux 1.4. 229Gentoo Linux 1.4.
256</p> 230</p>
257 231
232<p>
233The <b><uri link="gentoo-upgrading.xml">Gentoo Upgrading Guide</uri></b> goes
234deeper into the motivation behind the easy-upgrading system Gentoo uses and
235provides more information about the so-called "profiles".
236</p>
237
238<p>
239The <b><uri link="genkernel.xml">Genkernel Guide</uri></b> intends to provide a
240reference of all the functions provided by genkernel.
241</p>
242
243<p>
244With the help of our <b><uri link="colinux-howto.xml">coLinux HOWTO</uri></b>
245you are able to run Gentoo from within Windows.
246</p>
247
258</body> 248</body>
259</section> 249</section>
260</chapter> 250</chapter>
261 251
262<chapter> 252<chapter>
270Gentoo Gentoo. This includes our init-system, Portage, USE-flags etc. 260Gentoo Gentoo. This includes our init-system, Portage, USE-flags etc.
271</p> 261</p>
272 262
273<p> 263<p>
274The Gentoo Handbook has a part on <uri 264The Gentoo Handbook has a part on <uri
275link="handbook/handbook.xml?part=2">Working with Gentoo</uri> which contains 265link="handbook/handbook-x86.xml?part=2">Working with Gentoo</uri> which contains
276information on Portage, USE flags, the Gentoo Init system and environment 266information on Portage, USE flags, the Gentoo Init system and environment
277variables. 267variables.
278</p> 268</p>
279 269
280</body> 270</body>
282<section> 272<section>
283<title>Portage and Related Documentation</title> 273<title>Portage and Related Documentation</title>
284<body> 274<body>
285 275
286<p> 276<p>
287The <b><uri link="portage-user.xml">Portage User Guide</uri></b> briefly covers how 277The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=2">Portage and
278Software</uri></b> chapter in the Gentoo Handbook briefly covers how to keep
288to keep your packages up to date and how to maintain your installed software. 279your packages up to date and how to maintain your installed software. In other
289In other words: this guide tells you how to use <c>emerge</c>. 280words, this chapter tells you how to use <c>emerge</c>.
290</p> 281</p>
282
291 283
292<p> 284<p>
293The <b><uri link="portage-manual.xml">Portage Manual</uri></b> provides a general 285The <b><uri link="portage-manual.xml">Portage Manual</uri></b> provides a general
294overview of Portage, detailed configuration information and an end user guide 286overview of Portage, detailed configuration information and an end user guide
295to installing and maintaining packages using the Portage system. It is 287to installing and maintaining packages using the Portage system. It is
296far more extended than the Portage User Guide. 288far more extended than the Portage User Guide.
297</p> 289</p>
298 290
299<p> 291<p>
300The <b><uri link="use-howto.xml">USE Howto</uri></b> introduces you to the ultimate 292The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=1">USE Flags</uri></b>
293chapter in the Gentoo Handbook introduces you to the ultimate
301tool for customizing Gentoo -- USE flags. This howto helps you decide which 294tool for customizing Gentoo -- USE flags. This howto helps you decide which
302USE flags you need. It also describes the use of <c>etcat</c> to receive 295USE flags you need. It also describes the use of <c>etcat</c> to receive
303more verbose information regarding USE-flags on a package. 296more verbose information regarding USE-flags on a package.
304</p> 297</p>
305 298
308<section> 301<section>
309<title>Configuring Gentoo</title> 302<title>Configuring Gentoo</title>
310<body> 303<body>
311 304
312<p> 305<p>
313The <b><uri link="env.d-howto.xml">ENV.D Howto</uri></b> explains how to manage 306The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=6">Environment
307Variables</uri></b> chapter in the Gentoo Handbook explains how to manage
314environment variables (such as <path>$PATH</path>) and the dynamic linker 308environment variables (such as <path>$PATH</path>) and the dynamic linker
315cache easily. 309cache easily.
316</p> 310</p>
317 311
318<p> 312<p>
319The <b><uri link="rc-scripts.xml">RC-Script Guide</uri></b> details our system 313The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=5">Initscripts</uri></b>
314chapter in the Gentoo Handbook details our system
320startup and service management scripts. Besides the regular 315startup and service management scripts. Besides the regular
321initscript-related items it also covers initscript dependencies and 316initscript-related items it also covers initscript dependencies and
322support for virtuals. 317support for virtuals.
323</p> 318</p>
324 319
378Gentoo Linux. IPv6 is the next Internet Protocol and is gaining 373Gentoo Linux. IPv6 is the next Internet Protocol and is gaining
379popularity widely. 374popularity widely.
380</p> 375</p>
381 376
382<p> 377<p>
383The <b><uri link="uml.xml">User Mode Linux Guide</uri></b> shows how to use User-Mode 378The <b><uri link="uml.xml">User Mode Linux Guide</uri></b> shows how to use
384Linux under Gentoo Linux. User Mode Linux (UML) provides a nice feature 379User-Mode Linux under Gentoo Linux. User Mode Linux (UML) provides a nice
385for Linux: Running Linux inside Linux (inside Linux inside Linux ...). 380feature for Linux: Running Linux inside Linux (inside Linux inside Linux ...).
386With UML, you can easily create virtual setups. 381With UML, you can easily create virtual setups.
387</p> 382</p>
383
384<!--
385<p>
386The <b><uri link="selinux-uml-guide.xml">SELinux UML Guide</uri></b> show you
387how to set up a UML installation with SELinux support.
388</p>
389-->
388 390
389</body> 391</body>
390</section> 392</section>
391<section> 393<section>
392<title>Specific Administration Guides</title> 394<title>Specific Administration Guides</title>
423The <b><uri link="devfs-guide.xml">DevFS Guide</uri></b> describes how DevFS works 425The <b><uri link="devfs-guide.xml">DevFS Guide</uri></b> describes how DevFS works
424and how to administer it. 426and how to administer it.
425</p> 427</p>
426 428
427<p> 429<p>
430The <b><uri link="udev-guide.xml">Gentoo udev Guide</uri></b> describes the new
431device file management (using udev) which replaces DevFS and informs the reader
432how udev is integrated in Gentoo.
433</p>
434
435<p>
428The <b><uri link="printing-howto.xml">Printing Howto</uri></b> is a comprehensive 436The <b><uri link="printing-howto.xml">Printing Howto</uri></b> is a comprehensive
429guide to Gentoo and printing. 437guide to Gentoo and printing.
430</p> 438</p>
431 439
432<p> 440<p>
433The <b><uri link="openafs.xml">OpenAFS Guide</uri></b> documents the use and 441The <b><uri link="openafs.xml">OpenAFS Guide</uri></b> documents the use and
434installation of OpenAFS, a distributed network-based file sharing technology. 442installation of OpenAFS, a distributed network-based file sharing technology.
435</p> 443</p>
436 444
437<p> 445<p>
438The <b><uri link="virt-mail-howto.xml">Virtual/Mailhost Howto</uri></b> is the 446The <b><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></b> is
439essential guide for any mail administrator. It covers the use of MySQL for 447the essential guide for any postfix mail administrator. It covers the use of MySQL
440virtual users, webbased e-mail software, mailinglist software etc. 448for virtual users, webbased e-mail software, mailinglist software etc.
441</p>
442
443</body>
444</section>
445</chapter>
446
447<chapter>
448<title>Desktop Related Documentation</title>
449<section>
450<title>Introduction</title>
451<body>
452
453<p> 449</p>
454The Desktop Related Documentation contains our Desktop Configuration Guide 450
455with several other desktop related documents, including several
456application-specific guides.
457</p> 451<p>
458 452The <b><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></b> is a pretty
459</body> 453useful guide for running a qmail based mail system. It focuses on remote
460</section> 454access and encrypted communication.
461<section>
462<title>Desktop Configuration</title>
463<body>
464
465<p> 455</p>
466The <b><uri link="desktop.xml">Desktop Configuration Guide</uri></b> explains how to 456
467set up a fully-functional Gentoo Linux desktop machine. This includes
468configuring KDE/GNOME, Using e-mail, File Sharing (using Samba), etc.
469</p> 457<p>
470 458The <b><uri link="gentoo-sparc-netboot-howto.xml">Gentoo/SPARC Netboot
459HOWTO</uri></b> describes how to setup a network booting environment for a Sun
460Microsystems SPARC or UltraSPARC based computer.
471<p> 461</p>
472The <b><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></b> is a 462
473comprehensive guide on how to install and use ALSA (Advanced Linux Sound
474Architecture).
475</p> 463<p>
476 464 The <b><uri link="gentoo-sparc-obpreference.xml">Gentoo SPARC OpenBoot PROM reference
465Guide</uri></b> offers a guide to the SPARC OpenBoot system, available on all
466Sun Microsytsms SPARC/UltraSparc based computers.
477<p> 467</p>
478The <b><uri link="java.xml">Java Guide</uri></b> explains how Java is handled under 468
479Gentoo Linux.
480</p> 469<p>
481 470The <b><uri link="quick-samba-howto.xml">Quick SAMBA Howto</uri></b> gives you a
482<p> 471step-by-step introduction to Samba and includes instructions on setting up an
483The <b><uri link="guide-localization.xml">Localisation Guide</uri></b> explains how 472anti-virus checking for the Samba shares.
484to localise Gentoo Linux for non-English users.
485</p>
486
487<p>
488The <b><uri link="dri-howto.xml">Direct Rendering Howto</uri></b> explains how to get
4893D acceleration working using XFree-DRM.
490</p>
491
492<p>
493The <b><uri link="ati-faq.xml">ATI FAQ</uri></b> provides the answers to frequently
494asked questions regarding ATI graphical cards.
495</p>
496
497</body>
498</section>
499<section>
500<title>Application Specific Documentation</title>
501<body>
502
503<p>
504The <b><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></b> leads by example
505to explain the basics of Nano.
506</p>
507
508<p>
509The <b><uri link="vi-guide.xml">Vi Guide</uri></b> uses the cheatsheet method to
510teach the basics of vi.
511</p>
512
513<p>
514The <b><uri link="gnupg-user.xml">GnuPG User Guide</uri></b> is the definitive guide
515on GnuPG.
516</p>
517
518<p>
519The <b><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></b>
520explains how to use fetchmail, procmail, mutt, and nbsmtp.
521</p>
522
523<p>
524The <b><uri link="cvs-tutorial.xml">CVS Tutorial</uri></b> documents the basics of
525using CVS, the Concurrent Versioning System.
526</p> 473</p>
527 474
528</body> 475</body>
529</section> 476</section>
530</chapter> 477</chapter>
534<section> 481<section>
535<title>Introduction</title> 482<title>Introduction</title>
536<body> 483<body>
537 484
538<p> 485<p>
539Gentoo is a volunteer-driven distribution. It is therefor vital to have 486Gentoo is a volunteer-driven distribution. It is therefore vital to have
540high-quality development-related documentation available so that interested 487high-quality development-related documentation available so that interested
541users can easily learn how to help in the development of their favorite 488users can easily learn how to help in the development of their favorite
542distribution. 489distribution.
543</p> 490</p>
544 491
545</body> 492</body>
546</section> 493</section>
547<section> 494<section>
495<title>Gentoo Developer Handbook</title>
496<body>
497
498<p>
499All developer-specific documentation, including but not limited to Ebuild and
500Eclass development, policies and such, has now been bundled in one awsome <b>
501<uri link="/proj/en/devrel/handbook/handbook.xml">Gentoo Developer
502Handbook</uri></b> for your reading pleasure.
503</p>
504
505</body>
506</section>
507<section>
548<title>Gentoo Development Policies</title> 508<title>Gentoo Development Policies</title>
549<body> 509<body>
550
551<p>
552The <b><uri link="policy.xml">Gentoo Linux Development Policy</uri></b> details
553current policy for the creation of ebuilds.
554</p>
555
556<!--
557<p>
558The <b><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></b>
559details current policy for Gentoo Linux releases.
560</p>
561-->
562 510
563<p> 511<p>
564The <b><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></b> 512The <b><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></b>
565details current policy for the creation and editing of documentation. 513details current policy for the creation and editing of documentation.
566</p> 514</p>
570<section> 518<section>
571<title>Development Related Documentation</title> 519<title>Development Related Documentation</title>
572<body> 520<body>
573 521
574<p> 522<p>
575The <b><uri link="gentoo-howto.xml">Ebuild HOWTO</uri></b> explains how to
576create ebuilds.
577</p>
578
579<p>
580The <b><uri link="eclass-howto.xml">Eclass HOWTO</uri></b> shows how to create
581ebuilds that support OOP-like inheritance features.
582</p>
583
584<p>
585The <b><uri link="stage-building-guide.xml">Stage Building Guide</uri></b>
586details the stage tarball creation process.
587</p>
588
589<p>
590The <b><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></b> 523The <b><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></b>
591explains how to submit user-authored ebuilds. 524explains how to submit user-authored ebuilds.
592</p> 525</p>
593 526
594<!-- Not reviewed yet
595<p>
596The <b><uri link="metadata.xml">Metadata document</uri></b> explains how to
597write up a <path>metadata.xml</path> file for a package.
598</p>
599-->
600
601<p> 527<p>
602The <b><uri link="xml-guide.xml">GuideXML Guide</uri></b> documents the XML 528The <b><uri link="xml-guide.xml">GuideXML Guide</uri></b> documents the XML
603format used in Gentoo Linux's web-based documentation. 529format used in Gentoo Linux's web-based documentation.
530</p>
531
532<p>
533The <b><uri link="doc-tipsntricks.xml">Doc Developers' Tips &amp;
534Tricks</uri></b> contains some pointers for documentation developers.
535</p>
536
537<p>
538The <b><uri link="cvs-tutorial.xml">CVS Tutorial</uri></b> documents the basics
539of using CVS, the Concurrent Versioning System.
604</p> 540</p>
605 541
606</body> 542</body>
607</section> 543</section>
608</chapter> 544</chapter>
626</body> 562</body>
627</section> 563</section>
628</chapter> 564</chapter>
629<chapter> 565<chapter>
630<title>Document Listing</title> 566<title>Document Listing</title>
567<section>
631<body> 568<body>
632 569
633<p> 570<p>
634For people who like to get a short overview on available documentation, here it 571For people who like to get a short overview on available documentation, here it
635is :) 572is :)
637 574
638<table> 575<table>
639<tr><th>Frequently Asked Questions</th></tr> 576<tr><th>Frequently Asked Questions</th></tr>
640<tr><ti><uri link="faq.xml">Gentoo FAQ</uri></ti></tr> 577<tr><ti><uri link="faq.xml">Gentoo FAQ</uri></ti></tr>
641<tr><ti><uri link="gentoo-ppc-faq.xml">Gentoo PPC FAQ</uri></ti></tr> 578<tr><ti><uri link="gentoo-ppc-faq.xml">Gentoo PPC FAQ</uri></ti></tr>
579<tr><ti><uri link="gentoo-sparc-faq.xml">Gentoo SPARC FAQ</uri></ti></tr>
642<tr><th>Installation Related Documentation</th></tr> 580<tr><th>Installation Related Documentation</th></tr>
643<tr><ti><uri link="gentoo-x86-install.xml">Gentoo x86 Installation Guide</uri></ti></tr> 581<tr><ti><uri link="handbook/">Gentoo Handbook</uri></ti></tr>
644<tr><ti><uri link="gentoo-alpha-install.xml">Gentoo Alpha Installation Guide</uri></ti></tr>
645<tr><ti><uri link="gentoo-hppa-install.xml">Gentoo HPPA Installation Guide</uri></ti></tr>
646<tr><ti><uri link="gentoo-ppc-install.xml">Gentoo PPC Installation Guide</uri></ti></tr>
647<tr><ti><uri link="gentoo-sparc-install.xml">Gentoo SPARC Installation Guide</uri></ti></tr>
648<tr><ti><uri link="gentoo-mips-install.xml">Gentoo MIPS Installation Guide</uri></ti></tr>
649<!--<tr><ti><uri link="gentoo-x86-quickinstall.xml">Gentoo x86 Quick Installation Rerefence</uri></ti></tr>--> 582<tr><ti><uri link="gentoo-x86-quickinstall.xml">Gentoo x86 Quick Installation Rerefence</uri></ti></tr>
583<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> 584<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> 585<tr><ti><uri link="altinstall.xml">Alternative Installation Guide</uri></ti></tr>
652<!--<tr><ti><uri link="lvm.xml">LVM Guide</uri></ti></tr>--> 586<tr><ti><uri link="lvm2.xml">LVM2 Guide</uri></ti></tr>
587<tr><ti><uri link="gentoo-x86-tipsntricks.xml">Gentoo/x86 Tips 'n Tricks Document</uri></ti></tr>
653<tr><ti><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade Guide</uri></ti></tr> 588<tr><ti><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade Guide</uri></ti></tr>
589<tr><ti><uri link="gentoo-upgrading.xml">Gentoo Upgrading HOWTO</uri></ti></tr>
590<tr><ti><uri link="genkernel.xml">Genkernel Guide</uri></ti></tr>
591<tr><ti><uri link="colinux-howto.xml">coLinux HOWTO</uri></ti></tr>
654<tr><th>Gentoo System Documentation</th></tr> 592<tr><th>Gentoo System Documentation</th></tr>
655<tr><ti><uri link="portage-user.xml">Portage User Guide</uri></ti></tr> 593<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=2">Portage and Software</uri></ti></tr>
656<tr><ti><uri link="portage-manual.xml">Portage Manual Guide</uri></ti></tr> 594<tr><ti><uri link="portage-manual.xml">Portage Manual Guide</uri></ti></tr>
657<tr><ti><uri link="use-howto.xml">USE Howto</uri></ti></tr> 595<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=1">USE Flags</uri></ti></tr>
658<tr><ti><uri link="env.d-howto.xml">ENV.D Howto</uri></ti></tr> 596<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=6">Environment Variables</uri></ti></tr>
659<tr><ti><uri link="rc-scripts.xml">RC-Script Guide</uri></ti></tr> 597<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=5">Initscripts</uri></ti></tr>
660<tr><ti><uri link="gentoo-kernel.xml">Gentoo Kernel Guide</uri></ti></tr> 598<tr><ti><uri link="gentoo-kernel.xml">Gentoo Kernel Guide</uri></ti></tr>
661<tr><th>System Administration Documentation</th></tr> 599<tr><th>System Administration Documentation</th></tr>
662<tr><ti><uri link="gentoo-security.xml">Gentoo Security Guide</uri></ti></tr> 600<tr><ti><uri link="gentoo-security.xml">Gentoo Security Guide</uri></ti></tr>
663<tr><ti><uri link="prelink-howto.xml">Prelinking Howto</uri></ti></tr> 601<tr><ti><uri link="prelink-howto.xml">Prelinking Howto</uri></ti></tr>
664<tr><ti><uri link="ipv6.xml">IPv6 Guide</uri></ti></tr> 602<tr><ti><uri link="ipv6.xml">IPv6 Guide</uri></ti></tr>
665<tr><ti><uri link="uml.xml">User Mode Linux Guide</uri></ti></tr> 603<tr><ti><uri link="uml.xml">User Mode Linux Guide</uri></ti></tr>
604<!-- <tr><ti><uri link="selinux-uml-guide.xml">SELinux UML Guide</uri></ti></tr>
605-->
666<tr><ti><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></ti></tr> 606<!-- <tr><ti><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></ti></tr> -->
667<tr><ti><uri link="openmosix-howto.xml">OpenMosix Guide</uri></ti></tr> 607<tr><ti><uri link="openmosix-howto.xml">OpenMosix Guide</uri></ti></tr>
668<tr><ti><uri link="diskless-howto.xml">Diskless Guide</uri></ti></tr> 608<tr><ti><uri link="diskless-howto.xml">Diskless Guide</uri></ti></tr>
669<tr><ti><uri link="ltsp.xml">LTSP Guide</uri></ti></tr> 609<tr><ti><uri link="ltsp.xml">LTSP Guide</uri></ti></tr>
670<tr><ti><uri link="distcc.xml">DistCC Guide</uri></ti></tr> 610<tr><ti><uri link="distcc.xml">DistCC Guide</uri></ti></tr>
671<tr><ti><uri link="devfs-guide.xml">DevFS Guide</uri></ti></tr> 611<tr><ti><uri link="devfs-guide.xml">DevFS Guide</uri></ti></tr>
612<tr><ti><uri link="udev-guide.xml">Gentoo udev Guide</uri></ti></tr>
672<tr><ti><uri link="printing-howto.xml">Printing Guide</uri></ti></tr> 613<tr><ti><uri link="printing-howto.xml">Printing Guide</uri></ti></tr>
673<tr><ti><uri link="openafs.xml">OpenAFS Guide</uri></ti></tr> 614<tr><ti><uri link="openafs.xml">OpenAFS Guide</uri></ti></tr>
674<tr><ti><uri link="virt-mail-howto.xml">Virtual/Mailhost Howto</uri></ti></tr> 615<tr><ti><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></ti></tr>
675<tr><th>Desktop Related Documentation</th></tr>
676<tr><ti><uri link="desktop.xml">Desktop Configuration Guide</uri></ti></tr>
677<tr><ti><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></ti></tr>
678<tr><ti><uri link="java.xml">Java Guide</uri></ti></tr>
679<tr><ti><uri link="guide-localization.xml">Localisation Guide</uri></ti></tr>
680<tr><ti><uri link="dri-howto.xml">Direct Rendering Howto</uri></ti></tr> 616<tr><ti><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></ti></tr>
681<tr><ti><uri link="ati-faq.xml">ATI FAQ</uri></ti></tr> 617<tr><ti><uri link="gentoo-sparc-netboot-howto.xml">Gentoo/SPARC Netboot Howto</uri></ti></tr>
682<tr><ti><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></ti></tr> 618<tr><ti><uri link="gentoo-sparc-obpreference.xml">Gentoo SPARC OpenBoot PROM Reference Guide</uri></ti></tr>
683<tr><ti><uri link="vi-guide.xml">Vi Guide</uri></ti></tr> 619<tr><ti><uri link="quick-samba-howto.xml">Quick Samba HOWTO</uri></ti></tr>
684<tr><ti><uri link="gnupg-user.xml">GnuPG User Guide</uri></ti></tr>
685<tr><ti><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></ti></tr>
686<tr><ti><uri link="cvs-tutorial.xml">CVS Tutorial</uri></ti></tr>
687<tr><th>Gentoo Development Documentation</th></tr> 620<tr><th>Gentoo Development Documentation</th></tr>
688<tr><ti><uri link="policy.xml">Gentoo Linux Development Policy</uri></ti></tr> 621<tr><ti><uri link="policy.xml">Gentoo Linux Development Policy</uri></ti></tr>
689<!-- <tr><ti><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></ti></tr> --> 622<!-- <tr><ti><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></ti></tr> -->
690<tr><ti><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></ti></tr> 623<tr><ti><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></ti></tr>
691<tr><ti><uri link="gentoo-howto.xml">Ebuild Howto</uri></ti></tr> 624<tr><ti><uri link="gentoo-howto.xml">Ebuild Howto</uri></ti></tr>
692<tr><ti><uri link="eclass-howto.xml">Eclass Howto</uri></ti></tr> 625<tr><ti><uri link="eclass-howto.xml">Eclass Howto</uri></ti></tr>
693<tr><ti><uri link="stage-building-guide.xml">Stage Building Guide</uri></ti></tr>
694<tr><ti><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></ti></tr> 626<tr><ti><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></ti></tr>
627<tr><ti><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></ti></tr>
695<!-- <tr><ti><uri link="metadata.xml">Metadata document</uri></ti></tr> --> 628<tr><ti><uri link="metadata.xml">Metadata document</uri></ti></tr>
629<tr><ti><uri link="xml-guide.xml">GuideXML Guide</uri></ti></tr>
630<tr><ti><uri link="doc-tipsntricks.xml">Doc Developers' Tips &amp; Tricks</uri></ti></tr>
631<tr><ti><uri link="cvs-tutorial.xml">CVS Tutorial</uri></ti></tr>
696<tr><th>Other Documentation</th></tr> 632<tr><th>Other Documentation</th></tr>
697<tr><ti><uri link="rsync.xml">Gentoo RSync Mirror</uri></ti></tr> 633<tr><ti><uri link="rsync.xml">Gentoo RSync Mirror</uri></ti></tr>
698<tr><ti><uri link="source_mirrors.xml">Gentoo Distfiles Mirror</uri></ti></tr> 634<tr><ti><uri link="source_mirrors.xml">Gentoo Distfiles Mirror</uri></ti></tr>
699</table> 635</table>
700 636
701</body> 637</body>
638</section>
702</chapter> 639</chapter>
703</mainpage> 640</mainpage>

Legend:
Removed from v.1.24  
changed lines
  Added in v.1.68

  ViewVC Help
Powered by ViewVC 1.1.20