/[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.36 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.36 2004/02/27 16:14:58 dertobi123 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 mainpage 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>
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.15</version> 19<version>2.32</version>
20 <date>February 26, 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. 168followed during the installation.
167</p> 169</p>
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 <b><uri link="/doc/en/handbook/handbook.xml?part=1">Installing
177Gentoo</uri></b> in our <b><uri link="/doc/en/handbook/index.xml">Gentoo 178The first part of our <b><uri link="/doc/en/handbook/index.xml">Gentoo
178Handbook</uri></b> explains how to install Gentoo on your system. It contains 179Handbook</uri></b> explains how to install Gentoo on your system. Each
179instructions for all users, all architectures. 180architecture-specific version contains instructions for all users.
180</p>
181
182<!-- unlinked until updated
183<p> 181</p>
184For experienced users we also have a <b><uri 182
183<p>
184For experienced users we also have Quick Installation Reference documents:
185</p>
186
187<ul>
185link="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>
186</p> 189 <li><b><uri link="gentoo-sparc-quickinstall.xml">Sparc Quick Installation Reference</uri></b></li>
187--> 190</ul>
191
188<p> 192<p>
189Alpha-users are probably also interested in our <b><uri 193Alpha-users are probably also interested in our <b><uri
190link="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
191explains 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.
192</p> 196</p>
202environment 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
203environments we provide the <b><uri link="altinstall.xml">Alternative 207environments we provide the <b><uri link="altinstall.xml">Alternative
204Installation Guide</uri></b> which lists the installation steps needed to install 208Installation Guide</uri></b> which lists the installation steps needed to install
205Gentoo from another medium (distribution, bootable CD, network boot, etc.). 209Gentoo from another medium (distribution, bootable CD, network boot, etc.).
206</p> 210</p>
207<!-- Doc needs updating for LVM2 and 2.6 kernels (also 2.4 <-> 2.6 coop) 211
208<p> 212<p>
209Users 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
210Guide</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
211you have to go through to get your LVM scheme up and running. 215and running.
216</p>
217
212</p> 218<p>
213--> 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
214<p> 226<p>
215The <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
216Guide</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
217Gentoo Linux 1.4. 229Gentoo Linux 1.4.
218</p> 230</p>
219 231
220<p> 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>
221The <b><uri link="genkernel.xml">Genkernel Guide</uri></b> intends to provide a 239The <b><uri link="genkernel.xml">Genkernel Guide</uri></b> intends to provide a
222reference of all the functions provided by genkernel. 240reference of all the functions provided by genkernel.
223</p> 241</p>
224 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
225</body> 248</body>
226</section> 249</section>
227</chapter> 250</chapter>
228 251
229<chapter> 252<chapter>
237Gentoo Gentoo. This includes our init-system, Portage, USE-flags etc. 260Gentoo Gentoo. This includes our init-system, Portage, USE-flags etc.
238</p> 261</p>
239 262
240<p> 263<p>
241The Gentoo Handbook has a part on <uri 264The Gentoo Handbook has a part on <uri
242link="handbook/handbook.xml?part=2">Working with Gentoo</uri> which contains 265link="handbook/handbook-x86.xml?part=2">Working with Gentoo</uri> which contains
243information on Portage, USE flags, the Gentoo Init system and environment 266information on Portage, USE flags, the Gentoo Init system and environment
244variables. 267variables.
245</p> 268</p>
246 269
247</body> 270</body>
249<section> 272<section>
250<title>Portage and Related Documentation</title> 273<title>Portage and Related Documentation</title>
251<body> 274<body>
252 275
253<p> 276<p>
254The <b><uri link="handbook/handbook.xml?part=2&amp;chap=2">Portage and 277The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=2">Portage and
255Software</uri></b> chapter in the Gentoo Handbook briefly covers how to keep 278Software</uri></b> chapter in the Gentoo Handbook briefly covers how to keep
256your packages up to date and how to maintain your installed software. In other 279your packages up to date and how to maintain your installed software. In other
257words, this chapter tells you how to use <c>emerge</c>. 280words, this chapter tells you how to use <c>emerge</c>.
258</p> 281</p>
259 282
264to installing and maintaining packages using the Portage system. It is 287to installing and maintaining packages using the Portage system. It is
265far more extended than the Portage User Guide. 288far more extended than the Portage User Guide.
266</p> 289</p>
267 290
268<p> 291<p>
269The <b><uri link="handbook/handbook.xml?part=2&amp;chap=1">USE Flags</uri></b> 292The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=1">USE Flags</uri></b>
270chapter in the Gentoo Handbook introduces you to the ultimate 293chapter in the Gentoo Handbook introduces you to the ultimate
271tool for customizing Gentoo -- USE flags. This howto helps you decide which 294tool for customizing Gentoo -- USE flags. This howto helps you decide which
272USE 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
273more verbose information regarding USE-flags on a package. 296more verbose information regarding USE-flags on a package.
274</p> 297</p>
278<section> 301<section>
279<title>Configuring Gentoo</title> 302<title>Configuring Gentoo</title>
280<body> 303<body>
281 304
282<p> 305<p>
283The <b><uri link="handbook/handbook.xml?part=2&amp;chap=6">Environment 306The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=6">Environment
284Variables</uri></b> chapter in the Gentoo Handbook explains how to manage 307Variables</uri></b> chapter in the Gentoo Handbook explains how to manage
285environment variables (such as <path>$PATH</path>) and the dynamic linker 308environment variables (such as <path>$PATH</path>) and the dynamic linker
286cache easily. 309cache easily.
287</p> 310</p>
288 311
289<p> 312<p>
290The <b><uri link="handbook/handbook.xml?part=2&amp;chap=5">Initscripts</uri></b> 313The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=5">Initscripts</uri></b>
291chapter in the Gentoo Handbook details our system 314chapter in the Gentoo Handbook details our system
292startup and service management scripts. Besides the regular 315startup and service management scripts. Besides the regular
293initscript-related items it also covers initscript dependencies and 316initscript-related items it also covers initscript dependencies and
294support for virtuals. 317support for virtuals.
295</p> 318</p>
350Gentoo Linux. IPv6 is the next Internet Protocol and is gaining 373Gentoo Linux. IPv6 is the next Internet Protocol and is gaining
351popularity widely. 374popularity widely.
352</p> 375</p>
353 376
354<p> 377<p>
355The <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
356Linux under Gentoo Linux. User Mode Linux (UML) provides a nice feature 379User-Mode Linux under Gentoo Linux. User Mode Linux (UML) provides a nice
357for Linux: Running Linux inside Linux (inside Linux inside Linux ...). 380feature for Linux: Running Linux inside Linux (inside Linux inside Linux ...).
358With UML, you can easily create virtual setups. 381With UML, you can easily create virtual setups.
359</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-->
360 390
361</body> 391</body>
362</section> 392</section>
363<section> 393<section>
364<title>Specific Administration Guides</title> 394<title>Specific Administration Guides</title>
392</p> 422</p>
393 423
394<p> 424<p>
395The <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
396and how to administer it. 426and how to administer it.
427</p>
428
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.
397</p> 433</p>
398 434
399<p> 435<p>
400The <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
401guide to Gentoo and printing. 437guide to Gentoo and printing.
416The <b><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></b> is a pretty 452The <b><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></b> is a pretty
417useful guide for running a qmail based mail system. It focuses on remote 453useful guide for running a qmail based mail system. It focuses on remote
418access and encrypted communication. 454access and encrypted communication.
419</p> 455</p>
420 456
421</body>
422</section>
423</chapter>
424
425<chapter>
426<title>Desktop Related Documentation</title>
427<section>
428<title>Introduction</title>
429<body>
430
431<p>
432The Desktop Related Documentation contains our Desktop Configuration Guide
433with several other desktop related documents, including several
434application-specific guides.
435</p> 457<p>
436 458The <b><uri link="gentoo-sparc-netboot-howto.xml">Gentoo/SPARC Netboot
437</body> 459HOWTO</uri></b> describes how to setup a network booting environment for a Sun
438</section> 460Microsystems SPARC or UltraSPARC based computer.
439<section>
440<title>Desktop Configuration</title>
441<body>
442
443<p> 461</p>
444The <b><uri link="desktop.xml">Desktop Configuration Guide</uri></b> explains how to 462
445set up a fully-functional Gentoo Linux desktop machine. This includes
446configuring KDE/GNOME, Using e-mail, File Sharing (using Samba), etc.
447</p> 463<p>
448 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.
449<p> 467</p>
450The <b><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></b> is a 468
451comprehensive guide on how to install and use ALSA (Advanced Linux Sound
452Architecture).
453</p> 469<p>
454 470The <b><uri link="quick-samba-howto.xml">Quick SAMBA Howto</uri></b> gives you a
455<p> 471step-by-step introduction to Samba and includes instructions on setting up an
456The <b><uri link="java.xml">Java Guide</uri></b> explains how Java is handled under 472anti-virus checking for the Samba shares.
457Gentoo Linux.
458</p>
459
460<p>
461The <b><uri link="guide-localization.xml">Localisation Guide</uri></b> explains how
462to localise Gentoo Linux for non-English users.
463</p>
464
465<p>
466The <b><uri link="dri-howto.xml">Direct Rendering Howto</uri></b> explains how to get
4673D acceleration working using XFree-DRM.
468</p>
469
470<p>
471The <b><uri link="ati-faq.xml">ATI FAQ</uri></b> provides the answers to frequently
472asked questions regarding ATI graphical cards.
473</p>
474
475</body>
476</section>
477<section>
478<title>Application Specific Documentation</title>
479<body>
480
481<p>
482The <b><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></b> leads by example
483to explain the basics of Nano.
484</p>
485
486<p>
487The <b><uri link="vi-guide.xml">Vi Guide</uri></b> uses the cheatsheet method to
488teach the basics of vi.
489</p>
490
491<p>
492The <b><uri link="gnupg-user.xml">GnuPG User Guide</uri></b> is the definitive guide
493on GnuPG.
494</p>
495
496<p>
497The <b><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></b>
498explains how to use fetchmail, procmail, mutt, and nbsmtp.
499</p>
500
501<p>
502The <b><uri link="cvs-tutorial.xml">CVS Tutorial</uri></b> documents the basics of
503using CVS, the Concurrent Versioning System.
504</p> 473</p>
505 474
506</body> 475</body>
507</section> 476</section>
508</chapter> 477</chapter>
512<section> 481<section>
513<title>Introduction</title> 482<title>Introduction</title>
514<body> 483<body>
515 484
516<p> 485<p>
517Gentoo is a volunteer-driven distribution. It is therefor vital to have 486Gentoo is a volunteer-driven distribution. It is therefore vital to have
518high-quality development-related documentation available so that interested 487high-quality development-related documentation available so that interested
519users 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
520distribution. 489distribution.
521</p> 490</p>
522 491
523</body> 492</body>
524</section> 493</section>
525<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>
526<title>Gentoo Development Policies</title> 508<title>Gentoo Development Policies</title>
527<body> 509<body>
528
529<p>
530The <b><uri link="policy.xml">Gentoo Linux Development Policy</uri></b> details
531current policy for the creation of ebuilds.
532</p>
533
534<!--
535<p>
536The <b><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></b>
537details current policy for Gentoo Linux releases.
538</p>
539-->
540 510
541<p> 511<p>
542The <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>
543details current policy for the creation and editing of documentation. 513details current policy for the creation and editing of documentation.
544</p> 514</p>
548<section> 518<section>
549<title>Development Related Documentation</title> 519<title>Development Related Documentation</title>
550<body> 520<body>
551 521
552<p> 522<p>
553The <b><uri link="gentoo-howto.xml">Ebuild HOWTO</uri></b> explains how to
554create ebuilds.
555</p>
556
557<p>
558The <b><uri link="eclass-howto.xml">Eclass HOWTO</uri></b> shows how to create
559ebuilds that support OOP-like inheritance features.
560</p>
561
562<p>
563The <b><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></b> 523The <b><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></b>
564explains how to submit user-authored ebuilds. 524explains how to submit user-authored ebuilds.
565</p> 525</p>
566 526
567<p> 527<p>
568The <b><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></b>
569lists the common mistakes contributors/developers make when trying to submit an
570ebuild.
571</p>
572
573<p>
574The <b><uri link="metadata.xml">Metadata document</uri></b> explains how to
575write up a <path>metadata.xml</path> file for a package.
576</p>
577
578<p>
579The <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
580format 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.
581</p> 540</p>
582 541
583</body> 542</body>
584</section> 543</section>
585</chapter> 544</chapter>
615 574
616<table> 575<table>
617<tr><th>Frequently Asked Questions</th></tr> 576<tr><th>Frequently Asked Questions</th></tr>
618<tr><ti><uri link="faq.xml">Gentoo FAQ</uri></ti></tr> 577<tr><ti><uri link="faq.xml">Gentoo FAQ</uri></ti></tr>
619<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>
620<tr><th>Installation Related Documentation</th></tr> 580<tr><th>Installation Related Documentation</th></tr>
621<tr><ti><uri link="handbook/handbook.xml?part=1">Installing Gentoo</uri></ti></tr> 581<tr><ti><uri link="handbook/">Gentoo Handbook</uri></ti></tr>
622<!--<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>
623<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>
624<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>
625<!--<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>
626<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>
627<tr><ti><uri link="genkernel.xml">Genkernel Guide</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>
628<tr><th>Gentoo System Documentation</th></tr> 592<tr><th>Gentoo System Documentation</th></tr>
629<tr><ti><uri link="handbook/handbook.xml?part=2&amp;chap=2">Portage and Software</uri></ti></tr> 593<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=2">Portage and Software</uri></ti></tr>
630<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>
631<tr><ti><uri link="handbook/handbook.xml?part=2&amp;chap=1">USE Flags</uri></ti></tr> 595<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=1">USE Flags</uri></ti></tr>
632<tr><ti><uri link="handbook/handbook.xml?part=2&amp;chap=6">Environment Variables</uri></ti></tr> 596<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=6">Environment Variables</uri></ti></tr>
633<tr><ti><uri link="handbook/handbook.xml?part=2&amp;chap=5">Initscripts</uri></ti></tr> 597<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=5">Initscripts</uri></ti></tr>
634<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>
635<tr><th>System Administration Documentation</th></tr> 599<tr><th>System Administration Documentation</th></tr>
636<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>
637<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>
638<tr><ti><uri link="ipv6.xml">IPv6 Guide</uri></ti></tr> 602<tr><ti><uri link="ipv6.xml">IPv6 Guide</uri></ti></tr>
639<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-->
640<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> -->
641<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>
642<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>
643<tr><ti><uri link="ltsp.xml">LTSP Guide</uri></ti></tr> 609<tr><ti><uri link="ltsp.xml">LTSP Guide</uri></ti></tr>
644<tr><ti><uri link="distcc.xml">DistCC Guide</uri></ti></tr> 610<tr><ti><uri link="distcc.xml">DistCC Guide</uri></ti></tr>
645<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>
646<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>
647<tr><ti><uri link="openafs.xml">OpenAFS Guide</uri></ti></tr> 614<tr><ti><uri link="openafs.xml">OpenAFS Guide</uri></ti></tr>
648<tr><ti><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></ti></tr> 615<tr><ti><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></ti></tr>
649<tr><ti><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></ti></tr> 616<tr><ti><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></ti></tr>
650<tr><th>Desktop Related Documentation</th></tr> 617<tr><ti><uri link="gentoo-sparc-netboot-howto.xml">Gentoo/SPARC Netboot Howto</uri></ti></tr>
651<tr><ti><uri link="desktop.xml">Desktop Configuration Guide</uri></ti></tr> 618<tr><ti><uri link="gentoo-sparc-obpreference.xml">Gentoo SPARC OpenBoot PROM Reference Guide</uri></ti></tr>
652<tr><ti><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></ti></tr> 619<tr><ti><uri link="quick-samba-howto.xml">Quick Samba HOWTO</uri></ti></tr>
653<tr><ti><uri link="java.xml">Java Guide</uri></ti></tr>
654<tr><ti><uri link="guide-localization.xml">Localisation Guide</uri></ti></tr>
655<tr><ti><uri link="dri-howto.xml">Direct Rendering Howto</uri></ti></tr>
656<tr><ti><uri link="ati-faq.xml">ATI FAQ</uri></ti></tr>
657<tr><ti><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></ti></tr>
658<tr><ti><uri link="vi-guide.xml">Vi Guide</uri></ti></tr>
659<tr><ti><uri link="gnupg-user.xml">GnuPG User Guide</uri></ti></tr>
660<tr><ti><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></ti></tr>
661<tr><ti><uri link="cvs-tutorial.xml">CVS Tutorial</uri></ti></tr>
662<tr><th>Gentoo Development Documentation</th></tr> 620<tr><th>Gentoo Development Documentation</th></tr>
663<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>
664<!-- <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> -->
665<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>
666<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>
667<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>
668<tr><ti><uri link="stage-building-guide.xml">Stage Building Guide</uri></ti></tr>
669<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>
670<tr><ti><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></ti></tr> 627<tr><ti><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></ti></tr>
671<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>
672<tr><th>Other Documentation</th></tr> 632<tr><th>Other Documentation</th></tr>
673<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>
674<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>
675</table> 635</table>
676 636

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

  ViewVC Help
Powered by ViewVC 1.1.20