NetBSD/gnu/dist/postfix/man/man1/qshape.1

.\"	$NetBSD: qshape.1,v 1.1.1.3 2005/08/18 21:03:50 rpaulo Exp $
.\"
.TH QSHAPE 1 
.ad
.fi
.SH NAME
qshape
\-
Print Postfix queue domain and age distribution
.SH "SYNOPSIS"
.na
.nf
.fi
\fBqshape\fR [\fB-s\fR] [\fB-p\fR] [\fB-m \fImin_subdomains\fR]
        [\fB-b \fIbucket_count\fR] [\fB-t \fIbucket_time\fR]
        [\fB-l\fR] [\fB-w \fIterminal_width\fR]
        [\fB-c \fIconfig_directory\fR] [\fIqueue_name\fR ...]
.SH DESCRIPTION
.ad
.fi
The \fBqshape\fR 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 \fBmail_owner\fR specified in \fImain.cf\fR (typically
\fBpostfix\fR).

Options:
.IP \fB-s\fR
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.
.IP \fB-p\fR
Generate aggregate statistics for parent domains. Top level domains
are not shown, nor are domains with fewer than \fImin_subdomains\fR
subdomains. The names of parent domains are shown with a leading dot,
(e.g. \fI.example.com\fR).
.IP "\fB-m \fImin_subdomains\fR"
When used with the \fB-p\fR option, sets the minimum subdomain count
needed to show a separate line for a parent domain. The default is 5.
.IP "\fB-b \fIbucket_count\fR"
The age distribution is broken up into a sequence of geometrically
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.
.IP "\fB-t \fIbucket_time\fR"
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.
.IP "\fB-l\fR"
Instead of using a geometric age sequence, use a linear age sequence,
in other words simple multiples of \fBbucket_time\fR.

This feature is available in Postfix 2.2 and later.
.IP "\fB-w \fIterminal_width\fR"
The output is right justified, with the counts for the last
bucket shown on the 80th column, the \fIterminal_width\fR 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 specified
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.
.IP "\fB-c \fIconfig_directory\fR"
The \fBmain.cf\fR configuration file is in the named directory
instead of the default configuration directory.
.PP
Arguments:
.IP \fIqueue_name\fR
By default \fBqshape\fR displays the combined distribution of
the incoming and active queues. 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 \fImain.cf\fR \fBqueue_directory\fR parameter setting.
While \fImain.cf\fR supports the use of \fI$variable\fR expansion
in the definition of the \fBqueue_directory\fR parameter, the
\fBqshape\fR program does not. If you must use variable expansions
in the \fBqueue_directory\fR setting, you must specify an explicit
absolute path for each queue subdirectory even if you want the
default incoming and active queue distribution.
.SH "SEE ALSO"
.na
.nf
mailq(1), List all messages in the queue.
QSHAPE_README Examples and background material.
.SH "FILES"
.na
.nf
$config_directory/main.cf, Postfix installation parameters.
$queue_directory/maildrop/, local submission directory.
$queue_directory/incoming/, new message queue.
$queue_directory/hold/, messages waiting for tech support.
$queue_directory/active/, messages scheduled for delivery.
$queue_directory/deferred/, messages postponed for later delivery.
.SH "LICENSE"
.na
.nf
.ad
.fi
The Secure Mailer license must be distributed with this software.
.SH "AUTHOR(S)"
.na
.nf
Victor Duchovni
Morgan Stanley