debian/manpages/exiqsumm.8

   1 .\"                                      Hey, EMACS: -*- nroff -*-
   2 .\" First parameter, NAME, should be all caps
   3 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
   4 .\" other parameters are allowed: see man(7), man(1)
   5 .TH EXIQSUMM 8 "March 26, 2003"
   6 .\" Please adjust this date whenever revising the manpage.
   7 .\"
   8 .\" Some roff macros, for reference:
   9 .\" .nh        disable hyphenation
  10 .\" .hy        enable hyphenation
  11 .\" .ad l      left justify
  12 .\" .ad b      justify to both left and right margins
  13 .\" .nf        disable filling
  14 .\" .fi        enable filling
  15 .\" .br        insert line break
  16 .\" .sp <n>    insert n+1 empty lines
  17 .\" for manpage-specific macros, see man(7)
  18 .\" \(oqthis text is enclosed in single quotes\(cq
  19 .\" \(lqthis text is enclosed in double quotes\(rq
  20 .SH NAME
  21 exiqsumm \- Summarising the queue
  22 .SH SYNOPSIS
  23 .B exiqsumm
  24 .I [\-a] [\-c]
  25
  26 .SH DESCRIPTION
  27 The
  28 .B exiqsumm
  29 utility is a Perl script which reads the output of
  30 .I exim \-bp
  31 and produces a summary of the messages on the queue.
  32 Thus, you use it by running a command such as
  33
  34   exim \-bp | exiqsumm
  35
  36 The output consists of one line for each domain that has messages waiting
  37 for it, as in the following example:
  38
  39     3   2322   74m   66m  msn.com.example
  40
  41 This lists the number of messages for the domain, their total volume, and
  42 the length of time that the oldest and the newest messages have been
  43 waiting.
  44 By default the output is sorted on the domain name, but
  45 .B exiqsumm
  46 has the options
  47 .I \-a
  48 and
  49 .I \-c,
  50 which cause the output to be sorted by oldest message and by count of
  51 messages, respectively.
  52
  53 The output of
  54 .I exim \-bp
  55 contains the original addresses in the message, so this also applies to
  56 the output from
  57 .B exiqsumm.
  58 No domains from addresses generated by aliasing or forwarding are included
  59 (unless the \(lqone_time\(rq option of the redirect router has been used to
  60 convert them into \(oqtop level\(cq addresses).
  61
  62 .SH BUGS
  63 This manual page needs a major re-work. If somebody knows better groff
  64 than us and has more experience in writing manual pages, any patches
  65 would be greatly appreciated.
  66
  67 .SH SEE ALSO
  68 .BR exim (8),
  69 /usr/share/doc/exim4\-base/
  70
  71 .SH AUTHOR
  72 This manual page was stitched together from spec.txt by
  73 Andreas Metzler <ametzler at downhill.at.eu.org>,
  74 for the Debian GNU/Linux system (but may be used by others).