freebsd-dev/contrib/sendmail/mailstats/mailstats.8

.\" Copyright (c) 1998-2001 Sendmail, Inc. and its suppliers.
.\"	 All rights reserved.
.\"
.\" By using this file, you agree to the terms and conditions set
.\" forth in the LICENSE file which can be found at the top level of
.\" the sendmail distribution.
.\"
.\"
.\"	$Id: mailstats.8,v 8.17.4.6 2001/05/07 22:06:38 gshapiro Exp $
.\"
.TH MAILSTATS 8 "$Date: 2001/05/07 22:06:38 $"
.SH NAME
mailstats
\- display mail statistics
.SH SYNOPSIS
.B mailstats
.RB [ \-o "] [" \-p ]
.RB [ \-C 
.IR cffile ]
.RB [ \-f
.IR stfile ]
.SH DESCRIPTION
The
.B mailstats
utility displays the current mail statistics.
.PP
First, the time at which statistics started being kept is displayed,
in the format specified by 
ctime(3).  
Then, 
the statistics for each mailer are displayed on a single line, 
each with the following white space separated fields:
.sp
.RS
.PD 0.2v
.TP 1.2i
.B M
The mailer number.
.TP 
.B msgsfr
Number of messages from the mailer.
.TP
.B bytes_from
Kbytes from the mailer.
.TP
.B msgsto
Number of messages to the mailer.
.TP
.B bytes_to
Kbytes to the mailer.
.TP
.B msgsrej
Number of messages rejected.
.TP
.B msgsdis
Number of messages discarded.
.TP
.B Mailer
The name of the mailer.
.PD
.RE
.PP
After this display, a line totaling the values for all of the mailers 
is displayed (preceded with a ``T''),
separated from the previous information by a line containing only equals 
(``='') 
characters.
Another line preceded with a ``C'' lists the number of connections.
.PP
The options are as follows:
.TP 
.B \-C
Read the specified file instead of the default
.B sendmail
configuration file.
.TP
.B \-f
Read the specified statistics file instead of the statistics file
specified in the
.B sendmail 
configuration file.
.TP 
.B \-p
Output information in program-readable mode and clear statistics.
.TP
.B \-o
Don't display the name of the mailer in the output.
.PP
The
.B mailstats
utility exits 0 on success, and >0 if an error occurs.
.SH FILES
.PD 0.2v
.TP 2.5i
/etc/mail/sendmail.cf
The default
.B sendmail
configuration file.
.TP
/etc/mail/statistics
The default
.B sendmail
statistics file.
.PD
.SH SEE ALSO
mailq(1), 
sendmail(8)
Import sendmail 8.11.4 2001-05-28 17:08:52 +00:00			`.\" Copyright (c) 1998-2001 Sendmail, Inc. and its suppliers.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.\" All rights reserved.`
Import sendmail-8.9.1 (slightly trimmed) onto a fresh branch under src/contrib as per various discussions. I will copy across our changes and then point the Makefiles across once the dust has settled.. 1998-08-03 05:56:20 +00:00			`.\"`
			`.\" By using this file, you agree to the terms and conditions set`
			`.\" forth in the LICENSE file which can be found at the top level of`
			`.\" the sendmail distribution.`
			`.\"`
			`.\"`
Import sendmail 8.11.4 2001-05-28 17:08:52 +00:00			`.\" $Id: mailstats.8,v 8.17.4.6 2001/05/07 22:06:38 gshapiro Exp $`
Import sendmail-8.9.1 (slightly trimmed) onto a fresh branch under src/contrib as per various discussions. I will copy across our changes and then point the Makefiles across once the dust has settled.. 1998-08-03 05:56:20 +00:00			`.\"`
Import sendmail 8.11.4 2001-05-28 17:08:52 +00:00			`.TH MAILSTATS 8 "$Date: 2001/05/07 22:06:38 $"`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.SH NAME`
Import sendmail 8.11.2 2001-01-21 22:17:06 +00:00			`mailstats`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`\- display mail statistics`
			`.SH SYNOPSIS`
			`.B mailstats`
			`.RB [ \-o "] [" \-p ]`
			`.RB [ \-C`
			`.IR cffile ]`
			`.RB [ \-f`
			`.IR stfile ]`
			`.SH DESCRIPTION`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`The`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.B mailstats`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`utility displays the current mail statistics.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.PP`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`First, the time at which statistics started being kept is displayed,`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`in the format specified by`
			`ctime(3).`
			`Then,`
			`the statistics for each mailer are displayed on a single line,`
			`each with the following white space separated fields:`
			`.sp`
			`.RS`
			`.PD 0.2v`
			`.TP 1.2i`
			`.B M`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`The mailer number.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`.B msgsfr`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`Number of messages from the mailer.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`.B bytes_from`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`Kbytes from the mailer.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`.B msgsto`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`Number of messages to the mailer.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`.B bytes_to`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`Kbytes to the mailer.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`.B msgsrej`
Import sendmail-8.9.2 onto vendor branch (update from 8.9.1) Obtained from: ftp.sendamil.org 1999-01-12 12:26:57 +00:00			`Number of messages rejected.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`.B msgsdis`
Import sendmail-8.9.2 onto vendor branch (update from 8.9.1) Obtained from: ftp.sendamil.org 1999-01-12 12:26:57 +00:00			`Number of messages discarded.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`.B Mailer`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`The name of the mailer.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.PD`
			`.RE`
			`.PP`
			`After this display, a line totaling the values for all of the mailers`
Import sendmail 8.11.4 2001-05-28 17:08:52 +00:00			is displayed (preceded with a ``T''),
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`separated from the previous information by a line containing only equals`
			(``='')
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`characters.`
Import sendmail 8.11.4 2001-05-28 17:08:52 +00:00			Another line preceded with a ``C'' lists the number of connections.
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.PP`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`The options are as follows:`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`.B \-C`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`Read the specified file instead of the default`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.B sendmail`
Import sendmail 8.11.2 2001-01-21 22:17:06 +00:00			`configuration file.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`.B \-f`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`Read the specified statistics file instead of the statistics file`
			`specified in the`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.B sendmail`
Import sendmail 8.11.2 2001-01-21 22:17:06 +00:00			`configuration file.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`.B \-p`
Import sendmail-8.9.2 onto vendor branch (update from 8.9.1) Obtained from: ftp.sendamil.org 1999-01-12 12:26:57 +00:00			`Output information in program-readable mode and clear statistics.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`.B \-o`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`Don't display the name of the mailer in the output.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.PP`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`The`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.B mailstats`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`utility exits 0 on success, and >0 if an error occurs.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.SH FILES`
			`.PD 0.2v`
			`.TP 2.5i`
			`/etc/mail/sendmail.cf`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`The default`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.B sendmail`
Import sendmail 8.11.2 2001-01-21 22:17:06 +00:00			`configuration file.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.TP`
			`/etc/mail/statistics`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`The default`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.B sendmail`
Import sendmail-8.8.2 onto the vendor branch Obtained from: Eric Allman <eric@sendmail.org> 1996-10-24 04:51:14 +00:00			`statistics file.`
Import of sendmail version 8.11.0 into vendor branch SENDMAIL with release tag v8_11_0. Obtained from: ftp://ftp.sendmail.org/pub/sendmail/ 2000-08-12 21:55:49 +00:00			`.PD`
			`.SH SEE ALSO`
			`mailq(1),`
			`sendmail(8)`