Pfqueue: Unterschied zwischen den Versionen

Aus Foxwiki
Keine Bearbeitungszusammenfassung
Zeile 53: Zeile 53:
PFQUEUE(8)                      System Manager's Manual                    PFQUEUE(8)
PFQUEUE(8)                      System Manager's Manual                    PFQUEUE(8)


NAME
== NAME ==


SYNOPSIS
== SYNOPSIS ==
pfqueue  [-ehvn] [-b postfix1|postfix2|exim] [-q queue#] [-m maxmsg]  [-s sec‐
pfqueue  [-ehvn] [-b postfix1|postfix2|exim] [-q queue#] [-m maxmsg]  [-s sec‐
onds] [-l seconds] [-B backends_path]            [-p executables_path] [-c con‐
onds] [-l seconds] [-B backends_path]            [-p executables_path] [-c con‐
fig_path] [-d seconds]
fig_path] [-d seconds]


DESCRIPTION
== DESCRIPTION ==
pfqueue is a simple console tool for managing MTA (Mail Transfer Agent) message
pfqueue is a simple console tool for managing MTA (Mail Transfer Agent) message queues. It handles queues through 'backends', libraries that interact with  the MTA, and displays informations through a console, ncurses based 'frontend'.
queues. It handles queues through 'backends', libraries that interact with  the
Currently,  pfqueue  has backends for Postfix (both 1.x and 2.x) and Exim (both version 3 and 4).
MTA, and displays informations through a console, ncurses based 'frontend'.
Currently,  pfqueue  has backends for Postfix (both 1.x and 2.x) and Exim (both
version 3 and 4).


EXIT STATUS
== EXIT STATUS ==
pfqueue returns 0 if everything goes fine, or:
pfqueue returns 0 if everything goes fine, or:


Zeile 78: Zeile 75:
-4 if pfqueue library cannot be started
-4 if pfqueue library cannot be started


OPTIONS
== OPTIONS ==
pfqueue accepts the following options, which are common to any backend:
pfqueue accepts the following options, which are common to any backend:


-B backends_path
-B backends_path Tell pfqueue where backends are located. They  should  be  automatically found, since your installation should have placed them in a standard lib dir. If not so, use this option to force it.
Tell pfqueue where backends are located. They  should  be  automatically
found, since your installation should have placed them in a standard lib
dir. If not so, use this option to force it.


-b backend
-b backend Load a given backend. It can be autodetect, postfix1, postfix2 or  exim.
Load a given backend. It can be autodetect, postfix1, postfix2 or  exim.
Backends  are libraries named pfq_backendname.so, located in the instal‐
Backends  are libraries named pfq_backendname.so, located in the instal‐
lation library path (except for autodetect,  which  is  only  a  virtual
lation library path (except for autodetect,  which  is  only  a  virtual backend  that will try to guess what kind of MTA is installed on the ma‐
backend  that will try to guess what kind of MTA is installed on the ma‐
chine, and to load the proper backend).
chine, and to load the proper backend).


Zeile 97: Zeile 89:
-h    Show usage.
-h    Show usage.


-c config
-c config Use a custom MTA configuration; note that the meaning of 'configuration'
Use a custom MTA configuration; note that the meaning of 'configuration'
may vary: for example, postfix needs a directory, exim needs a file.
may vary: for example, postfix needs a directory, exim needs a file.


-m max Set the maximum number of messages shown in a queue. The default is 200.
-m max Set the maximum number of messages shown in a queue. The default is 200.


-s seconds
-s seconds Set the display autorefresh rate in seconds. Default is 1.
Set the display autorefresh rate in seconds. Default is 1.


-e    Start  reading  from/to fields from message envelope instead of headers,
-e    Start  reading  from/to fields from message envelope instead of headers,
if the backend (and MTA) supports it.
if the backend (and MTA) supports it.


-p directory
-p directory Set MTA executables path.
Set MTA executables path.


-q queue_num
-q queue_num Start by scanning the queue number queue_num: 1 for deferred, 2 for  ac‐
Start by scanning the queue number queue_num: 1 for deferred, 2 for  ac‐
tive,  3  for  incoming,  4  for hold, whatever the MTA calls them. Some backends may not support all of these queues.
tive,  3  for  incoming,  4  for hold, whatever the MTA calls them. Some
backends may not support all of these queues.


