Documentation

 < Free Open Study > 



There is a wide selection of documentation available for qmail, including the man pages that come with the source-code distribution and various online sources.

Man Pages

The qmail distribution comes with a complete set of man pages. After installation, they're in /var/qmail/man. You'll probably need to add that directory to your MANPATH environment variable so you can easily view them. Table 1-7 describes how to set MANPATH using different shells.

Table 1-7: Setting MANPATH

SHELL

COMMAND

Bourne (/bin/sh)

MANPATH=$MANPATH:/var/qmail/man; export MANPATH

Bash, Korn

export MANPATH=$MANPATH:/var/qmail/man

C Shell

setenv MANPATH $MANPATH:/var/qmail/man

At this point, commands in the format man name-of-qmail-man-page should display the appropriate man page. The man pages are also available online in HTML format (http://www.qmail.org/mail/index.html).

Note 

The qmail man pages are loaded with information, but they require careful reading because they're written in a dense, technical style.You might want to print a set and read it through once to familiarize yourself with what's there and where it is. Little information is repeated on multiple pages, so if you don't know where something is covered, it can be hard to find it.

Documents

The qmail distribution includes a series of documents installed under /var/qmail/doc. They include the following:

  • FAQ contains common questions with answers.

  • INSTALL* contains installation documentation.

  • PIC.* contains descriptions of how qmail performs key tasks. See the "Architecture" section for more information.

These documents, and various other installation-related documentation, are also available online (http://www.qmail/org/man/index.html).

FAQs

There are two official FAQs:

  • /var/qmail/doc/FAQ is the plain text version.

  • http://cr.yp.to/qmail/faq.html is the online HTML version.

The HTML version is more complete and is updated more often.

Official qmail Site

The primary source of information is the official qmail site maintained by Bernstein (http://cr.yp.to/qmail.html).

This site includes

  • A description of qmail

  • A list of qmail's features

  • The qmail security guarantee

  • The online version of the FAQ

  • Documentation for specialized configurations

  • A list of large sites using qmail

  • Changes in recent versions of qmail

  • Plans for the future

  • Pointers to related packages

Unofficial qmail Site

The unofficial qmail site (http://www.qmail.org/) is an indispensable resource for qmail managers and users. Topics covered include

  • User-contributed add-ons

  • A list of providers of commercial support for qmail

  • A collection of handy tips

  • Information about virus detection and spam prevention

  • User-contributed documentation

List Archives

The qmail e-mail mailing list, maintained by Bernstein, is a valuable source of troubleshooting information. A Web archive of the list messages (http://www.ornl.gov/its/archives/mailing-lists/qmail/) also has a search engine (http://www-archive.ornl.gov:8000/).

Most questions about qmail can be answered by searching the list archives first.



 < Free Open Study > 



The Qmail Handbook
The qmail Handbook
ISBN: 1893115402
EAN: 2147483647
Year: 2001
Pages: 186
Authors: Dave Sill

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net