Updated MACHINES to show package requirements on Linux and Cygwin.

[nmh] / man / mhbuild.man

diff --git a/man/mhbuild.man b/man/mhbuild.man
index ab757d3465dfff12089a562958e523aff01d202e..2f0e8ee7b21c675159c1e0001178a1beb002ff82 100644 (file)
--- a/man/mhbuild.man
+++ b/man/mhbuild.man
@@ -9,6 +9,7 @@ mhbuild \- translate MIME composition draft
 .HP 5
 .B mhbuild
 .I file
 .HP 5
 .B mhbuild
 .I file

+.RB [ \-auto " | " \-noauto ]

 .RB [ \-list " | " \-nolist ]
 .RB [ \-realsize " | " \-norealsize ]
 .RB [ \-headers " | " \-noheaders ]
 .RB [ \-list " | " \-nolist ]
 .RB [ \-realsize " | " \-norealsize ]
 .RB [ \-headers " | " \-noheaders ]


@@ -17,6 +18,9 @@ mhbuild \- translate MIME composition draft
 .RB [ \-contentid " | " \-nocontentid ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-check " | " \-nocheck ]
 .RB [ \-contentid " | " \-nocontentid ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-check " | " \-nocheck ]

+.RB [ \-headerencoding 
+.IR encoding\-algorithm
+.RB " | " \-autoheaderencoding ]

 .RB [ \-version ]
 .RB [ \-help ]
 .ad
 .RB [ \-version ]
 .RB [ \-help ]
 .ad


@@ -28,11 +32,8 @@ a valid MIME message.
 .PP
 .B mhbuild
 creates multi-media messages as specified in RFC 2045
 .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.
+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
 .PP
 If you specify the name of the composition file as \*(lq-\*(rq,
 then


@@ -454,6 +455,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
 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
 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,6 +546,14 @@ to execute
 .B mhbuild
 to translate the composition file into MIME format.
 .PP
 .B mhbuild
 to translate the composition file into MIME format.
 .PP

+Normally it is an error to invoke
+.B mhbuild
+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

 It is also possible to have the
 .B whatnow
 program invoke
 It is also possible to have the
 .B whatnow
 program invoke


@@ -714,4 +736,5 @@ is checked.
 .RB ` \-contentid '
 .RB ` \-nocheck '
 .RB ` \-noverbose '
 .RB ` \-contentid '
 .RB ` \-nocheck '
 .RB ` \-noverbose '

+.RB ` \-autoheaderencoding '

 .fi
 .fi