X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=mimedecode.docbook;h=02ee7a5b3ccfaddacdbb87bd1c4eb1e7b51b330b;hb=d7aac25395b00e62c5c79160b81dbfcb58f14bcd;hp=555c5f2525be9d84e7dcf442bfce9cf585bfe835;hpb=1f2c7c40dca5b1937436c71d529d0b1f733302ce;p=mimedecode.git

diff --git a/mimedecode.docbook b/mimedecode.docbook
index 555c5f2..02ee7a5 100644
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -92,6 +92,9 @@
       <arg choice="opt">
          <option>-Bbeit mask</option>
       </arg>
+      <arg choice="opt">
+         <option>--save-headers|body|message mask</option>
+      </arg>
       <arg choice="opt">
          <option>-O dest_dir</option>
       </arg>
@@ -387,22 +390,23 @@
    </varlistentry>
 
    <varlistentry>
-      <term>-b mask</term>
+      <term>-B mask</term>
       <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 pass the part as is,
-            without any additional processing.
+           Append mask to the list of binary content types that will be not
+           content-transfer-decoded (will be left as base64 or such).
          </para>
       </listitem>
    </varlistentry>
 
    <varlistentry>
-      <term>-B mask</term>
+      <term>-b mask</term>
       <listitem>
          <para>
-           Append mask to the list of binary content types that will be not
-           content-transfer-decoded (will be left as base64 or such).
+            Append mask to the list of binary content types; if the message to
+            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>
@@ -421,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>
@@ -433,9 +438,29 @@
       <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>
+
+   <varlistentry>
+      <term>--save-headers mask</term>
+   </varlistentry>
+
+   <varlistentry>
+      <term>--save-body mask</term>
+   </varlistentry>
+
+   <varlistentry>
+      <term>--save-message mask</term>
+      <listitem>
+         <para>
+            Append mask to a list of content types to save to a file;
+            --save-headers saves only decoded headers of the message (or
+            subpart); --save-body saves only decoded body; --save-message saves
+            the entire message or subpart (headers + body).
          </para>
       </listitem>
    </varlistentry>
@@ -444,8 +469,8 @@
       <term>-O dest_dir</term>
       <listitem>
          <para>
-           Set destination directory for the output files. 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>
@@ -454,8 +479,8 @@
       <term>-o output_file</term>
       <listitem>
          <para>
-            Set the output file. Uses destination directory from option -O.
-            Also useful in case of redirected stdin:
+            Save output to the file related to the destination directory from
+            option -O. Also useful in case of redirected stdin:
             <programlisting language="sh">mimedecode.py -o output_file &lt; input_file
 cat input_file | mimedecode.py -o output_file</programlisting>
          </para>
@@ -467,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
@@ -491,9 +516,24 @@ 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>
+
+<para>
+  The 3 save options (--save-headers/body/message) are similar. They make the
+  program to save every non-multipart subpart (only headers, or body, or the
+  entire subpart: headers + body) that corresponds to the given mask to a file.
+  Before saving the message (or the subpart) is decoded according to all other
+  options and placed to the output stream as usual. Filename for the file is
+  created using "filename" parameter from the Content-Disposition header, or
+  "name" parameter from the Content-Type header if one of those exist; a serial
+  counter is prepended to the filename to avoid collisions; if there are no
+  name/filename parameters, or the name/filename parameters contain forbidden
+  characters (null, slash, backslash) the filename is just the serial counter.
+  The file is saved in the directory set with -O (default is the current
+  directory).
+</para>
 </refsect1>