xref: /freebsd/contrib/sendmail/mailstats/mailstats.8 (revision daf1cffce2e07931f27c6c6998652e90df6ba87e)
1.\" Copyright (c) 1998 Sendmail, Inc.  All rights reserved.
2.\"
3.\" By using this file, you agree to the terms and conditions set
4.\" forth in the LICENSE file which can be found at the top level of
5.\" the sendmail distribution.
6.\"
7.\"
8.\"	@(#)mailstats.8	8.8 (Berkeley) 11/13/1998
9.\"
10.Dd April 25, 1996
11.Dt MAILSTATS 1
12.Os BSD 3
13.Sh NAME
14.Nm mailstats
15.Nd display mail statistics
16.Sh SYNOPSIS
17.Nm mailstats
18.Op Fl o
19.if \nP .Op Fl p
20.Op Fl C Ar cffile
21.Op Fl f Ar stfile
22.Sh DESCRIPTION
23The
24.Nm mailstats
25utility displays the current mail statistics.
26.Pp
27First, the time at which statistics started being kept is displayed,
28in the format specified by
29.Xr ctime 3 .
30Then,
31the statistics for each mailer are displayed on a single line,
32each with the following whitespace separated fields:
33.Pp
34.Bl -tag -width 10n -offset indent -compact
35.It Sy M
36The mailer number.
37.It Sy msgsfr
38Number of messages from the mailer.
39.It Sy bytes_from
40Kbytes from the mailer.
41.It Sy msgsto
42Number of messages to the mailer.
43.It Sy bytes_to
44Kbytes to the mailer.
45.It Sy msgsrej
46Number of messages rejected.
47.It Sy msgsdis
48Number of messages discarded.
49.It Sy Mailer
50The name of the mailer.
51.El
52.Pp
53After this display, a line totaling the values for all of the mailers
54is displayed,
55separated from the previous information by a line containing only equals
56.Pq Dq \&=
57characters.
58.Pp
59The options are as follows:
60.Bl -tag -width Ds
61.It Fl C
62Read the specified file instead of the default
63.Nm sendmail
64.Dq cf
65file.
66.It Fl f
67Read the specified statistics file instead of the statistics file
68specified in the
69.Nm sendmail
70.Dq cf
71file.
72.if \nP \
73\{
74.It Fl p
75Output information in program-readable mode and clear statistics.
76.\}
77.It Fl o
78Don't display the name of the mailer in the output.
79.El
80.Pp
81The
82.Nm mailstats
83utility exits 0 on success, and >0 if an error occurs.
84.Sh FILES
85.Bl -tag -width /var/log/sendmail.stXX -compact
86.ie \nP .It Pa /etc/mail/sendmail.cf
87.el .It Pa /etc/sendmail.cf
88The default
89.Nm sendmail
90.Dq cf
91file.
92.ie \nP .It Pa /etc/mail/statistics
93.el .It Pa /var/log/sendmail.st
94The default
95.Nm sendmail
96statistics file.
97.El
98.Sh SEE ALSO
99.Xr mailq 1 ,
100.Xr sendmail 8
101