Pfqueue: Unterschied zwischen den Versionen

Aus Foxwiki
Keine Bearbeitungszusammenfassung
K Textersetzung - „== Syntax ==“ durch „== Aufruf ==“
 
(31 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 3: Zeile 3:


== Beschreibung ==
== Beschreibung ==
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'.
Verwaltung MTA (Mail Transfer Agent) Nachrichtenwarteschlangen
Currently,  pfqueue has backends for Postfix (both 1.x and 2.x) and Exim (both version 3 and 4).
 
; Backends
* Bibliotheken, die mit dem MTA interagieren
* zeigt Informationen über eine Konsole, ein ncurses-basiertes "Frontend", an.
 
Derzeit hat pfqueue Backends für
* Postfix (sowohl 1.x als auch 2.x)
* Exim (sowohl Version 3 als auch 4)


== Installation ==
== Installation ==
== Syntax ==
'''root@debian ~ #''' apt install pfqueue
== SYNOPSIS ==  
 
  pfqueue [-ehvn] [-b postfix1|postfix2|exim] [-q queue#] [-m maxmsg]  [-s seconds] [-l seconds] [-B backends_path] [-p executables_path] [-c config_path] [-d seconds]
== Aufruf ==
  '''root@debian ~ # ''' pfqueue [-ehvn] [-b postfix1|postfix2|exim] [-q queue#] [-m maxmsg]  [-s seconds] [-l seconds] [-B backends_path] [-p executables_path] [-c config_path] [-d seconds]


=== Parameter ===
=== Parameter ===
Zeile 15: Zeile 23:
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 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.
{| class="wikitable sortable options"
 
|-
-b backend Load a given backend. It can be autodetect, postfix1, postfix2 or  exim.
! Option !! Beschreibung
|-
| -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‐
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‐
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 machine, and to load the proper backend).
chine, and to load the proper backend).
|-
 
| -v || Show version.
-v     Show version.
|-
 
| -h || Show usage.
-h     Show usage.
|-
 
| -c config || Use a custom MTA configuration; note that the meaning of 'configuration'
-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.
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  active,  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 retreiving  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  performing  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.
|}


-m max Set the maximum number of messages shown in a queue. The default is 200.
=== Umgebung ===
 
=== Rückgabewert ===
-s seconds Set the display autorefresh rate in seconds. Default is 1.
-0 everything goes fine, or:
 
  -1 pfqueue library cannot be initialized
-e    Start  reading  from/to fields from message envelope instead of headers,
  -2 frontend cannot be initialized
if the backend (and MTA) supports it.
  -3 you are not root
 
  -4 pfqueue library cannot be started
-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.
 
=== Umgebungsvariablen ===
=== 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


== Konfiguration ==
== Konfiguration ==
=== Dateien ===
=== Dateien ===


== Anwendungen ==
== Anwendung ==
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 upper 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.
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.
UP/DOWN arrow keys Move the cursor up/down.


HOME/END or g/G Move to the top/bottom of the list.
HOME/END or g/G 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 are general keys that cannot be generically described. For Postfix, they will  select  respectively  'deferred', 'active', 'incoming', 'hold' and
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
'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‐
ing on their status.
ing on their status.


d      Delete message.
d      Delete message.


h      Hold message.
h      Hold message.


l      Release message.
l      Release message.


r      Requeue 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‐
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.
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
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.
(see above) is present, all messages between the tagged and  the  marked will be tagged.


a      Tag all messages.
a      Tag all messages.


u      Untag all messages.
u      Untag all messages.


;      Make  delete/hold/release/requeue actions work on all of the tagged mes‐
;      Make  delete/hold/release/requeue actions work on all of the tagged mes‐
Zeile 144: Zeile 150:
== Dokumentation ==
== Dokumentation ==
=== RFC ===
=== RFC ===
=== Man-Pages ===
=== Man-Page ===
# PFQUEUE(8)
# PFQUEUE(8)
=== Info-Pages ===
=== Info-Pages ===
Zeile 150: Zeile 156:


== Links ==
== Links ==
=== Projekt-Homepage ===
=== Projekt ===
=== Weblinks ===
=== Weblinks ===
=== Einzelnachweise ===
<references />


== Testfragen ==
 
<div class="toccolours mw-collapsible mw-collapsed">
 
''Testfrage 1''
[[Kategorie:Linux/Befehl]]
<div class="mw-collapsible-content">'''Antwort1'''</div>
[[Kategorie:Postfix/Verwaltung]]
</div>
<div class="toccolours mw-collapsible mw-collapsed">
''Testfrage 2''
<div class="mw-collapsible-content">'''Antwort2'''</div>
</div>
<div class="toccolours mw-collapsible mw-collapsed">
''Testfrage 3''
<div class="mw-collapsible-content">'''Antwort3'''</div>
</div>
<div class="toccolours mw-collapsible mw-collapsed">
''Testfrage 4''
<div class="mw-collapsible-content">'''Antwort4'''</div>
</div>
<div class="toccolours mw-collapsible mw-collapsed">
''Testfrage 5''
<div class="mw-collapsible-content">'''Antwort5'''</div>
</div>
[[Kategorie:Entwurf]]
[[Kategorie:Linux:Befehl]]
[[Kategorie:Postfix:Verwaltung]]

Aktuelle Version vom 12. November 2024, 18:47 Uhr

pfqueue - queue realtime scanner for MTA

Beschreibung

Verwaltung MTA (Mail Transfer Agent) Nachrichtenwarteschlangen

Backends
  • Bibliotheken, die mit dem MTA interagieren
  • zeigt Informationen über eine Konsole, ein ncurses-basiertes "Frontend", an.

Derzeit hat pfqueue Backends für

  • Postfix (sowohl 1.x als auch 2.x)
  • Exim (sowohl Version 3 als auch 4)

Installation

root@debian ~ # apt install pfqueue

Aufruf

root@debian ~ #  pfqueue [-ehvn] [-b postfix1|postfix2|exim] [-q queue#] [-m maxmsg]  [-s seconds] [-l seconds] [-B backends_path] [-p executables_path] [-c config_path] [-d seconds]

Parameter

Optionen

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

Option Beschreibung
-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 machine, 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 active, 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 retreiving 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 performing 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.

Umgebung

Rückgabewert

-0 everything goes fine, or:
-1 pfqueue library cannot be initialized
-2 frontend cannot be initialized
-3 you are not root
-4 pfqueue library cannot be started

Konfiguration

Dateien

Anwendung

During program run, what you see is a window divided into two sections: the upper 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.

Sicherheit

Dokumentation

RFC

Man-Page

  1. PFQUEUE(8)

Info-Pages

Siehe auch

Links

Projekt

Weblinks