]> diplodocus.org Git - nmh/blobdiff - man/mhbuild.man
Oops, should have offset file in showbuildenv rather than cat.
[nmh] / man / mhbuild.man
index 7667b3a353b7a3ba0b3019ab7ab3d207350ae18e..1ff553033c6cfb9fe442b11fd412b0a7b333dee8 100644 (file)
@@ -1,4 +1,4 @@
-.TH MHBUILD %manext1% "September 23, 2016" "%nmhversion%"
+.TH MHBUILD %manext1% "October 15, 2016" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -8,6 +8,8 @@ mhbuild \- translate MIME composition draft
 .na
 .HP 5
 .B mhbuild
+.RB [ \-help ]
+.RB [ \-version ]
 .I file
 .RB [ \-auto " | " \-noauto ]
 .RB [ \-list " | " \-nolist ]
@@ -25,8 +27,6 @@ mhbuild \- translate MIME composition draft
 .RB [ \-maxunencoded
 .IR line\-length ]
 .RB [ \-dist ]
-.RB [ \-version ]
-.RB [ \-help ]
 .ad
 .SH DESCRIPTION
 The
@@ -194,6 +194,7 @@ entry, e.g.,
 excludes parts of that
 .I TYPE
 from the draft.
+.PP
 The
 .I mhn.defaults
 file
@@ -204,7 +205,9 @@ and
 entries.
 Profile entries can be used to override corresponding
 .I mhn.defaults
-entries, as usual.
+entries, as usual.  Text converters should limit text line lengths
+to a maximum of 78 characters, and must limit them to a maximum of 998
+characters, per RFC 5322 Sec.\& 2.1.1.
 .PP
 For each
 .I TYPE
@@ -214,14 +217,13 @@ part in
 runs
 .I CONVERTER ARGSTRING
 on the content of the part.
-.PP
 Each part in
 .I FILE
 that has no corresponding TYPE entry in the profile or
 .I mhn.defaults
 is
 excluded from the draft; the user can include them using mhbuild
-directives as usual.
+directives.
 .PP
 .B repl
 inserts
@@ -765,17 +767,19 @@ 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,
+for base\-64 encoding,
 .I quoted
 for quoted\-printable encoding, and
-.I utf-8
-which requires that all 8-bit header field bodies be encoded as UTF-8
-(RFC 6530) and that the SMTP server support SMTPUTF8 (RFC 6531).
+.I utf\-8
+which requires that all 8\-bit header field bodies be encoded as UTF\-8
+(RFC 6530) and that the message be sent to a SMTP server that supports
+SMTPUTF8 (RFC 6531).
 The
 .B \-autoheaderencoding
-switch will instruct
+switch instructs
 .B mhbuild
-to automatically pick the algorithm that results in a shorter encoded string.
+to automatically pick the encoding, either base64 or quoted\-printable,
+that results in a shorter encoded string.
 .PP
 Putting this all together,
 here is an example of a more complicated message draft.
@@ -829,7 +833,7 @@ the
 switch, then
 .B mhbuild
 will encode each content with
-a transfer encoding, even it the content contains only 7\-bit data.
+a transfer encoding, even if the content contains only 7\-bit data.
 This
 is to increase the likelihood that the content is not changed while in
 transport.
@@ -1049,6 +1053,9 @@ Template for composing contents.
 .I "Multipurpose Internet Mail Extensions (MIME) Part Three: Message Header Extensions for Non-ASCII Text"
 (RFC 2047)
 .PP
+.I "Internet Message Format"
+(RFC 5322)
+.PP
 .I "MIME Parameter Value and Encoded Word Extensions: Character Sets, Languages, and Continuations"
 (RFC 2231)
 .PP