xref: /netbsd-src/external/ibm-public/postfix/dist/html/qshape.1.html (revision 059c16a85b0b39d60ad6d18f53c09510815afa2b)
1<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN"
2        "http://www.w3.org/TR/html4/loose.dtd">
3<html> <head>
4<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5<link rel='stylesheet' type='text/css' href='postfix-doc.css'>
6<title> Postfix manual - qshape(1) </title>
7</head> <body> <pre>
8QSHAPE(1)                                                            QSHAPE(1)
9
10<b>NAME</b>
11       qshape - Print Postfix queue domain and age distribution
12
13<b>SYNOPSIS</b>
14       <b>qshape</b> [<b>-s</b>] [<b>-p</b>] [<b>-m</b> <i>min</i><b>_</b><i>subdomains</i>]
15               [<b>-b</b> <i>bucket</i><b>_</b><i>count</i>] [<b>-t</b> <i>bucket</i><b>_</b><i>time</i>]
16               [<b>-l</b>] [<b>-w</b> <i>terminal</i><b>_</b><i>width</i>]
17               [<b>-N</b> <i>batch</i><b>_</b><i>msg</i><b>_</b><i>count</i>] [<b>-n</b> <i>batch</i><b>_</b><i>top</i><b>_</b><i>domains</i>]
18               [<b>-c</b> <i>config</i><b>_</b><i>directory</i>] [<i>queue</i><b>_</b><i>name</i> ...]
19
20<b>DESCRIPTION</b>
21       The <b>qshape</b> program helps the administrator understand the Postfix queue
22       message distribution in time and by sender domain or recipient  domain.
23       The program needs read access to the queue directories and queue files,
24       so it must run as the superuser or the <b><a href="postconf.5.html#mail_owner">mail_owner</a></b> specified in  <a href="postconf.5.html"><b>main.cf</b></a>
25       (typically <b>postfix</b>).
26
27       Options:
28
29       <b>-s</b>     Display  the sender domain distribution instead of the recipient
30              domain distribution.  By default the recipient  distribution  is
31              displayed.  There  can  be more recipients than messages, but as
32              each message has only one sender, the sender distribution  is  a
33              message distribution.
34
35       <b>-p</b>     Generate  aggregate  statistics  for  parent  domains. Top level
36              domains are not shown, nor are domains with fewer than  <i>min</i><b>_</b><i>sub-</i>
37              <i>domains</i> subdomains. The names of parent domains are shown with a
38              leading dot, (e.g. <i>.example.com</i>).
39
40       <b>-m</b> <i>min</i><b>_</b><i>subdomains</i>
41              When used with the <b>-p</b> option, sets the minimum  subdomain  count
42              needed  to show a separate line for a parent domain. The default
43              is 5.
44
45       <b>-b</b> <i>bucket</i><b>_</b><i>count</i>
46              The age distribution is broken up into a sequence  of  geometri-
47              cally  increasing  intervals.  This  option  sets  the number of
48              intervals or "buckets". Each bucket has a maximum queue age that
49              is  twice  as  large  as  that  of the previous bucket. The last
50              bucket has no age limit.
51
52       <b>-t</b> <i>bucket</i><b>_</b><i>time</i>
53              The age limit in minutes for the first time bucket. The  default
54              value  is  5,  meaning  that  the  first  bucket counts messages
55              between 0 and 5 minutes old.
56
57       <b>-l</b>     Instead of using a geometric age  sequence,  use  a  linear  age
58              sequence, in other words simple multiples of <b>bucket_time</b>.
59
60              This feature is available in Postfix 2.2 and later.
61
62       <b>-w</b> <i>terminal</i><b>_</b><i>width</i>
63              The  output  is  right  justified,  with the counts for the last
64              bucket shown on the  80th  column,  the  <i>terminal</i><b>_</b><i>width</i>  can  be
65              adjusted for wider screens allowing more buckets to be displayed
66              without truncating the domain names on the left. When a row  for
67              a  full  domain name and its counters does not fit in the speci-
68              fied number of columns, only the last 17  bytes  of  the  domain
69              name  are  shown  with  the  prefix replaced by a '+' character.
70              Truncated parent domain rows are shown as '.+' followed  by  the
71              last 16 bytes of the domain name. If this is still too narrow to
72              show the domain name and all the  counters,  the  terminal_width
73              limit is violated.
74
75       <b>-N</b> <i>batch</i><b>_</b><i>msg</i><b>_</b><i>count</i>
76              When  the  output device is a terminal, intermediate results are
77              shown each  "batch_msg_count"  messages.  This  produces  usable
78              results  in  a  reasonable  time even when the <a href="QSHAPE_README.html#deferred_queue">deferred queue</a> is
79              large. The default is to show intermediate  results  every  1000
80              messages.
81
82       <b>-n</b> <i>batch</i><b>_</b><i>top</i><b>_</b><i>domains</i>
83              When  reporting  intermediate  or  final results to a termainal,
84              report only the top  "batch_top_domains"  domains.  The  default
85              limit is 20 domains.
86
87       <b>-c</b> <i>config</i><b>_</b><i>directory</i>
88              The <a href="postconf.5.html"><b>main.cf</b></a> configuration file is in the named directory instead
89              of the default configuration directory.
90
91       Arguments:
92
93       <i>queue</i><b>_</b><i>name</i>
94              By default <b>qshape</b> displays  the  combined  distribution  of  the
95              incoming  and  <a href="QSHAPE_README.html#active_queue">active  queues</a>.  To  display  a  different set of
96              queues, just list their directory names  on  the  command  line.
97              Absolute paths are used as is, other paths are taken relative to
98              the <a href="postconf.5.html"><b>main.cf</a> <a href="postconf.5.html#queue_directory">queue_directory</a></b> parameter  setting.   While  <a href="postconf.5.html"><b>main.cf</b></a>
99              supports the use of <i>$variable</i> expansion in the definition of the
100              <b><a href="postconf.5.html#queue_directory">queue_directory</a></b> parameter, the <b>qshape</b> program does not.  If  you
101              must use variable expansions in the <b><a href="postconf.5.html#queue_directory">queue_directory</a></b> setting, you
102              must specify an explicit absolute path for each queue  subdirec-
103              tory even if you want the default <a href="QSHAPE_README.html#incoming_queue">incoming</a> and <a href="QSHAPE_README.html#active_queue">active queue</a> dis-
104              tribution.
105
106<b>SEE ALSO</b>
107       <a href="mailq.1.html">mailq(1)</a>, List all messages in the queue.
108       <a href="QSHAPE_README.html">QSHAPE_README</a> Examples and background material.
109
110<b>FILES</b>
111       $<a href="postconf.5.html#config_directory">config_directory</a>/<a href="postconf.5.html">main.cf</a>, Postfix installation parameters.
112       $<a href="postconf.5.html#queue_directory">queue_directory</a>/maildrop/, local submission directory.
113       $<a href="postconf.5.html#queue_directory">queue_directory</a>/incoming/, new message queue.
114       $<a href="postconf.5.html#queue_directory">queue_directory</a>/hold/, messages waiting for tech support.
115       $<a href="postconf.5.html#queue_directory">queue_directory</a>/active/, messages scheduled for delivery.
116       $<a href="postconf.5.html#queue_directory">queue_directory</a>/deferred/, messages postponed for later delivery.
117
118<b>LICENSE</b>
119       The Secure Mailer license must be distributed with this software.
120
121<b>AUTHOR(S)</b>
122       Victor Duchovni
123       Morgan Stanley
124
125                                                                     QSHAPE(1)
126</pre> </body> </html>
127