X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=mimedecode.docbook;h=1060f4fc75b62503c56d296e02793a433d5dfc39;hb=833057498a432c1777e2442b7ce8abe88feb0e34;hp=d98db683691271f016f08df8cfedd248c961c106;hpb=132782e4926381f746dd9ea6b03e3feaaf52579a;p=mimedecode.git
diff --git a/mimedecode.docbook b/mimedecode.docbook
index d98db68..1060f4f 100644
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -57,16 +57,46 @@
-
+
-
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -253,6 +283,35 @@
+
+ -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).
+
+
+
+
-P
@@ -263,31 +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.
- --remove-params=header
+ -R header1[,header2,header3,...]:param1[,param2,param3,...]
- Add the header to a list of headers from which all parameters will
- be removed; initially the list is empty.
+ 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).
@@ -297,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.
@@ -336,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
@@ -349,7 +488,7 @@ 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
@@ -379,6 +518,19 @@ cat input_file | mimedecode.py -o output_file
Initially all 4 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).
+