X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=mimedecode.docbook;h=0a690213af43010f8db11d01742d939ebd922938;hb=16d98dbe4bd8cb9cda80da5d1e881aecc872e486;hp=28af4acd0d4e0b7e35d725fa681b7149221331c2;hpb=5609ebe933595e091f216abf575c448b514d7cb1;p=mimedecode.git
diff --git a/mimedecode.docbook b/mimedecode.docbook
index 28af4ac..0a69021 100644
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -51,19 +51,49 @@
-
+
-
+
-
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -134,6 +164,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
@@ -209,6 +246,19 @@
+
+ -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.
+
+
+
+
-D
@@ -219,13 +269,42 @@
- -p header:param
+ -p header1[,header2,header3,...]:param1[,param2,param3,...]
+
+
+ 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,...]
- 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".
+ Decode all parameters except listed for all headers (except listed).
@@ -240,31 +319,69 @@
- -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.
@@ -280,6 +397,16 @@
+
+ -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).
+
+
+
+
-e mask
@@ -313,11 +440,22 @@
+
+ -O dest_dir
+
+
+ Set destination directory for the output files. 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
@@ -326,7 +464,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