From: Ken Hornstein <kenh@pobox.com>
Date: Tue, 4 Feb 2014 02:45:41 +0000 (-0500)
Subject: Document changes to mhbuild.
X-Git-Url: https://diplodocus.org/git/nmh/commitdiff_plain/9b706433f5b980baf270695f836d8cfe0510f4e6?ds=sidebyside;hp=f93ce652c5d1361b00a28db7bbb9e638197a6676

Document changes to mhbuild.
---

diff --git a/docs/pending-release-notes b/docs/pending-release-notes
index 464554b0..35bc26a3 100644
--- a/docs/pending-release-notes
+++ b/docs/pending-release-notes
@@ -72,6 +72,8 @@ NEW FEATURES
 - A new header, "Attach", is supported by mhbuild; it is used to replace
   previous functionality (which by default used a header named
   Nmh-Attachment).
+- The default Content-Transfer-Encoding for text parts is now 8bit.
+- mhbuild(1) now supports a selectable Content-Transfer-Encoding
 
 -----------------
 OBSOLETE FEATURES
diff --git a/man/mhbuild.man b/man/mhbuild.man
index e4bd7933..db80e232 100644
--- a/man/mhbuild.man
+++ b/man/mhbuild.man
@@ -21,6 +21,8 @@ mhbuild \- translate MIME composition draft
 .RB [ \-headerencoding 
 .IR encoding\-algorithm
 .RB " | " \-autoheaderencoding ]
+.RB [ \-maxunencoded
+.IR line\-length ]
 .RB [ \-dist ]
 .RB [ \-version ]
 .RB [ \-help ]
@@ -401,6 +403,18 @@ characters.  The
 switch suppresses creation of all \*(lqContent-ID:\*(rq headers,
 even in the top level of the message.
 .PP
+Normally
+.B mhbuild
+will choose an appropriate Content\-Transfer\-Encoding based on the content
+and the MIME Content\-Type.  However, you can override that in an
+.B mhbuild
+directive by specifying \*(lq*\*(rq and the encoding.  Acceptable encoding
+values are \*(lq8bit\*(rq, \*(lqqp\(*rq (for quoted\-printable), and
+\*(lqb64\*(rq (for base64 encoding).  It should be noted that undesired
+results may occur if 8bit or quoted\-printable is selected for binary
+content, due to the translation between Unix line endings and the line
+endings use by the mail transport system.
+.PP
 In addition to the various directives, plaintext can be present.
 Plaintext is gathered, until a directive is found or the draft is
 exhausted, and this is made to form a text content.  If the plaintext
@@ -473,6 +487,13 @@ 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
+By default text content with the high bit set is encoded with a 8bit
+Content\-Transfer\-Encoding.  If the text has lines longer than the value
+of
+.B \-maxunencoded
+(which defaults to 78) then the text is encoded using the quoted\-printable
+encoding.
+.PP
 The
 .B \-headerencoding
 switch will indicate which algorithm to use when encoding any message headers
@@ -643,6 +664,7 @@ directive    ::=     "#" type "/" subtype
                          [ "<" id ">" ]
                          [ "[" description "]" ]
                          [ "{" disposition "}" ]
+			 [ "*8bit" | "*qp" | "*b64" ]
                          [ filename ]
                          EOL
 
@@ -652,6 +674,7 @@ directive    ::=     "#" type "/" subtype
                          [ "<" id ">" ]
                          [ "[" description "]" ]
                          [ "{" disposition "}" ]
+			 [ "*8bit" | "*qp" | "*b64" ]
                          external-parameters
                          EOL
 
@@ -683,6 +706,7 @@ plaintext    ::=     [ "Content-Description:"
                          [ "(" comment ")" ]
                          [ "[" description "]" ]
                          [ "{" disposition "}" ]
+			 [ "*8bit" | "*qp" | "*b64" ]
                          EOL
                          1*line
                      [ "#" EOL ]
@@ -754,4 +778,5 @@ is checked.
 .RB ` \-nocheck '
 .RB ` \-noverbose '
 .RB ` \-autoheaderencoding '
+.RB ` "\-maxunencoded\ 78"'
 .fi