1 |
<?xml version="1.0" encoding="UTF-8"?> |
2 |
<!-- $Header: /home/cvsroot/gentoo/xml/htdocs/doc/en/index.xml,v 1.41 2004/03/02 11:46:57 swift Exp $ --> |
3 |
<!DOCTYPE mainpage SYSTEM "/dtd/guide.dtd"> |
4 |
<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 |
<author title="Editor"><!-- zhen@gentoo.org --> |
10 |
John P. Davis |
11 |
</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 |
<version>2.17</version> |
20 |
<date>March 6, 2004</date> |
21 |
|
22 |
<chapter> |
23 |
<title>Gentoo Documentation Resources</title> |
24 |
<section> |
25 |
<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 |
<uri link="http://www.gentoo.org/doc/da/index.xml">Danish</uri> | |
34 |
<uri link="http://www.gentoo.org/doc/nl/index.xml">Dutch</uri> | |
35 |
<uri link="http://www.gentoo.org/doc/en/index.xml">English</uri> | |
36 |
<uri link="http://www.gentoo.org/doc/fr/index.xml">French</uri> | |
37 |
<uri link="http://www.gentoo.org/doc/de/index.xml">German</uri> | |
38 |
<uri link="http://www.gentoo.org/doc/hu/index.xml">Hungarian</uri> | |
39 |
<!-- <uri link="http://www.gentoo.org/doc/id/index.xml">Indonesian</uri> | --> |
40 |
<uri link="http://www.gentoo.org/doc/it/index.xml">Italian</uri> | |
41 |
<uri link="http://www.gentoo.org/doc/ja/index.xml">Japanese</uri> | |
42 |
<!-- <uri link="http://www.gentoo.org/doc/kr/index.xml">Korean</uri> | --> |
43 |
<uri link="http://www.gentoo.org/doc/ru/index.xml">Russian</uri> | |
44 |
<uri link="http://www.gentoo.org/doc/es/index.xml">Spanish</uri> | |
45 |
<uri link="http://www.gentoo.org/doc/tw/index.xml">Traditional Chinese</uri> |
46 |
</p> |
47 |
|
48 |
</body> |
49 |
</section> |
50 |
<section> |
51 |
<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 |
<li><uri link="#doc_chap8">Overview of Available Documentation</uri></li> |
63 |
</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 |
a bug report for "Docs-developer" or "Docs-user". These bug reports will |
85 |
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 |
link="neysx@gentoo.org">Xavier Neys</mail> who is in charge of |
102 |
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 |
two official FAQs maintained by the Gentoo Documentation Project: |
114 |
</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 |
</ul> |
122 |
|
123 |
<p> |
124 |
Furthermore we have a very extensive collection of FAQs on our <uri |
125 |
link="http://forums.gentoo.org">forums</uri>. To view those, go to |
126 |
<uri>http://forums.gentoo.org/viewforum.php?f=40</uri>. |
127 |
</p> |
128 |
|
129 |
</body> |
130 |
</section> |
131 |
<section> |
132 |
<title>Gentoo Handbook</title> |
133 |
<body> |
134 |
|
135 |
<p> |
136 |
The Gentoo Documentation Project has started with the <uri |
137 |
link="handbook/handbook.xml">Gentoo Handbook</uri> development. Currently, the |
138 |
first two parts (<uri link="handbook/handbook.xml?part=1">Installing |
139 |
Gentoo</uri> and <uri link="handbook/handbook.xml?part=2">Working with |
140 |
Gentoo</uri>) are finished and have reached the "official" stage. Users are |
141 |
encouraged to use the installation instructions from the Handbook and <uri |
142 |
link="http://bugs.gentoo.org/enter_bug.cgi?product=Docs-user">bug</uri> us with |
143 |
their experience (please use the <e>Handbook</e> component). |
144 |
</p> |
145 |
|
146 |
<p> |
147 |
More information can be found on the <uri link="handbook/index.xml">Gentoo |
148 |
Handbook Effort</uri> homepage. |
149 |
</p> |
150 |
|
151 |
</body> |
152 |
</section> |
153 |
</chapter> |
154 |
|
155 |
<chapter> |
156 |
<title>Installation Related Resources</title> |
157 |
<section> |
158 |
<title>Introduction</title> |
159 |
<body> |
160 |
|
161 |
<p> |
162 |
The installation related documentation provides information that can be usefull |
163 |
during the installation of Gentoo Linux. This includes the part on "Installing |
164 |
Gentoo" in our Gentoo Handbook, as well as the older but still maintained |
165 |
architecture-related installation resources and tutorials that are to be |
166 |
followed during the installation. |
167 |
</p> |
168 |
|
169 |
</body> |
170 |
</section> |
171 |
<section> |
172 |
<title>Installation Guides</title> |
173 |
<body> |
174 |
|
175 |
<p> |
176 |
The part on <b><uri link="/doc/en/handbook/handbook.xml?part=1">Installing |
177 |
Gentoo</uri></b> in our <b><uri link="/doc/en/handbook/index.xml">Gentoo |
178 |
Handbook</uri></b> explains how to install Gentoo on your system. It contains |
179 |
instructions for all users, all architectures. |
180 |
</p> |
181 |
|
182 |
<p> |
183 |
For experienced users we also have a <b><uri |
184 |
link="gentoo-x86-quickinstall.xml">x86 Quick Installation Reference</uri></b>. |
185 |
</p> |
186 |
|
187 |
<p> |
188 |
Alpha-users are probably also interested in our <b><uri |
189 |
link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></b>, which |
190 |
explains how to set up the Compaq Tools package for Gentoo Alpha users. |
191 |
</p> |
192 |
|
193 |
</body> |
194 |
</section> |
195 |
<section> |
196 |
<title>Other Installation Related Documentation</title> |
197 |
<body> |
198 |
|
199 |
<p> |
200 |
For some people, the installation guide above doesn't suffice since their |
201 |
environment doesn't permit them to boot from a LiveCD. To anticipate their |
202 |
environments we provide the <b><uri link="altinstall.xml">Alternative |
203 |
Installation Guide</uri></b> which lists the installation steps needed to install |
204 |
Gentoo from another medium (distribution, bootable CD, network boot, etc.). |
205 |
</p> |
206 |
<!-- Doc needs updating for LVM2 and 2.6 kernels (also 2.4 <-> 2.6 coop) |
207 |
<p> |
208 |
Users interested in using LVM should read up our <b><uri link="lvm.xml">LVM |
209 |
Guide</uri></b> (implemented in the Gentoo Handbook) which explains what steps |
210 |
you have to go through to get your LVM scheme up and running. |
211 |
</p> |
212 |
--> |
213 |
<p> |
214 |
The <b><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade |
215 |
Guide</uri></b> explains how to upgrade your Gentoo Linux 1.x systems to |
216 |
Gentoo Linux 1.4. |
217 |
</p> |
218 |
|
219 |
<p> |
220 |
The <b><uri link="genkernel.xml">Genkernel Guide</uri></b> intends to provide a |
221 |
reference of all the functions provided by genkernel. |
222 |
</p> |
223 |
|
224 |
</body> |
225 |
</section> |
226 |
</chapter> |
227 |
|
228 |
<chapter> |
229 |
<title>Gentoo System Documentation</title> |
230 |
<section> |
231 |
<title>Introduction</title> |
232 |
<body> |
233 |
|
234 |
<p> |
235 |
The Gentoo System Documentation contains several guides about what makes |
236 |
Gentoo Gentoo. This includes our init-system, Portage, USE-flags etc. |
237 |
</p> |
238 |
|
239 |
<p> |
240 |
The Gentoo Handbook has a part on <uri |
241 |
link="handbook/handbook.xml?part=2">Working with Gentoo</uri> which contains |
242 |
information on Portage, USE flags, the Gentoo Init system and environment |
243 |
variables. |
244 |
</p> |
245 |
|
246 |
</body> |
247 |
</section> |
248 |
<section> |
249 |
<title>Portage and Related Documentation</title> |
250 |
<body> |
251 |
|
252 |
<p> |
253 |
The <b><uri link="handbook/handbook.xml?part=2&chap=2">Portage and |
254 |
Software</uri></b> chapter in the Gentoo Handbook briefly covers how to keep |
255 |
your packages up to date and how to maintain your installed software. In other |
256 |
words, this chapter tells you how to use <c>emerge</c>. |
257 |
</p> |
258 |
|
259 |
|
260 |
<p> |
261 |
The <b><uri link="portage-manual.xml">Portage Manual</uri></b> provides a general |
262 |
overview of Portage, detailed configuration information and an end user guide |
263 |
to installing and maintaining packages using the Portage system. It is |
264 |
far more extended than the Portage User Guide. |
265 |
</p> |
266 |
|
267 |
<p> |
268 |
The <b><uri link="handbook/handbook.xml?part=2&chap=1">USE Flags</uri></b> |
269 |
chapter in the Gentoo Handbook introduces you to the ultimate |
270 |
tool for customizing Gentoo -- USE flags. This howto helps you decide which |
271 |
USE flags you need. It also describes the use of <c>etcat</c> to receive |
272 |
more verbose information regarding USE-flags on a package. |
273 |
</p> |
274 |
|
275 |
</body> |
276 |
</section> |
277 |
<section> |
278 |
<title>Configuring Gentoo</title> |
279 |
<body> |
280 |
|
281 |
<p> |
282 |
The <b><uri link="handbook/handbook.xml?part=2&chap=6">Environment |
283 |
Variables</uri></b> chapter in the Gentoo Handbook explains how to manage |
284 |
environment variables (such as <path>$PATH</path>) and the dynamic linker |
285 |
cache easily. |
286 |
</p> |
287 |
|
288 |
<p> |
289 |
The <b><uri link="handbook/handbook.xml?part=2&chap=5">Initscripts</uri></b> |
290 |
chapter in the Gentoo Handbook details our system |
291 |
startup and service management scripts. Besides the regular |
292 |
initscript-related items it also covers initscript dependencies and |
293 |
support for virtuals. |
294 |
</p> |
295 |
|
296 |
</body> |
297 |
</section> |
298 |
<section> |
299 |
<title>Gentoo Choices</title> |
300 |
<body> |
301 |
|
302 |
<p> |
303 |
The <b><uri link="gentoo-kernel.xml">Kernel Guide</uri></b> lists the various |
304 |
kernel sources Gentoo provides. Most of these kernels are maintained by |
305 |
the <uri link="http://www.gentoo.org/proj/en/kernel">Gentoo Kernel |
306 |
Project</uri>. |
307 |
</p> |
308 |
|
309 |
</body> |
310 |
</section> |
311 |
</chapter> |
312 |
|
313 |
<chapter> |
314 |
<title>System Administration Documentation</title> |
315 |
<section> |
316 |
<title>Introduction</title> |
317 |
<body> |
318 |
|
319 |
<p> |
320 |
The System Administration Documentation contains tutorials and guides on how to |
321 |
install, configure and/or manage certain aspects of system administration. |
322 |
Although the focus is on Gentoo systems, several of these guides can very well |
323 |
be used by non-Gentoo users. |
324 |
</p> |
325 |
|
326 |
</body> |
327 |
</section> |
328 |
<section> |
329 |
<title>General System Administration</title> |
330 |
<body> |
331 |
|
332 |
<p> |
333 |
The <b><uri link="gentoo-security.xml">Gentoo Security Guide</uri></b> explains how |
334 |
to harden a Gentoo Linux system against intruders and attacks. It |
335 |
contains general security information (securing services, designing firewalls, |
336 |
using IDS, kernel security etc.). For even tighter hardening please |
337 |
visit the <uri link="http://www.gentoo.org/proj/en/hardened">Gentoo |
338 |
Hardened</uri> website. |
339 |
</p> |
340 |
|
341 |
<p> |
342 |
The <b><uri link="prelink-howto.xml">Prelinking Guide</uri></b> explains how to |
343 |
enhance your system using prelink. With prelinking, bigger applications |
344 |
start up faster. |
345 |
</p> |
346 |
|
347 |
<p> |
348 |
The <b><uri link="ipv6.xml">IPv6 Guide</uri></b> shows how to setup IPv6 under |
349 |
Gentoo Linux. IPv6 is the next Internet Protocol and is gaining |
350 |
popularity widely. |
351 |
</p> |
352 |
|
353 |
<p> |
354 |
The <b><uri link="uml.xml">User Mode Linux Guide</uri></b> shows how to use User-Mode |
355 |
Linux under Gentoo Linux. User Mode Linux (UML) provides a nice feature |
356 |
for Linux: Running Linux inside Linux (inside Linux inside Linux ...). |
357 |
With UML, you can easily create virtual setups. |
358 |
</p> |
359 |
|
360 |
</body> |
361 |
</section> |
362 |
<section> |
363 |
<title>Specific Administration Guides</title> |
364 |
<body> |
365 |
|
366 |
<!-- Some possible security issues, see #39718 |
367 |
<p> |
368 |
The <b><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></b> explains how |
369 |
to administer user accounts centralised using OpenLDAP. |
370 |
</p> |
371 |
--> |
372 |
|
373 |
<p> |
374 |
The <b><uri link="openmosix-howto.xml">OpenMosix Howto</uri></b> describes step by |
375 |
step how you can create a farm of openmosix nodes (a cluster of several PCs). |
376 |
</p> |
377 |
|
378 |
<p> |
379 |
The <b><uri link="diskless-howto.xml">Diskless Howto</uri></b> describes step by |
380 |
step how you can set up diskless nodes with Gentoo. |
381 |
</p> |
382 |
|
383 |
<p> |
384 |
The <b><uri link="ltsp.xml">LTSP Guide</uri></b> explains how to setup a Linux |
385 |
Terminal Server with Gentoo. |
386 |
</p> |
387 |
|
388 |
<p> |
389 |
The <b><uri link="distcc.xml">Distcc Guide</uri></b> informs you how to use distcc |
390 |
for distributed compilations with Gentoo Linux. |
391 |
</p> |
392 |
|
393 |
<p> |
394 |
The <b><uri link="devfs-guide.xml">DevFS Guide</uri></b> describes how DevFS works |
395 |
and how to administer it. |
396 |
</p> |
397 |
|
398 |
<p> |
399 |
The <b><uri link="udev-guide.xml">Gentoo udev Guide</uri></b> describes the new |
400 |
device file management (using udev) which replaces DevFS and informs the reader |
401 |
how udev is integrated in Gentoo. |
402 |
</p> |
403 |
|
404 |
<p> |
405 |
The <b><uri link="printing-howto.xml">Printing Howto</uri></b> is a comprehensive |
406 |
guide to Gentoo and printing. |
407 |
</p> |
408 |
|
409 |
<p> |
410 |
The <b><uri link="openafs.xml">OpenAFS Guide</uri></b> documents the use and |
411 |
installation of OpenAFS, a distributed network-based file sharing technology. |
412 |
</p> |
413 |
|
414 |
<p> |
415 |
The <b><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></b> is |
416 |
the essential guide for any postfix mail administrator. It covers the use of MySQL |
417 |
for virtual users, webbased e-mail software, mailinglist software etc. |
418 |
</p> |
419 |
|
420 |
<p> |
421 |
The <b><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></b> is a pretty |
422 |
useful guide for running a qmail based mail system. It focuses on remote |
423 |
access and encrypted communication. |
424 |
</p> |
425 |
|
426 |
</body> |
427 |
</section> |
428 |
</chapter> |
429 |
|
430 |
<chapter> |
431 |
<title>Desktop Related Documentation</title> |
432 |
<section> |
433 |
<title>Introduction</title> |
434 |
<body> |
435 |
|
436 |
<p> |
437 |
The Desktop Related Documentation contains our Desktop Configuration Guide |
438 |
with several other desktop related documents, including several |
439 |
application-specific guides. |
440 |
</p> |
441 |
|
442 |
</body> |
443 |
</section> |
444 |
<section> |
445 |
<title>Desktop Configuration</title> |
446 |
<body> |
447 |
|
448 |
<p> |
449 |
The <b><uri link="desktop.xml">Desktop Configuration Guide</uri></b> explains how to |
450 |
set up a fully-functional Gentoo Linux desktop machine. This includes |
451 |
configuring KDE/GNOME, Using e-mail, File Sharing (using Samba), etc. |
452 |
</p> |
453 |
|
454 |
<p> |
455 |
The <b><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></b> is a |
456 |
comprehensive guide on how to install and use ALSA (Advanced Linux Sound |
457 |
Architecture). |
458 |
</p> |
459 |
|
460 |
<p> |
461 |
The <b><uri link="java.xml">Java Guide</uri></b> explains how Java is handled under |
462 |
Gentoo Linux. |
463 |
</p> |
464 |
|
465 |
<p> |
466 |
The <b><uri link="guide-localization.xml">Localisation Guide</uri></b> explains how |
467 |
to localise Gentoo Linux for non-English users. |
468 |
</p> |
469 |
|
470 |
<p> |
471 |
The <b><uri link="dri-howto.xml">Direct Rendering Howto</uri></b> explains how to get |
472 |
3D acceleration working using XFree-DRM. |
473 |
</p> |
474 |
|
475 |
<p> |
476 |
The <b><uri link="ati-faq.xml">ATI FAQ</uri></b> provides the answers to frequently |
477 |
asked questions regarding ATI graphical cards. |
478 |
</p> |
479 |
|
480 |
</body> |
481 |
</section> |
482 |
<section> |
483 |
<title>Application Specific Documentation</title> |
484 |
<body> |
485 |
|
486 |
<p> |
487 |
The <b><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></b> leads by example |
488 |
to explain the basics of Nano. |
489 |
</p> |
490 |
|
491 |
<p> |
492 |
The <b><uri link="vi-guide.xml">Vi Guide</uri></b> uses the cheatsheet method to |
493 |
teach the basics of vi. |
494 |
</p> |
495 |
|
496 |
<p> |
497 |
The <b><uri link="gnupg-user.xml">GnuPG User Guide</uri></b> is the definitive guide |
498 |
on GnuPG. |
499 |
</p> |
500 |
|
501 |
<p> |
502 |
The <b><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></b> |
503 |
explains how to use fetchmail, procmail, mutt, and nbsmtp. |
504 |
</p> |
505 |
|
506 |
<p> |
507 |
The <b><uri link="cvs-tutorial.xml">CVS Tutorial</uri></b> documents the basics of |
508 |
using CVS, the Concurrent Versioning System. |
509 |
</p> |
510 |
|
511 |
</body> |
512 |
</section> |
513 |
</chapter> |
514 |
|
515 |
<chapter> |
516 |
<title>Gentoo Development Documentation</title> |
517 |
<section> |
518 |
<title>Introduction</title> |
519 |
<body> |
520 |
|
521 |
<p> |
522 |
Gentoo is a volunteer-driven distribution. It is therefor vital to have |
523 |
high-quality development-related documentation available so that interested |
524 |
users can easily learn how to help in the development of their favorite |
525 |
distribution. |
526 |
</p> |
527 |
|
528 |
</body> |
529 |
</section> |
530 |
<section> |
531 |
<title>Gentoo Development Policies</title> |
532 |
<body> |
533 |
|
534 |
<p> |
535 |
The <b><uri link="policy.xml">Gentoo Linux Development Policy</uri></b> details |
536 |
current policy for the creation of ebuilds. |
537 |
</p> |
538 |
|
539 |
<!-- |
540 |
<p> |
541 |
The <b><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></b> |
542 |
details current policy for Gentoo Linux releases. |
543 |
</p> |
544 |
--> |
545 |
|
546 |
<p> |
547 |
The <b><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></b> |
548 |
details current policy for the creation and editing of documentation. |
549 |
</p> |
550 |
|
551 |
</body> |
552 |
</section> |
553 |
<section> |
554 |
<title>Development Related Documentation</title> |
555 |
<body> |
556 |
|
557 |
<p> |
558 |
The <b><uri link="gentoo-howto.xml">Ebuild HOWTO</uri></b> explains how to |
559 |
create ebuilds. |
560 |
</p> |
561 |
|
562 |
<p> |
563 |
The <b><uri link="eclass-howto.xml">Eclass HOWTO</uri></b> shows how to create |
564 |
ebuilds that support OOP-like inheritance features. |
565 |
</p> |
566 |
|
567 |
<p> |
568 |
The <b><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></b> |
569 |
explains how to submit user-authored ebuilds. |
570 |
</p> |
571 |
|
572 |
<p> |
573 |
The <b><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></b> |
574 |
lists the common mistakes contributors/developers make when trying to submit an |
575 |
ebuild. |
576 |
</p> |
577 |
|
578 |
<p> |
579 |
The <b><uri link="metadata.xml">Metadata document</uri></b> explains how to |
580 |
write up a <path>metadata.xml</path> file for a package. |
581 |
</p> |
582 |
|
583 |
<p> |
584 |
The <b><uri link="xml-guide.xml">GuideXML Guide</uri></b> documents the XML |
585 |
format used in Gentoo Linux's web-based documentation. |
586 |
</p> |
587 |
|
588 |
</body> |
589 |
</section> |
590 |
</chapter> |
591 |
|
592 |
<chapter> |
593 |
<title>Other Documentation</title> |
594 |
<section> |
595 |
<body> |
596 |
|
597 |
<ul> |
598 |
<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> |
599 |
<li><b><uri link="http://www.gentoo.org/main/en/about.xml">About</uri></b> the Gentoo Project.</li> |
600 |
<li>Gentoo's <b><uri link="http://www.gentoo.org/main/en/contract.xml">Social Contract</uri></b>.</li> |
601 |
<li>More on the <b><uri link="http://www.gentoo.org/proj/en/site.xml">XML projects</uri></b> Gentoo has gone through.</li> |
602 |
<li>How to <b><uri link="rsync.xml">Mirror Gentoo : Rsync</uri></b>.</li> |
603 |
<li>How to <b><uri link="source_mirrors.xml">Mirror Gentoo : Distfiles</uri></b>.</li> |
604 |
<li>Gentoo Linux News (<uri link="http://www.gentoo.org/rdf/en/gentoo-news.rdf">RDF</uri>, <uri |
605 |
link="http://purl.org/net/syndication/subscribe/?rss=http://www.gentoo.org/rdf/en/gentoo-news.rdf">Subscribe</uri>).</li> |
606 |
</ul> |
607 |
|
608 |
</body> |
609 |
</section> |
610 |
</chapter> |
611 |
<chapter> |
612 |
<title>Document Listing</title> |
613 |
<section> |
614 |
<body> |
615 |
|
616 |
<p> |
617 |
For people who like to get a short overview on available documentation, here it |
618 |
is :) |
619 |
</p> |
620 |
|
621 |
<table> |
622 |
<tr><th>Frequently Asked Questions</th></tr> |
623 |
<tr><ti><uri link="faq.xml">Gentoo FAQ</uri></ti></tr> |
624 |
<tr><ti><uri link="gentoo-ppc-faq.xml">Gentoo PPC FAQ</uri></ti></tr> |
625 |
<tr><th>Installation Related Documentation</th></tr> |
626 |
<tr><ti><uri link="handbook/handbook.xml?part=1">Installing Gentoo</uri></ti></tr> |
627 |
<tr><ti><uri link="gentoo-x86-quickinstall.xml">Gentoo x86 Quick Installation Rerefence</uri></ti></tr> |
628 |
<tr><ti><uri link="gentoo-alpha-compaq-tools.xml">Compaq Alpha Tools Guide</uri></ti></tr> |
629 |
<tr><ti><uri link="altinstall.xml">Alternative Installation Guide</uri></ti></tr> |
630 |
<!--<tr><ti><uri link="lvm.xml">LVM Guide</uri></ti></tr>--> |
631 |
<tr><ti><uri link="new-upgrade-to-gentoo-1.4.xml">Gentoo Linux 1.4 Upgrade Guide</uri></ti></tr> |
632 |
<tr><ti><uri link="genkernel.xml">Genkernel Guide</uri></ti></tr> |
633 |
<tr><th>Gentoo System Documentation</th></tr> |
634 |
<tr><ti><uri link="handbook/handbook.xml?part=2&chap=2">Portage and Software</uri></ti></tr> |
635 |
<tr><ti><uri link="portage-manual.xml">Portage Manual Guide</uri></ti></tr> |
636 |
<tr><ti><uri link="handbook/handbook.xml?part=2&chap=1">USE Flags</uri></ti></tr> |
637 |
<tr><ti><uri link="handbook/handbook.xml?part=2&chap=6">Environment Variables</uri></ti></tr> |
638 |
<tr><ti><uri link="handbook/handbook.xml?part=2&chap=5">Initscripts</uri></ti></tr> |
639 |
<tr><ti><uri link="gentoo-kernel.xml">Gentoo Kernel Guide</uri></ti></tr> |
640 |
<tr><th>System Administration Documentation</th></tr> |
641 |
<tr><ti><uri link="gentoo-security.xml">Gentoo Security Guide</uri></ti></tr> |
642 |
<tr><ti><uri link="prelink-howto.xml">Prelinking Howto</uri></ti></tr> |
643 |
<tr><ti><uri link="ipv6.xml">IPv6 Guide</uri></ti></tr> |
644 |
<tr><ti><uri link="uml.xml">User Mode Linux Guide</uri></ti></tr> |
645 |
<tr><ti><uri link="ldap-howto.xml">LDAP Authentification Howto</uri></ti></tr> |
646 |
<tr><ti><uri link="openmosix-howto.xml">OpenMosix Guide</uri></ti></tr> |
647 |
<tr><ti><uri link="diskless-howto.xml">Diskless Guide</uri></ti></tr> |
648 |
<tr><ti><uri link="ltsp.xml">LTSP Guide</uri></ti></tr> |
649 |
<tr><ti><uri link="distcc.xml">DistCC Guide</uri></ti></tr> |
650 |
<tr><ti><uri link="devfs-guide.xml">DevFS Guide</uri></ti></tr> |
651 |
<tr><ti><uri link="udev-guide.xml">Gentoo udev Guide</uri></ti></tr> |
652 |
<tr><ti><uri link="printing-howto.xml">Printing Guide</uri></ti></tr> |
653 |
<tr><ti><uri link="openafs.xml">OpenAFS Guide</uri></ti></tr> |
654 |
<tr><ti><uri link="virt-mail-howto.xml">Virtual/Mailhost Postfix Howto</uri></ti></tr> |
655 |
<tr><ti><uri link="qmail-howto.xml">qmail/vpopmail Howto</uri></ti></tr> |
656 |
<tr><th>Desktop Related Documentation</th></tr> |
657 |
<tr><ti><uri link="desktop.xml">Desktop Configuration Guide</uri></ti></tr> |
658 |
<tr><ti><uri link="alsa-guide.xml">ALSA Configuration Guide</uri></ti></tr> |
659 |
<tr><ti><uri link="java.xml">Java Guide</uri></ti></tr> |
660 |
<tr><ti><uri link="guide-localization.xml">Localisation Guide</uri></ti></tr> |
661 |
<tr><ti><uri link="dri-howto.xml">Direct Rendering Howto</uri></ti></tr> |
662 |
<tr><ti><uri link="ati-faq.xml">ATI FAQ</uri></ti></tr> |
663 |
<tr><ti><uri link="nano-basics-guide.xml">Nano Basics Guide</uri></ti></tr> |
664 |
<tr><ti><uri link="vi-guide.xml">Vi Guide</uri></ti></tr> |
665 |
<tr><ti><uri link="gnupg-user.xml">GnuPG User Guide</uri></ti></tr> |
666 |
<tr><ti><uri link="guide-to-mutt.xml">Quickstart Guide to CLI E-mail Tools</uri></ti></tr> |
667 |
<tr><ti><uri link="cvs-tutorial.xml">CVS Tutorial</uri></ti></tr> |
668 |
<tr><th>Gentoo Development Documentation</th></tr> |
669 |
<tr><ti><uri link="policy.xml">Gentoo Linux Development Policy</uri></ti></tr> |
670 |
<!-- <tr><ti><uri link="gentoo-release-policy.xml">Gentoo Linux Release Policy</uri></ti></tr> --> |
671 |
<tr><ti><uri link="doc-policy.xml">Gentoo Linux Documentation Policy</uri></ti></tr> |
672 |
<tr><ti><uri link="gentoo-howto.xml">Ebuild Howto</uri></ti></tr> |
673 |
<tr><ti><uri link="eclass-howto.xml">Eclass Howto</uri></ti></tr> |
674 |
<!--<tr><ti><uri link="stage-building-guide.xml">Stage Building Guide</uri></ti></tr>--> |
675 |
<tr><ti><uri link="ebuild-submit.xml">Contributing Ebuilds Guide</uri></ti></tr> |
676 |
<tr><ti><uri link="ebuild-mistakes.xml">Common Gentoo Ebuild Mistakes</uri></ti></tr> |
677 |
<tr><ti><uri link="metadata.xml">Metadata document</uri></ti></tr> |
678 |
<tr><th>Other Documentation</th></tr> |
679 |
<tr><ti><uri link="rsync.xml">Gentoo RSync Mirror</uri></ti></tr> |
680 |
<tr><ti><uri link="source_mirrors.xml">Gentoo Distfiles Mirror</uri></ti></tr> |
681 |
</table> |
682 |
|
683 |
</body> |
684 |
</section> |
685 |
</chapter> |
686 |
</mainpage> |