/[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.27 Revision 1.79
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.27 2004/02/12 19:32:53 vapier Exp $ --> 2<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/index.xml,v 1.79 2004/08/31 18:57:03 neysx 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.11</version> 19<version>2.37</version>
20 <date>February 11, 2004</date> 20<date>August 30, 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>
34<uri link="http://www.gentoo.org/doc/nl/index.xml">Dutch</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> | 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> | 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> | 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> | 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> | 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> | 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> | 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> | --> 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> | 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> | 44<uri link="http://www.gentoo.org/doc/es/index.xml">Spanish</uri> |
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.
196</p>
197
198<p>
199AMD64-users should start with the <b><uri
200link="/proj/en/base/amd64/technotes.xml">AMD64 Technotes</uri></b> which
201contains information about the AMD64 Project, Installation Notes, Download
202Instructions and more.
230</p> 203</p>
231 204
232</body> 205</body>
233</section> 206</section>
234<section> 207<section>
240environment doesn't permit them to boot from a LiveCD. To anticipate their 213environment doesn't permit them to boot from a LiveCD. To anticipate their
241environments we provide the <b><uri link="altinstall.xml">Alternative 214environments we provide the <b><uri link="altinstall.xml">Alternative
242Installation Guide</uri></b> which lists the installation steps needed to install 215Installation Guide</uri></b> which lists the installation steps needed to install
243Gentoo from another medium (distribution, bootable CD, network boot, etc.). 216Gentoo from another medium (distribution, bootable CD, network boot, etc.).
244</p> 217</p>
245<!-- Doc needs updating for LVM2 and 2.6 kernels (also 2.4 <-> 2.6 coop) 218
246<p> 219<p>
247Users interested in using LVM should read up our <b><uri link="lvm.xml">LVM 220Users 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 221Guide</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. 222and running.
223</p>
224
250</p> 225<p>
251--> 226As our installation instructions allow for great flexibility, there are many
227tips and tricks that can be persued during the installation. We have a <b><uri
228link="gentoo-x86-tipsntricks.xml">Gentoo/x86 Installation Tips 'n
229Tricks</uri></b> document online (which also contains interesting Tips 'n Tricks
230for other architectures).
231</p>
232
252<p> 233<p>
253The <b><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade 234The <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 235Guide</uri></b> explains how to upgrade your Gentoo Linux 1.x systems to
255Gentoo Linux 1.4. 236Gentoo Linux 1.4.
256</p> 237</p>
257 238
239<p>
240The <b><uri link="gentoo-upgrading.xml">Gentoo Upgrading Guide</uri></b> goes
241deeper into the motivation behind the easy-upgrading system Gentoo uses and
242provides more information about the so-called "profiles".
243</p>
244
245<p>
246The <b><uri link="genkernel.xml">Genkernel Guide</uri></b> intends to provide a
247reference of all the functions provided by genkernel.
248</p>
249
250<p>
251With the help of our <b><uri link="colinux-howto.xml">coLinux Howto</uri></b>
252you are able to run Gentoo from within Windows.
253</p>
254
258</body> 255</body>
259</section> 256</section>
260</chapter> 257</chapter>
261 258
262<chapter> 259<chapter>
270Gentoo Gentoo. This includes our init-system, Portage, USE-flags etc. 267Gentoo Gentoo. This includes our init-system, Portage, USE-flags etc.
271</p> 268</p>
272 269
273<p> 270<p>
274The Gentoo Handbook has a part on <uri 271The Gentoo Handbook has a part on <uri
275link="handbook/handbook.xml?part=2">Working with Gentoo</uri> which contains 272link="handbook/handbook-x86.xml?part=2">Working with Gentoo</uri> which contains
276information on Portage, USE flags, the Gentoo Init system and environment 273information on Portage, USE flags, the Gentoo Init system and environment
277variables. 274variables.
278</p> 275</p>
279 276
280</body> 277</body>
282<section> 279<section>
283<title>Portage and Related Documentation</title> 280<title>Portage and Related Documentation</title>
284<body> 281<body>
285 282
286<p> 283<p>
287The <b><uri link="portage-user.xml">Portage User Guide</uri></b> briefly covers how 284The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=2">Portage and
285Software</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. 286your 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>. 287words, this chapter tells you how to use <c>emerge</c>.
290</p>
291
292<p> 288</p>
293The <b><uri link="portage-manual.xml">Portage Manual</uri></b> provides a general 289
294overview of Portage, detailed configuration information and an end user guide 290
295to installing and maintaining packages using the Portage system. It is
296far more extended than the Portage User Guide.
297</p> 291<p>
298 292The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=3">Portage
293Features</uri></b> chapter in the Gentoo Handbook provides a general
294overview of Portage' features.
299<p> 295</p>
300The <b><uri link="use-howto.xml">USE Howto</uri></b> introduces you to the ultimate 296
297<p>
298The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=4">Controlling
299Portage Behaviour</uri></b> chapter in the Gentoo Handbook informs you how to
300tweak Portage to suit your environment, your needs.
301</p>
302
303<p>
304The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=1">USE Flags</uri></b>
305chapter in the Gentoo Handbook introduces you to the ultimate
301tool for customizing Gentoo -- USE flags. This howto helps you decide which 306tool 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 307USE flags you need. It also describes the use of <c>etcat</c> to receive
303more verbose information regarding USE-flags on a package. 308more verbose information regarding USE-flags on a package.
304</p> 309</p>
305 310
311<p>
312The <b><uri link="gentoolkit.xml">Gentoolkit Guide</uri></b> describes a set of
313very useful portage add-ons.
314</p>
315
316<p>
317The <b><uri link="macos-guide.xml">Gentoo for Mac OS X Guide</uri></b> shows
318how to install portage on a Mac OS X system.
319</p>
320
306</body> 321</body>
307</section> 322</section>
308<section> 323<section>
309<title>Configuring Gentoo</title> 324<title>Configuring Gentoo</title>
310<body> 325<body>
311 326
312<p> 327<p>
313The <b><uri link="env.d-howto.xml">ENV.D Howto</uri></b> explains how to manage 328The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=6">Environment
329Variables</uri></b> chapter in the Gentoo Handbook explains how to manage
314environment variables (such as <path>$PATH</path>) and the dynamic linker 330environment variables (such as <path>$PATH</path>) and the dynamic linker
315cache easily. 331cache easily.
316</p> 332</p>
317 333
318<p> 334<p>
319The <b><uri link="rc-scripts.xml">RC-Script Guide</uri></b> details our system 335The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=5">Initscripts</uri></b>
336chapter in the Gentoo Handbook details our system
320startup and service management scripts. Besides the regular 337startup and service management scripts. Besides the regular
321initscript-related items it also covers initscript dependencies and 338initscript-related items it also covers initscript dependencies and
322support for virtuals. 339support for virtuals.
323</p> 340</p>
324 341
378Gentoo Linux. IPv6 is the next Internet Protocol and is gaining 395Gentoo Linux. IPv6 is the next Internet Protocol and is gaining
379popularity widely. 396popularity widely.
380</p> 397</p>
381 398
382<p> 399<p>
383The <b><uri link="uml.xml">User Mode Linux Guide</uri></b> shows how to use User-Mode 400The <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 401User-Mode Linux under Gentoo Linux. User Mode Linux (UML) provides a nice
385for Linux: Running Linux inside Linux (inside Linux inside Linux ...). 402feature for Linux: Running Linux inside Linux (inside Linux inside Linux ...).
386With UML, you can easily create virtual setups. 403With UML, you can easily create virtual setups.
387</p> 404</p>
405
406<!--
407<p>
408The <b><uri link="selinux-uml-guide.xml">SELinux UML Guide</uri></b> show you
409how to set up a UML installation with SELinux support.
410</p>
411-->
388 412
389</body> 413</body>
390</section> 414</section>
391<section> 415<section>
392<title>Specific Administration Guides</title> 416<title>Specific Administration Guides</title>
420</p> 444</p>
421 445
422<p> 446<p>
423The <b><uri link="devfs-guide.xml">DevFS Guide</uri></b> describes how DevFS works 447The <b><uri link="devfs-guide.xml">DevFS Guide</uri></b> describes how DevFS works
424and how to administer it. 448and how to administer it.
449</p>
450
451<p>
452The <b><uri link="udev-guide.xml">Gentoo udev Guide</uri></b> describes the new
453device file management (using udev) which replaces DevFS and informs the reader
454how udev is integrated in Gentoo.
425</p> 455</p>
426 456
427<p> 457<p>
428The <b><uri link="printing-howto.xml">Printing Howto</uri></b> is a comprehensive 458The <b><uri link="printing-howto.xml">Printing Howto</uri></b> is a comprehensive
429guide to Gentoo and printing. 459guide to Gentoo and printing.
440for virtual users, webbased e-mail software, mailinglist software etc. 470for virtual users, webbased e-mail software, mailinglist software etc.
441</p> 471</p>
442 472
443<p> 473<p>
444The <b><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></b> is a pretty 474The <b><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></b> is a pretty
445useful for running a qmail based mail system. It focuses on remote access and 475useful guide for running a qmail based mail system. It focuses on remote
446encrypted communication. 476access and encrypted communication.
447</p>
448
449</body>
450</section>
451</chapter>
452
453<chapter>
454<title>Desktop Related Documentation</title>
455<section>
456<title>Introduction</title>
457<body>
458
459<p> 477</p>
460The Desktop Related Documentation contains our Desktop Configuration Guide 478
461with several other desktop related documents, including several
462application-specific guides.
463</p> 479<p>
464 480The <b><uri link="gentoo-sparc-netboot-howto.xml">Gentoo/SPARC Netboot
465</body> 481Howto</uri></b> describes how to setup a network booting environment for a Sun
466</section> 482Microsystems SPARC or UltraSPARC based computer.
467<section>
468<title>Desktop Configuration</title>
469<body>
470
471<p> 483</p>
472The <b><uri link="desktop.xml">Desktop Configuration Guide</uri></b> explains how to 484
473set up a fully-functional Gentoo Linux desktop machine. This includes
474configuring KDE/GNOME, Using e-mail, File Sharing (using Samba), etc.
475</p> 485<p>
476 486 The <b><uri link="gentoo-sparc-obpreference.xml">Gentoo SPARC OpenBoot PROM reference
487Guide</uri></b> offers a guide to the SPARC OpenBoot system, available on all
488Sun Microsytsms SPARC/UltraSparc based computers.
477<p> 489</p>
478The <b><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></b> is a 490
479comprehensive guide on how to install and use ALSA (Advanced Linux Sound
480Architecture).
481</p> 491<p>
482 492The <b><uri link="quick-samba-howto.xml">Quick SAMBA Howto</uri></b> gives you a
493step-by-step introduction to Samba and includes instructions on setting up an
494anti-virus checking for the Samba shares.
483<p> 495</p>
484The <b><uri link="java.xml">Java Guide</uri></b> explains how Java is handled under 496
485Gentoo Linux.
486</p> 497<p>
487 498The <b><uri link="home-router-howto.xml">Home Router Howto</uri></b> teaches you how to
488<p> 499turn any Gentoo machine into a router for a small network. Perfect for turning an old
489The <b><uri link="guide-localization.xml">Localisation Guide</uri></b> explains how 500computer in your home into a useful firewall/router/etc...
490to localise Gentoo Linux for non-English users.
491</p>
492
493<p>
494The <b><uri link="dri-howto.xml">Direct Rendering Howto</uri></b> explains how to get
4953D acceleration working using XFree-DRM.
496</p>
497
498<p>
499The <b><uri link="ati-faq.xml">ATI FAQ</uri></b> provides the answers to frequently
500asked questions regarding ATI graphical cards.
501</p>
502
503</body>
504</section>
505<section>
506<title>Application Specific Documentation</title>
507<body>
508
509<p>
510The <b><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></b> leads by example
511to explain the basics of Nano.
512</p>
513
514<p>
515The <b><uri link="vi-guide.xml">Vi Guide</uri></b> uses the cheatsheet method to
516teach the basics of vi.
517</p>
518
519<p>
520The <b><uri link="gnupg-user.xml">GnuPG User Guide</uri></b> is the definitive guide
521on GnuPG.
522</p>
523
524<p>
525The <b><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></b>
526explains how to use fetchmail, procmail, mutt, and nbsmtp.
527</p>
528
529<p>
530The <b><uri link="cvs-tutorial.xml">CVS Tutorial</uri></b> documents the basics of
531using CVS, the Concurrent Versioning System.
532</p> 501</p>
533 502
534</body> 503</body>
535</section> 504</section>
536</chapter> 505</chapter>
540<section> 509<section>
541<title>Introduction</title> 510<title>Introduction</title>
542<body> 511<body>
543 512
544<p> 513<p>
545Gentoo is a volunteer-driven distribution. It is therefor vital to have 514Gentoo is a volunteer-driven distribution. It is therefore vital to have
546high-quality development-related documentation available so that interested 515high-quality development-related documentation available so that interested
547users can easily learn how to help in the development of their favorite 516users can easily learn how to help in the development of their favorite
548distribution. 517distribution.
549</p> 518</p>
550 519
551</body> 520</body>
552</section> 521</section>
553<section> 522<section>
523<title>Gentoo Developer Handbook</title>
524<body>
525
526<p>
527All developer-specific documentation, including but not limited to Ebuild and
528Eclass development, policies and such, has now been bundled in one awsome <b>
529<uri link="/proj/en/devrel/handbook/handbook.xml">Gentoo Developer
530Handbook</uri></b> for your reading pleasure.
531</p>
532
533</body>
534</section>
535<section>
554<title>Gentoo Development Policies</title> 536<title>Gentoo Development Policies</title>
555<body> 537<body>
556 538
557<p> 539<p>
558The <b><uri link="policy.xml">Gentoo Linux Development Policy</uri></b> details
559current policy for the creation of ebuilds.
560</p>
561
562<!--
563<p>
564The <b><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></b>
565details current policy for Gentoo Linux releases.
566</p>
567-->
568
569<p>
570The <b><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></b> 540The <b><uri link="/proj/en/gdp/doc/doc-policy.xml">Gentoo Linux Documentation Policy</uri></b>
571details current policy for the creation and editing of documentation. 541details current policy for the creation and editing of documentation.
572</p> 542</p>
573 543
574</body> 544</body>
575</section> 545</section>
576<section> 546<section>
577<title>Development Related Documentation</title> 547<title>Development Related Documentation</title>
578<body> 548<body>
579
580<p>
581The <b><uri link="gentoo-howto.xml">Ebuild HOWTO</uri></b> explains how to
582create ebuilds.
583</p>
584
585<p>
586The <b><uri link="eclass-howto.xml">Eclass HOWTO</uri></b> shows how to create
587ebuilds that support OOP-like inheritance features.
588</p>
589
590<p>
591The <b><uri link="stage-building-guide.xml">Stage Building Guide</uri></b>
592details the stage tarball creation process.
593</p>
594 549
595<p> 550<p>
596The <b><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></b> 551The <b><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></b>
597explains how to submit user-authored ebuilds. 552explains how to submit user-authored ebuilds.
598</p> 553</p>
599 554
600<p> 555<p>
601The <b><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></b>
602lists the common mistakes contributors/developers make when trying to submit an
603ebuild.
604</p>
605
606<p>
607The <b><uri link="metadata.xml">Metadata document</uri></b> explains how to
608write up a <path>metadata.xml</path> file for a package.
609</p>
610
611<p>
612The <b><uri link="xml-guide.xml">GuideXML Guide</uri></b> documents the XML 556The <b><uri link="xml-guide.xml">GuideXML Guide</uri></b> documents the XML
613format used in Gentoo Linux's web-based documentation. 557format used in Gentoo Linux's web-based documentation.
558</p>
559
560<p>
561The <b><uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Doc Developers' Tips
562&amp; Tricks</uri></b> contains some pointers for documentation developers.
563</p>
564
565<p>
566The <b><uri link="cvs-tutorial.xml">CVS Tutorial</uri></b> documents the basics
567of using CVS, the Concurrent Versioning System.
614</p> 568</p>
615 569
616</body> 570</body>
617</section> 571</section>
618</chapter> 572</chapter>
636</body> 590</body>
637</section> 591</section>
638</chapter> 592</chapter>
639<chapter> 593<chapter>
640<title>Document Listing</title> 594<title>Document Listing</title>
595<section>
641<body> 596<body>
642 597
643<p> 598<p>
644For people who like to get a short overview on available documentation, here it 599For people who like to get a short overview on available documentation, here it
645is :) 600is :)
647 602
648<table> 603<table>
649<tr><th>Frequently Asked Questions</th></tr> 604<tr><th>Frequently Asked Questions</th></tr>
650<tr><ti><uri link="faq.xml">Gentoo FAQ</uri></ti></tr> 605<tr><ti><uri link="faq.xml">Gentoo FAQ</uri></ti></tr>
651<tr><ti><uri link="gentoo-ppc-faq.xml">Gentoo PPC FAQ</uri></ti></tr> 606<tr><ti><uri link="gentoo-ppc-faq.xml">Gentoo PPC FAQ</uri></ti></tr>
607<tr><ti><uri link="gentoo-sparc-faq.xml">Gentoo SPARC FAQ</uri></ti></tr>
652<tr><th>Installation Related Documentation</th></tr> 608<tr><th>Installation Related Documentation</th></tr>
653<tr><ti><uri link="gentoo-x86-install.xml">Gentoo x86 Installation Guide</uri></ti></tr> 609<tr><ti><uri link="handbook/">Gentoo Handbook</uri></ti></tr>
654<tr><ti><uri link="gentoo-alpha-install.xml">Gentoo Alpha Installation Guide</uri></ti></tr>
655<tr><ti><uri link="gentoo-hppa-install.xml">Gentoo HPPA Installation Guide</uri></ti></tr>
656<tr><ti><uri link="gentoo-ppc-install.xml">Gentoo PPC Installation Guide</uri></ti></tr>
657<tr><ti><uri link="gentoo-sparc-install.xml">Gentoo SPARC Installation Guide</uri></ti></tr>
658<tr><ti><uri link="gentoo-mips-install.xml">Gentoo MIPS Installation Guide</uri></ti></tr>
659<!--<tr><ti><uri link="gentoo-x86-quickinstall.xml">Gentoo x86 Quick Installation Rerefence</uri></ti></tr>--> 610<tr><ti><uri link="gentoo-x86-quickinstall.xml">Gentoo x86 Quick Installation Reference</uri></ti></tr>
611<tr><ti><uri link="gentoo-sparc-quickinstall.xml">Gentoo sparc Quick Installation Reference</uri></ti></tr>
660<tr><ti><uri link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></ti></tr> 612<tr><ti><uri link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></ti></tr>
613<tr><ti><uri link="/proj/en/base/amd64/technotes.xml">AMD64 Technotes</uri></ti></tr>
661<tr><ti><uri link="altinstall.xml">Alternative Installation Guide</uri></ti></tr> 614<tr><ti><uri link="altinstall.xml">Alternative Installation Guide</uri></ti></tr>
662<!--<tr><ti><uri link="lvm.xml">LVM Guide</uri></ti></tr>--> 615<tr><ti><uri link="lvm2.xml">LVM2 Guide</uri></ti></tr>
616<tr><ti><uri link="gentoo-x86-tipsntricks.xml">Gentoo/x86 Tips 'n Tricks Document</uri></ti></tr>
663<tr><ti><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade Guide</uri></ti></tr> 617<tr><ti><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade Guide</uri></ti></tr>
618<tr><ti><uri link="gentoo-upgrading.xml">Gentoo Upgrading Howto</uri></ti></tr>
619<tr><ti><uri link="genkernel.xml">Genkernel Guide</uri></ti></tr>
620<tr><ti><uri link="colinux-howto.xml">coLinux Howto</uri></ti></tr>
664<tr><th>Gentoo System Documentation</th></tr> 621<tr><th>Gentoo System Documentation</th></tr>
665<tr><ti><uri link="portage-user.xml">Portage User Guide</uri></ti></tr> 622<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=2">Portage and Software</uri></ti></tr>
666<tr><ti><uri link="portage-manual.xml">Portage Manual Guide</uri></ti></tr> 623<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=3">Portage Features</uri></ti></tr>
667<tr><ti><uri link="use-howto.xml">USE Howto</uri></ti></tr> 624<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=4">Controlling Portage Behaviour</uri></ti></tr>
668<tr><ti><uri link="env.d-howto.xml">ENV.D Howto</uri></ti></tr> 625<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=1">USE Flags</uri></ti></tr>
669<tr><ti><uri link="rc-scripts.xml">RC-Script Guide</uri></ti></tr> 626<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=6">Environment Variables</uri></ti></tr>
627<tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=5">Initscripts</uri></ti></tr>
670<tr><ti><uri link="gentoo-kernel.xml">Gentoo Kernel Guide</uri></ti></tr> 628<tr><ti><uri link="gentoo-kernel.xml">Gentoo Kernel Guide</uri></ti></tr>
629<tr><ti><uri link="gentoolkit.xml">Gentoolkit Guide</uri></ti></tr>
630<tr><ti><uri link="macos-guide.xml">Gentoo for Mac OS X</uri></ti></tr>
671<tr><th>System Administration Documentation</th></tr> 631<tr><th>System Administration Documentation</th></tr>
672<tr><ti><uri link="gentoo-security.xml">Gentoo Security Guide</uri></ti></tr> 632<tr><ti><uri link="gentoo-security.xml">Gentoo Security Guide</uri></ti></tr>
673<tr><ti><uri link="prelink-howto.xml">Prelinking Howto</uri></ti></tr> 633<tr><ti><uri link="prelink-howto.xml">Prelinking Howto</uri></ti></tr>
674<tr><ti><uri link="ipv6.xml">IPv6 Guide</uri></ti></tr> 634<tr><ti><uri link="ipv6.xml">IPv6 Guide</uri></ti></tr>
675<tr><ti><uri link="uml.xml">User Mode Linux Guide</uri></ti></tr> 635<tr><ti><uri link="uml.xml">User Mode Linux Guide</uri></ti></tr>
636<!-- <tr><ti><uri link="selinux-uml-guide.xml">SELinux UML Guide</uri></ti></tr>
637-->
676<tr><ti><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></ti></tr> 638<!-- <tr><ti><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></ti></tr> -->
677<tr><ti><uri link="openmosix-howto.xml">OpenMosix Guide</uri></ti></tr> 639<tr><ti><uri link="openmosix-howto.xml">OpenMosix Guide</uri></ti></tr>
678<tr><ti><uri link="diskless-howto.xml">Diskless Guide</uri></ti></tr> 640<tr><ti><uri link="diskless-howto.xml">Diskless Guide</uri></ti></tr>
679<tr><ti><uri link="ltsp.xml">LTSP Guide</uri></ti></tr> 641<tr><ti><uri link="ltsp.xml">LTSP Guide</uri></ti></tr>
680<tr><ti><uri link="distcc.xml">DistCC Guide</uri></ti></tr> 642<tr><ti><uri link="distcc.xml">DistCC Guide</uri></ti></tr>
681<tr><ti><uri link="devfs-guide.xml">DevFS Guide</uri></ti></tr> 643<tr><ti><uri link="devfs-guide.xml">DevFS Guide</uri></ti></tr>
644<tr><ti><uri link="udev-guide.xml">Gentoo udev Guide</uri></ti></tr>
682<tr><ti><uri link="printing-howto.xml">Printing Guide</uri></ti></tr> 645<tr><ti><uri link="printing-howto.xml">Printing Guide</uri></ti></tr>
683<tr><ti><uri link="openafs.xml">OpenAFS Guide</uri></ti></tr> 646<tr><ti><uri link="openafs.xml">OpenAFS Guide</uri></ti></tr>
684<tr><ti><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></ti></tr> 647<tr><ti><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></ti></tr>
685<tr><ti><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></ti></tr> 648<tr><ti><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></ti></tr>
686<tr><th>Desktop Related Documentation</th></tr> 649<tr><ti><uri link="gentoo-sparc-netboot-howto.xml">Gentoo/SPARC Netboot Howto</uri></ti></tr>
687<tr><ti><uri link="desktop.xml">Desktop Configuration Guide</uri></ti></tr> 650<tr><ti><uri link="gentoo-sparc-obpreference.xml">Gentoo SPARC OpenBoot PROM Reference Guide</uri></ti></tr>
688<tr><ti><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></ti></tr> 651<tr><ti><uri link="quick-samba-howto.xml">Quick Samba Howto</uri></ti></tr>
689<tr><ti><uri link="java.xml">Java Guide</uri></ti></tr>
690<tr><ti><uri link="guide-localization.xml">Localisation Guide</uri></ti></tr>
691<tr><ti><uri link="dri-howto.xml">Direct Rendering Howto</uri></ti></tr> 652<tr><ti><uri link="home-router-howto.xml">Home Router Howto</uri></ti></tr>
692<tr><ti><uri link="ati-faq.xml">ATI FAQ</uri></ti></tr>
693<tr><ti><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></ti></tr>
694<tr><ti><uri link="vi-guide.xml">Vi Guide</uri></ti></tr>
695<tr><ti><uri link="gnupg-user.xml">GnuPG User Guide</uri></ti></tr>
696<tr><ti><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></ti></tr>
697<tr><ti><uri link="cvs-tutorial.xml">CVS Tutorial</uri></ti></tr>
698<tr><th>Gentoo Development Documentation</th></tr> 653<tr><th>Gentoo Development Documentation</th></tr>
654<tr><ti><uri link="/proj/en/devrel/handbook/handbook.xml">Gentoo Developer Handbook</uri></ti></tr>
699<tr><ti><uri link="policy.xml">Gentoo Linux Development Policy</uri></ti></tr> 655<tr><ti><uri link="policy.xml">Gentoo Linux Development Policy</uri></ti></tr>
700<!-- <tr><ti><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></ti></tr> --> 656<!-- <tr><ti><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></ti></tr> -->
701<tr><ti><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></ti></tr> 657<tr><ti><uri link="/proj/en/gdp/doc/doc-policy.xml">Gentoo Linux Documentation Policy</uri></ti></tr>
702<tr><ti><uri link="gentoo-howto.xml">Ebuild Howto</uri></ti></tr>
703<tr><ti><uri link="eclass-howto.xml">Eclass Howto</uri></ti></tr>
704<tr><ti><uri link="stage-building-guide.xml">Stage Building Guide</uri></ti></tr>
705<tr><ti><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></ti></tr> 658<tr><ti><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></ti></tr>
706<tr><ti><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></ti></tr> 659<tr><ti><uri link="xml-guide.xml">GuideXML Guide</uri></ti></tr>
707<tr><ti><uri link="metadata.xml">Metadata document</uri></ti></tr> 660<tr><ti><uri link="/proj/en/gdp/doc/doc-tipsntricks.xml">Doc Developers' Tips &amp; Tricks</uri></ti></tr>
661<tr><ti><uri link="cvs-tutorial.xml">CVS Tutorial</uri></ti></tr>
708<tr><th>Other Documentation</th></tr> 662<tr><th>Other Documentation</th></tr>
709<tr><ti><uri link="rsync.xml">Gentoo RSync Mirror</uri></ti></tr> 663<tr><ti><uri link="rsync.xml">Gentoo RSync Mirror</uri></ti></tr>
710<tr><ti><uri link="source_mirrors.xml">Gentoo Distfiles Mirror</uri></ti></tr> 664<tr><ti><uri link="source_mirrors.xml">Gentoo Distfiles Mirror</uri></ti></tr>
711</table> 665</table>
712 666
713</body> 667</body>
668</section>
714</chapter> 669</chapter>
715</mainpage> 670</mainpage>

Legend:
Removed from v.1.27  
changed lines
  Added in v.1.79

  ViewVC Help
Powered by ViewVC 1.1.20