Merge from vendor branch LIBSTDC++:
[dragonfly.git] / contrib / sendmail / mailstats / mailstats.8
1 .\" Copyright (c) 1998-2002 Sendmail, Inc. and its suppliers.
2 .\"      All rights reserved.
3 .\"
4 .\" By using this file, you agree to the terms and conditions set
5 .\" forth in the LICENSE file which can be found at the top level of
6 .\" the sendmail distribution.
7 .\"
8 .\"
9 .\"     $Id: mailstats.8,v 8.30.2.1 2002/09/26 23:03:39 gshapiro Exp $
10 .\"
11 .TH MAILSTATS 8 "$Date: 2002/09/26 23:03:39 $"
12 .SH NAME
13 mailstats
14 \- display mail statistics
15 .SH SYNOPSIS
16 .B mailstats
17 .RB [ \-c "] [" \-o "] [" \-p "] [" \-P ]
18 .RB [ \-C 
19 .IR cffile ]
20 .RB [ \-f
21 .IR stfile ]
22 .SH DESCRIPTION
23 The
24 .B mailstats
25 utility displays the current mail statistics.
26 .PP
27 First, the time at which statistics started being kept is displayed,
28 in the format specified by 
29 ctime(3).  
30 Then, 
31 the statistics for each mailer are displayed on a single line, 
32 each with the following white space separated fields:
33 .sp
34 .RS
35 .PD 0.2v
36 .TP 1.2i
37 .B M
38 The mailer number.
39 .TP 
40 .B msgsfr
41 Number of messages from the mailer.
42 .TP
43 .B bytes_from
44 Kbytes from the mailer.
45 .TP
46 .B msgsto
47 Number of messages to the mailer.
48 .TP
49 .B bytes_to
50 Kbytes to the mailer.
51 .TP
52 .B msgsrej
53 Number of messages rejected.
54 .TP
55 .B msgsdis
56 Number of messages discarded.
57 .TP
58 .B Mailer
59 The name of the mailer.
60 .PD
61 .RE
62 .PP
63 After this display, a line totaling the values for all of the mailers 
64 is displayed (preceded with a ``T''),
65 separated from the previous information by a line containing only equals 
66 (``='') 
67 characters.
68 Another line preceded with a ``C'' lists the number of TCP connections.
69 .PP
70 The options are as follows:
71 .TP 
72 .B \-C
73 Read the specified file instead of the default
74 .B sendmail
75 configuration file.
76 .TP
77 .B \-c
78 Try to use submit.cf instead of the default
79 .B sendmail
80 configuration file.
81 .TP
82 .B \-f
83 Read the specified statistics file instead of the statistics file
84 specified in the
85 .B sendmail 
86 configuration file.
87 .TP 
88 .B \-P
89 Output information in program-readable mode without clearing statistics.
90 .TP
91 .B \-p
92 Output information in program-readable mode and clear statistics.
93 .TP
94 .B \-o
95 Don't display the name of the mailer in the output.
96 .PP
97 The
98 .B mailstats
99 utility exits 0 on success, and >0 if an error occurs.
100 .SH FILES
101 .PD 0.2v
102 .TP 2.5i
103 /etc/mail/sendmail.cf
104 The default
105 .B sendmail
106 configuration file.
107 .TP
108 /etc/mail/statistics
109 The default
110 .B sendmail
111 statistics file.
112 .PD
113 .SH SEE ALSO
114 mailq(1), 
115 sendmail(8)