usr/src/man/man1/mailstats.1

   1 '\" te
   2 .\"  Copyright (c) 2004, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH MAILSTATS 1 "Jun 24, 2004"
   7 .SH NAME
   8 mailstats \- print statistics collected by sendmail
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBmailstats\fR [\fB-o\fR] [\fB-c\fR ] [\fB-C\fR \fIconfigfile\fR] [\fB-f\fR \fIstatisticsfile\fR]
  13      [\fB-p\fR] [\fB-P\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBmailstats\fR utility prints out the statistics collected by the
  20 \fBsendmail\fR(1M) program on mailer usage. These statistics are collected if
  21 the file indicated by the \fBStatusFile\fR configuration option of
  22 \fBsendmail\fR (defined in \fB/etc/mail/sendmail.cf\fR) exists. The default
  23 statistics file is \fB/etc/mail/statistics\fR.
  24 .sp
  25 .LP
  26 To enable \fBmailstats\fR, you must, as root, touch \fB/etc/mail/statistics\fR.
  27 See the \fBStatusFile\fR processing option in \fBsendmail\fR(1M).
  28 .sp
  29 .LP
  30 \fBmailstats\fR first prints the time that the statistics file was created and
  31 the last time it was modified. Then, the statistics for each mailer are
  32 displayed on a single line, each with the following whitespace-separated
  33 fields:
  34 .sp
  35 .ne 2
  36 .na
  37 \fBM\fR
  38 .ad
  39 .RS 14n
  40 The mailer number.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fBmsgsfr\fR
  47 .ad
  48 .RS 14n
  49 Number of messages from the mailer.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fBbytes_from\fR
  56 .ad
  57 .RS 14n
  58 Kbytes from the mailer.
  59 .RE
  60
  61 .sp
  62 .ne 2
  63 .na
  64 \fBmsgsto\fR
  65 .ad
  66 .RS 14n
  67 Number of messages to the mailer.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fBbytes_to\fR
  74 .ad
  75 .RS 14n
  76 Kbytes to the mailer.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fBmsgsrej\fR
  83 .ad
  84 .RS 14n
  85 Number of messages rejected by the mailer.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fBmsgsdis\fR
  92 .ad
  93 .RS 14n
  94 Number of messages discarded by the mailer.
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fBmsgsqur\fR
 101 .ad
 102 .RS 14n
 103 Number of messages quarantined by the mailer.
 104 .RE
 105
 106 .sp
 107 .ne 2
 108 .na
 109 \fBMailer\fR
 110 .ad
 111 .RS 14n
 112 The name of the mailer.
 113 .RE
 114
 115 .sp
 116 .LP
 117 The display of statistics described above is followed by a separation line
 118 containing only equal sign (\fB=\fR) characters. After the separation line, a
 119 line preceded with a "\fBT\fR" and totaling the values for all of the mailers
 120 is displayed. This is followed by another line preceded with a "\fBC\fR" that
 121 lists the number of TCP connections.
 122 .sp
 123 .LP
 124 To reinitialize the statistics file once a night, add an entry to root's
 125 \fBcrontab\fR(1):
 126 .sp
 127 .in +2
 128 .nf
 129 mailstats -p > /dev/null
 130 .fi
 131 .in -2
 132 .sp
 133
 134 .SH OPTIONS
 135 .sp
 136 .LP
 137 The following options are supported:
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fB-c\fR \fR
 142 .ad
 143 .RS 21n
 144 Try to use \fBsubmit.cf\fR instead of the default \fBsendmail\fR configuration
 145 file.
 146 .RE
 147
 148 .sp
 149 .ne 2
 150 .na
 151 \fB\fB-C\fR \fIconfigfile\fR\fR
 152 .ad
 153 .RS 21n
 154 Specify a \fBsendmail\fR configuration file.
 155 .RE
 156
 157 .sp
 158 .ne 2
 159 .na
 160 \fB\fB-f\fR \fIstatisticsfile\fR\fR
 161 .ad
 162 .RS 21n
 163 Specify a \fBsendmail\fR statistics file.
 164 .RE
 165
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fB-o\fR\fR
 170 .ad
 171 .RS 21n
 172 Do not display the name of the mailer in the output.
 173 .RE
 174
 175 .sp
 176 .ne 2
 177 .na
 178 \fB\fB-p\fR\fR
 179 .ad
 180 .RS 21n
 181 Output information in program-readable mode and clear statistics.
 182 .RE
 183
 184 .sp
 185 .ne 2
 186 .na
 187 \fB\fB-P\fR\fR
 188 .ad
 189 .RS 21n
 190 Output information in program-readable mode without clearing statistics.
 191 .RE
 192
 193 .SH USAGE
 194 .sp
 195 .LP
 196 See \fBlargefile\fR(5) for the description of the behavior of \fBmailstats\fR
 197 when encountering files greater than or equal to 2 Gbyte ( 2^31 bytes).
 198 .SH FILES
 199 .sp
 200 .ne 2
 201 .na
 202 \fB\fB/dev/null\fR\fR
 203 .ad
 204 .RS 25n
 205 Zero-lined file
 206 .RE
 207
 208 .sp
 209 .ne 2
 210 .na
 211 \fB\fB/etc/mail/statistics\fR\fR
 212 .ad
 213 .RS 25n
 214 Default \fBsendmail\fR statistics file
 215 .RE
 216
 217 .sp
 218 .ne 2
 219 .na
 220 \fB\fB/etc/mail/sendmail.cf\fR\fR
 221 .ad
 222 .RS 25n
 223 Default \fBsendmail\fR configuration file
 224 .RE
 225
 226 .SH ATTRIBUTES
 227 .sp
 228 .LP
 229 See \fBattributes\fR(5) for descriptions of the following attributes:
 230 .sp
 231
 232 .sp
 233 .TS
 234 box;
 235 c | c
 236 l | l .
 237 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 238 _
 239 Output Stability        Unstable
 240 .TE
 241
 242 .SH SEE ALSO
 243 .sp
 244 .LP
 245 \fBcrontab\fR(1), \fBcron\fR(1M), \fBsendmail\fR(1M), \fBattributes\fR(5),
 246 \fBlargefile\fR(5)