-.TH MHBUILD %manext1% "March 21, 2013" "%nmhversion%"
+.TH MHBUILD %manext1% "January 23, 2014" "%nmhversion%"
.\"
.\" %nmhwarning%
.\"
.HP 5
.B mhbuild
.I file
+.RB [ \-auto " | " \-noauto ]
.RB [ \-list " | " \-nolist ]
.RB [ \-realsize " | " \-norealsize ]
.RB [ \-headers " | " \-noheaders ]
.RB [ \-headerencoding
.IR encoding\-algorithm
.RB " | " \-autoheaderencoding ]
+.RB [ \-maxunencoded
+.IR line\-length ]
+.RB [ \-dist ]
.RB [ \-version ]
.RB [ \-help ]
.ad
is present, then the listing will show any \*(lqextra\*(rq information
that is present in the message, such as comments in the
\*(lqContent-Type\*(rq header.
+.SS "Simplified Attachment Interface"
+For users who wish to simply attach files to text content,
+.B mhbuild
+will scan the composition file for \*(lqAttach\*(rq headers. An
+\*(lqAttach\*(rq header contains a filename that will be appended to the
+message using normal MIME encapsulation rules. One filename is allowed
+per \*(lqAttach\*(rq header, but multiple \*(lqAttach\*(rq headers are
+allowed ber composition file.
.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
+These files will be appended after any other MIME content, including any
+content specified by
.B mhbuild
-to automatically pick the encoding algorithm based on the frequency of
-8\-bit characters.
+directives (see below). See
+.IR send (1)
+for more details.
.SS "Translating the Composition File"
.B mhbuild
is essentially a filter to aid in the composition of MIME
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
high bit set) and the character set is not specified as above, then
.B mhbuild
will assume the character set is of the type given by the
-environment variable MM_CHARSET. If this environment variable is not
+standard
+.IR locale (1)
+environment variables. If these environment variables are not
set, then the character set will be labeled as \*(lqx-unknown\*(rq.
.PP
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
+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
.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.
+The use of
+.B \-auto
+also enables the
+.B \-nodirectives
+switch.
.PP
Finally, you should consider adding this line to your profile:
.PP
.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
[ "<" id ">" ]
[ "[" description "]" ]
[ "{" disposition "}" ]
+ [ "*8bit" | "*qp" | "*b64" ]
[ filename ]
EOL
[ "<" id ">" ]
[ "[" description "]" ]
[ "{" disposition "}" ]
+ [ "*8bit" | "*qp" | "*b64" ]
external-parameters
EOL
[ "(" comment ")" ]
[ "[" description "]" ]
[ "{" disposition "}" ]
+ [ "*8bit" | "*qp" | "*b64" ]
EOL
1*line
[ "#" EOL ]
.RB ` \-nocheck '
.RB ` \-noverbose '
.RB ` \-autoheaderencoding '
+.RB ` "\-maxunencoded\ 78"'
.fi
projects / nmh / blobdiff