-l limit
-l limit Make pfqueue limit the time for scanning the queue tree and for retreiv‐
Make pfqueue limit the time for scanning the queue tree and for retreiv‐
ing  messages  informations  to this number of seconds; time is not that accurate, since blocking I/O operations may cause lags, but it shouldn't go too far.  Obviously, limiting process run time may lead to uncomplete results.  Use this option just in case pfqueue takes too  long  in  per‐
ing  messages  informations  to this number of seconds; time is not that
forming  operations,  or  you have a very slow machine, or you have very busy queues.
accurate, since blocking I/O operations may cause lags, but it shouldn't
go too far.  Obviously, limiting process run time may lead to uncomplete
results.  Use this option just in case pfqueue takes too  long  in  per‐
forming  operations,  or  you have a very slow machine, or you have very
busy queues.


-d seconds
-d seconds Seconds to wait between queue scans. Default is 1.
Seconds to wait between queue scans. Default is 1.


-n    Toggle colors off; note that use of colors  can  be  toggled  also  when
-n    Toggle colors off; note that use of colors  can  be  toggled  also  when pfqueue is running, with '+' key.
pfqueue is running, with '+' key.


-r    Remote  host  to connect to. This implies a spfqueue instance running on
-r    Remote  host  to connect to. This implies a spfqueue instance running on the remote host.
the remote host.


USAGE
== USAGE ==
During program run, what you see is a window divided into two sections: the up‐
During program run, what you see is a window divided into two sections: the up‐
per  one  is the list of messages found in the current queue, and the lower one
per  one  is the list of messages found in the current queue, and the lower one is a small selection of details for the current message.
is a small selection of details for the current message.
A number of operation can then be done on a single message, or on  a  bunch  of selected messages.
A number of operation can then be done on a single message, or on  a  bunch  of
selected messages.


UP/DOWN arrow keys
UP/DOWN arrow keys Move the cursor up/down.
Move the cursor up/down.


HOME/END or g/G
HOME/END or g/G Move to the top/bottom of the list.
Move to the top/bottom of the list.


1, 2, 3, 4, 5
1, 2, 3, 4, 5
Select  queue to show. Every MTA handles queues in its own way, so these
Select  queue to show. Every MTA handles queues in its own way, so these are general keys that cannot be generically described. For Postfix, they will  select  respectively  'deferred', 'active', 'incoming', 'hold' and
are general keys that cannot be generically described. For Postfix, they
will  select  respectively  'deferred', 'active', 'incoming', 'hold' and
'corrupt' queues. For Exim, they will have no effect since  the  backend
'corrupt' queues. For Exim, they will have no effect since  the  backend
(and Exim, really) does not archive messages in different queues depend‐
(and Exim, really) does not archive messages in different queues depend‐
Zeile 164: Zeile 137:
r      Requeue message.
r      Requeue message.


m      Mark current message: this will "mark" the message as  the  start  of  a
m      Mark current message: this will "mark" the message as  the  start  of  a block,  and  the following 't' key (see below) will tag all messages be‐
block,  and  the following 't' key (see below) will tag all messages be‐
tween that and the tagged one.
tween that and the tagged one.


t      Tag/untag message; tagged messages will be shown in bold. To operate  on
t      Tag/untag message; tagged messages will be shown in bold. To operate  on all  the  tagged  messages  at once, use ';' key (see below).  If a mark
all  the  tagged  messages  at once, use ';' key (see below).  If a mark
(see above) is present, all messages between the tagged and  the  marked will be tagged.
(see above) is present, all messages between the tagged and  the  marked
will be tagged.


a      Tag all messages.
a      Tag all messages.
Zeile 184: Zeile 154:
tus (';' key).
tus (';' key).


e      Toggle reading from/to fields from envelope or headers, if  the  backend
e      Toggle reading from/to fields from envelope or headers, if  the  backend supports it.
supports it.


s      Show current message details.
s      Show current message details.


/      Find  first  message  matching a POSIX regexp; the regexp you use can be
/      Find  first  message  matching a POSIX regexp; the regexp you use can be prefixed by one of f:, t:, e:, s: which will limit the  search  in,  re‐
prefixed by one of f:, t:, e:, s: which will limit the  search  in,  re‐
spectively,  the From, To, From-or-To, Subject fields. The default is to search everywhere.
spectively,  the From, To, From-or-To, Subject fields. The default is to
search everywhere.


