1PFQUEUE(1) General Commands Manual PFQUEUE(1)
2
6 pfqueue - A queue realtime scanner for MTA
7
9 pfqueue [-ehvn] [-b postfix1|postfix2|exim] [-q queue#] [-m maxmsg]
10 [-s seconds] [-l seconds] [-B backends_path] [-p executa‐
11 bles_path] [-c config_path] [-d seconds]
12
15 pfqueue is a simple console tool for managing MTA (Mail Transfer Agent)
16 message queues. It handles queues through 'backends', libraries that
17 interact with the MTA, and displays informations through a console,
18 ncurses based 'frontend'.
19 Currently, pfqueue has backends for Postfix (both 1.x and 2.x) and Exim
20 (both version 3 and 4).
21
24 pfqueue returns 0 if everything goes fine, or:
25 -1 if pfqueue library cannot be initialized
27 -2 if frontend cannot be initialized
29 -3 if you are not root
31 -4 if pfqueue library cannot be started
33
36 pfqueue accepts the following options, which are common to any backend:
37 -B backends_path
39 Tell pfqueue where backends are located. They should be automat‐
40 ically found, since your installation should have placed them in
41 a standard lib dir. If not so, use this option to force it.
42 -b backend
44 Load a given backend. It can be autodetect, postfix1, postfix2
45 or exim. Backends are libraries named pfq_backendname.so,
46 located in the installation library path (except for autodetect,
47 which is only a virtual backend that will try to guess what kind
48 of MTA is installed on the machine, and to load the proper back‐
49 end).
50 -v Show version.
52 -h Show usage.
54 -c config
56 Use a custom MTA configuration; note that the meaning of 'con‐
57 figuration' may vary: for example, postfix needs a directory,
58 exim needs a file.
59 -m max Set the maximum number of messages shown in a queue. The default
61 is 200.
62 -s seconds
64 Set the display autorefresh rate in seconds. Default is 1.
65 -e Start reading from/to fields from message envelope instead of
67 headers, if the backend (and MTA) supports it.
68 -p directory
70 Set MTA executables path.
71 -q queue_num
73 Start by scanning the queue number queue_num: 1 for deferred, 2
74 for active, 3 for incoming, 4 for hold, whatever the MTA calls
75 them. Some backends may not support all of these queues.
76 -l limit
78 Make pfqueue limit the time for scanning the queue tree and for
79 retreiving messages informations to this number of seconds; time
80 is not that accurate, since blocking I/O operations may cause
81 lags, but it shouldn't go too far. Obviously, limiting process
82 run time may lead to uncomplete results. Use this option just
83 in case pfqueue takes too long in performing operations, or you
84 have a very slow machine, or you have very busy queues.
85 -d seconds
87 Seconds to wait between queue scans. Default is 1.
88 -n Toggle colors off; note that use of colors can be toggled also
90 when pfqueue is running, with '+' key.
91 -r Remote host to connect to. This implies a spfqueue instance run‐
93 ning on the remote host.
94
96 During program run, what you see is a window divided into two sections:
97 the upper one is the list of messages found in the current queue, and
98 the lower one is a small selection of details for the current message.
99 A number of operation can then be done on a single message, or on a
100 bunch of selected messages.
101 UP/DOWN arrow keys
103 Move the cursor up/down.
104 HOME/END or g/G
106 Move to the top/bottom of the list.
107 1, 2, 3, 4, 5
109 Select queue to show. Every MTA handles queues in its own way,
110 so these are general keys that cannot be generically described.
111 For Postfix, they will select respectively 'deferred', 'active',
112 'incoming', 'hold' and 'corrupt' queues. For Exim, they will
113 have no effect since the backend (and Exim, really) does not ar‐
114 chive messages in different queues depending on their status.
115 d Delete message.
117 h Hold message.
119 l Release message.
121 r Requeue message.
123 m Mark current message: this will "mark" the message as the start
125 of a block, and the following 't' key (see below) will tag all
126 messages between that and the tagged one.
127 t Tag/untag message; tagged messages will be shown in bold. To
129 operate on all the tagged messages at once, use ';' key (see
130 below). If a mark (see above) is present, all messages between
131 the tagged and the marked will be tagged.
132 a Tag all messages.
134 u Untag all messages.
136 ; Make delete/hold/release/requeue actions work on all of the
138 tagged messages at once.
139 : Toggle auto-work-on-tagged: when activated, and if there are
141 tagged messages, actions will work on tagged indipendently of
142 work-on-tagged status (';' key).
143 e Toggle reading from/to fields from envelope or headers, if the
145 backend supports it.
146 s Show current message details.
148 / Find first message matching a POSIX regexp; the regexp you use
150 can be prefixed by one of f:, t:, e:, s: which will limit the
151 search in, respectively, the From, To, From-or-To, Subject
152 fields. The default is to search everywhere.
153 n Find next message matching last used regexp.
155 p Find previous message matching last used regexp.
157 T Search and tag messages: all messages matching the regexp will
159 be tagged; the same prefixes described in '/' search can be
160 used.
161 c Enable/disable confirmation request for action on messages.
163 - Toggle queue scanning on/off. Use it when you have a fast chang‐
165 ing situation and you want to freeze it for further examination.
166 Note that then scanning is disabled, the messages you see in the
167 list may have gone away (delivered?) in the meantime.
168 + Toggle colors on/off.
170 > Increase body window height.
172 < Decrease body window height.
174 , Scroll body window up.
176 b Show/hide body window.
178 . Scroll body window down.
180 B Toggle body automatic show on/off.
182 s Show body in a new window.
184 S Sort queue by from/to/subject. Keep in mind that it may slow
186 down interface, since the full queue must be read in order to be
187 sorted.
188 ENTER Show body of current message (if automatic show is off): if body
190 window is not enabled, it behaves like 's' key.
191
193 Stefano Rivoir <s.rivoir@gts.it>
194
196 pfqueue was originally thought as a dedicated Postfix tool, and actu‐
197 ally it has been so up to version 0.3.8; since version 0.4.0 it has
198 been extended to use pluggable libraries in order to support virtually
199 any kind of MTA.
200 January 19, 2007 PFQUEUE(1)