~ubuntu-branches/ubuntu/vivid/postfix/vivid-proposed

« back to all changes in this revision

Viewing changes to html/qshape.1.html

  • Committer: Bazaar Package Importer
  • Author(s): LaMont Jones
  • Date: 2005-02-27 09:33:07 UTC
  • Revision ID: james.westby@ubuntu.com-20050227093307-cn789t27ibnlh6tf
Tags: upstream-2.1.5
ImportĀ upstreamĀ versionĀ 2.1.5

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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>-w</b> <i>terminal</i><b>_</b><i>width</i>]
 
16
               [<b>-c</b> <i>config</i><b>_</b><i>directory</i>] [<i>queue</i><b>_</b><i>name</i> ...]
 
17
 
 
18
<b>DESCRIPTION</b>
 
19
       The  <b>qshape</b> program helps the administrator understand the
 
20
       Postfix queue message distribution in time and  by  sender
 
21
       domain  or recipient domain. The program needs read access
 
22
       to the queue directories and queue files, so it  must  run
 
23
       as  the  superuser  or the <b><a href="postconf.5.html#mail_owner">mail_owner</a></b> specified in <i>main.cf</i>
 
24
       (typically <b>postfix</b>).
 
25
 
 
26
       Options:
 
27
 
 
28
       <b>-s</b>     Display the sender domain distribution  instead  of
 
29
              the  recipient domain distribution.  By default the
 
30
              recipient distribution is displayed. There  can  be
 
31
              more  recipients than messages, but as each message
 
32
              has only one sender, the sender distribution is a a
 
33
              message distribution.
 
34
 
 
35
       <b>-p</b>     Generate  aggregate  statistics for parent domains.
 
36
              Top level domains are not shown,  nor  are  domains
 
37
              with  fewer  than  <i>min</i><b>_</b><i>subdomains</i>  subdomains.  The
 
38
              names of parent domains are shown  with  a  leading
 
39
              dot, (e.g. <i>.example.com</i>).
 
40
 
 
41
       <b>-m</b> <i>min</i><b>_</b><i>subdomains</i>
 
42
              When used with the <b>-p</b> option, sets the minimum sub-
 
43
              domain count needed to show a separate line  for  a
 
44
              parent domain. The default is 5.
 
45
 
 
46
       <b>-b</b> <i>bucket</i><b>_</b><i>count</i>
 
47
              The  age  distribution is broken up into a sequence
 
48
              of geometrically increasing intervals. This  option
 
49
              sets  the  number  of  intervals or "buckets". Each
 
50
              bucket has a maximum queue age  that  is  twice  as
 
51
              large  as  that  of  the  previous bucket. The last
 
52
              bucket has no age limit.
 
53
 
 
54
       <b>-b</b> <i>bucket</i><b>_</b><i>time</i>
 
55
              The age limit in minutes for the first time bucket.
 
56
              The  default  value  is  5,  meaning that the first
 
57
              bucket counts messages between 0 and 5 minutes old.
 
58
 
 
59
       <b>-w</b> <i>terminal</i><b>_</b><i>width</i>
 
60
              The  output is right justified, with the counts for
 
61
              the last bucket shown on the 80th column, the  <i>ter-</i>
 
62
              <i>minal</i><b>_</b><i>width</i>  can  be  adjusted  for  wider  screens
 
63
              allowing more buckets to be displayed with truncat-
 
64
              ing  the domain names on the left. When a row for a
 
65
              full domain name and its counters does not  fit  in
 
66
              the  specified  number of columns, only the last 17
 
67
              bytes of the domain name are shown with the  prefix
 
68
              replaced  by  a  '+'  character.  Truncated  parent
 
69
              domain rows are shown as '.+' followed by the  last
 
70
              16  bytes  of the domain name. If this is still too
 
71
              narrow to show the domain name and  all  the  coun-
 
72
              ters, the terminal_width limit is violated.
 
73
 
 
74
       <b>-c</b> <i>config</i><b>_</b><i>directory</i>
 
75
              The  <b>main.cf</b>  configuration  file  is  in the named
 
76
              directory  instead  of  the  default  configuration
 
77
              directory.
 
78
 
 
79
       Arguments:
 
80
 
 
81
       <i>queue</i><b>_</b><i>name</i>
 
82
              By  default  <b>qshape</b> displays the combined distribu-
 
83
              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
 
84
              a  different  set of queues, just list their direc-
 
85
              tory names on the command line.  Absolute paths are
 
86
              used  as  is, other paths are taken relative to the
 
87
              <i>main.cf</i> <b><a href="postconf.5.html#queue_directory">queue_directory</a></b> parameter  setting.   While
 
88
              <i>main.cf</i>  supports the use of <i>$variable</i> expansion in
 
89
              the definition of  the  <b><a href="postconf.5.html#queue_directory">queue_directory</a></b>  parameter,
 
90
              the  <b>qshape</b> program does not. If you must use vari-
 
91
              able expansions in the <b><a href="postconf.5.html#queue_directory">queue_directory</a></b> setting, you
 
92
              must  specify  an  explicit  absolute path for each
 
93
              queue subdirectory even if  you  want  the  default
 
94
              <a href="QSHAPE_README.html#incoming_queue">incoming</a> and <a href="QSHAPE_README.html#active_queue">active queue</a> distribution.
 
95
 
 
96
<b>SEE ALSO</b>
 
97
       <a href="mailq.1.html">mailq(1)</a> List all messages in the queue.
 
98
       <a href="QSHAPE_README.html">QSHAPE_README</a> Examples and background material.
 
99
 
 
100
<b>FILES</b>
 
101
       $<a href="postconf.5.html#config_directory">config_directory</a>/main.cf, Postfix installation parameters.
 
102
       $<a href="postconf.5.html#queue_directory">queue_directory</a>/maildrop/, local submission directory.
 
103
       $<a href="postconf.5.html#queue_directory">queue_directory</a>/incoming/, new message queue.
 
104
       $<a href="postconf.5.html#queue_directory">queue_directory</a>/hold/, messages waiting for tech support.
 
105
       $<a href="postconf.5.html#queue_directory">queue_directory</a>/active/, messages scheduled for delivery.
 
106
       $<a href="postconf.5.html#queue_directory">queue_directory</a>/deferred/, messages postponed for later delivery.
 
107
 
 
108
<b>LICENSE</b>
 
109
       The  Secure  Mailer  license must be distributed with this
 
110
       software.
 
111
 
 
112
<b>AUTHOR(S)</b>
 
113
       Victor Duchovni
 
114
       Morgan Stanley
 
115
 
 
116
                                                        QSHAPE(1)
 
117
</pre> </body> </html>