Browse Source

Fix some errors and do some cleanup in manpage.

Emmanuel Bouthenot 13 years ago
parent
commit
feb60fae50
2 changed files with 33 additions and 22 deletions
  1. 1 0
      CHANGELOG
  2. 32 22
      pmailq.pod

+ 1 - 0
CHANGELOG

@@ -6,6 +6,7 @@ ChangeLog
 Version 0.4 (2010-12-29):
     * Replace the usage of the deprecated popen2.Popen3() with
       subprocess.Popen().
+    * Fix some errors and do some cleanup in manpage.
 
 Version 0.3 (2010-01-31):
     * Fix dead lock while processing a large amount of datas in mail queue

+ 32 - 22
pmailq.pod

@@ -10,10 +10,11 @@ pmailq B<--help>
 
 =head1 DESCRIPTION
 
-pmailq parses output of B<mailq> command from postfix (ie: I<postqueue -p>) and permits
-to perform some actions (like removing or displaying in a machine readable format) on
-a bunch of entries in queue, selected by applying patterns on criterias like email
-address, error message from smtp server, message size, mail status in queue.
+pmailq parses output of B<mailq> command from postfix (ie: I<postqueue -p>). It
+permits to perform some actions (like removing or displaying in a machine
+readable format) on a group of entries in queue. They are selected by applying
+filters on criterias like email address, error message from SMTP server, message
+size, mail status in queue.
 
 =head1 COMMANDS
 
@@ -21,17 +22,19 @@ Action to perform on selected entries.
 
 =over 2
 
-=item B<list> (default command) 
+=item B<list> (default command)
 
-show a detailed listing of the selected entries
+Show a detailed listing of the selected entries.
 
-=item B<parse> 
+=item B<parse>
 
-show a listing of the selected entries in a machine readable format
+Show a listing of the selected entries in a machine readable format.
 
-=item B<del> 
+=item B<del>
 
-delete (via I<postsuper -d>) selected entries
+Delete (via I<postsuper -d>) selected entries.
+
+=back
 
 =head1 OPTIONS
 
@@ -39,52 +42,57 @@ delete (via I<postsuper -d>) selected entries
 
 =item B<-e> I<PATTERN>, B<--email>=I<PATTERN>
 
-select entries in queue with email matching PATTERN (PATTERN accepts wildcards)
+Select entries in queue with email matching PATTERN (PATTERN accepts wildcards).
 
 =item B<-m> I<PATTERN>, B<--msg>=I<PATTERN>
 
-select entries in queue with error message matching PATTERN (PATTERN accepts wildcards)
+Select entries in queue with error message matching PATTERN (PATTERN accepts
+wildcards).
 
 =item B<-l> I<SIZE>, B<--size-lower>=I<SIZE>
 
-select entries in queue with size lower than SIZE bytes
+Select entries in queue with size lower than SIZE bytes.
 
 =item B<-u> I<SIZE>, B<--size-upper>=I<SIZE>
 
-select entries in queue with size upper than SIZE bytes
+Select entries in queue with size upper than SIZE bytes.
 
 =item B<-a>
 
-select 'active' entries in queue
+Select 'active' entries in queue.
 
 =item B<-o>
 
-select 'on hold' entries in queue
+Select 'on hold' entries in queue.
 
 =item B<--version>
 
-show program's version number and exit
+Show program's version number and exit.
 
 =item B<-h>, B<--help>
 
-show this help message and exit
+Show this help message and exit.
+
+=back
 
 =head1 EXAMPLES
 
 =over 1
 
-Example n°1 : display all the mails in queue to "*@example.com*" with a size between 3000 and 3200 bytes in a machine readable format :
+Example 1: display all the entries in queue sent to an email address matching
+"*@example.com*" with a size between 3000 and 3200 bytes in a machine readable
+format:
 
  # pmailq -u 3000 -l 3200 -e "*@example.com" parse
  7E75214643A4|Fri Aug 31|3154|1|0|edgar@example.com
  B0BDE146B640|Thu Aug 30|3199|1|0|paul@example.com
  B587E146B675|Wed Aug 29|3065|0|0|paul@example.com
  CF3C514656E4|Wed Aug 29|3161|0|0|abuse@example.com
-      /\         /\       /\  \  \      
+      /\         /\       /\  \  \
    queue id     date     size  \  \ on hold (or not)
                                 \ active (or not)
 
-Example 2 : remove all mails in queue not sent because of a connection time out :
+Example 2: remove all mails in queue not sent because of a connection time out:
 
  # pmailq -m "*connection*timed*out" del
  deleting 00CF514616D3 [OK]
@@ -94,6 +102,8 @@ Example n°2 : remove all mails in queue not sent because of a connection time o
  deleting 3B3901460F62 [OK]
  deleting 3AE58147019F [OK]
 
+=back
+
 =head1 SEE ALSO
 
 L<postsuper(1)> privileged queue operations, L<postqueue(1)> mail queue control
@@ -104,7 +114,7 @@ Emmanuel Bouthenot <kolter@openics.org>
 
 =head1 COPYRIGHT AND LICENSE
 
-Copyright 2007 by Emmanuel Bouthenot <kolter@openics.org>
+Copyright 2007-2011 by Emmanuel Bouthenot <kolter@openics.org>
 
 This program is released under the "do What The Fuck you want to Public Licence"
 Version 2, as published by Sam Hocevar.