.TH "pcheck" "1" "" "" ""
.SH "NAME"
pcheck \- popcheck client
.SH "SYNOPSIS"
.B "pcheck"
[\-s \fBSERVER\fR,
--server=\fBSERVER\fR]
[\-p \fBPORT\fR,
--port=\fBPORT\fR]
[\-t \fBTIMEOUT\fR,
--timeout=\fBTIMEOUT\fR]
[\--help]
[\--version]
.SH "DESCRIPTION"
.PP
This command is used for checking the proper function of the
\fBpcheckd\fR\&. It will send a UDP request to the
\fBpcheckd\fR running on the machine 
\fBserver\fR (default: 127\&.0\&.0\&.1) on port
\fBport\fR (default: 50110)\&. It will wait for
\fBtimeout\fR seconds for an answer\&. The
answer is printed on stdout\&.
.PP
There are two types of requests: The mailbox request (-m) will ask
the server about the state of the named mailbox and will output it
(\&'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 output of the command is the answer to the request returned by
the server\&. It has the general format \&'+OK some message\&' if the
request was successfull or \&'-ERR error message\&' if some error occured
on the server side\&.
.SH "OPTIONS"
.TP
--help
Get help on parameters\&.
.TP
--version
Print version information\&.
.TP
-s \fBserver\fR
Host name or IP address of POPCHECK server\&.
.TP
-p \fBport\fR
UDP port for POPCHECK service on server\&.
.TP
-t \fBtimeout\fR
Timeout in seconds when waiting for answer\&.
.TP
-l
Return load avarage of server\&.
.TP
-m \fBmailbox\fR
Name of mailbox to check\&.
.SH "RETURN CODES"
.TP
0
Successful, \&'no mails\&' when using option -m\&.
.TP
1
Successful, \&'mails available\&' when using option -m\&.
.TP
2
Error connecting to server, other system errors or
"-ERR" msg from server
.TP
3
Error while parsing the command line\&.
.SH "SEE ALSO"
.PP
pcheckd(8), 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