Add option -O to set the destination directory

[mimedecode.git] / mimedecode.docbook

diff --git a/mimedecode.docbook b/mimedecode.docbook
index 6a926ad6c318eb9f87e619329763bac2314fbbd1..555c5f2525be9d84e7dcf442bfce9cf585bfe835 100644 (file)
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -58,7 +58,11 @@
       </arg>
       <arg choice="opt">
         <option>-p *[,-header1,-header2,-header3,...]:param1[,param2,param3,...]</option>
+      </arg>
+      <arg choice="opt">
         <option>-p header1[,header2,header3,...]:*[,-param1,-param2,-param3,...]</option>
+      </arg>
+      <arg choice="opt">
         <option>-p *[,-header1,-header2,-header3,...]:*[,-param1,-param2,-param3,...]</option>
       </arg>
       <arg choice="opt">
@@ -69,12 +73,27 @@
       </arg>
       <arg choice="opt">
         <option>-R header1[,header2,header3,...]:param1[,param2,param3,...]</option>
+      </arg>
+      <arg choice="opt">
         <option>-R *[,-header1,-header2,-header3,...]:param1[,param2,param3,...]</option>
+      </arg>
+      <arg choice="opt">
         <option>-R header1[,header2,header3,...]:*[,-param1,-param2,-param3,...]</option>
+      </arg>
+      <arg choice="opt">
         <option>-R *[,-header1,-header2,-header3,...]:*[,-param1,-param2,-param3,...]</option>
       </arg>
       <arg choice="opt">
-         <option>-beit mask</option>
+         <option>--set-header header:value</option>
+      </arg>
+      <arg choice="opt">
+         <option>--set-param header:param=value</option>
+      </arg>
+      <arg choice="opt">
+         <option>-Bbeit mask</option>
+      </arg>
+      <arg choice="opt">
+         <option>-O dest_dir</option>
       </arg>
       <arg choice="opt">
          <option>-o output_file</option>
@@ -347,6 +366,26 @@
       </listitem>
    </varlistentry>
 
+   <varlistentry>
+      <term>--set-header header:value</term>
+      <listitem>
+         <para>
+           The program sets or changes value for the header to the given value
+           (only at the top-level message).
+         </para>
+      </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>
@@ -358,6 +397,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>
@@ -391,11 +440,22 @@
       </listitem>
    </varlistentry>
 
+   <varlistentry>
+      <term>-O dest_dir</term>
+      <listitem>
+         <para>
+           Set destination directory for the output files. 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:
+            Set the output file. Uses 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>
@@ -404,7 +464,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