mirror of https://github.com/tLDP/LDP
348 lines
9.6 KiB
Plaintext
348 lines
9.6 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 osSect SYSTEM "osSect.sgml">
|
|
<!ENTITY adminSect SYSTEM "adminSect.sgml">
|
|
<!ENTITY hwSect SYSTEM "hwSect.sgml">
|
|
<!ENTITY networkingSect SYSTEM "networkingSect.sgml">
|
|
<!ENTITY appsSect SYSTEM "appsSect.sgml">
|
|
<!ENTITY programmingSect SYSTEM "programmSect.sgml">
|
|
<!ENTITY otherLangSect SYSTEM "otherLangSect.sgml">
|
|
<!ENTITY miscSect SYSTEM "miscSect.sgml">
|
|
<!ENTITY archivedSect SYSTEM "archived.sgml">
|
|
]>
|
|
|
|
<BOOK>
|
|
|
|
<BOOKINFO>
|
|
|
|
<title><ULINK URL="http://www.tldp.org/">LDP</ULINK> HOWTO-INDEX</title>
|
|
|
|
<author>
|
|
<FirstName>Guylhem</FirstName>
|
|
<Surname>Aznar</Surname>
|
|
</author>
|
|
<author>
|
|
<FirstName>Joshua</FirstName>
|
|
<Surname>Drake</Surname>
|
|
</author>
|
|
<author>
|
|
<FirstName>Greg</FirstName>
|
|
<Surname>Ferguson</Surname>
|
|
</author>
|
|
|
|
<pubdate>v9.0, 2005-12-29</pubdate>
|
|
|
|
<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 detail a 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>
|
|
|
|
</CHAPTER>
|
|
|
|
|
|
<CHAPTER id="location">
|
|
<Title>Where Can I Get Linux HOWTOs?</Title>
|
|
|
|
<Para>
|
|
HOWTOs can be retrieved via anonymous FTP from
|
|
<EMPHASIS><ULINK URL="ftp://www.ibiblio.org/pub/Linux/docs/HOWTO/">
|
|
ftp://www.ibiblio.org/pub/Linux/docs/HOWTO/</ULink></EMPHASIS>
|
|
as well as from many <ULINK URL="http://www.ibiblio.org/pub/Linux/MIRRORS.html">
|
|
mirror sites</ULink> around the world. Please use a mirror site
|
|
if possible.
|
|
</Para>
|
|
|
|
<Para>
|
|
You can also browse HOWTOs in
|
|
<ULINK URL="howtos.html">HTML format</ULink> or grab
|
|
<ULINK URL="http://www.ibiblio.org/pub/Linux/docs/HOWTO/other-formats/html/Linux-html-HOWTOs.tar.gz">
|
|
Linux-html-HOWTOs.tar.gz</ULink>
|
|
for viewing on your own workstation. The files will be extracted into
|
|
<EMPHASIS>HOWTO/</EMPHASIS>.
|
|
</Para>
|
|
|
|
<Para>
|
|
Other formats can be accessed from the HOWTO
|
|
<ULINK URL="http://tldp.org/docs.html#howto">documents page</ULink> of
|
|
the LDP. </Para>
|
|
|
|
<Para>
|
|
Many <ULINK URL="http://tldp.org/mirrors.html">mirror sites</ULink>
|
|
mirror the HTML files. <EMPHASIS>tldp.org</EMPHASIS>
|
|
is heavily used, so please use a mirror site if possible.</Para>
|
|
|
|
</CHAPTER>
|
|
|
|
|
|
<CHAPTER id="translations">
|
|
<Title>HOWTO Translations</Title>
|
|
|
|
<Para>
|
|
Some HOWTO translations are available
|
|
on <ULINK URL="ftp://ibiblio.org/pub/Linux/docs/HOWTO/translations/">
|
|
ibiblio.org</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>Hebrew</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>
|
|
Romanian (ro)</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Russian (ru)</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 ibiblio.org, please read the directory
|
|
structure specification at
|
|
<ULINK URL="http://ibiblio.org/pub/Linux/docs/HOWTO/translations/Directory-Structure">
|
|
http://ibiblio.org/pub/Linux/docs/HOWTO/translations/Directory-Structure</ULink>
|
|
and contact the LDP.
|
|
</Para>
|
|
</CHAPTER>
|
|
|
|
&categoryChap;
|
|
&howtoChap;
|
|
&miniChap;
|
|
|
|
<CHAPTER id="unmaintained">
|
|
<Title>Unmaintained HOWTOs</Title>
|
|
|
|
<Para>
|
|
There are a number of unmaintained documents, which can be found at:
|
|
<EMPHASIS><ULINK URL="http://www.tldp.org/authors/unmaint.html">
|
|
http://tldp.org/authors/unmaint.html</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 those that document older programs
|
|
and procedures that still might be in use, or those that cover more
|
|
obscure topics.
|
|
</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:feedback@en.tldp.org">
|
|
feedback@en.tldp.org</ULink>
|
|
</EMPHASIS>.
|
|
If you want to maintain a unmaintained HOWTO, please try to contact
|
|
the former author.</Para>
|
|
<Para>
|
|
Consult the <ULINK URL="../../LDP/LDP-Author-Guide/index.html">
|
|
LDP Author Guide</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; or DocBook XML.
|
|
Refer to the <ULINK URL="../../LDP/LDP-Author-Guide/index.html">
|
|
LDP Author Guide</ULink> for further information.</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Use other HOWTOs a model. The SGML/XML source to the HOWTOs is available
|
|
on Linux FTP sites. In addition, examine the
|
|
<ULINK URL="../../LDP/LDP-Author-Guide/index.html">LDP Author Guide</ULink>,
|
|
the <ULINK URL="../../manifesto.html">LDP manifesto</ULink>
|
|
(and license guide), and the
|
|
<ULINK URL="../../authors/index.html">Authors Resources area</ULink> of the LDP site.
|
|
</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 LDP Sample HOWTO by <emphasis>various_authors</emphasis> v6.1, 2001-05-01</Para>
|
|
<Para>Refer to the <ULINK URL="../../LDP/LDP-Author-Guide/index.html">LDP Author Guide</ULink> for further information.</Para>
|
|
</ListItem>
|
|
<ListItem>
|
|
<Para>
|
|
Lastly, be prepared to receive questions and comments about your writing.
|
|
There are several hundreds of accesses to the 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:submit@en.tldp.org">
|
|
submit@en.tldp.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 Information</Title>
|
|
|
|
<Para>
|
|
This document, <emphasis>LDP HOWTO-INDEX</emphasis>,
|
|
is copyrighted (c) 1995 - 2006 by Tim Bynum, Guylhem Aznar,
|
|
Joshua Drake and Greg Ferguson. Permission is granted
|
|
to copy, distribute and/or modify this document under the terms of the
|
|
GNU Free Documentation License, Version 1.1 or any later version published
|
|
by the Free Software Foundation; with no Invariant Sections, with no
|
|
Front-Cover Texts, and with no Back-Cover Texts. A copy of the license
|
|
is available at <ulink url="http://www.gnu.org/copyleft/fdl.html">
|
|
http://www.gnu.org/copyleft/fdl.html</ulink>.
|
|
</para>
|
|
|
|
<para>
|
|
If you have questions, please
|
|
<ulink url="../../mailinfo.html">contact</ulink> the LDP.
|
|
</Para>
|
|
|
|
<para><emphasis>Note: if you wish to use this as a boilerplate copyright
|
|
notice for your own document(s), feel free to do so.</emphasis></para>
|
|
|
|
</CHAPTER>
|
|
|
|
</Book>
|
|
|