Add more details about -Bbeit options

[mimedecode.git] / mimedecode.docbook

diff --git a/mimedecode.docbook b/mimedecode.docbook
index 1060f4fc75b62503c56d296e02793a433d5dfc39..d61acaef38957d1dc203027ea23302cb717bb267 100644 (file)
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -404,9 +404,9 @@
       <listitem>
          <para>
             Append mask to the list of binary content types; if the message to
-            decode has a part of this type the program will
-            content-transfer-decode (base64 or whatever to 8bit binary) it but
-            pass the part as is, without any further processing.
+            decode has a part of this type the program content-transfer-decodes
+            (base64 or whatever to 8bit binary) it and outputs the decoded part
+            as is, without any further processing.
          </para>
       </listitem>
    </varlistentry>
@@ -425,9 +425,10 @@
       <term>-i mask</term>
       <listitem>
          <para>
-            Append mask to the list of content types to ignore; if the message to
-            decode has a part of this type the program will not pass it, instead
-            a line "Message body of type `%s' skipped." will be issued.
+            Append mask to the list of content types to ignore; if the message
+            to decode has a part of this type the program outputs headers but
+            skips the body. Instead a line "Message body of type %s skipped."
+            will be issued.
          </para>
       </listitem>
    </varlistentry>
@@ -437,9 +438,9 @@
       <listitem>
          <para>
             Append mask to the list of content types to convert to text; if the
-            message to decode has a part of this type the program will consult
-            mailcap database, find first copiousoutput filter and convert the
-            part.
+            message to decode has a part of this type the program consults
+            mailcap database, find the first copiousoutput filter and, if any
+            filter is found, converts the part.
          </para>
       </listitem>
    </varlistentry>
@@ -468,8 +469,8 @@
       <term>-O dest_dir</term>
       <listitem>
          <para>
-           Set destination directory for the output files; the directory must
-           exist. Default is current directory.
+           Set destination directory for the output files; if the directory
+           doesn't exist it will be created. Default is the current directory.
           </para>
       </listitem>
    </varlistentry>
@@ -491,21 +492,21 @@ cat input_file | mimedecode.py -o output_file</programlisting>
    The 5 list options (-Bbeit) require more explanation. They allow a user to
    control body decoding with great flexibility. Think about said mail archive;
    for example, its maintainer wants to put there only texts, convert
-   Postscript/PDF to text, pass HTML and images as is, and ignore everything
-   else. Easy:
+   PDF/Postscript to text, pass HTML and images as is (decoding base64 to html
+   but left images in base64), and ignore everything else. Easy:
 </para>
 
 <para>
 <code language="sh">
-   mimedecode.py -t application/postscript -t application/pdf -b text/html
-         -b 'image/*' -i '*/*'
+   mimedecode.py -t application/pdf -t application/postscript -b text/html
+         -B 'image/*' -i '*/*'
 </code>
 </para>
 
 <para>
    When the program decodes a message (non-MIME or a non-multipart subpart of a
    MIME message), it consults Content-Type header. The content type is searched
-   in all 4 lists, in order "text-binary-ignore-error". If found, appropriate
+   in all 5 lists, in order "text-binary-ignore-error". If found, appropriate
    action performed. If not found, the program search the same lists for
    "type/*" mask (the type of "text/html" is just "text"). If found,
    appropriate action performed. If not found, the program search the same
@@ -515,7 +516,7 @@ cat input_file | mimedecode.py -o output_file</programlisting>
 </para>
 
 <para>
-   Initially all 4 lists are empty, so without any additional parameters
+   Initially all 5 lists are empty, so without any additional parameters
 the program always uses the default decoding.
 </para>