X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=mimedecode.docbook;h=401197944585dd8bcc1656d430a7841dbdc3a89d;hb=fa2d7bb797e9f0735f299cd19192ac3782475a96;hp=6fcc39822f8dce7e19b13b82950894b76fed927e;hpb=ae8aeab467eba38d6fbc4c52e2f31e31cba11404;p=mimedecode.git
diff --git a/mimedecode.docbook b/mimedecode.docbook
index 6fcc398..4011979 100644
--- a/mimedecode.docbook
+++ b/mimedecode.docbook
@@ -48,19 +48,49 @@
-
+
-
+
-
+
-
+
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -100,12 +130,14 @@
- 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.
@@ -129,6 +161,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
@@ -194,12 +233,25 @@
- -d header
+ -d header1[,header2,header3...]
+
+
+ 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...]
- 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.
@@ -214,13 +266,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).
@@ -235,21 +316,69 @@
- -r header
+ -r header1[,header2,header3...]
+
+
+ Add the header(s) to a list of headers to remove completely;
+ initially the list is empty.
+
+
+
+
+
+ -r *[,-header1,-header2,-header3...]
- Add the header to a list of headers to remove completely; initially
- the list is empty.
+ Remove all headers except listed.
- -R header:param
+ -R header1[,header2,header3,...]:param1[,param2,param3,...]
- Add the pair (header, param) to a list of headers parameters to
- remove; 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.
@@ -265,6 +394,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
@@ -311,7 +450,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