]> git.phdru.name Git - mimedecode.git/blobdiff - mimedecode.docbook
Add option --set-header=header:value
[mimedecode.git] / mimedecode.docbook
index 87bd3643cb7b2def88c2681e56554723da608a13..86e84a6d316b348049efd8b3519e935b1d1daa69 100644 (file)
          <option>-H|--host=hostname</option>
       </arg>
       <arg choice="opt">
-         <option>-d header</option>
+         <option>-d header1[,header2,header3...]</option>
       </arg>
       <arg choice="opt">
-         <option>-p header:param</option>
+         <option>-d *[,-header1,-header2,-header3...]</option>
       </arg>
       <arg choice="opt">
-         <option>-r header</option>
+        <option>-p header1[,header2,header3,...]:param1[,param2,param3,...]</option>
       </arg>
       <arg choice="opt">
-         <option>-R header:param</option>
+        <option>-p *[,-header1,-header2,-header3,...]:param1[,param2,param3,...]</option>
+      </arg>
+      <arg choice="opt">
+        <option>-p header1[,header2,header3,...]:*[,-param1,-param2,-param3,...]</option>
+      </arg>
+      <arg choice="opt">
+        <option>-p *[,-header1,-header2,-header3,...]:*[,-param1,-param2,-param3,...]</option>
+      </arg>
+      <arg choice="opt">
+         <option>-r header1[,header2,header3...]</option>
+      </arg>
+      <arg choice="opt">
+         <option>-r *[,-header1,-header2,-header3...]</option>
+      </arg>
+      <arg choice="opt">
+        <option>-R header1[,header2,header3,...]:param1[,param2,param3,...]</option>
+      </arg>
+      <arg choice="opt">
+        <option>-R *[,-header1,-header2,-header3,...]:param1[,param2,param3,...]</option>
+      </arg>
+      <arg choice="opt">
+        <option>-R header1[,header2,header3,...]:*[,-param1,-param2,-param3,...]</option>
+      </arg>
+      <arg choice="opt">
+        <option>-R *[,-header1,-header2,-header3,...]:*[,-param1,-param2,-param3,...]</option>
+      </arg>
+      <arg choice="opt">
+         <option>--set-header header:value</option>
       </arg>
       <arg choice="opt">
          <option>-beit mask</option>
 <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>
@@ -91,21 +118,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>
@@ -129,6 +158,13 @@ command-line options.
 </para>
 </refsect1>
 
+<refsect1>
+  <para>
+    Please be warned that in the following options asterisk is a shell
+    metacharacter and should be escaped or quoted. Either write -d \*,-h1,-h2
+    or -d '*,-h1,-h2' or such.
+  </para>
+</refsect1>
 
 <refsect1>
 <title>OPTIONS</title>
@@ -194,12 +230,25 @@ command-line options.
    </varlistentry>
 
    <varlistentry>
-      <term>-d header</term>
+      <term>-d header1[,header2,header3...]</term>
+      <listitem>
+         <para>
+            Add the header(s) to a list of headers to decode; initially the
+            list contains headers "From", "To", "Cc", "Reply-To",
+            "Mail-Followup-To" and "Subject".
+         </para>
+      </listitem>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-d *[,-header1,-header2,-header3...]</term>
       <listitem>
          <para>
-            Add the header to a list of headers to decode; initially the list
-            contains headers "From", "To", "Cc", "Reply-To", "Mail-Followup-To"
-            and "Subject".
+           This variant completely changes headers decoding. First, the list of
+           headers to decode is cleared. Then all the headers are decoded
+           except the given list of exceptions (headers listed with '-'). In
+           this mode it would be meaningless to give more than one -d options
+           but the program doesn't enforce it.
          </para>
       </listitem>
    </varlistentry>
@@ -214,13 +263,42 @@ command-line options.
    </varlistentry>
 
    <varlistentry>
-      <term>-p header:param</term>
+      <term>-p header1[,header2,header3,...]:param1[,param2,param3,...]</term>
       <listitem>
          <para>
-            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".
+            Add the parameters(s) to a list of headers parameters to decode;
+            the parameters will be decoded only for the given header(s).
+            Initially the list contains header "Content-Type", parameter "name";
+            and header "Content-Disposition", parameter "filename".
+         </para>
+      </listitem>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-p *[,-header1,-header2,-header3,...]:param1[,param2,param3,...]</term>
+      <listitem>
+         <para>
+            Add the parameters(s) to a list of headers parameters to decode;
+            the parameters will be decoded for all headers except the given
+            ones.
+         </para>
+      </listitem>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-p header1[,header2,header3,...]:*[,-param1,-param2,-param3,...]</term>
+      <listitem>
+         <para>
+           Decode all parameters except listed for the given list of headers.
+         </para>
+      </listitem>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-p *[,-header1,-header2,-header3,...]:*[,-param1,-param2,-param3,...]</term>
+      <listitem>
+         <para>
+           Decode all parameters except listed for all headers (except listed).
          </para>
       </listitem>
    </varlistentry>
@@ -235,21 +313,59 @@ command-line options.
    </varlistentry>
 
    <varlistentry>
-      <term>-r header</term>
+      <term>-r header1[,header2,header3...]</term>
+      <listitem>
+         <para>
+            Add the header(s) to a list of headers to remove completely;
+            initially the list is empty.
+         </para>
+      </listitem>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-r *[,-header1,-header2,-header3...]</term>
+      <listitem>
+         <para>
+           Remove all headers except listed.
+         </para>
+      </listitem>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-R header1[,header2,header3,...]:param1[,param2,param3,...]</term>
+      <listitem>
+         <para>
+            Add the parameters(s) to a list of headers parameters to remove;
+            the parameters will be decoded only for the given header(s).
+            Initially the list is empty.
+         </para>
+      </listitem>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-R *[,-header1,-header2,-header3,...]:param1[,param2,param3,...]</term>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-R header1[,header2,header3,...]:*[,-param1,-param2,-param3,...]</term>
+   </varlistentry>
+
+   <varlistentry>
+      <term>-R *[,-header1,-header2,-header3,...]:*[,-param1,-param2,-param3,...]</term>
       <listitem>
          <para>
-            Add the header to a list of headers to remove completely; initially
-            the list is empty.
+           Remove listed parameters (or all parameters except listed) frome
+           these headers (or from all headers except listed).
          </para>
       </listitem>
    </varlistentry>
 
    <varlistentry>
-      <term>-R header:param</term>
+      <term>--set-header header:value</term>
       <listitem>
          <para>
-            Add the pair (header, param) to a list of headers parameters to
-            remove; initially the list is empty.
+           The program sets or changes value for the header to the given value
+           (only at the top-level message).
          </para>
       </listitem>
    </varlistentry>
@@ -311,11 +427,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>