X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=mimedecode.docbook;h=8fda9a21cb1510165bd7b48fda1a846d05021847;hb=eefabcd05d2257ff8de79d5d291f721e06a3c827;hp=5282d1c19e15c33f0571736bfca1636db1bc6e05;hpb=447050247973e721ede0065cb08d2b565ca0d47a;p=mimedecode.git

diff --git a/mimedecode.docbook b/mimedecode.docbook
index 5282d1c..8fda9a2 100644
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -44,6 +44,9 @@
       <arg choice="opt">
          <option>-f charset</option>
       </arg>
+      <arg choice="opt">
+         <option>-H|--host=hostname</option>
+      </arg>
       <arg choice="opt">
          <option>-d header</option>
       </arg>
@@ -81,42 +84,42 @@ much desirable.
 </para>
 
 <para>
-   It is a program to decode MIME messages. The program expects one input file
-(either on the command line or on stdin) which is treated as an RFC822 message,
-and decoded to stdout. If the file is not an RFC822 message it is just piped to
-stdout as is. If the file is a simple RFC822 message it is just decoded as one
-part. If it is a MIME message with multiple parts ("attachments") all parts are
-decoded recursively. Decoding can be controlled by the command-line options.
+   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.
 </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, especially in the M$ Ophice GUI (often
-referred as "Windoze") world, where programmers are often ignorant lamers who
-never even heard about RFCs. Correct parameter encoding specified by RFC2231.
-This program decodes RFC2231-encoded parameters, too.
+   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.
 </para>
 
 <para>
    Then the body of the message (or the current part) is decoded. Decoding
-starts with looking at header Content-Transfer-Encoding. If the header
-specifies non-8bit encoding (usually base64 or quoted-printable), the body
-converted to 8bit. Then, if its content type is multipart (multipart/related or
-multipart/mixed, e.g) every part is recursively decoded. If it is not
-multipart, mailcap database is consulted to find a way to convert the body to
-plain text. (I have no idea how mailcap could be configured on said M$ Ophice
-GUI, 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 first copiousoutput filter it can find. If there is
-no any filter the body just passed unconverted.
+   starts with looking at header Content-Transfer-Encoding. If the header
+   specifies non-8bit encoding (usually base64 or quoted-printable), the body
+   converted to 8bit. Then, if its content type is multipart (multipart/related
+   or multipart/mixed, e.g) every part is recursively decoded. If it is not
+   multipart, mailcap database is consulted to find a way to convert the body
+   to plain text. (I have no idea how mailcap can be configured on OSes other
+   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 are no filters the body just passed as is.
 </para>
 
 <para>
-   Then Content-Type header consulted for charset. If it is not equal to
-current default charset the body text recoded. Finally message headers and body
-flushed to stdout.
+   Then Content-Type header is consulted for charset. If it is not equal to the
+   current locale charset and recoding is allowed the body text is recoded.
+   Finally message headers and the body are flushed to stdout.
 </para>
 </refsect1>
 
@@ -148,8 +151,8 @@ flushed to stdout.
       <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>
@@ -158,7 +161,7 @@ flushed to stdout.
       <term>-C</term>
       <listitem>
          <para>
-            Do not recode character sets in message body.
+            Do not recode character sets in message bodies.
          </para>
       </listitem>
    </varlistentry>
@@ -168,7 +171,18 @@ flushed to stdout.
       <listitem>
          <para>
             Force this charset to be the current default charset instead of
-            sys.getdefaultencoding().
+            the current locale.
+         </para>
+      </listitem>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-H hostname</term>
+      <term>--host=hostname</term>
+      <listitem>
+         <para>
+           Use this hostname in X-MIME-Autoconverted headers instead of the
+           current hostname.
          </para>
       </listitem>
    </varlistentry>
@@ -178,7 +192,8 @@ flushed to stdout.
       <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>
@@ -196,9 +211,10 @@ flushed to stdout.
       <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>
@@ -228,7 +244,7 @@ flushed to stdout.
       <listitem>
          <para>
             Append mask to the list of error content types; if the message to
-            decode has a part of this type the program will raise ValueError.
+            decode has a part of this type the program fails with ValueError.
          </para>
       </listitem>
    </varlistentry>
@@ -284,15 +300,15 @@ else. Easy:
 </para>
 
 <para>
-   When the program decodes a message (or its part), it consults
-Content-Type header. The content type is searched in all 4 lists, in order
-"text-binary-ignore-error". If found, appropriate action performed. If not
-found, the program search the same lists for "type/*" mask (the type of
-"text/html" is just "text"). If found, appropriate action performed. If not
-found, the program search the same lists for "*/*" mask. If found,
-appropriate action performed. If not found, the program uses default
-action, which is to decode everything to text (if mailcap specifies
-a filter).
+   When the program decodes a message (non-MIME or a non-multipart subpart of a
+   MIME message), it consults Content-Type header. The content type is searched
+   in all 4 lists, in order "text-binary-ignore-error". If found, appropriate
+   action performed. If not found, the program search the same lists for
+   "type/*" mask (the type of "text/html" is just "text"). If found,
+   appropriate action performed. If not found, the program search the same
+   lists for "*/*" mask. If found, appropriate action performed. If not found,
+   the program uses default action, which is to decode everything to text (if
+   mailcap specifies a filter).
 </para>
 
 <para>
@@ -304,12 +320,14 @@ the program always uses the default decoding.
 
 <refsect1>
 <title>ENVIRONMENT</title>
+<variablelist>
+  <varlistentry><term>LANG</term></varlistentry>
+  <varlistentry><term>LC_ALL</term></varlistentry>
+  <varlistentry><term>LC_CTYPE</term></varlistentry>
+</variablelist>
 <para>
-   LANG
-   LC_ALL
-   LC_CTYPE
-      Define current locale settings. Used to determine current default
-      charset (if your Python is properly installed and configured).
+  Define current locale settings. Used to determine current default charset (if
+  your Python is properly installed and configured).
 </para>
 </refsect1>
 
@@ -318,12 +336,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 koi8-r -
-the program will recode the message to 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>
 
@@ -331,7 +350,9 @@ the program will recode the message to the wrong charset.
 <refsect1>
 <title>AUTHOR</title>
 <para>
-   Oleg Broytman &lt;phd@phdru.name&gt;
+  <firstname>Oleg</firstname>
+  <surname>Broytman</surname>
+  <email>phd@phdru.name</email>
 </para>
 </refsect1>
 
@@ -339,7 +360,7 @@ the program will recode the message to the wrong charset.
 <refsect1>
 <title>COPYRIGHT</title>
 <para>
-   Copyright (C) 2001-2014 PhiloSoft Design
+  Copyright (C) 2001-2014 PhiloSoft Design.
 </para>
 </refsect1>