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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.59 - (hide annotations) (download) (as text)
Sun May 9 12:36:27 2004 UTC (10 years, 7 months ago) by peitolm
Branch: MAIN
Changes since 1.58: +3 -3 lines
File MIME type: application/xml
Name change of obpreference.xml to gentoo-sparc-obpreference.xml

1 swift 1.1 <?xml version="1.0" encoding="UTF-8"?>
2 peitolm 1.59 <!-- $Header: /home/cvsroot/gentoo/xml/htdocs/doc/en/index.xml,v 1.58 2004/05/09 12:26:15 peitolm Exp $ -->
3 swift 1.32 <!DOCTYPE mainpage SYSTEM "/dtd/guide.dtd">
4 swift 1.1 <mainpage id="docs">
5     <title>Gentoo Documentation Resources</title>
6     <author title="Author">
7     <mail link="drobbins@gentoo.org">Daniel Robbins</mail>
8     </author>
9 swift 1.6 <author title="Editor"><!-- zhen@gentoo.org -->
10     John P. Davis
11 swift 1.1 </author>
12     <author title="Editor">Colin Morey</author>
13     <author title="Editor">
14     <mail link="peesh@gentoo.org">Jorge Paulo</mail>
15     </author>
16     <author title="Editor">
17     <mail link="swift@gentoo.org">Sven Vermeulen</mail>
18     </author>
19 swift 1.57 <version>2.26</version>
20 swift 1.56 <date>May 09, 2004</date>
21 swift 1.1
22     <chapter>
23     <title>Gentoo Documentation Resources</title>
24     <section>
25 swift 1.2 <title>Available Languages</title>
26     <body>
27    
28     <p>
29     This page (and documentation) is available in the following languages:
30     </p>
31    
32     <p>
33 swift 1.9 <uri link="http://www.gentoo.org/doc/da/index.xml">Danish</uri> |
34 swift 1.2 <uri link="http://www.gentoo.org/doc/nl/index.xml">Dutch</uri> |
35     <uri link="http://www.gentoo.org/doc/en/index.xml">English</uri> |
36     <uri link="http://www.gentoo.org/doc/fr/index.xml">French</uri> |
37     <uri link="http://www.gentoo.org/doc/de/index.xml">German</uri> |
38     <uri link="http://www.gentoo.org/doc/hu/index.xml">Hungarian</uri> |
39 erwin 1.46 <uri link="http://www.gentoo.org/doc/id/index.xml">Indonesian</uri> |
40 swift 1.2 <uri link="http://www.gentoo.org/doc/it/index.xml">Italian</uri> |
41     <uri link="http://www.gentoo.org/doc/ja/index.xml">Japanese</uri> |
42 swift 1.10 <!-- <uri link="http://www.gentoo.org/doc/kr/index.xml">Korean</uri> | -->
43 swift 1.2 <uri link="http://www.gentoo.org/doc/ru/index.xml">Russian</uri> |
44     <uri link="http://www.gentoo.org/doc/es/index.xml">Spanish</uri> |
45 dertobi123 1.36 <uri link="http://www.gentoo.org/doc/tw/index.xml">Traditional Chinese</uri>
46 swift 1.2 </p>
47    
48     </body>
49     </section>
50     <section>
51 swift 1.1 <title>Contents</title>
52     <body>
53    
54     <ul>
55     <li><uri link="#doc_chap1">Introduction</uri></li>
56     <li><uri link="#doc_chap2">Installation Related Resources</uri></li>
57     <li><uri link="#doc_chap3">Gentoo System 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>
60     <li><uri link="#doc_chap6">Gentoo Development Documentation</uri></li>
61     <li><uri link="#doc_chap7">Other Documentation</uri></li>
62 swift 1.5 <li><uri link="#doc_chap8">Overview of Available Documentation</uri></li>
63 swift 1.1 </ul>
64    
65     </body>
66     </section>
67     <section>
68     <title>Introduction</title>
69     <body>
70    
71     <p>
72     Welcome to the Gentoo Documentation Resources. This page will give you a
73     quick overview on the documentation we provide. Most documentation is
74     released under the <uri
75     link="http://creativecommons.org/licenses/by-sa/1.0">Creative Commons -
76     Attribution / Share Alike</uri> license, an open documentation license. All
77     documentation should also be available in a printer-friendly format. To view
78     this document, append <path>?style=printable</path> to the URL.
79     </p>
80    
81     <p>
82     If you find bugs in our documentation or have proposals, please use our
83     <uri link="http://bugs.gentoo.org">Bugtracking System</uri> and fill in
84 swift 1.17 a bug report for "Docs-developer" or "Docs-user". These bug reports will
85 swift 1.1 then be handled by the <uri
86     link="http://www.gentoo.org/proj/en/gdp">Gentoo Documentation
87     Project</uri>.
88     </p>
89    
90     </body>
91     </section>
92     <section>
93     <title>Internationalisation Effort</title>
94     <body>
95    
96     <p>
97     Our documentation is available in several languages. Although not all
98     documents are translated, we do our best to keep them all up to date and
99     provide our users with as much translated documentation as possible. If
100     you want to help with our translation efforts, please contact <mail
101 neysx 1.40 link="neysx@gentoo.org">Xavier Neys</mail> who is in charge of
102 swift 1.1 the internationalisation efforts.
103     </p>
104    
105     </body>
106     </section>
107     <section>
108     <title>Frequently Asked Questions</title>
109     <body>
110    
111     <p>
112     As with every major project Gentoo has a FAQ too. We have first and foremost
113 swift 1.54 a couple of official FAQs maintained by the Gentoo Documentation Project:
114 swift 1.1 </p>
115    
116     <ul>
117     <li>The <b><uri link="faq.xml">Gentoo FAQ</uri></b> answers Frequently Asked Questions
118     about 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
120     Asked Questions about Gentoo Linux on the PowerPC platform.</li>
121 swift 1.52 <li>The <b><uri link="gentoo-sparc-faq.xml">Gentoo SPARC FAQ</uri></b> answers
122     Frequently Asked Questions about Gentoo Linux on the SPARC platform.</li>
123 swift 1.1 </ul>
124    
125     <p>
126     Furthermore we have a very extensive collection of FAQs on our <uri
127     link="http://forums.gentoo.org">forums</uri>. To view those, go to
128     <uri>http://forums.gentoo.org/viewforum.php?f=40</uri>.
129 swift 1.8 </p>
130    
131     </body>
132     </section>
133     <section>
134     <title>Gentoo Handbook</title>
135     <body>
136    
137     <p>
138     The Gentoo Documentation Project has started with the <uri
139 neysx 1.49 link="handbook/">Gentoo Handbook</uri> development. Currently, the
140     first two parts (<uri link="handbook/handbook-x86.xml?part=1">Installing
141     Gentoo</uri> and <uri link="handbook/handbook-x86.xml?part=2">Working with
142 swift 1.18 Gentoo</uri>) are finished and have reached the "official" stage. Users are
143     encouraged to use the installation instructions from the Handbook and <uri
144 swift 1.8 link="http://bugs.gentoo.org/enter_bug.cgi?product=Docs-user">bug</uri> us with
145     their experience (please use the <e>Handbook</e> component).
146     </p>
147    
148     <p>
149 neysx 1.49 More information can be found on the <uri link="handbook/">Gentoo
150 swift 1.8 Handbook Effort</uri> homepage.
151 swift 1.1 </p>
152    
153     </body>
154     </section>
155     </chapter>
156    
157     <chapter>
158     <title>Installation Related Resources</title>
159     <section>
160     <title>Introduction</title>
161     <body>
162    
163     <p>
164 swift 1.11 The installation related documentation provides information that can be usefull
165     during the installation of Gentoo Linux. This includes the part on "Installing
166     Gentoo" in our Gentoo Handbook, as well as the older but still maintained
167     architecture-related installation resources and tutorials that are to be
168 swift 1.31 followed during the installation.
169 swift 1.1 </p>
170    
171     </body>
172     </section>
173     <section>
174     <title>Installation Guides</title>
175     <body>
176    
177     <p>
178 neysx 1.49 The first part of our <b><uri link="/doc/en/handbook/index.xml">Gentoo
179     Handbook</uri></b> explains how to install Gentoo on your system. Each
180     architecture-specific version contains instructions for all users.
181 swift 1.1 </p>
182    
183     <p>
184 swift 1.47 For experienced users we also have Quick Installation Reference documents:
185 swift 1.1 </p>
186 swift 1.42
187 swift 1.47 <ul>
188     <li><b><uri link="gentoo-x86-quickinstall.xml">x86 Quick Installation Reference</uri></b></li>
189     <li><b><uri link="gentoo-sparc-quickinstall.xml">Sparc Quick Installation Reference</uri></b></li>
190     </ul>
191    
192 swift 1.1 <p>
193     Alpha-users are probably also interested in our <b><uri
194     link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></b>, which
195     explains how to set up the Compaq Tools package for Gentoo Alpha users.
196     </p>
197    
198     </body>
199     </section>
200     <section>
201     <title>Other Installation Related Documentation</title>
202     <body>
203    
204     <p>
205     For some people, the installation guide above doesn't suffice since their
206     environment doesn't permit them to boot from a LiveCD. To anticipate their
207     environments we provide the <b><uri link="altinstall.xml">Alternative
208     Installation Guide</uri></b> which lists the installation steps needed to install
209     Gentoo from another medium (distribution, bootable CD, network boot, etc.).
210     </p>
211 neysx 1.48
212 swift 1.1 <p>
213 neysx 1.48 Users interested in using LVM2 should read up our <b><uri link="lvm2.xml">LVM2
214     Guide</uri></b> which explains the steps required to get your LVM2 scheme up
215     and running.
216 swift 1.1 </p>
217 neysx 1.48
218 swift 1.1 <p>
219 swift 1.51 As our installation instructions allow for great flexibility, there are many
220     tips and tricks that can be persued during the installation. We have a <b><uri
221     link="gentoo-x86-tipsntricks.xml">Gentoo/x86 Installation Tips 'n
222     Tricks</uri></b> document online (which also contains interesting Tips 'n Tricks
223     for other architectures).
224     </p>
225    
226     <p>
227 swift 1.1 The <b><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade
228     Guide</uri></b> explains how to upgrade your Gentoo Linux 1.x systems to
229     Gentoo Linux 1.4.
230     </p>
231    
232 swift 1.29 <p>
233     The <b><uri link="genkernel.xml">Genkernel Guide</uri></b> intends to provide a
234     reference of all the functions provided by genkernel.
235     </p>
236    
237 swift 1.55 <p>
238     With the help of our <b><uri link="colinux-howto.xml">coLinux HOWTO</uri></b>
239     you are able to run Gentoo from within Windows.
240     </p>
241    
242 swift 1.1 </body>
243     </section>
244     </chapter>
245    
246     <chapter>
247     <title>Gentoo System Documentation</title>
248     <section>
249     <title>Introduction</title>
250     <body>
251    
252     <p>
253     The Gentoo System Documentation contains several guides about what makes
254     Gentoo Gentoo. This includes our init-system, Portage, USE-flags etc.
255     </p>
256    
257 swift 1.18 <p>
258     The Gentoo Handbook has a part on <uri
259 neysx 1.49 link="handbook/handbook-x86.xml?part=2">Working with Gentoo</uri> which contains
260 swift 1.18 information on Portage, USE flags, the Gentoo Init system and environment
261     variables.
262     </p>
263    
264 swift 1.1 </body>
265     </section>
266     <section>
267     <title>Portage and Related Documentation</title>
268     <body>
269    
270     <p>
271 neysx 1.49 The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=2">Portage and
272 swift 1.33 Software</uri></b> chapter in the Gentoo Handbook briefly covers how to keep
273     your packages up to date and how to maintain your installed software. In other
274     words, this chapter tells you how to use <c>emerge</c>.
275 swift 1.1 </p>
276    
277 swift 1.33
278 swift 1.1 <p>
279     The <b><uri link="portage-manual.xml">Portage Manual</uri></b> provides a general
280     overview of Portage, detailed configuration information and an end user guide
281     to installing and maintaining packages using the Portage system. It is
282     far more extended than the Portage User Guide.
283     </p>
284    
285     <p>
286 neysx 1.49 The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=1">USE Flags</uri></b>
287 swift 1.33 chapter in the Gentoo Handbook introduces you to the ultimate
288 swift 1.1 tool for customizing Gentoo -- USE flags. This howto helps you decide which
289     USE flags you need. It also describes the use of <c>etcat</c> to receive
290 swift 1.7 more verbose information regarding USE-flags on a package.
291 swift 1.1 </p>
292    
293     </body>
294     </section>
295     <section>
296     <title>Configuring Gentoo</title>
297     <body>
298    
299     <p>
300 neysx 1.49 The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=6">Environment
301 swift 1.33 Variables</uri></b> chapter in the Gentoo Handbook explains how to manage
302 swift 1.1 environment variables (such as <path>$PATH</path>) and the dynamic linker
303     cache easily.
304     </p>
305    
306     <p>
307 neysx 1.49 The <b><uri link="handbook/handbook-x86.xml?part=2&amp;chap=5">Initscripts</uri></b>
308 swift 1.33 chapter in the Gentoo Handbook details our system
309 swift 1.1 startup and service management scripts. Besides the regular
310     initscript-related items it also covers initscript dependencies and
311     support for virtuals.
312     </p>
313    
314     </body>
315     </section>
316     <section>
317     <title>Gentoo Choices</title>
318     <body>
319    
320     <p>
321     The <b><uri link="gentoo-kernel.xml">Kernel Guide</uri></b> lists the various
322     kernel sources Gentoo provides. Most of these kernels are maintained by
323     the <uri link="http://www.gentoo.org/proj/en/kernel">Gentoo Kernel
324     Project</uri>.
325     </p>
326    
327     </body>
328     </section>
329     </chapter>
330    
331     <chapter>
332     <title>System Administration Documentation</title>
333     <section>
334     <title>Introduction</title>
335     <body>
336    
337     <p>
338     The System Administration Documentation contains tutorials and guides on how to
339     install, configure and/or manage certain aspects of system administration.
340     Although the focus is on Gentoo systems, several of these guides can very well
341     be used by non-Gentoo users.
342     </p>
343    
344     </body>
345     </section>
346     <section>
347     <title>General System Administration</title>
348     <body>
349    
350     <p>
351     The <b><uri link="gentoo-security.xml">Gentoo Security Guide</uri></b> explains how
352     to harden a Gentoo Linux system against intruders and attacks. It
353     contains general security information (securing services, designing firewalls,
354     using IDS, kernel security etc.). For even tighter hardening please
355     visit the <uri link="http://www.gentoo.org/proj/en/hardened">Gentoo
356     Hardened</uri> website.
357     </p>
358    
359     <p>
360     The <b><uri link="prelink-howto.xml">Prelinking Guide</uri></b> explains how to
361     enhance your system using prelink. With prelinking, bigger applications
362     start up faster.
363     </p>
364    
365     <p>
366     The <b><uri link="ipv6.xml">IPv6 Guide</uri></b> shows how to setup IPv6 under
367     Gentoo Linux. IPv6 is the next Internet Protocol and is gaining
368     popularity widely.
369     </p>
370    
371     <p>
372 swift 1.44 The <b><uri link="uml.xml">User Mode Linux Guide</uri></b> shows how to use
373     User-Mode Linux under Gentoo Linux. User Mode Linux (UML) provides a nice
374     feature for Linux: Running Linux inside Linux (inside Linux inside Linux ...).
375 swift 1.1 With UML, you can easily create virtual setups.
376     </p>
377    
378 swift 1.56 <!--
379 swift 1.44 <p>
380     The <b><uri link="selinux-uml-guide.xml">SELinux UML Guide</uri></b> show you
381     how to set up a UML installation with SELinux support.
382     </p>
383 swift 1.56 -->
384 swift 1.44
385 swift 1.1 </body>
386     </section>
387     <section>
388     <title>Specific Administration Guides</title>
389     <body>
390    
391 swift 1.23 <!-- Some possible security issues, see #39718
392 swift 1.1 <p>
393     The <b><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></b> explains how
394     to administer user accounts centralised using OpenLDAP.
395     </p>
396 swift 1.23 -->
397 swift 1.1
398     <p>
399     The <b><uri link="openmosix-howto.xml">OpenMosix Howto</uri></b> describes step by
400 neysx 1.12 step how you can create a farm of openmosix nodes (a cluster of several PCs).
401     </p>
402    
403     <p>
404     The <b><uri link="diskless-howto.xml">Diskless Howto</uri></b> describes step by
405     step how you can set up diskless nodes with Gentoo.
406 swift 1.1 </p>
407    
408     <p>
409     The <b><uri link="ltsp.xml">LTSP Guide</uri></b> explains how to setup a Linux
410     Terminal Server with Gentoo.
411     </p>
412    
413     <p>
414     The <b><uri link="distcc.xml">Distcc Guide</uri></b> informs you how to use distcc
415     for distributed compilations with Gentoo Linux.
416     </p>
417    
418     <p>
419     The <b><uri link="devfs-guide.xml">DevFS Guide</uri></b> describes how DevFS works
420     and how to administer it.
421     </p>
422    
423     <p>
424 swift 1.41 The <b><uri link="udev-guide.xml">Gentoo udev Guide</uri></b> describes the new
425     device file management (using udev) which replaces DevFS and informs the reader
426     how udev is integrated in Gentoo.
427     </p>
428    
429     <p>
430 swift 1.1 The <b><uri link="printing-howto.xml">Printing Howto</uri></b> is a comprehensive
431     guide to Gentoo and printing.
432     </p>
433    
434     <p>
435     The <b><uri link="openafs.xml">OpenAFS Guide</uri></b> documents the use and
436     installation of OpenAFS, a distributed network-based file sharing technology.
437     </p>
438    
439     <p>
440 vapier 1.27 The <b><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></b> is
441     the essential guide for any postfix mail administrator. It covers the use of MySQL
442     for virtual users, webbased e-mail software, mailinglist software etc.
443     </p>
444    
445     <p>
446     The <b><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></b> is a pretty
447 vapier 1.28 useful guide for running a qmail based mail system. It focuses on remote
448     access and encrypted communication.
449 swift 1.1 </p>
450    
451 swift 1.52 <p>
452     The <b><uri link="gentoo-sparc-netboot-howto.xml">Gentoo/SPARC Netboot
453     HOWTO</uri></b> describes how to setup a network booting environment for a Sun
454     Microsystems SPARC or UltraSPARC based computer.
455     </p>
456    
457 swift 1.57 <p>
458 peitolm 1.59 The <b><uri link="gentoo-sparc-obpreference.sml">Gentoo SPARC OpenBoot PROM reference
459 peitolm 1.58 Guide</uri></b> offers a guide to the SPARC OpenBoot system, available on all
460     Sun Microsytsms SPARC/UltraSparc based computers.
461     </p>
462    
463     <p>
464 swift 1.57 The <b><uri link="quick-samba-howto.xml">Quick SAMBA Howto</uri></b> gives you a
465     step-by-step introduction to Samba and includes instructions on setting up an
466     anti-virus checking for the Samba shares.
467     </p>
468    
469 swift 1.1 </body>
470     </section>
471     </chapter>
472    
473     <chapter>
474     <title>Desktop Related Documentation</title>
475     <section>
476     <title>Introduction</title>
477     <body>
478    
479     <p>
480     The Desktop Related Documentation contains our Desktop Configuration Guide
481     with several other desktop related documents, including several
482     application-specific guides.
483     </p>
484    
485     </body>
486     </section>
487     <section>
488     <title>Desktop Configuration</title>
489     <body>
490    
491     <p>
492     The <b><uri link="desktop.xml">Desktop Configuration Guide</uri></b> explains how to
493     set up a fully-functional Gentoo Linux desktop machine. This includes
494     configuring KDE/GNOME, Using e-mail, File Sharing (using Samba), etc.
495     </p>
496    
497     <p>
498     The <b><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></b> is a
499     comprehensive guide on how to install and use ALSA (Advanced Linux Sound
500     Architecture).
501     </p>
502    
503     <p>
504     The <b><uri link="java.xml">Java Guide</uri></b> explains how Java is handled under
505     Gentoo Linux.
506     </p>
507    
508     <p>
509     The <b><uri link="guide-localization.xml">Localisation Guide</uri></b> explains how
510     to localise Gentoo Linux for non-English users.
511     </p>
512    
513     <p>
514     The <b><uri link="dri-howto.xml">Direct Rendering Howto</uri></b> explains how to get
515     3D acceleration working using XFree-DRM.
516     </p>
517    
518     <p>
519     The <b><uri link="ati-faq.xml">ATI FAQ</uri></b> provides the answers to frequently
520     asked questions regarding ATI graphical cards.
521     </p>
522    
523     </body>
524     </section>
525     <section>
526     <title>Application Specific Documentation</title>
527     <body>
528    
529     <p>
530     The <b><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></b> leads by example
531     to explain the basics of Nano.
532     </p>
533    
534     <p>
535     The <b><uri link="vi-guide.xml">Vi Guide</uri></b> uses the cheatsheet method to
536     teach the basics of vi.
537     </p>
538    
539     <p>
540     The <b><uri link="gnupg-user.xml">GnuPG User Guide</uri></b> is the definitive guide
541     on GnuPG.
542     </p>
543    
544     <p>
545     The <b><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></b>
546     explains how to use fetchmail, procmail, mutt, and nbsmtp.
547     </p>
548    
549     <p>
550     The <b><uri link="cvs-tutorial.xml">CVS Tutorial</uri></b> documents the basics of
551     using CVS, the Concurrent Versioning System.
552     </p>
553    
554     </body>
555     </section>
556     </chapter>
557    
558     <chapter>
559     <title>Gentoo Development Documentation</title>
560     <section>
561     <title>Introduction</title>
562     <body>
563    
564     <p>
565 swift 1.53 Gentoo is a volunteer-driven distribution. It is therefore vital to have
566 swift 1.1 high-quality development-related documentation available so that interested
567     users can easily learn how to help in the development of their favorite
568     distribution.
569     </p>
570    
571     </body>
572     </section>
573     <section>
574     <title>Gentoo Development Policies</title>
575     <body>
576    
577     <p>
578     The <b><uri link="policy.xml">Gentoo Linux Development Policy</uri></b> details
579     current policy for the creation of ebuilds.
580     </p>
581    
582 swift 1.15 <!--
583 swift 1.1 <p>
584     The <b><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></b>
585     details current policy for Gentoo Linux releases.
586     </p>
587 swift 1.15 -->
588 swift 1.1
589     <p>
590 swift 1.24 The <b><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></b>
591     details current policy for the creation and editing of documentation.
592 swift 1.1 </p>
593    
594     </body>
595     </section>
596     <section>
597     <title>Development Related Documentation</title>
598     <body>
599    
600     <p>
601 swift 1.24 The <b><uri link="gentoo-howto.xml">Ebuild HOWTO</uri></b> explains how to
602     create ebuilds.
603 swift 1.1 </p>
604    
605     <p>
606     The <b><uri link="eclass-howto.xml">Eclass HOWTO</uri></b> shows how to create
607     ebuilds that support OOP-like inheritance features.
608     </p>
609    
610     <p>
611 swift 1.24 The <b><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></b>
612     explains how to submit user-authored ebuilds.
613 swift 1.1 </p>
614    
615 swift 1.25 <p>
616     The <b><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></b>
617     lists the common mistakes contributors/developers make when trying to submit an
618     ebuild.
619     </p>
620    
621 swift 1.1 <p>
622 swift 1.24 The <b><uri link="metadata.xml">Metadata document</uri></b> explains how to
623     write up a <path>metadata.xml</path> file for a package.
624     </p>
625    
626     <p>
627     The <b><uri link="xml-guide.xml">GuideXML Guide</uri></b> documents the XML
628     format used in Gentoo Linux's web-based documentation.
629 swift 1.1 </p>
630    
631 neysx 1.45 <p>
632     The <b><uri link="doc-tipsntricks.xml">Doc Developers' Tips &amp;
633     Tricks</uri></b> contains some pointers for documentation developers.
634     </p>
635    
636 swift 1.1 </body>
637     </section>
638     </chapter>
639    
640     <chapter>
641     <title>Other Documentation</title>
642     <section>
643     <body>
644    
645     <ul>
646     <li>View our <uri link="http://www.gentoo.org/cgi-bin/viewcvs.cgi">CVS repository</uri> if you need to look at our code and ebuilds.</li>
647     <li><b><uri link="http://www.gentoo.org/main/en/about.xml">About</uri></b> the Gentoo Project.</li>
648     <li>Gentoo's <b><uri link="http://www.gentoo.org/main/en/contract.xml">Social Contract</uri></b>.</li>
649     <li>More on the <b><uri link="http://www.gentoo.org/proj/en/site.xml">XML projects</uri></b> Gentoo has gone through.</li>
650     <li>How to <b><uri link="rsync.xml">Mirror Gentoo : Rsync</uri></b>.</li>
651     <li>How to <b><uri link="source_mirrors.xml">Mirror Gentoo : Distfiles</uri></b>.</li>
652     <li>Gentoo Linux News (<uri link="http://www.gentoo.org/rdf/en/gentoo-news.rdf">RDF</uri>, <uri
653     link="http://purl.org/net/syndication/subscribe/?rss=http://www.gentoo.org/rdf/en/gentoo-news.rdf">Subscribe</uri>).</li>
654     </ul>
655    
656     </body>
657     </section>
658     </chapter>
659 swift 1.4 <chapter>
660     <title>Document Listing</title>
661 swift 1.32 <section>
662 swift 1.4 <body>
663    
664     <p>
665     For people who like to get a short overview on available documentation, here it
666     is :)
667     </p>
668    
669     <table>
670     <tr><th>Frequently Asked Questions</th></tr>
671     <tr><ti><uri link="faq.xml">Gentoo FAQ</uri></ti></tr>
672     <tr><ti><uri link="gentoo-ppc-faq.xml">Gentoo PPC FAQ</uri></ti></tr>
673 swift 1.52 <tr><ti><uri link="gentoo-sparc-faq.xml">Gentoo SPARC FAQ</uri></ti></tr>
674 swift 1.4 <tr><th>Installation Related Documentation</th></tr>
675 neysx 1.49 <tr><ti><uri link="handbook/">Gentoo Handbook</uri></ti></tr>
676 swift 1.42 <tr><ti><uri link="gentoo-x86-quickinstall.xml">Gentoo x86 Quick Installation Rerefence</uri></ti></tr>
677 swift 1.47 <tr><ti><uri link="gentoo-sparc-quickinstall.xml">Gentoo sparc Quick Installation Rerefence</uri></ti></tr>
678 swift 1.4 <tr><ti><uri link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></ti></tr>
679     <tr><ti><uri link="altinstall.xml">Alternative Installation Guide</uri></ti></tr>
680 neysx 1.48 <tr><ti><uri link="lvm2.xml">LVM2 Guide</uri></ti></tr>
681 swift 1.51 <tr><ti><uri link="gentoo-x86-tipsntricks.xml">Gentoo/x86 Tips 'n Tricks Document</uri></ti></tr>
682 swift 1.4 <tr><ti><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade Guide</uri></ti></tr>
683 swift 1.29 <tr><ti><uri link="genkernel.xml">Genkernel Guide</uri></ti></tr>
684 swift 1.55 <tr><ti><uri link="colinux-howto.xml">coLinux HOWTO</uri></ti></tr>
685 swift 1.4 <tr><th>Gentoo System Documentation</th></tr>
686 neysx 1.49 <tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=2">Portage and Software</uri></ti></tr>
687 swift 1.4 <tr><ti><uri link="portage-manual.xml">Portage Manual Guide</uri></ti></tr>
688 neysx 1.49 <tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=1">USE Flags</uri></ti></tr>
689     <tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=6">Environment Variables</uri></ti></tr>
690     <tr><ti><uri link="handbook/handbook-x86.xml?part=2&amp;chap=5">Initscripts</uri></ti></tr>
691 swift 1.4 <tr><ti><uri link="gentoo-kernel.xml">Gentoo Kernel Guide</uri></ti></tr>
692     <tr><th>System Administration Documentation</th></tr>
693     <tr><ti><uri link="gentoo-security.xml">Gentoo Security Guide</uri></ti></tr>
694     <tr><ti><uri link="prelink-howto.xml">Prelinking Howto</uri></ti></tr>
695     <tr><ti><uri link="ipv6.xml">IPv6 Guide</uri></ti></tr>
696     <tr><ti><uri link="uml.xml">User Mode Linux Guide</uri></ti></tr>
697 swift 1.56 <!-- <tr><ti><uri link="selinux-uml-guide.xml">SELinux UML Guide</uri></ti></tr>
698     -->
699 swift 1.50 <!-- <tr><ti><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></ti></tr> -->
700 swift 1.4 <tr><ti><uri link="openmosix-howto.xml">OpenMosix Guide</uri></ti></tr>
701 neysx 1.12 <tr><ti><uri link="diskless-howto.xml">Diskless Guide</uri></ti></tr>
702 swift 1.4 <tr><ti><uri link="ltsp.xml">LTSP Guide</uri></ti></tr>
703     <tr><ti><uri link="distcc.xml">DistCC Guide</uri></ti></tr>
704     <tr><ti><uri link="devfs-guide.xml">DevFS Guide</uri></ti></tr>
705 swift 1.41 <tr><ti><uri link="udev-guide.xml">Gentoo udev Guide</uri></ti></tr>
706 swift 1.4 <tr><ti><uri link="printing-howto.xml">Printing Guide</uri></ti></tr>
707     <tr><ti><uri link="openafs.xml">OpenAFS Guide</uri></ti></tr>
708 vapier 1.27 <tr><ti><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></ti></tr>
709     <tr><ti><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></ti></tr>
710 swift 1.52 <tr><ti><uri link="gentoo-sparc-netboot-howto.xml">Gentoo/SPARC Netboot Howto</uri></ti></tr>
711 peitolm 1.59 <tr><ti><uri link="gentoo-sparc-obpreference.xml">Gentoo SPARC OpenBoot PROM Reference Guide</uri></ti></tr>
712 swift 1.57 <tr><ti><uri link="quick-samba-howto.xml">Quick Samba HOWTO</uri></ti></tr>
713 swift 1.4 <tr><th>Desktop Related Documentation</th></tr>
714     <tr><ti><uri link="desktop.xml">Desktop Configuration Guide</uri></ti></tr>
715     <tr><ti><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></ti></tr>
716     <tr><ti><uri link="java.xml">Java Guide</uri></ti></tr>
717     <tr><ti><uri link="guide-localization.xml">Localisation Guide</uri></ti></tr>
718     <tr><ti><uri link="dri-howto.xml">Direct Rendering Howto</uri></ti></tr>
719     <tr><ti><uri link="ati-faq.xml">ATI FAQ</uri></ti></tr>
720     <tr><ti><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></ti></tr>
721     <tr><ti><uri link="vi-guide.xml">Vi Guide</uri></ti></tr>
722 swift 1.14 <tr><ti><uri link="gnupg-user.xml">GnuPG User Guide</uri></ti></tr>
723 swift 1.4 <tr><ti><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></ti></tr>
724     <tr><ti><uri link="cvs-tutorial.xml">CVS Tutorial</uri></ti></tr>
725     <tr><th>Gentoo Development Documentation</th></tr>
726     <tr><ti><uri link="policy.xml">Gentoo Linux Development Policy</uri></ti></tr>
727 swift 1.16 <!-- <tr><ti><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></ti></tr> -->
728 swift 1.4 <tr><ti><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></ti></tr>
729     <tr><ti><uri link="gentoo-howto.xml">Ebuild Howto</uri></ti></tr>
730     <tr><ti><uri link="eclass-howto.xml">Eclass Howto</uri></ti></tr>
731     <tr><ti><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></ti></tr>
732 swift 1.25 <tr><ti><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></ti></tr>
733 swift 1.26 <tr><ti><uri link="metadata.xml">Metadata document</uri></ti></tr>
734 neysx 1.45 <tr><ti><uri link="xml-guide.xml">GuideXML Guide</uri></ti></tr>
735     <tr><ti><uri link="doc-tipsntricks.xml">Doc Developers' Tips &amp; Tricks</uri></ti></tr>
736 swift 1.4 <tr><th>Other Documentation</th></tr>
737     <tr><ti><uri link="rsync.xml">Gentoo RSync Mirror</uri></ti></tr>
738     <tr><ti><uri link="source_mirrors.xml">Gentoo Distfiles Mirror</uri></ti></tr>
739     </table>
740    
741     </body>
742 swift 1.32 </section>
743 swift 1.4 </chapter>
744 swift 1.1 </mainpage>

  ViewVC Help
Powered by ViewVC 1.1.20