mirror of https://github.com/tLDP/LDP
375 lines
11 KiB
Plaintext
375 lines
11 KiB
Plaintext
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
|
|
<!ENTITY categoryChap SYSTEM "categoryChap.sgml">
|
|
<!ENTITY howtoChap SYSTEM "howtoChap.sgml">
|
|
<!ENTITY miniChap SYSTEM "miniChap.sgml">
|
|
<!ENTITY adminSect SYSTEM "adminSect.sgml">
|
|
<!ENTITY hardwareSect SYSTEM "hardwareSec.sgml">
|
|
<!ENTITY networkingSect SYSTEM "networkingSect.sgml">
|
|
<!ENTITY otherLangSect SYSTEM "otherLangSect.sgml">
|
|
<!ENTITY programmingSect SYSTEM "programmSect.sgml">
|
|
]>
|
|
|
|
<BOOK>
|
|
<BOOKINFO>
|
|
<Title><ULINK URL="http://www.linuxdoc.org/">LDP</ULINK> HOWTO-INDEX</Title>
|
|
<AUTHOR>
|
|
<FirstName>
|
|
Guylhem</FirstName>
|
|
<Surname>
|
|
Aznar</Surname>
|
|
</AUTHOR>
|
|
<AUTHOR>
|
|
<FirstName>
|
|
Greg</FirstName>
|
|
<Surname>
|
|
Ferguson</Surname>
|
|
</AUTHOR>
|
|
<AUTHOR>
|
|
<FirstName>
|
|
Joshua</FirstName>
|
|
<Surname>
|
|
Drake</Surname>
|
|
</AUTHOR>
|
|
<PubDate>
|
|
11 Jun 2000</PubDate>
|
|
<COPYRIGHT>
|
|
<YEAR>
|
|
2000</YEAR>
|
|
<HOLDER>
|
|
The Authors</HOLDER>
|
|
</COPYRIGHT>
|
|
<ABSTRACT>
|
|
<PARA>
|
|
This document contains an index to the Linux HOWTOs as well as other
|
|
information about the HOWTO project.</PARA>
|
|
</ABSTRACT>
|
|
</BOOKINFO>
|
|
|
|
|
|
<CHAPTER id="intro">
|
|
<Title>What Are Linux HOWTOs?</Title>
|
|
|
|
<Para>
|
|
Linux HOWTOs are documents which describe in detaila certain aspect
|
|
of configuring or using Linux. For example, there is the <Emphasis>
|
|
Installation HOWTO</Emphasis>, which gives instructions on installing Linux,
|
|
and the <Emphasis>Mail Administrator HOWTO</Emphasis>, which describes
|
|
how to set up and configure mail under Linux.
|
|
Other examples include the <Emphasis>Net HOWTO</Emphasis> and the
|
|
<Emphasis>Printing HOWTO</Emphasis>.
|
|
</Para>
|
|
<Para>
|
|
HOWTOs are comprehensive docs - much like an FAQ but generally not
|
|
in question-and-answer format. However, many HOWTOs contain a FAQ
|
|
section at the end.
|
|
</Para>
|
|
<Para>
|
|
There are several HOWTO formats available: plain text, PostScript, PDF, and HTML.</Para>
|
|
<Para>
|
|
In addition to the HOWTOs, there are a multitude of mini-HOWTOs on short, specific subjects.</Para>
|
|
</CHAPTER>
|
|
|
|
|
|
<CHAPTER id="location">
|
|
<Title>Where Can I Get Linux HOWTOs?</Title>
|
|
|
|
<Para>
|
|
HOWTOs can be retrieved via anonymous FTP from the following sites:<ItemizedList>
|
|
<ListItem>
|
|
<Para>
|
|
<EMPHASIS>
|
|
<ULINK URL="ftp://metalab.unc.edu/pub/Linux/docs/HOWTO">
|
|
ftp://metalab.unc.edu/pub/Linux/docs/HOWTO</ULink>
|
|
</EMPHASIS>
|
|
</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
<EMPHASIS>
|
|
<ULINK URL="ftp://tsx-11.mit.edu/pub/linux/docs/HOWTO">
|
|
ftp://tsx-11.mit.edu/pub/linux/docs/HOWTO</ULink>
|
|
</EMPHASIS>
|
|
</Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
</Para>
|
|
<Para>
|
|
as well as many <ULINK URL="ftp://metalab.unc.edu/pub/Linux/MIRRORS.html">
|
|
mirror sites</ULink>.
|
|
</Para>
|
|
<Para>
|
|
You can also browse HOWTOs <ULINK URL="howto.html">
|
|
in HTML format</ULink>
|
|
or grab <ULINK URL="http://metalab.unc.edu/pub/Linux/docs/HOWTO/other-formats/html/Linux-html-HOWTOs.tar.gz">
|
|
Linux-html-HOWTOs.tar.gz</ULink>
|
|
for viewing on your own PC. The files will be extracted into
|
|
HOWTO/html/.</Para>
|
|
<Para>
|
|
Many <ULINK URL="http://www.linuxdoc.org/mirrors.html">
|
|
mirror sites</ULink>
|
|
mirror the HTML files.</Para>
|
|
<Para>
|
|
<EMPHASIS>
|
|
www.linuxdoc.org</EMPHASIS>
|
|
is heavily used, so please use a mirror site if possible.</Para>
|
|
<Para>
|
|
A HOWTO index is also posted towards the beginning of the month
|
|
to the Usenet newsgroup<EMPHASIS>
|
|
comp.os.linux.answers</EMPHASIS>.
|
|
There is a tool called
|
|
<ULINK URL="ftp://metalab.unc.edu/pub/Linux/system/news/misc/">NewstoHOWTO</ULink>
|
|
that will assemble the postings.</Para>
|
|
</CHAPTER>
|
|
|
|
|
|
<CHAPTER id="translations">
|
|
<Title>HOWTO Translations</Title>
|
|
|
|
<Para>
|
|
HOWTO translations are available
|
|
on <ULINK URL="ftp://metalab.unc.edu/pub/Linux/docs/HOWTO/translations">
|
|
metalab.unc.edu</ULink>
|
|
and mirrors around the world. So far, there are:<ItemizedList>
|
|
<ListItem>
|
|
<Para>
|
|
Chinese (zh)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Croatian (hr)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
French (fr)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
German (de)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Hellenic (el)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Indonesian (id)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Italian (it)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Japanese (ja)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Korean (ko)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Polish (pl)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Slovenian (sl)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Spanish (es)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Swedish (sv)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Turkish (tr)</Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
</Para>
|
|
<Para>
|
|
If you know of any other translation projects, please let us know and they
|
|
will be added to this list. If you are interested in getting your
|
|
translations archived on metalab.unc.edu, please read the directory
|
|
structure specification at
|
|
<ULINK URL="http://metalab.unc.edu/pub/Linux/docs/HOWTO/translations/Directory-Structure">
|
|
http://metalab.unc.edu/pub/Linux/docs/HOWTO/translations/Directory-Structure</ULink>
|
|
and contact the LDP.
|
|
</Para>
|
|
</CHAPTER>
|
|
|
|
&categoryChap;
|
|
&howtoChap;
|
|
&miniChap;
|
|
|
|
<CHAPTER id="special">
|
|
<Title>Special HOWTOs</Title>
|
|
|
|
<Para>
|
|
The <Emphasis>High Availability HOWTO</Emphasis>,
|
|
by Harald Milz <hm@seneca.muc.de> is available at <EMPHASIS>
|
|
<ULINK URL="http://metalab.unc.edu/pub/Linux/ALPHA/linux-ha/High-Availability-HOWTO.html">
|
|
http://metalab.unc.edu/pub/Linux/ALPHA/linux-ha/High-Availability-HOWTO.html</ULink>
|
|
</EMPHASIS>.
|
|
It is not included with the HOWTO collection because it relies
|
|
on figures and cannot be distributed in all supported formats.</Para>
|
|
</CHAPTER>
|
|
|
|
|
|
<CHAPTER id="unmaintained">
|
|
<Title>Unmaintained HOWTOs</Title>
|
|
|
|
<Para>
|
|
There are a number of unmaintained documents, which can be found at:
|
|
<EMPHASIS><ULINK URL="http://metalab.unc.edu/pub/Linux/docs/HOWTO/unmaintained/">
|
|
http://metalab.unc.edu/pub/Linux/docs/HOWTO/unmaintained/</ULink>
|
|
</EMPHASIS>.
|
|
</Para>
|
|
<Para>
|
|
These are kept around since old documentation is sometimes better than
|
|
none. However, you should
|
|
<Emphasis>be aware that you are reading old documentation</Emphasis>.
|
|
</Para>
|
|
<Para>
|
|
If the date tag is too old, please consider the HOWTO as unmaintained.</Para>
|
|
<Para>
|
|
However, there are exceptions, such as old programs (for example UUCP HOWTO) or
|
|
not-so-hot topics (for example AX-25 HOWTO).
|
|
</Para>
|
|
</CHAPTER>
|
|
|
|
|
|
<CHAPTER id="writing">
|
|
<Title>Writing and Submitting a HOWTO</Title>
|
|
|
|
<Para>
|
|
If you are interested in writing or maintaining a HOWTO,
|
|
please contact us <emphasis>FIRST!!!</Emphasis> at
|
|
<EMPHASIS>
|
|
<ULINK URL="mailto:ldp-discuss@lists.linuxdoc.org">
|
|
ldp-discuss@lists.linuxdoc.org</ULink>
|
|
</EMPHASIS>.
|
|
If you want to maintain a unmaintained HOWTO, please try to contact
|
|
the former author.</Para>
|
|
<Para>
|
|
Consult the <ULINK URL="../HOWTO-HOWTO/index.html">
|
|
HOWTO-HOWTO</ULink>
|
|
for detailed information on writing and submitting a HOWTO.</Para>
|
|
<Para>
|
|
Here are a few general guidelines that you should follow when writing
|
|
a HOWTO:</Para>
|
|
<Para>
|
|
<ItemizedList>
|
|
<ListItem>
|
|
<Para>
|
|
Try to use meaningful structure and organization, and write clearly.
|
|
Remember that many of the people reading HOWTOs do not speak English
|
|
as their first language.</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Make sure that all of the information is correct. We can't stress
|
|
this enough. When in doubt, speculate, but make it clear that
|
|
you're only guessing. </Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Make sure that you are covering the most recent version of the available
|
|
software. Also, be sure to include full instructions on where software
|
|
can be downloaded from (FTP site name, fullpathname), and the current
|
|
version number and release date of the software.</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Include an FAQ section at the end, if appropriate. Many HOWTO documents
|
|
need a ``FAQ'' or ``Common Problems'' section to cover information which
|
|
cannot be covered in the regular text.</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
HOWTOs <Emphasis>should</Emphasis> be submitted to us in either
|
|
DocBook or linuxdoc SGML. Refer to the <ULINK URL="../HOWTO-HOWTO/index.html">
|
|
HOWTO-HOWTO</ULink> for further information.</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Use other HOWTOs a model. The SGML source to the HOWTOs is available
|
|
on Linux FTP sites. In addition, examine the
|
|
<ULINK URL="../HOWTO-HOWTO/index.html">HOWTO-HOWTO</ULink>,
|
|
the <ULINK URL="../../manifesto.html">LDP manifesto</ULink>
|
|
(and license guide), and the
|
|
<ULINK URL="http://metalab.unc.edu/godoy/using-docbook/using-docbook.html">
|
|
Using DocBook HOWTO</ULink>.
|
|
</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Make sure that your name, email address, date, and a version number
|
|
is near the beginning of the document. You could also include WWW
|
|
addresses and a postal mail address if you want. The standard header is:
|
|
Title / Author's name and email address / Version number and date.
|
|
For example:
|
|
</Para>
|
|
<Para>The Linux HOWTO Index by Tim Bynum v2.10.29, 31 July 1997</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Lastly, be prepared to receive questions and comments about your writing.
|
|
There are several hundreds of accesses to thei HOWTO collection every day
|
|
from around the world!</Para>
|
|
</ListItem>
|
|
</ItemizedList>
|
|
</Para>
|
|
<Para>
|
|
After you have written the HOWTO, mail the SGML source to us at <EMPHASIS>
|
|
<ULINK URL="mailto:ldp-submit@lists.linuxdoc.org">
|
|
ldp-submit@lists.linuxdoc.org</ULink>
|
|
</EMPHASIS>.
|
|
</Para>
|
|
<Para>
|
|
It is <Emphasis>important</Emphasis> that you go through us when submitting a
|
|
HOWTO, as we maintain the archives and need to keep track of what HOWTOs
|
|
are being written and who is doing what. </Para>
|
|
<Para>
|
|
Please send the LDP periodic updates whenever appropriate.</Para>
|
|
</CHAPTER>
|
|
|
|
|
|
<CHAPTER id="copyright">
|
|
<Title>Copyright</Title>
|
|
|
|
<Para>
|
|
Copyright (c) 1995 - 2000 by Tim Bynum. Copyright (c) 2000
|
|
by Guylhem Aznar / Greg Ferguson / Joshua Drake
|
|
</Para>
|
|
<Para>
|
|
Unless otherwise stated, Linux HOWTO documents are copyrighted by their
|
|
respective authors. Linux HOWTO documents may be reproduced and distributed
|
|
in whole or in part, in any medium physical or electronic, as long as
|
|
this copyright notice is retained on all copies. Commercial redistribution
|
|
is allowed and encouraged; however, the author would like to be notified of
|
|
any such distributions.</Para>
|
|
<Para>
|
|
All translations, derivative works, or aggregate works incorporating
|
|
any Linux HOWTO documents must be covered under this copyright notice.
|
|
That is, you may not produce a derivative work from a HOWTO and impose
|
|
additional restrictions on its distribution. Exceptions to these rules
|
|
may be granted under certain conditions; please contact the Linux HOWTO
|
|
coordinator at the address given below.</Para>
|
|
<Para>
|
|
In short, we wish to promote dissemination of this information through as
|
|
many channels as possible. However, we do wish to retain copyright on the
|
|
HOWTO documents, and would like to be notified of any plans to redistribute
|
|
the HOWTOs.</Para>
|
|
<Para>
|
|
If you have questions, please contact the Linux HOWTO coordinator, at
|
|
<EMPHASIS><ULINK URL="mailto:linux-howto@metalab.unc.edu">
|
|
linux-howto@metalab.unc.edu</ULink></EMPHASIS> via email.
|
|
</Para>
|
|
</CHAPTER>
|
|
|
|
|
|
</Book>
|
|
|