# LDP HOWTO-INDEX

Guylhem
Aznar
Joshua
Drake
Greg
Ferguson
v9.0, 2005-12-29

This document contains an index to the Linux HOWTOs as well as other information about the HOWTO project.

## What Are Linux HOWTOs?

Linux HOWTOs are documents which describe in detail a certain aspect of configuring or using Linux. For example, there is the Installation HOWTO, which gives instructions on installing Linux, and the Mail Administrator HOWTO, which describes how to set up and configure mail under Linux. Other examples include the Net HOWTO and the Printing HOWTO.

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.

There are several HOWTO formats available: plain text, PostScript, PDF, and HTML.

## Where Can I Get Linux HOWTOs?

HOWTOs can be retrieved via anonymous FTP from ftp://www.ibiblio.org/pub/Linux/docs/HOWTO/ as well as from many mirror sites around the world. Please use a mirror site if possible.

You can also browse HOWTOs in HTML format or grab Linux-html-HOWTOs.tar.gz for viewing on your own workstation. The files will be extracted into HOWTO/.

Other formats can be accessed from the HOWTO documents page of the LDP.

Many mirror sites mirror the HTML files. tldp.org is heavily used, so please use a mirror site if possible.

## HOWTO Translations

Some HOWTO translations are available on ibiblio.org and mirrors around the world. So far, there are:

- Chinese (zh)

- Croatian (hr)

- French (fr)

- German (de)

- Hebrew

- Hellenic (el)

- Indonesian (id)

- Italian (it)

- Japanese (ja)

- Korean (ko)

- Polish (pl)

- Romanian (ro)

- Russian (ru)

- Slovenian (sl)

- Spanish (es)

- Swedish (sv)

- Turkish (tr)

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 http://ibiblio.org/pub/Linux/docs/HOWTO/translations/Directory-Structure and contact the LDP.

&categoryChap; &howtoChap; &miniChap;

## Unmaintained HOWTOs

There are a number of unmaintained documents, which can be found at: http://tldp.org/authors/unmaint.html .

These are kept around since old documentation is sometimes better than none. However, you should be aware that you are reading old documentation.

If the date tag is too old, please consider the HOWTO as unmaintained.

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.

## Writing and Submitting a HOWTO

If you are interested in writing or maintaining a HOWTO, please contact us FIRST at feedback@en.tldp.org . If you want to maintain a unmaintained HOWTO, please try to contact the former author.

Consult the LDP Author Guide for detailed information on writing and submitting a HOWTO.

Here are a few general guidelines that you should follow when writing a HOWTO:

- 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.

- 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.

- 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.

- 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.

- HOWTOs should be submitted to us in either DocBook or linuxdoc SGML; or DocBook XML. Refer to the LDP Author Guide for further information.

- Use other HOWTOs a model. The SGML/XML source to the HOWTOs is available on Linux FTP sites. In addition, examine the LDP Author Guide, the LDP manifesto (and license guide), and the Authors Resources area of the LDP site.

- 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:

  The LDP Sample HOWTO by various_authors v6.1, 2001-05-01

  Refer to the LDP Author Guide for further information.

- 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.

After you have written the HOWTO, mail the SGML source to us at submit@en.tldp.org .

It is important 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.

Please send the LDP periodic updates whenever appropriate.

## Copyright Information

This document, LDP HOWTO-INDEX, 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 http://www.gnu.org/copyleft/fdl.html.

If you have questions, please contact the LDP.

Note: if you wish to use this as a boilerplate copyright notice for your own document(s), feel free to do so.