X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=mimedecode.docbook;h=9acc3209b228b2c4c25898205fc9f46251bb0231;hb=d0300ffa1ef1f9afee0e4d53c725f54773d89c13;hp=83b0e54cd213791c4a1f40517d07b2ed43fc5345;hpb=5a0b966d01b89f668ce0cea40208d511e1bc04f7;p=mimedecode.git
diff --git a/mimedecode.docbook b/mimedecode.docbook
index 83b0e54..9acc320 100644
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -48,19 +48,55 @@
-
+
-
+
-
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -131,6 +167,13 @@
+
+
+ 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.
+
+OPTIONS
@@ -196,12 +239,25 @@
- -d header
+ -d header1[,header2,header3...]
- 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".
+ 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".
+
+
+
+
+
+ -d *[,-header1,-header2,-header3...]
+
+
+ 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.
@@ -216,13 +272,42 @@
- -p header:param
+ -p header1[,header2,header3,...]:param1[,param2,param3,...]
- 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".
+
+
+
+
+
+ -p *[,-header1,-header2,-header3,...]:param1[,param2,param3,...]
+
+
+ Add the parameters(s) to a list of headers parameters to decode;
+ the parameters will be decoded for all headers except the given
+ ones.
+
+
+
+
+
+ -p header1[,header2,header3,...]:*[,-param1,-param2,-param3,...]
+
+
+ Decode all parameters except listed for the given list of headers.
+
+
+
+
+
+ -p *[,-header1,-header2,-header3,...]:*[,-param1,-param2,-param3,...]
+
+
+ Decode all parameters except listed for all headers (except listed).
@@ -237,21 +322,79 @@
- -r header
+ -r header1[,header2,header3...]
- Add the header to a list of headers to remove completely; initially
- the list is empty.
+ Add the header(s) to a list of headers to remove completely;
+ initially the list is empty.
- -R header:param
+ -r *[,-header1,-header2,-header3...]
- Add the pair (header, param) to a list of headers parameters to
- remove; initially the list is empty.
+ Remove all headers except listed.
+
+
+
+
+
+ -R header1[,header2,header3,...]:param1[,param2,param3,...]
+
+
+ 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.
+
+
+
+
+
+ -R *[,-header1,-header2,-header3,...]:param1[,param2,param3,...]
+
+
+
+ -R header1[,header2,header3,...]:*[,-param1,-param2,-param3,...]
+
+
+
+ -R *[,-header1,-header2,-header3,...]:*[,-param1,-param2,-param3,...]
+
+
+ Remove listed parameters (or all parameters except listed) frome
+ these headers (or from all headers except listed).
+
+
+
+
+
+ --set-header header:value
+
+
+ The program sets or changes value for the header to the given value
+ (only at the top-level message).
+
+
+
+
+
+ --set-param header:param=value
+
+
+ The program sets or changes value for the header's parameter to the
+ given value (only at the top-level message). The header must exist.
+
+
+
+
+
+ -B mask
+
+
+ Append mask to the list of binary content types that will be not
+ content-transfer-decoded (will be left as base64 or such).
@@ -261,8 +404,9 @@
Append mask to the list of binary content types; if the message to
- decode has a part of this type the program will pass the part as is,
- without any additional processing.
+ decode has a part of this type the program will
+ content-transfer-decode (base64 or whatever to 8bit binary) it but
+ pass the part as is, without any further processing.
@@ -300,11 +444,42 @@
+
+ --save-headers mask
+
+
+
+ --save-body mask
+
+
+
+ --save-message mask
+
+
+ Append mask to a list of content types to save to a file;
+ --save-headers saves only decoded headers of the message (or
+ subpart); --save-body saves only decoded body; --save-message saves
+ the entire message or subpart (headers + body).
+
+
+
+
+
+ -O dest_dir
+
+
+ Set destination directory for the output files; the directory must
+ exist. Default is current directory.
+
+
+
+
-o output_file
- Useful to set the output file in case of redirected stdin:
+ Save output to the file related to the destination directory from
+ option -O. Also useful in case of redirected stdin:
mimedecode.py -o output_file < input_file
cat input_file | mimedecode.py -o output_file
@@ -313,24 +488,24 @@ cat input_file | mimedecode.py -o output_file
- The 4 list options (-beit) require more explanation. They allow a user to
+ The 5 list options (-Bbeit) 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:
+ PDF/Postscript to text, pass HTML and images as is (decoding base64 to html
+ but left images in base64), and ignore everything else. Easy:
- mimedecode.py -t application/postscript -t application/pdf -b text/html
- -b 'image/*' -i '*/*'
+ mimedecode.py -t application/pdf -t application/postscript -b text/html
+ -B 'image/*' -i '*/*'
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
+ in all 5 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
@@ -340,9 +515,22 @@ cat input_file | mimedecode.py -o output_file
- Initially all 4 lists are empty, so without any additional parameters
+ Initially all 5 lists are empty, so without any additional parameters
the program always uses the default decoding.
+
+
+ The 3 save list options (--save-headers/body/message) are similar. They make
+ the program to save every non-multipart subpart (only headers, or body, or
+ the entire subpart) that corresponds to the given mask to a file. Before
+ saving the message (or the subpart) is decoded according to all other options
+ and placed to the output stream as usual. Filename for the file is created
+ using "filename" parameter from the Content-Disposition header, or "name"
+ parameter from the Content-Type header if one of those exist; a serial
+ counter is prepended to the filename to avoid collisions; if there are no
+ name/filename parameters, the filename is just the serial counter. The file
+ is saved in the directory set with -O (default is the current directory).
+