.\" -*- Nroff -*- manual page for POP3Lite's configuration file
.\" Copyright (C) 2000, 2001 Gergely Nagy <8@free.bsd.hu>
.\" This file is part of POP3Lite.
.\"
.\" POP3Lite is free software; you can redistribute it and/or modify
.\" it under the terms of the GNU General Public License as published by
.\" the Free Software Foundation; either version 2 of the License, or
.\" (at your option) any later version.
.\"
.\" POP3Lite is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
.\"
.\" $Id: pop3lite.conf.5.in,v 1.2.2.1 2001/05/02 08:54:09 algernon Exp $
.TH "pop3lite.conf" 5 "03 JANUARY 2001" "POP3Lite" "POP3Lite POP3 Daemon"
.SH NAME
/etc/pop3lite.conf \- configuration file for
.B pop3lite(8)
.SH SYNTAX
The file 
.I /etc/pop3lite.conf
contains the configuration for the
.B pop3lite(8)
program.

The configuration file is built up from key and value pairs,
separated by an equation (=) sign.

A key may only contain alphanumerics, and some other
characters, such as dots, underscores, etc.

Ideally, values contain only these characters. However, they
may contain others.

Special characters (the quotation mark, the backslash, and the
hash mark) can be escaped by prefixing them with a backslash.
However, you only have to escape the backslash if it stands
before another special character.

To illustrate this, let's look at an example!

If you want the parser to interpret a value as

	the quotation mark (")

You would write this:

	the quotation mark (\\")

However, to make it interpret a value as

	the backslash (\e)

You can write it exactly the same.

If you want to quote longer sequences, enclose them in
quotation marks. Note that between the quotes, you don't have
to escape other quotes.

The parser treats a value as a list, with blanks or comas
separating the items. Therefore, if you want to put any of
these characters in a value, you have to enclose it in double
quotes. They can't be escaped otherwise.

Leading and trailing spaces are ignored, everything after an
unescaped hash mark is treated as comment, and ignored.

If a line ends with a single, unescaped backslash, the next
line will be treated as if it were appended to the current
one. This allows breaking up long lines into shorter ones.
.SH OPTIONS
Although there are built-in options, they're not guaranteed
to have any effect, because any module can reimplement any
function, thus making an option useless. However, if you read
the module's documentation too, there won't be any problem.
.TP
\fBAUTO_LOGOUT_TIME\fP
The time (in minutes) of inactivity after a session is automatically
ended. Defaults to
.IR 10 .
.TP
\fBDEFAULT.GREETING\fP
The default greeting message. Defaults to
.IR "POP3 server ready" .
.TP
\fBLISTEN.HOST\fP
The host name or IP address to listen on in standalone mode. If empty,
listen on all possible addresses.
.TP
\fBLISTEN.PORT\fP
The port to listen on in standalone mode. Defaults to
.IR 110 .
.TP
\fBMAILBOX_TEMPLATE\fP
The path to the mailboxes. This is a template, containing one
variable, \fI%s\fP, which will be replaced by the appropriate
user name. Defaults to
.IR /var/mail/%s .
.TP
\fBMAX_CHILDREN\fP
The maximum number of children to allow. That is, the maximum number
of clients that can be served at the same time. The zero value is
interpreted as unlimited. Available only in standalone mode. Defaults
to
.IR 20 .
.TP
\fBMINIMUM_LOG_LEVEL\fP
The minimum priority required to log a message. Defaults to
.IR 1 .
.TP
\fBMODULE_DIRS\fP
A list of directories where modules are stored. Defaults to
.IR /lib/pop3lite .
.TP
\fBMODULE_LIST\fP
A list of modules to load. They can be specified either via
full path, or relative to any directory listed in \fIMODULE_DIRS\fP.
By default, this is empty.
.TP
\fBQUIT_ON_ERROR\fP
If this option is specified, POP3Lite will issue an implicit quit
if the connection drops or any other error occurs. This violates
the RFCs, but may come handy for users using flaky phone lines.
By default this is off.
.TP
\fBRUN_GID\fP
The gid to set after authentication. By default, the daemon uses
the gid of the logged in user.
.TP
\fBSYSLOG.DISABLE\fP
When this is turned on, all logging to syslog will be disabled.
Defaults to \fIno\fP.
.SH FILES
.I /etc/pop3lite.conf
.SH SEE ALSO
.BR pop3lite (8)
.SH AUTHOR
Gergely Nagy <8@free.bsd.hu>