Document that the directory for -O must exist

[mimedecode.git] / mimedecode.docbook

diff --git a/mimedecode.docbook b/mimedecode.docbook
index 86e84a6d316b348049efd8b3519e935b1d1daa69..53a547b41c88cfa9d8f89cbec7b0146195742a1d 100644 (file)
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -87,7 +87,16 @@
          <option>--set-header header:value</option>
       </arg>
       <arg choice="opt">
-         <option>-beit mask</option>
+         <option>--set-param header:param=value</option>
+      </arg>
+      <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>
       <arg choice="opt">
          <option>-o output_file</option>
@@ -370,6 +379,16 @@
       </listitem>
    </varlistentry>
 
+   <varlistentry>
+      <term>--set-param header:param=value</term>
+      <listitem>
+         <para>
+           The program sets or changes value for the header's parameter to the
+           given value (only at the top-level message). The header must exist.
+         </para>
+      </listitem>
+   </varlistentry>
+
    <varlistentry>
       <term>-b mask</term>
       <listitem>
@@ -381,6 +400,16 @@
       </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>-e mask</term>
       <listitem>
@@ -414,11 +443,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).
+         </para>
+      </listitem>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-O dest_dir</term>
+      <listitem>
+         <para>
+           Set destination directory for the output files; the directory must
+           exist. 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>
@@ -427,7 +487,7 @@ 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
@@ -457,6 +517,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>