no-op to force check the buildbots.

[nmh] / man / mhbuild.man

diff --git a/man/mhbuild.man b/man/mhbuild.man
index db80e232d6d39388874d66e5399bb420562ca19b..4b261f33def3d05d61551ca2901f9d8d7ac6d1b4 100644 (file)
--- a/man/mhbuild.man
+++ b/man/mhbuild.man
@@ -1,4 +1,4 @@
-.TH MHBUILD %manext1% "January 23, 2014" "%nmhversion%"
+.TH MHBUILD %manext1% "March 13, 2014" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\"
 .\" %nmhwarning%
 .\"


@@ -17,6 +17,7 @@ mhbuild \- translate MIME composition draft
 .RB [ \-rfc934mode " | " \-norfc934mode ]
 .RB [ \-contentid " | " \-nocontentid ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-rfc934mode " | " \-norfc934mode ]
 .RB [ \-contentid " | " \-nocontentid ]
 .RB [ \-verbose " | " \-noverbose ]

+.RB [ \-disposition " | " \-nodisposition ]

 .RB [ \-check " | " \-nocheck ]
 .RB [ \-headerencoding 
 .IR encoding\-algorithm
 .RB [ \-check " | " \-nocheck ]
 .RB [ \-headerencoding 
 .IR encoding\-algorithm


@@ -36,7 +37,7 @@ a valid MIME message.
 .B mhbuild
 creates multi-media messages as specified in RFC 2045
 to RFC 2049.  This includes the encoding of message headers as specified
 .B mhbuild
 creates multi-media messages as specified in RFC 2045
 to RFC 2049.  This includes the encoding of message headers as specified

-by RFC 2047.
+by RFC 2047, and the encoding of MIME parameters as specified in RFC 2231.

 .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


@@ -81,6 +82,11 @@ switch
 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.
 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.

+.PP
+If the
+.B \-disposition
+switch is present, then the listing will show any relevant information from
+the \*(lqContent-Disposition\*(rq header.

 .SS "Simplified Attachment Interface"
 For users who wish to simply attach files to text content,
 .B mhbuild
 .SS "Simplified Attachment Interface"
 For users who wish to simply attach files to text content,
 .B mhbuild


@@ -96,6 +102,23 @@ content specified by
 directives (see below).  See
 .IR send (1)
 for more details.
 directives (see below).  See
 .IR send (1)
 for more details.

+.PP
+By default, the Content-Disposition will be \*(lqattachment\*(rq.
+.B mhbuild
+looks for user profile and mhn.defaults entries of the form
+.PP
+.RS 5
+mhbuild-disposition-<type>/<subtype>
+.RE
+or
+.RS 5
+mhbuild-disposition-<type>
+.RE
+.PP
+to supply the disposition value.  The only supported values are
+.I attachment
+and
+.IR inline.

 .SS "Translating the Composition File"
 .B mhbuild
 is essentially a filter to aid in the composition of MIME
 .SS "Translating the Composition File"
 .B mhbuild
 is essentially a filter to aid in the composition of MIME


@@ -300,7 +323,7 @@ would be as follows:
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-Any long URLs will be wrapped according to RFC 2017 rules.
+Any long URLs will be wrapped according to RFC 2231 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
 .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


@@ -409,7 +432,7 @@ 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
 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
+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
 \*(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


@@ -638,15 +661,17 @@ definitions useful for that machine.
 .PP
 Finally,
 .B mhbuild
 .PP
 Finally,
 .B mhbuild

-will attempt to consult a global
-.B mhbuild
-user profile, e.g.,
+will attempt to consult

 .PP
 .RS 5
 .PP
 .RS 5

-%etcdir%/mhn.defaults
+%nmhetcdir%/mhn.defaults

 .RE
 .PP
 if it exists.
 .RE
 .PP
 if it exists.

+.PP
+See "Profile Lookup" in
+.IR mh-profile (5)
+for the profile search order, and for how duplicate entries are treated.

 .SS "Syntax of Composition Files"
 The following is the formal syntax of a
 .B mhbuild
 .SS "Syntax of Composition Files"
 The following is the formal syntax of a
 .B mhbuild


@@ -723,15 +748,15 @@ locations: absolute pathnames are accessed directly, tilde expansion
 is done on usernames, and files are searched for in the user's
 .I Mail
 directory as specified in their profile.  If not found there, the directory
 is done on usernames, and files are searched for in the user's
 .I Mail
 directory as specified in their profile.  If not found there, the directory

-.RI \*(lq %etcdir% \*(rq
+.RI \*(lq %nmhetcdir% \*(rq

 is checked.
 .PP
 .fc ^ ~
 .nf
 is checked.
 .PP
 .fc ^ ~
 .nf

-.ta \w'%etcdir%/ExtraBigFileName  'u
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u

 ^$HOME/\&.mh\(ruprofile~^The user profile
 ^$MHBUILD~^Additional profile entries
 ^$HOME/\&.mh\(ruprofile~^The user profile
 ^$MHBUILD~^Additional profile entries

-^%etcdir%/mhn.defaults~^System default MIME profile entries
+^%nmhetcdir%/mhn.defaults~^System default MIME profile entries

 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~


@@ -766,9 +791,13 @@ is checked.
 (RFC 2048),
 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Five: Conformance Criteria and Examples"
 (RFC 2048),
 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Five: Conformance Criteria and Examples"

-(RFC 2049)
+(RFC 2049),
+.PP

 .I "Definition of the URL MIME External-Body Access-Type"
 .I "Definition of the URL MIME External-Body Access-Type"

-(RFC 2017)
+(RFC 2017),
+.PP
+.I "MIME Parameter Value and Encoded Word Extensions: Character Sets, Languages, and Continuations"
+(RFC 2231)

 .SH DEFAULTS
 .nf
 .RB ` \-headers '
 .SH DEFAULTS
 .nf
 .RB ` \-headers '


@@ -777,6 +806,7 @@ is checked.
 .RB ` \-contentid '
 .RB ` \-nocheck '
 .RB ` \-noverbose '
 .RB ` \-contentid '
 .RB ` \-nocheck '
 .RB ` \-noverbose '

+.RB ` \-nodisposition '

 .RB ` \-autoheaderencoding '
 .RB ` "\-maxunencoded\ 78"'
 .fi
 .RB ` \-autoheaderencoding '
 .RB ` "\-maxunencoded\ 78"'
 .fi