external/ibm-public/postfix/dist/man/man1/qshape.1

   1 .\"     $NetBSD$
   2 .\"
   3 .TH QSHAPE 1
   4 .ad
   5 .fi
   6 .SH NAME
   7 qshape
   8 \-
   9 Print Postfix queue domain and age distribution
  10 .SH "SYNOPSIS"
  11 .na
  12 .nf
  13 .fi
  14 \fBqshape\fR [\fB-s\fR] [\fB-p\fR] [\fB-m \fImin_subdomains\fR]
  15         [\fB-b \fIbucket_count\fR] [\fB-t \fIbucket_time\fR]
  16         [\fB-l\fR] [\fB-w \fIterminal_width\fR]
  17         [\fB-N \fIbatch_msg_count\fR] [\fB-n \fIbatch_top_domains\fR]
  18         [\fB-c \fIconfig_directory\fR] [\fIqueue_name\fR ...]
  19 .SH DESCRIPTION
  20 .ad
  21 .fi
  22 The \fBqshape\fR program helps the administrator understand the
  23 Postfix queue message distribution in time and by sender domain
  24 or recipient domain. The program needs read access to the queue
  25 directories and queue files, so it must run as the superuser or
  26 the \fBmail_owner\fR specified in \fBmain.cf\fR (typically
  27 \fBpostfix\fR).
  28
  29 Options:
  30 .IP \fB-s\fR
  31 Display the sender domain distribution instead of the recipient
  32 domain distribution.  By default the recipient distribution is
  33 displayed. There can be more recipients than messages, but as
  34 each message has only one sender, the sender distribution is a
  35 message distribution.
  36 .IP \fB-p\fR
  37 Generate aggregate statistics for parent domains. Top level domains
  38 are not shown, nor are domains with fewer than \fImin_subdomains\fR
  39 subdomains. The names of parent domains are shown with a leading dot,
  40 (e.g. \fI.example.com\fR).
  41 .IP "\fB-m \fImin_subdomains\fR"
  42 When used with the \fB-p\fR option, sets the minimum subdomain count
  43 needed to show a separate line for a parent domain. The default is 5.
  44 .IP "\fB-b \fIbucket_count\fR"
  45 The age distribution is broken up into a sequence of geometrically
  46 increasing intervals. This option sets the number of intervals
  47 or "buckets". Each bucket has a maximum queue age that is twice
  48 as large as that of the previous bucket. The last bucket has no
  49 age limit.
  50 .IP "\fB-t \fIbucket_time\fR"
  51 The age limit in minutes for the first time bucket. The default
  52 value is 5, meaning that the first bucket counts messages between
  53 0 and 5 minutes old.
  54 .IP "\fB-l\fR"
  55 Instead of using a geometric age sequence, use a linear age sequence,
  56 in other words simple multiples of \fBbucket_time\fR.
  57
  58 This feature is available in Postfix 2.2 and later.
  59 .IP "\fB-w \fIterminal_width\fR"
  60 The output is right justified, with the counts for the last
  61 bucket shown on the 80th column, the \fIterminal_width\fR can be
  62 adjusted for wider screens allowing more buckets to be displayed
  63 without truncating the domain names on the left. When a row for a
  64 full domain name and its counters does not fit in the specified
  65 number of columns, only the last 17 bytes of the domain name
  66 are shown with the prefix replaced by a '+' character. Truncated
  67 parent domain rows are shown as '.+' followed by the last 16 bytes
  68 of the domain name. If this is still too narrow to show the domain
  69 name and all the counters, the terminal_width limit is violated.
  70 .IP "\fB-N \fIbatch_msg_count\fR"
  71 When the output device is a terminal, intermediate results are
  72 shown each "batch_msg_count" messages. This produces usable results
  73 in a reasonable time even when the deferred queue is large. The
  74 default is to show intermediate results every 1000 messages.
  75 .IP "\fB-n \fIbatch_top_domains\fR"
  76 When reporting intermediate or final results to a termainal, report
  77 only the top "batch_top_domains" domains. The default limit is 20
  78 domains.
  79 .IP "\fB-c \fIconfig_directory\fR"
  80 The \fBmain.cf\fR configuration file is in the named directory
  81 instead of the default configuration directory.
  82 .PP
  83 Arguments:
  84 .IP \fIqueue_name\fR
  85 By default \fBqshape\fR displays the combined distribution of
  86 the incoming and active queues. To display a different set of
  87 queues, just list their directory names on the command line.
  88 Absolute paths are used as is, other paths are taken relative
  89 to the \fBmain.cf\fR \fBqueue_directory\fR parameter setting.
  90 While \fBmain.cf\fR supports the use of \fI$variable\fR expansion
  91 in the definition of the \fBqueue_directory\fR parameter, the
  92 \fBqshape\fR program does not. If you must use variable expansions
  93 in the \fBqueue_directory\fR setting, you must specify an explicit
  94 absolute path for each queue subdirectory even if you want the
  95 default incoming and active queue distribution.
  96 .SH "SEE ALSO"
  97 .na
  98 .nf
  99 mailq(1), List all messages in the queue.
 100 QSHAPE_README Examples and background material.
 101 .SH "FILES"
 102 .na
 103 .nf
 104 $config_directory/main.cf, Postfix installation parameters.
 105 $queue_directory/maildrop/, local submission directory.
 106 $queue_directory/incoming/, new message queue.
 107 $queue_directory/hold/, messages waiting for tech support.
 108 $queue_directory/active/, messages scheduled for delivery.
 109 $queue_directory/deferred/, messages postponed for later delivery.
 110 .SH "LICENSE"
 111 .na
 112 .nf
 113 .ad
 114 .fi
 115 The Secure Mailer license must be distributed with this software.
 116 .SH "AUTHOR(S)"
 117 .na
 118 .nf
 119 Victor Duchovni
 120 Morgan Stanley