contrib/sendmail/mailstats/mailstats.8

   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
  23 The
  24 .Nm 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 .Xr ctime 3 .
  30 Then,
  31 the statistics for each mailer are displayed on a single line,
  32 each with the following whitespace separated fields:
  33 .Pp
  34 .Bl -tag -width 10n -offset indent -compact
  35 .It Sy M
  36 The mailer number.
  37 .It Sy msgsfr
  38 Number of messages from the mailer.
  39 .It Sy bytes_from
  40 Kbytes from the mailer.
  41 .It Sy msgsto
  42 Number of messages to the mailer.
  43 .It Sy bytes_to
  44 Kbytes to the mailer.
  45 .It Sy msgsrej
  46 Number of messages rejected.
  47 .It Sy msgsdis
  48 Number of messages discarded.
  49 .It Sy Mailer
  50 The name of the mailer.
  51 .El
  52 .Pp
  53 After this display, a line totaling the values for all of the mailers
  54 is displayed,
  55 separated from the previous information by a line containing only equals
  56 .Pq Dq \&=
  57 characters.
  58 .Pp
  59 The options are as follows:
  60 .Bl -tag -width Ds
  61 .It Fl C
  62 Read the specified file instead of the default
  63 .Nm sendmail
  64 .Dq cf
  65 file.
  66 .It Fl f
  67 Read the specified statistics file instead of the statistics file
  68 specified in the
  69 .Nm sendmail
  70 .Dq cf
  71 file.
  72 .if \nP \
  73 \{
  74 .It Fl p
  75 Output information in program-readable mode and clear statistics.
  76 .\}
  77 .It Fl o
  78 Don't display the name of the mailer in the output.
  79 .El
  80 .Pp
  81 The
  82 .Nm mailstats
  83 utility 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
  88 The default
  89 .Nm sendmail
  90 .Dq cf
  91 file.
  92 .ie \nP .It Pa /etc/mail/statistics
  93 .el .It Pa /var/log/sendmail.st
  94 The default
  95 .Nm sendmail
  96 statistics file.
  97 .El
  98 .Sh SEE ALSO
  99 .Xr mailq 1 ,
 100 .Xr sendmail 8