source: trunk/third/sendmail/mailstats/mailstats.8 @ 12887

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