Allow * and exceptions for -p in the headers list

[mimedecode.git] / mimedecode.docbook

diff --git a/mimedecode.docbook b/mimedecode.docbook
index 83b0e54cd213791c4a1f40517d07b2ed43fc5345..f9650bd26891a9afaf85036f1090a9e4ce02c17a 100644 (file)
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -48,10 +48,13 @@
          <option>-H|--host=hostname</option>
       </arg>
       <arg choice="opt">
-         <option>-d header</option>
+         <option>-d header1[,header2,header3...]</option>
       </arg>
       <arg choice="opt">
-         <option>-p header:param</option>
+         <option>-d *[,-header1,-header2,-header3...]</option>
+      </arg>
+      <arg choice="opt">
+        <option>-p header1[,header2,header3,...]:param1[,param2,param3,...]</option>
       </arg>
       <arg choice="opt">
          <option>-r header</option>
@@ -59,6 +62,9 @@
       <arg choice="opt">
          <option>-R header:param</option>
       </arg>
+      <arg choice="opt">
+         <option>--remove-params=header</option>
+      </arg>
       <arg choice="opt">
          <option>-beit mask</option>
       </arg>
@@ -131,6 +137,13 @@
 </para>
 </refsect1>
 
+<refsect1>
+  <para>
+    Please be warned that in the following options asterisk is a shell
+    metacharacter and should be escaped or quoted. Either write -d \*,-h1,-h2
+    or -d '*,-h1,-h2' or such.
+  </para>
+</refsect1>
 
 <refsect1>
 <title>OPTIONS</title>
@@ -196,12 +209,25 @@
    </varlistentry>
 
    <varlistentry>
-      <term>-d header</term>
+      <term>-d header1[,header2,header3...]</term>
+      <listitem>
+         <para>
+            Add the header(s) to a list of headers to decode; initially the
+            list contains headers "From", "To", "Cc", "Reply-To",
+            "Mail-Followup-To" and "Subject".
+         </para>
+      </listitem>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-d *[,-header1,-header2,-header3...]</term>
       <listitem>
          <para>
-            Add the header to a list of headers to decode; initially the list
-            contains headers "From", "To", "Cc", "Reply-To", "Mail-Followup-To"
-            and "Subject".
+           This variant completely changes headers decoding. First, the list of
+           headers to decode is cleared. Then all the headers are decoded
+           except the given list of exceptions (headers listed with '-'). In
+           this mode it would be meaningless to give more than one -d options
+           but the program doesn't enforce it.
          </para>
       </listitem>
    </varlistentry>
@@ -216,13 +242,24 @@
    </varlistentry>
 
    <varlistentry>
-      <term>-p header:param</term>
+      <term>-p header1[,header2,header3,...]:param1[,param2,param3,...]</term>
       <listitem>
          <para>
-            Add the pair (header, param) to a list of headers parameters to
-            decode; initially the list contains header "Content-Type",
-            parameter "name" and header "Content-Disposition", parameter
-            "filename".
+            Add the parameters(s) to a list of headers parameters to decode;
+            the parameters will be decoded only for the given header(s).
+            Initially the list contains header "Content-Type", parameter "name";
+            and header "Content-Disposition", parameter "filename".
+         </para>
+      </listitem>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-p *[,-header1,-header2,-header3,...]:param1[,param2,param3,...]</term>
+      <listitem>
+         <para>
+            Add the parameters(s) to a list of headers parameters to decode;
+            the parameters will be decoded for all headers except the given
+            ones.
          </para>
       </listitem>
    </varlistentry>
@@ -256,6 +293,16 @@
       </listitem>
    </varlistentry>
 
+   <varlistentry>
+      <term>--remove-params=header</term>
+      <listitem>
+         <para>
+            Add the header to a list of headers from which all parameters will
+            be removed; initially the list is empty.
+         </para>
+      </listitem>
+   </varlistentry>
+
    <varlistentry>
       <term>-b mask</term>
       <listitem>