X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=mimedecode.docbook;h=6fcc39822f8dce7e19b13b82950894b76fed927e;hb=ae8aeab467eba38d6fbc4c52e2f31e31cba11404;hp=90eb11eb5f46e9bdf8e2d59669cd947de228b67b;hpb=64bde269318eb10622bdc5477ae30df8b6592e15;p=mimedecode.git

diff --git a/mimedecode.docbook b/mimedecode.docbook
index 90eb11e..6fcc398 100644
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -42,10 +42,10 @@
          <option>-cCDP</option>
       </arg>
       <arg choice="opt">
-         <option>-H|--host=hostname</option>
+         <option>-f charset</option>
       </arg>
       <arg choice="opt">
-         <option>-f charset</option>
+         <option>-H|--host=hostname</option>
       </arg>
       <arg choice="opt">
          <option>-d header</option>
@@ -53,6 +53,12 @@
       <arg choice="opt">
          <option>-p header:param</option>
       </arg>
+      <arg choice="opt">
+         <option>-r header</option>
+      </arg>
+      <arg choice="opt">
+         <option>-R header:param</option>
+      </arg>
       <arg choice="opt">
          <option>-beit mask</option>
       </arg>
@@ -70,13 +76,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>
@@ -85,12 +91,12 @@ 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>
@@ -113,13 +119,13 @@ command-line options.
    than POSIX, please don't ask me; real OS users can consult my example at
    <ulink url="http://phdru.name/Software/dotfiles/mailcap.html">http://phdru.name/Software/dotfiles/mailcap.html</ulink>).
    The decoding process uses the first copiousoutput filter it can find. If
-   there is no any filter the body just passed as is.
+   there are no filters the body just passed as is.
 </para>
 
 <para>
    Then Content-Type header is consulted for charset. If it is not equal to the
-   current locale charset the body text is recoded. Finally message headers and
-   the body are flushed to stdout.
+   current locale charset and recoding is allowed the body text is recoded.
+   Finally message headers and the body are flushed to stdout.
 </para>
 </refsect1>
 
@@ -151,8 +157,8 @@ command-line options.
       <term>-c</term>
       <listitem>
          <para>
-            Recode different character sets in message body to current default
-            charset; this is the default.
+            Recode different character sets in message bodies to the current
+            default charset; this is the default.
          </para>
       </listitem>
    </varlistentry>
@@ -161,28 +167,28 @@ command-line options.
       <term>-C</term>
       <listitem>
          <para>
-            Do not recode character sets in message body.
+            Do not recode character sets in message bodies.
          </para>
       </listitem>
    </varlistentry>
 
    <varlistentry>
-      <term>-H hostname</term>
-      <term>--host=hostname</term>
+      <term>-f charset</term>
       <listitem>
          <para>
-           Use this hostname in X-MIME-Autoconverted headers instead of the
-           current hostname.
+            Force this charset to be the current default charset instead of
+            the current locale.
          </para>
       </listitem>
    </varlistentry>
 
    <varlistentry>
-      <term>-f charset</term>
+      <term>-H hostname</term>
+      <term>--host=hostname</term>
       <listitem>
          <para>
-            Force this charset to be the current default charset instead of
-            the current locale.
+           Use this hostname in X-MIME-Autoconverted headers instead of the
+           current hostname.
          </para>
       </listitem>
    </varlistentry>
@@ -192,7 +198,8 @@ command-line options.
       <listitem>
          <para>
             Add the header to a list of headers to decode; initially the list
-            contains headers "From" and "Subject".
+            contains headers "From", "To", "Cc", "Reply-To", "Mail-Followup-To"
+            and "Subject".
          </para>
       </listitem>
    </varlistentry>
@@ -210,9 +217,10 @@ command-line options.
       <term>-p header:param</term>
       <listitem>
          <para>
-            Add the (header, param) pair to a list of headers' parameters to
-            decode; initially the list contains header "Content-Disposition",
-            parameter "filename".
+            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".
          </para>
       </listitem>
    </varlistentry>
@@ -221,7 +229,27 @@ 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>
+
+   <varlistentry>
+      <term>-r header</term>
+      <listitem>
+         <para>
+            Add the header to a list of headers to remove completely; initially
+            the list is empty.
+         </para>
+      </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>
@@ -283,11 +311,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>
@@ -334,12 +362,13 @@ the program always uses the default decoding.
 <title>BUGS</title>
 <para>
    The program may produce incorrect MIME message. The purpose of the program
-is to decode whatever it is possible to decode, not to produce absolutely
-correct MIME output. The incorrect parts are obvious - decoded Subject headers
-and filenames. Other than that output is correct MIME message. The program does
-not try to guess whether the headers are correct. For example, if a message
-header states that charset is iso8859-5, but the body is actually in utf-8
-the program will recode the message with the wrong charset.
+   is to decode whatever it is possible to decode, not to produce absolutely
+   correct MIME output. The incorrect parts are obvious - decoded
+   From/To/Cc/Reply-To/Mail-Followup-To/Subject headers and filenames. Other
+   than that output is correct MIME message. The program does not try to guess
+   whether the headers are correct. For example, if a message header states
+   that charset is iso8859-5, but the body is actually in utf-8 the program
+   will recode the message with the wrong charset.
 </para>
 </refsect1>