X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/d067b8780f39cb8d52e3e07a3b05ffcb1ed684ea..b3ee25c5997ddaee43a14a825df740c2e72e9189:/man/mhbuild.man diff --git a/man/mhbuild.man b/man/mhbuild.man index 6510b12b..abd9dcbc 100644 --- a/man/mhbuild.man +++ b/man/mhbuild.man @@ -9,6 +9,7 @@ mhbuild \- translate MIME composition draft .HP 5 .B mhbuild .I file +.RB [ \-auto " | " \-noauto ] .RB [ \-list " | " \-nolist ] .RB [ \-realsize " | " \-norealsize ] .RB [ \-headers " | " \-noheaders ] @@ -17,6 +18,10 @@ mhbuild \- translate MIME composition draft .RB [ \-contentid " | " \-nocontentid ] .RB [ \-verbose " | " \-noverbose ] .RB [ \-check " | " \-nocheck ] +.RB [ \-headerencoding +.IR encoding\-algorithm +.RB " | " \-autoheaderencoding ] +.RB [ \-dist ] .RB [ \-version ] .RB [ \-help ] .ad @@ -27,12 +32,9 @@ command will translate a MIME composition draft into a valid MIME message. .PP .B mhbuild -creates multi-media messages as specified in RFC\-2045 -to RFC\-2049. Currently -.B mhbuild -only supports encodings in -message bodies, and does not support the encoding of message headers as -specified in RFC\-2047. +creates multi-media messages as specified in RFC 2045 +to RFC 2049. This includes the encoding of message headers as specified +by RFC 2047. .PP If you specify the name of the composition file as \*(lq-\*(rq, then @@ -281,7 +283,7 @@ would be as follows: .fi .RE .PP -Any long URLs will be wrapped according to RFC\-2017 rules. +Any long URLs will be wrapped according to RFC 2017 rules. .PP The \*(lqmessage\*(rq directive (#forw) is used to specify a message or group of messages to include. You may optionally specify the name of @@ -291,7 +293,7 @@ given, it defaults to the current message. Hence, the message directive is similar to the .B forw command, except that the former uses -the MIME rules for encapsulation rather than those specified in RFC\-934. +the MIME rules for encapsulation rather than those specified in RFC 934. For example, .PP .RS 5 @@ -314,8 +316,8 @@ switch. This switch will indicate that .B mhbuild should attempt to utilize the MIME encapsulation rules in such a way that the \*(lqmultipart/digest\*(rq that is created -is (mostly) compatible with the encapsulation specified in RFC\-934. -If given, then RFC\-934 compliant user-agents should be able to burst the +is (mostly) compatible with the encapsulation specified in RFC 934. +If given, then RFC 934 compliant user-agents should be able to burst the message on reception\0--\0providing that the messages being encapsulated do not contain encapsulated messages themselves. The drawback of this approach is that the encapsulations are generated by placing an extra @@ -454,6 +456,19 @@ If a text content contains only 7\-bit characters and the character set is not specified as above, then the character set will be labeled as \*(lqus-ascii\*(rq. .PP +The +.B \-headerencoding +switch will indicate which algorithm to use when encoding any message headers +that contain 8\-bit characters. The valid arguments are +.I base64 +for based\-64 encoding and +.I quoted +for quoted\-printable encoding. The +.B \-autoheaderencoding +switch will instruct +.B mhbuild +to automatically pick the algorithm that results in a shorter encoded string. +.PP Putting this all together, here is an example of a more complicated message draft. The following draft will expand into a multipart/mixed message @@ -532,19 +547,13 @@ to execute .B mhbuild to translate the composition file into MIME format. .PP -It is also possible to have the -.B whatnow -program invoke +Normally it is an error to invoke .B mhbuild -automatically when a message is sent. To do this, you must add the line -.PP -.RS 5 -automimeproc: 1 -.RE -.PP -to your -.I \&.mh\(ruprofile -file. +on file that already in MIME format. The +.B \-auto +switch will cause +.B mhbuild +to exit without error if the input file already has valid MIME headers. .PP Finally, you should consider adding this line to your profile: .PP @@ -563,6 +572,14 @@ What now? list .RE .PP will work as you expect. +.PP +The +.B \-dist +switch is intended to be used by +.BR dist . +It will cause mhbuild to not generate any MIME headers in the composition +file (such as \*(lqMIME-Version\*(rq or \*(lqContent-Type\*(rq), but it +will still encode message headers according to RFC 2047. .SS "User Environment" Because the environment in which .B mhbuild @@ -685,27 +702,27 @@ is checked. .IR mhstore (1) .PP .I "Proposed Standard for Message Encapsulation" -(RFC\-934), +(RFC 934), .PP .I "The Content-MD5 Header Field" -(RFC\-1864), +(RFC 1864), .PP .I "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies" -(RFC\-2045), +(RFC 2045), .PP .I "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types" -(RFC\-2046), +(RFC 2046), .PP .I "Multipurpose Internet Mail Extensions (MIME) Part Three: Message Header Extensions for Non-ASCII Text" -(RFC\-2047), +(RFC 2047), .PP .I "Multipurpose Internet Mail Extensions (MIME) Part Four: Registration Procedures" -(RFC\-2048), +(RFC 2048), .PP .I "Multipurpose Internet Mail Extensions (MIME) Part Five: Conformance Criteria and Examples" -(RFC\-2049) +(RFC 2049) .I "Definition of the URL MIME External-Body Access-Type" -(RRC\-2017) +(RFC 2017) .SH DEFAULTS .nf .RB ` \-headers ' @@ -714,4 +731,5 @@ is checked. .RB ` \-contentid ' .RB ` \-nocheck ' .RB ` \-noverbose ' +.RB ` \-autoheaderencoding ' .fi