Make minor clarification

[mimedecode.git] / mimedecode.docbook

diff --git a/mimedecode.docbook b/mimedecode.docbook
index ac6c705c7ec907014a6b27eea14de55357c87ee4..5be05a8beb63f135a3a32d77203ba255463783d6 100644 (file)
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -1,9 +1,24 @@
 <?xml version="1.0" standalone="no"?>
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1//EN"
-   "http://www.oasis-open.org/docbook/xml/4.1/docbook.dtd">
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "file:///usr/share/xml/docbook/schema/dtd/4.5/docbookx.dtd">
 
 <refentry id="mimedecode.py">
 
+<refentryinfo>
+  <title>mimedecode.py</title>
+  <productname>mimedecode.docbook</productname>
+  <author>
+    <firstname>Oleg</firstname>
+    <surname>Broytman</surname>
+    <email>phd@phdru.name</email>
+    <personblurb/>
+  </author>
+  <copyright>
+    <year>2001-2014</year>
+    <holder>PhiloSoft Design.</holder>
+  </copyright>
+</refentryinfo>
+
 <refmeta>
    <refentrytitle>mimedecode.py</refentrytitle>
    <manvolnum>1</manvolnum>
@@ -38,7 +53,12 @@
       <arg choice="opt">
          <option>-beit mask</option>
       </arg>
-      <arg choice="opt">filename</arg>
+      <arg choice="opt">
+         <option>-o output_file</option>
+      </arg>
+      <arg choice="opt">input_file
+        <arg choice="opt">output_file</arg>
+      </arg>
    </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -88,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>
@@ -148,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>
@@ -208,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>
@@ -235,10 +255,21 @@ flushed to stdout.
          </para>
       </listitem>
    </varlistentry>
+
+   <varlistentry>
+      <term>-o output_file</term>
+      <listitem>
+         <para>
+            Useful to set the output file in case of redirected stdin:
+            <programlisting language="sh">mimedecode.py -o output_file &lt; input_file
+cat input_file | mimedecode.py -o output_file</programlisting>
+         </para>
+      </listitem>
+   </varlistentry>
 </variablelist>
 
 <para>
-   The last 4 options (-beit) require more explanation. They allow a user
+   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
@@ -246,7 +277,7 @@ else. Easy:
 </para>
 
 <para>
-<code language="shell">
+<code language="sh">
    mimedecode.py -t application/postscript -t application/pdf -b text/html
          -b 'image/*' -i '*/*'
 </code>
@@ -273,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>
 
@@ -292,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>
 
@@ -300,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>
 
@@ -308,7 +343,7 @@ the program will recode the message to the wrong charset.
 <refsect1>
 <title>COPYRIGHT</title>
 <para>
-   Copyright (C) 2001-2009 PhiloSoft Design
+  Copyright (C) 2001-2014 PhiloSoft Design.
 </para>
 </refsect1>
 
@@ -335,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>