X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=mimedecode.docbook;h=58ca08d5b2cabbf342ffc8dde8ffca9d975c50dd;hb=41e92ab685cbcf842d1c4f33b8b29f94193938ed;hp=8a939f68e0aec30ebbe1f0821398eeb5c4f5648b;hpb=cb1f0763841bbeced908b053960baf228b692ca1;p=mimedecode.git

diff --git a/mimedecode.docbook b/mimedecode.docbook
index 8a939f6..58ca08d 100644
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -90,7 +90,13 @@
          <option>--set-param header:param=value</option>
       </arg>
       <arg choice="opt">
-         <option>-beit mask</option>
+         <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>
       <arg choice="opt">
          <option>-o output_file</option>
@@ -383,13 +389,24 @@
       </listitem>
    </varlistentry>
 
+   <varlistentry>
+      <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).
+         </para>
+      </listitem>
+   </varlistentry>
+
    <varlistentry>
       <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.
+            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.
          </para>
       </listitem>
    </varlistentry>
@@ -427,11 +444,42 @@
       </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>
+
+   <varlistentry>
+      <term>-O dest_dir</term>
+      <listitem>
+         <para>
+           Set destination directory for the output files; if the directory
+           doesn't exist it will be created. Default is current directory.
+          </para>
+      </listitem>
+   </varlistentry>
+
    <varlistentry>
       <term>-o output_file</term>
       <listitem>
          <para>
-            Useful to set the output file 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>
@@ -440,24 +488,24 @@ cat input_file | mimedecode.py -o output_file</programlisting>
 </variablelist>
 
 <para>
-   The 4 list options (-beit) require more explanation. They allow a user to
+   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
@@ -467,9 +515,22 @@ 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 list 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) 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, the filename is just the serial counter. The file
+  is saved in the directory set with -O (default is the current directory).
+</para>
 </refsect1>