.TH "pcheckd" "1" "" "" ""
.SH "NAME"
pcheckd \- Checks for mail in maildir mailboxes
.SH "SYNOPSIS"
.B "pcheckd"
[\-l \fBFILE\fR,
--logfile \fBFILE\fR]
[\-m \fBDIR\fR,
--mailboxdir \fBDIR\fR]
[\-p \fBPORT\fR,
--port \fBPORT\fR]
[\-e \fBLOAD\fR,
--emptyload \fBLOAD\fR]
[\-f \fBNUM\fR,
--fork \fBNUM\fR]
[\-r \fBDIR\fR,
--rundir \fBDIR\fR]
[\-h \fBHOST\fR,
--host \fBHOST\fR]
[\--nodeamon]
[\--debug]
[\--help]
[\--version]
.SH "DESCRIPTION"
.PP
This program will open the named UDP port (default: 50110) and listen
for requests\&. It will send an answer to the requests back to the
client\&.
.PP
There are two types of requests: The mailbox request (\&'M\&') will ask
the server about the state of the named mailbox (\&'0 no mail\&',
\&'1 mail\&', \&'2 new mail\&', or \&'3 load too high\&')\&. The load request (\&'L\&')
will ask the server for the load avarage for the last minute\&.
.PP
The load is returned as an integer which is determined by reading
/proc/loadavg and cutting of everything after the decimal point\&.
.PP
This server is single threaded\&.
.SH "OPTIONS"
.TP
--help
Print short command line help\&.
.TP
--version
Print version information\&.
.TP
-l \fBFILE\fR, --logfile \fBFILE\fR
Name of logfile (default: \fB/var/log/popular/pcheckd\fR)
.TP
-m \fBDIR\fR --mailboxdir \fBDIR\fR
Directory where all the mailboxes reside\&. There can be an
arbitrary depth of subdirectories beneath this\&. All mailbox
names sent by the client are relative to this directory\&.
.TP
-p \fBPORT\fR, --port \fBPORT\fR
UDP port to listen to\&.
.TP
-e \fBLOAD\fR, --emptyload \fBLOAD\fR
If the system load average over the last minute is LOAD or
higher, a \&'M\&' request will be answered with \&'3 load too high\&'\&.
In this case \fBpproxy\fR will fake an empty
mailbox\&.
.TP
-f \fBNUM\fR, --fork \fBNUM\fR
Fork NUM processes at start of pcheckd\&. The parent and all the
children will answer requests\&. The parent doesn\&'t count towards
NUM, so there will be NUM+1 pcheckd processes\&.
.TP
-r \fBDIR\fR, --rundir \fBDIR\fR
Name of run directory\&. The pid file is saved into this directory\&.
(default: \fB/var/run/popular\fR)
.TP
-h \fBHOST\fR, --host \fBHOST\fR
Host name or IP number to bind to\&. This might be needed if you
have several IP numbers on one host\&. Default is to bind to
INADDR_ANY (0\&.0\&.0\&.0), i\&.e\&. to listen to all interfaces\&.
.TP
--nodeamon
Don\&'t run as daemon in the background\&.
.TP
--debug
Enable debug logging\&. This will log all packets as they are
received and sent\&.
.SH "SEE ALSO"
.PP
pcheck(1), pclean(8), pcontrol(1), pdeliver(1), pproxy(8), pserv(8), pstatus(1), ptestpdm(1), The POPular Manual
.SH "AUTHOR"
.PP
Jochen Topf jochen@remote\&.org
.PP
\fB
http://www\&.remote\&.org/jochen/mail/popular/
\fR
<URL:http://www\&.remote\&.org/jochen/mail/popular/>
.SH "COPYRIGHT"
.PP
The POPular suite is copyright (C) 1999-2002 by Jochen Topf
jochen@remote\&.org\&.
.PP
This program 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\&.
.PP
This program 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\&.
.PP
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