Added note that suffixes were removed from filenames of temporary files.

[nmh] / man / mhbuild.man

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

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


@@ -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,10 @@ 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 [ \-dist ]

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


@@ -27,12 +32,9 @@ command will translate a MIME composition draft into
 a valid MIME message.
 .PP
 .B mhbuild
 a valid MIME message.
 .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.
+creates multi-media messages as specified in RFC 2045
+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


@@ -77,6 +79,21 @@ 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.

+.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
+These files will be appended after any other MIME content, including any
+content specified by
+.B mhbuild
+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
 .SS "Translating the Composition File"
 .B mhbuild
 is essentially a filter to aid in the composition of MIME


@@ -234,7 +251,7 @@ separated accordingly.  For example,
     type=tar; \\
     conversions=compress \\
     [this is the nmh distribution] \\
     type=tar; \\
     conversions=compress \\
     [this is the nmh distribution] \\

-    {application; filename="nmh.tar.gz"} \\
+    {attachment; filename="nmh.tar.gz"} \\

     name="nmh.tar.gz"; \\
     directory="/pub/nmh"; \\
     site="ftp.math.gatech.edu"; \\
     name="nmh.tar.gz"; \\
     directory="/pub/nmh"; \\
     site="ftp.math.gatech.edu"; \\


@@ -255,7 +272,7 @@ These parameters are of the form:
 .RS 5
 .nf
 .ta \w'access-type=  'u
 .RS 5
 .nf
 .ta \w'access-type=  'u

-access-type=   usually \fIanon-ftp\fR or \fImail-server\fR
+access-type=   usually \fIanon-ftp\fR, \fImail-server\fR, or \fIurl\fR

 name=  filename
 permission=    read-only or read-write
 site=  hostname
 name=  filename
 permission=    read-only or read-write
 site=  hostname


@@ -265,9 +282,24 @@ size=      number of octets
 server=        mailbox
 subject=       subject to send
 body=  command to send for retrieval
 server=        mailbox
 subject=       subject to send
 body=  command to send for retrieval

+url=   URL of content

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

+A mimimum \*(lqexternal\-type\*(rq directive for the
+.B url
+.I access\-type
+would be as follows:
+.PP
+.RS 3
+.nf
+#@application/octet-stream [] access-type=url; \\
+  url="http://download.savannah.gnu.org/releases/nmh/nmh-1.5.tar.gz"
+.fi
+.RE
+.PP
+Any long URLs will be wrapped according to RFC 2017 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
 the folder and which messages are to be forwarded.  If a folder is not
 The \*(lqmessage\*(rq directive (#forw) is used to specify a message or
 group of messages to include.  You may optionally specify the name of
 the folder and which messages are to be forwarded.  If a folder is not


@@ -276,7 +308,7 @@ given, it defaults to the current message.  Hence, the message directive
 is similar to the
 .B forw
 command, except that the former uses
 is similar to the
 .B forw
 command, except that the former uses

-the MIME rules for encapsulation rather than those specified in RFC\-934.
+the MIME rules for encapsulation rather than those specified in RFC 934.

 For example,
 .PP
 .RS 5
 For example,
 .PP
 .RS 5


@@ -299,8 +331,8 @@ switch.  This switch will indicate that
 .B mhbuild
 should attempt to utilize the MIME encapsulation rules
 in such a way that the \*(lqmultipart/digest\*(rq that is created
 .B mhbuild
 should attempt to utilize the MIME encapsulation rules
 in such a way that the \*(lqmultipart/digest\*(rq that is created

-is (mostly) compatible with the encapsulation specified in RFC\-934.
-If given, then RFC\-934 compliant user-agents should be able to burst the
+is (mostly) compatible with the encapsulation specified in RFC 934.
+If given, then RFC 934 compliant user-agents should be able to burst the

 message on reception\0--\0providing that the messages being encapsulated
 do not contain encapsulated messages themselves.  The drawback of this
 approach is that the encapsulations are generated by placing an extra
 message on reception\0--\0providing that the messages being encapsulated
 do not contain encapsulated messages themselves.  The drawback of this
 approach is that the encapsulations are generated by placing an extra


@@ -432,13 +464,28 @@ If a text content contains any 8\-bit characters (characters with the
 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
 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
 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

+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


@@ -517,19 +564,18 @@ to execute
 .B mhbuild
 to translate the composition file into MIME format.
 .PP
 .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
 .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
 .PP
 Finally, you should consider adding this line to your profile:
 .PP


@@ -548,6 +594,14 @@ What now? list
 .RE
 .PP
 will work as you expect.
 .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
 .SS "User Environment"
 Because the environment in which
 .B mhbuild


@@ -639,6 +693,15 @@ line         ::=     "##" text EOL
 .fi
 .RE
 .SH FILES
 .fi
 .RE
 .SH FILES

+.B mhbuild
+looks for additional user profile files and mhn.defaults in multiple
+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
+.RI \*(lq %etcdir% \*(rq
+is checked.
+.PP

 .fc ^ ~
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u
 .fc ^ ~
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u


@@ -661,25 +724,27 @@ line         ::=     "##" text EOL
 .IR mhstore (1)
 .PP
 .I "Proposed Standard for Message Encapsulation"
 .IR mhstore (1)
 .PP
 .I "Proposed Standard for Message Encapsulation"

-(RFC\-934),
+(RFC 934),

 .PP
 .I "The Content-MD5 Header Field"
 .PP
 .I "The Content-MD5 Header Field"

-(RFC\-1864),
+(RFC 1864),

 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies"
 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies"

-(RFC\-2045),
+(RFC 2045),

 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types"
 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types"

-(RFC\-2046),
+(RFC 2046),

 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Three: Message Header Extensions for Non-ASCII Text"
 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Three: Message Header Extensions for Non-ASCII Text"

-(RFC\-2047),
+(RFC 2047),

 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Four: Registration Procedures"
 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Four: Registration Procedures"

-(RFC\-2048),
+(RFC 2048),

 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Five: Conformance Criteria and Examples"
 .PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Five: Conformance Criteria and Examples"

-(RFC\-2049)
+(RFC 2049)
+.I "Definition of the URL MIME External-Body Access-Type"
+(RFC 2017)

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


@@ -688,4 +753,5 @@ line         ::=     "##" text EOL
 .RB ` \-contentid '
 .RB ` \-nocheck '
 .RB ` \-noverbose '
 .RB ` \-contentid '
 .RB ` \-nocheck '
 .RB ` \-noverbose '

+.RB ` \-autoheaderencoding '

 .fi
 .fi