Version 2.3.8

[mimedecode.git] / mimedecode.docbook

diff --git a/mimedecode.docbook b/mimedecode.docbook
index 0605fa84da98e3845df8d51d3619b7eed7dbe7cf..382fba2cb2f6a79b998c12b3f7661c14fb7eb046 100644 (file)
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -56,6 +56,12 @@
       <arg choice="opt">
          <option>-r header</option>
       </arg>
+      <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>
@@ -73,13 +79,13 @@
 <title>DESCRIPTION</title>
 <para>
    Mail users, especially in non-English countries, often find that mail
-messages arrived in different formats, with different content types, in
-different encodings and charsets. Usually it is good because it allows to use
-an appropriate format/encoding/whatever. Sometimes, though, some unification is
-desirable. For example, one may want to put mail messages into an archive,
-make HTML indices, run search indexer, etc. In such situations converting
-messages to text in one character set and skipping some binary attachments is
-much desirable.
+   messages arrived in different formats, with different content types, in
+   different encodings and charsets. Usually it is good because it allows to
+   use an appropriate format/encoding/whatever. Sometimes, though, some
+   unification is desirable. For example, one may want to put mail messages
+   into an archive, make HTML indices, run search indexer, etc. In such
+   situations converting messages to text in one character set and skipping
+   some binary attachments is much desirable.
 </para>
 
 <para>
@@ -88,21 +94,23 @@ much desirable.
 
 <para>
    This is a program to decode MIME messages. The program expects one input
-file (either on command line or on stdin) which is treated as an RFC822
-message, and decodes to stdout or an output file. If the file is not an RFC822
-message it is just copied to the output one-to-one. If the file is a simple
-RFC822 message it is decoded as one part. If it is a MIME message with multiple
-parts ("attachments") all parts are decoded. Decoding can be controlled by
-command-line options.
+   file (either on command line or on stdin) which is treated as an RFC822
+   message, and decodes to stdout or an output file. If the file is not an
+   RFC822 message it is just copied to the output one-to-one. If the file is a
+   simple RFC822 message it is decoded as one part. If it is a MIME message
+   with multiple parts ("attachments") all parts are decoded. Decoding can be
+   controlled by command-line options.
 </para>
 
 <para>
-   First, Subject and Content-Disposition headers are examined. If any of those
-   exists, it is decoded according to RFC2047. Content-Disposition header is
-   not decoded - only its "filename" parameter. Encoded header parameters
-   violate the RFC, but widely deployed anyway by ignorant coders who never
-   even heard about RFCs. Correct parameter encoding specified by RFC2231. This
-   program decodes RFC2231-encoded parameters, too.
+   First, for every part the program removes headers and parameters listed with
+   -r and -R options. Then, Subject and Content-Disposition headers (and all
+   headers listed with -d and -p options) are examined. If any of those exists,
+   they are decoded according to RFC2047. Content-Disposition header is not
+   decoded - only its "filename" parameter. Encoded header parameters violate
+   the RFC, but widely deployed anyway by ignorant coders who never even heard
+   about RFCs. Correct parameter encoding specified by RFC2231. This program
+   decodes RFC2231-encoded parameters, too.
 </para>
 
 <para>
@@ -214,7 +222,7 @@ command-line options.
       <term>-p header:param</term>
       <listitem>
          <para>
-            Add the pair (header, param) to a list of headers' parameters to
+            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".
@@ -226,7 +234,7 @@ command-line options.
       <term>-P</term>
       <listitem>
          <para>
-            Clear the list of headers' parameters to decode (make it empty).
+            Clear the list of headers parameters to decode (make it empty).
          </para>
       </listitem>
    </varlistentry>
@@ -241,6 +249,26 @@ command-line options.
       </listitem>
    </varlistentry>
 
+   <varlistentry>
+      <term>-R header:param</term>
+      <listitem>
+         <para>
+            Add the pair (header, param) to a list of headers parameters to
+            remove; initially the list is empty.
+         </para>
+      </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>
@@ -298,11 +326,11 @@ cat input_file | mimedecode.py -o output_file</programlisting>
 </variablelist>
 
 <para>
-   The 4 list options (-beit) 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:
+   The 4 list options (-beit) 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:
 </para>
 
 <para>