n      Find next message matching last used regexp.
n      Find next message matching last used regexp.
Zeile 198: Zeile 165:
p      Find previous message matching last used regexp.
p      Find previous message matching last used regexp.


T      Search and tag messages:  all  messages  matching  the  regexp  will  be
T      Search and tag messages:  all  messages  matching  the  regexp  will  be tagged; the same prefixes described in '/' search can be used.
tagged; the same prefixes described in '/' search can be used.


c      Enable/disable confirmation request for action on messages.
c      Enable/disable confirmation request for action on messages.


-      Toggle queue scanning on/off. Use it when you have a fast changing situ‐
-      Toggle queue scanning on/off. Use it when you have a fast changing situ‐
ation and you want to freeze it for further examination. Note that  then
ation and you want to freeze it for further examination. Note that  then scanning  is  disabled,  the  messages you see in the list may have gone away (delivered?) in the meantime.
scanning  is  disabled,  the  messages you see in the list may have gone
away (delivered?) in the meantime.


+      Toggle colors on/off.
+      Toggle colors on/off.
Zeile 227: Zeile 191:
face, since the full queue must be read in order to be sorted.
face, since the full queue must be read in order to be sorted.


ENTER  Show  body of current message (if automatic show is off): if body window
ENTER  Show  body of current message (if automatic show is off): if body window is not enabled, it behaves like 's' key.
is not enabled, it behaves like 's' key.


AUTHOR
== AUTHOR ==
Stefano Rivoir <s.rivoir@gts.it>
Stefano Rivoir <s.rivoir@gts.it>


HISTORY
== HISTORY ==
pfqueue was originally thought as a dedicated Postfix tool, and actually it has
pfqueue was originally thought as a dedicated Postfix tool, and actually it has been  so  up  to version 0.3.8; since version 0.4.0 it has been extended to use pluggable libraries in order to support virtually any kind of MTA.
been  so  up  to version 0.3.8; since version 0.4.0 it has been extended to use
pluggable libraries in order to support virtually any kind of MTA.


January 19, 2007                        PFQUEUE(8)
January 19, 2007                        PFQUEUE(8)
[[Kategorie:Entwurf]]
[[Kategorie:Postfix:Verwaltung]]
{{DEFAULTSORT:pfqueue}}

Version vom 9. Juli 2022, 11:06 Uhr


topic kurze Beschreibung

Beschreibung

Installation

Syntax

Parameter

Optionen

Umgebungsvariablen

Exit-Status

Konfiguration

Dateien

Anwendungen

Sicherheit

Dokumentation

RFC

Man-Pages

Info-Pages

Siehe auch

Links

Projekt-Homepage

Weblinks

Einzelnachweise


Testfragen

Testfrage 1

Antwort1

Testfrage 2

Antwort2

Testfrage 3

Antwort3

Testfrage 4

Antwort4

Testfrage 5

Antwort5

Manpage

PFQUEUE(8) System Manager's Manual PFQUEUE(8)

NAME

SYNOPSIS

