1QSHAPE(1)                   General Commands Manual                  QSHAPE(1)
2
3
4

NAME

6       qshape - Print Postfix queue domain and age distribution
7

SYNOPSIS

9       qshape [-s] [-p] [-m min_subdomains]
10               [-b bucket_count] [-t bucket_time]
11               [-l] [-w terminal_width]
12               [-N batch_msg_count] [-n batch_top_domains]
13               [-c config_directory] [queue_name ...]
14

DESCRIPTION

16       The qshape program helps the administrator understand the Postfix queue
17       message distribution in time and by sender domain or recipient  domain.
18       The program needs read access to the queue directories and queue files,
19       so it must run as the superuser or the mail_owner specified in  main.cf
20       (typically postfix).
21
22       Options:
23
24       -s     Display  the sender domain distribution instead of the recipient
25              domain distribution.  By default the recipient  distribution  is
26              displayed.  There  can  be more recipients than messages, but as
27              each message has only one sender, the sender distribution  is  a
28              message distribution.
29
30       -p     Generate  aggregate  statistics  for  parent  domains. Top level
31              domains are not shown, nor are domains with fewer than  min_sub‐
32              domains subdomains. The names of parent domains are shown with a
33              leading dot, (e.g. .example.com).
34
35       -m min_subdomains
36              When used with the -p option, sets the minimum  subdomain  count
37              needed  to show a separate line for a parent domain. The default
38              is 5.
39
40       -b bucket_count
41              The age distribution is broken up into a sequence  of  geometri‐
42              cally  increasing  intervals.  This  option  sets  the number of
43              intervals or "buckets". Each bucket has a maximum queue age that
44              is  twice  as  large  as  that  of the previous bucket. The last
45              bucket has no age limit.
46
47       -t bucket_time
48              The age limit in minutes for the first time bucket. The  default
49              value  is  5,  meaning  that  the  first  bucket counts messages
50              between 0 and 5 minutes old.
51
52       -l     Instead of using a geometric age  sequence,  use  a  linear  age
53              sequence, in other words simple multiples of bucket_time.
54
55              This feature is available in Postfix 2.2 and later.
56
57       -w terminal_width
58              The  output  is  right  justified,  with the counts for the last
59              bucket shown on the  80th  column,  the  terminal_width  can  be
60              adjusted for wider screens allowing more buckets to be displayed
61              without truncating the domain names on the left. When a row  for
62              a  full  domain name and its counters does not fit in the speci‐
63              fied number of columns, only the last 17  bytes  of  the  domain
64              name  are  shown  with  the  prefix replaced by a '+' character.
65              Truncated parent domain rows are shown as '.+' followed  by  the
66              last 16 bytes of the domain name. If this is still too narrow to
67              show the domain name and all the  counters,  the  terminal_width
68              limit is violated.
69
70       -N batch_msg_count
71              When  the  output device is a terminal, intermediate results are
72              shown each  "batch_msg_count"  messages.  This  produces  usable
73              results  in  a  reasonable  time even when the deferred queue is
74              large. The default is to show intermediate  results  every  1000
75              messages.
76
77       -n batch_top_domains
78              When  reporting  intermediate  or  final results to a termainal,
79              report only the top  "batch_top_domains"  domains.  The  default
80              limit is 20 domains.
81
82       -c config_directory
83              The main.cf configuration file is in the named directory instead
84              of the default configuration directory.
85
86       Arguments:
87
88       queue_name
89              By default qshape displays  the  combined  distribution  of  the
90              incoming  and  active  queues.  To  display  a  different set of
91              queues, just list their directory names  on  the  command  line.
92              Absolute paths are used as is, other paths are taken relative to
93              the main.cf queue_directory parameter  setting.   While  main.cf
94              supports the use of $variable expansion in the definition of the
95              queue_directory parameter, the qshape program does not.  If  you
96              must use variable expansions in the queue_directory setting, you
97              must specify an explicit absolute path for each queue  subdirec‐
98              tory even if you want the default incoming and active queue dis‐
99              tribution.
100

SEE ALSO

102       mailq(1), List all messages in the queue.
103       QSHAPE_README Examples and background material.
104

FILES

106       $config_directory/main.cf, Postfix installation parameters.
107       $queue_directory/maildrop/, local submission directory.
108       $queue_directory/incoming/, new message queue.
109       $queue_directory/hold/, messages waiting for tech support.
110       $queue_directory/active/, messages scheduled for delivery.
111       $queue_directory/deferred/, messages postponed for later delivery.
112

LICENSE

114       The Secure Mailer license must be distributed with this software.
115

AUTHOR(S)

117       Victor Duchovni
118       Morgan Stanley
119
120
121
122                                                                     QSHAPE(1)
Impressum