postfix-master/qshape.1.html

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