TODO: add tests

[mimedecode.git] / mimedecode.docbook

diff --git a/mimedecode.docbook b/mimedecode.docbook
index 70b7a08602989dbb66533c6b3b8b37ad1d9252a3..5be05a8beb63f135a3a32d77203ba255463783d6 100644 (file)
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -108,9 +108,9 @@ 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
-http://phdru.name/Software/dotfiles/mailcap.html). The decoding process uses
-first copiousoutput filter it can find. If there is no any filter the body just
-passed unconverted.
+<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.
 </para>
 
 <para>
@@ -168,7 +168,7 @@ flushed to stdout.
       <listitem>
          <para>
             Force this charset to be the current default charset instead of
-            sys.getdefaultencoding().
+            the current locale.
          </para>
       </listitem>
    </varlistentry>
@@ -228,7 +228,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>
@@ -304,12 +304,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>
 
@@ -323,7 +325,7 @@ 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.
+the program will recode the message with the wrong charset.
 </para>
 </refsect1>
 
@@ -331,7 +333,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 +343,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>
 
@@ -366,7 +370,8 @@ the program will recode the message to the wrong charset.
 <refsect1>
 <title>SEE ALSO</title>
 <para>
-   mimedecode.py home page: http://phdru.name/Software/Python/#mimedecode
+  mimedecode.py home page:
+  <ulink url="http://phdru.name/Software/Python/#mimedecode">http://phdru.name/Software/Python/#mimedecode</ulink>
 </para>
 </refsect1>