X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=mimedecode.docbook;h=02ee7a5b3ccfaddacdbb87bd1c4eb1e7b51b330b;hb=006a9503ec8ea892ea9381de8d11865481b00096;hp=75ec36798b496bf80a167002f8ee25719b07043f;hpb=db0cd67905f741dcf93af7706c282afadf051718;p=mimedecode.git
diff --git a/mimedecode.docbook b/mimedecode.docbook
index 75ec367..02ee7a5 100644
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -58,7 +58,11 @@
+
+
+
+
@@ -68,13 +72,31 @@
-
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -319,21 +341,60 @@
- -R header:param
+ -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
- 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).
- --remove-params=header
+ --set-param header:param=value
- Add the header to a list of headers from which all parameters will
- be removed; initially the list is empty.
+ 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).
@@ -343,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 content-transfer-decodes
+ (base64 or whatever to 8bit binary) it and outputs the decoded part
+ as is, without any further processing.
@@ -363,9 +425,10 @@
-i mask
- Append mask to the list of content types to ignore; if the message to
- decode has a part of this type the program will not pass it, instead
- a line "Message body of type `%s' skipped." will be issued.
+ Append mask to the list of content types to ignore; if the message
+ to decode has a part of this type the program outputs headers but
+ skips the body. Instead a line "Message body of type %s skipped."
+ will be issued.
@@ -375,18 +438,49 @@
Append mask to the list of content types to convert to text; if the
- message to decode has a part of this type the program will consult
- mailcap database, find first copiousoutput filter and convert the
- part.
+ message to decode has a part of this type the program consults
+ mailcap database, find the first copiousoutput filter and, if any
+ filter is found, converts the part.
+
+ --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; if the directory
+ doesn't exist it will be created. Default is the 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
@@ -395,24 +489,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
@@ -422,9 +516,24 @@ 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 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: headers + body) 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, or the name/filename parameters contain forbidden
+ characters (null, slash, backslash) the filename is just the serial counter.
+ The file is saved in the directory set with -O (default is the current
+ directory).
+