diff options
Diffstat (limited to 'html/qshape.1.html')
| -rw-r--r-- | html/qshape.1.html | 125 |
1 files changed, 125 insertions, 0 deletions
diff --git a/html/qshape.1.html b/html/qshape.1.html new file mode 100644 index 0000000..07d206c --- /dev/null +++ b/html/qshape.1.html @@ -0,0 +1,125 @@ +<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN" + "http://www.w3.org/TR/html4/loose.dtd"> +<html> <head> +<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> +<title> Postfix manual - qshape(1) </title> +</head> <body> <pre> +QSHAPE(1) QSHAPE(1) + +<b>NAME</b> + qshape - Print Postfix queue domain and age distribution + +<b>SYNOPSIS</b> + <b>qshape</b> [<b>-s</b>] [<b>-p</b>] [<b>-m</b> <i>min</i><b>_</b><i>subdomains</i>] + [<b>-b</b> <i>bucket</i><b>_</b><i>count</i>] [<b>-t</b> <i>bucket</i><b>_</b><i>time</i>] + [<b>-l</b>] [<b>-w</b> <i>terminal</i><b>_</b><i>width</i>] + [<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>] + [<b>-c</b> <i>config</i><b>_</b><i>directory</i>] [<i>queue</i><b>_</b><i>name</i> ...] + +<b>DESCRIPTION</b> + The <b>qshape</b> program helps the administrator understand the Postfix queue + message distribution in time and by sender domain or recipient domain. + The program needs read access to the queue directories and queue files, + 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> + (typically <b>postfix</b>). + + Options: + + <b>-s</b> Display the sender domain distribution instead of the recipient + domain distribution. By default the recipient distribution is + displayed. There can be more recipients than messages, but as + each message has only one sender, the sender distribution is a + message distribution. + + <b>-p</b> Generate aggregate statistics for parent domains. Top level + domains are not shown, nor are domains with fewer than <i>min</i><b>_</b><i>sub-</i> + <i>domains</i> subdomains. The names of parent domains are shown with a + leading dot, (e.g. <i>.example.com</i>). + + <b>-m</b> <i>min</i><b>_</b><i>subdomains</i> + When used with the <b>-p</b> option, sets the minimum subdomain count + needed to show a separate line for a parent domain. The default + is 5. + + <b>-b</b> <i>bucket</i><b>_</b><i>count</i> + The age distribution is broken up into a sequence of geometri- + cally increasing intervals. This option sets the number of + intervals or "buckets". Each bucket has a maximum queue age that + is twice as large as that of the previous bucket. The last + bucket has no age limit. + + <b>-t</b> <i>bucket</i><b>_</b><i>time</i> + The age limit in minutes for the first time bucket. The default + value is 5, meaning that the first bucket counts messages + between 0 and 5 minutes old. + + <b>-l</b> Instead of using a geometric age sequence, use a linear age + sequence, in other words simple multiples of <b>bucket_time</b>. + + This feature is available in Postfix 2.2 and later. + + <b>-w</b> <i>terminal</i><b>_</b><i>width</i> + The output is right justified, with the counts for the last + bucket shown on the 80th column, the <i>terminal</i><b>_</b><i>width</i> can be + adjusted for wider screens allowing more buckets to be displayed + without truncating the domain names on the left. When a row for + a full domain name and its counters does not fit in the speci- + fied number of columns, only the last 17 bytes of the domain + name are shown with the prefix replaced by a '+' character. + Truncated parent domain rows are shown as '.+' followed by the + last 16 bytes of the domain name. If this is still too narrow to + show the domain name and all the counters, the terminal_width + limit is violated. + + <b>-N</b> <i>batch</i><b>_</b><i>msg</i><b>_</b><i>count</i> + When the output device is a terminal, intermediate results are + shown each "batch_msg_count" messages. This produces usable + results in a reasonable time even when the <a href="QSHAPE_README.html#deferred_queue">deferred queue</a> is + large. The default is to show intermediate results every 1000 + messages. + + <b>-n</b> <i>batch</i><b>_</b><i>top</i><b>_</b><i>domains</i> + When reporting intermediate or final results to a termainal, + report only the top "batch_top_domains" domains. The default + limit is 20 domains. + + <b>-c</b> <i>config</i><b>_</b><i>directory</i> + The <a href="postconf.5.html"><b>main.cf</b></a> configuration file is in the named directory instead + of the default configuration directory. + + Arguments: + + <i>queue</i><b>_</b><i>name</i> + By default <b>qshape</b> displays the combined distribution of the + incoming and <a href="QSHAPE_README.html#active_queue">active queues</a>. To display a different set of + queues, just list their directory names on the command line. + Absolute paths are used as is, other paths are taken relative to + 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> + supports the use of <i>$variable</i> expansion in the definition of the + <b><a href="postconf.5.html#queue_directory">queue_directory</a></b> parameter, the <b>qshape</b> program does not. If you + must use variable expansions in the <b><a href="postconf.5.html#queue_directory">queue_directory</a></b> setting, you + must specify an explicit absolute path for each queue subdirec- + 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- + tribution. + +<b>SEE ALSO</b> + <a href="mailq.1.html">mailq(1)</a>, List all messages in the queue. + <a href="QSHAPE_README.html">QSHAPE_README</a> Examples and background material. + +<b>FILES</b> + $<a href="postconf.5.html#config_directory">config_directory</a>/<a href="postconf.5.html">main.cf</a>, Postfix installation parameters. + $<a href="postconf.5.html#queue_directory">queue_directory</a>/maildrop/, local submission directory. + $<a href="postconf.5.html#queue_directory">queue_directory</a>/incoming/, new message queue. + $<a href="postconf.5.html#queue_directory">queue_directory</a>/hold/, messages waiting for tech support. + $<a href="postconf.5.html#queue_directory">queue_directory</a>/active/, messages scheduled for delivery. + $<a href="postconf.5.html#queue_directory">queue_directory</a>/deferred/, messages postponed for later delivery. + +<b>LICENSE</b> + The Secure Mailer license must be distributed with this software. + +<b>AUTHOR(S)</b> + Victor Duchovni + Morgan Stanley + + QSHAPE(1) +</pre> </body> </html> |