pfqueue [-ehvn] [-b postfix1|postfix2|exim] [-q queue#] [-m maxmsg] [-s sec‐ onds] [-l seconds] [-B backends_path] [-p executables_path] [-c con‐ fig_path] [-d seconds]

DESCRIPTION

pfqueue is a simple console tool for managing MTA (Mail Transfer Agent) message queues. It handles queues through 'backends', libraries that interact with the MTA, and displays informations through a console, ncurses based 'frontend'. Currently, pfqueue has backends for Postfix (both 1.x and 2.x) and Exim (both version 3 and 4).

EXIT STATUS

pfqueue returns 0 if everything goes fine, or:

-1 if pfqueue library cannot be initialized

-2 if frontend cannot be initialized

-3 if you are not root

-4 if pfqueue library cannot be started

OPTIONS

pfqueue accepts the following options, which are common to any backend:

-B backends_path Tell pfqueue where backends are located. They should be automatically found, since your installation should have placed them in a standard lib dir. If not so, use this option to force it.

-b backend Load a given backend. It can be autodetect, postfix1, postfix2 or exim. Backends are libraries named pfq_backendname.so, located in the instal‐ lation library path (except for autodetect, which is only a virtual backend that will try to guess what kind of MTA is installed on the ma‐ chine, and to load the proper backend).

-v Show version.

-h Show usage.

-c config Use a custom MTA configuration; note that the meaning of 'configuration' may vary: for example, postfix needs a directory, exim needs a file.

-m max Set the maximum number of messages shown in a queue. The default is 200.

-s seconds Set the display autorefresh rate in seconds. Default is 1.

-e Start reading from/to fields from message envelope instead of headers, if the backend (and MTA) supports it.

-p directory Set MTA executables path.

-q queue_num Start by scanning the queue number queue_num: 1 for deferred, 2 for ac‐ tive, 3 for incoming, 4 for hold, whatever the MTA calls them. Some backends may not support all of these queues.

-l limit Make pfqueue limit the time for scanning the queue tree and for retreiv‐ ing messages informations to this number of seconds; time is not that accurate, since blocking I/O operations may cause lags, but it shouldn't go too far. Obviously, limiting process run time may lead to uncomplete results. Use this option just in case pfqueue takes too long in per‐ forming operations, or you have a very slow machine, or you have very busy queues.

-d seconds Seconds to wait between queue scans. Default is 1.

-n Toggle colors off; note that use of colors can be toggled also when pfqueue is running, with '+' key.

-r Remote host to connect to. This implies a spfqueue instance running on the remote host.

USAGE

During program run, what you see is a window divided into two sections: the up‐ per one is the list of messages found in the current queue, and the lower one is a small selection of details for the current message. A number of operation can then be done on a single message, or on a bunch of selected messages.

UP/DOWN arrow keys Move the cursor up/down.

HOME/END or g/G Move to the top/bottom of the list.

1, 2, 3, 4, 5 Select queue to show. Every MTA handles queues in its own way, so these are general keys that cannot be generically described. For Postfix, they will select respectively 'deferred', 'active', 'incoming', 'hold' and 'corrupt' queues. For Exim, they will have no effect since the backend (and Exim, really) does not archive messages in different queues depend‐ ing on their status.

d Delete message.

h Hold message.

l Release message.

r Requeue message.

m Mark current message: this will "mark" the message as the start of a block, and the following 't' key (see below) will tag all messages be‐ tween that and the tagged one.

t Tag/untag message; tagged messages will be shown in bold. To operate on all the tagged messages at once, use ';' key (see below). If a mark (see above) is present, all messages between the tagged and the marked will be tagged.

a Tag all messages.

u Untag all messages.

Make delete/hold/release/requeue actions work on all of the tagged mes‐

sages at once.

Toggle auto-work-on-tagged: when activated, and if there are tagged mes‐

sages, actions will work on tagged indipendently of work-on-tagged sta‐ tus (';' key).

e Toggle reading from/to fields from envelope or headers, if the backend supports it.

s Show current message details.

/ Find first message matching a POSIX regexp; the regexp you use can be prefixed by one of f:, t:, e:, s: which will limit the search in, re‐ spectively, the From, To, From-or-To, Subject fields. The default is to search everywhere.

n Find next message matching last used regexp.

p Find previous message matching last used regexp.

T Search and tag messages: all messages matching the regexp will be tagged; the same prefixes described in '/' search can be used.

c Enable/disable confirmation request for action on messages.

- Toggle queue scanning on/off. Use it when you have a fast changing situ‐ ation and you want to freeze it for further examination. Note that then scanning is disabled, the messages you see in the list may have gone away (delivered?) in the meantime.

+ Toggle colors on/off.

> Increase body window height.

< Decrease body window height.

, Scroll body window up.

b Show/hide body window.

. Scroll body window down.

B Toggle body automatic show on/off.

s Show body in a new window.

S Sort queue by from/to/subject. Keep in mind that it may slow down inter‐ face, since the full queue must be read in order to be sorted.

ENTER Show body of current message (if automatic show is off): if body window is not enabled, it behaves like 's' key.

AUTHOR

Stefano Rivoir <s.rivoir@gts.it>

HISTORY

pfqueue was originally thought as a dedicated Postfix tool, and actually it has been so up to version 0.3.8; since version 0.4.0 it has been extended to use pluggable libraries in order to support virtually any kind of MTA.

January 19, 2007 PFQUEUE(8)