Better description for -b

[mimedecode.git] / mimedecode.docbook

diff --git a/mimedecode.docbook b/mimedecode.docbook
index 555c5f2525be9d84e7dcf442bfce9cf585bfe835..24691aded1acbde80a05791d136092c33135d7a8 100644 (file)
--- 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 will
+            content-transfer-decode (base64 or whatever to 8bit binary) it but
+            pass the part as is, without any further processing.
          </para>
       </listitem>
    </varlistentry>
@@ -440,12 +444,32 @@
       </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).
+         </para>
+      </listitem>
+   </varlistentry>
+
    <varlistentry>
       <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; the directory must
+           exist. Default is current directory.
           </para>
       </listitem>
    </varlistentry>
@@ -454,8 +478,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>
@@ -494,6 +518,19 @@ cat input_file | mimedecode.py -o output_file</programlisting>
    Initially all 4 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>