Remove RCS keywords, since they no longer work after git migration.
[mmh] / man / mhbuild.man
index 7024e48..b0af881 100644 (file)
@@ -1,11 +1,11 @@
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
 .TH MHBUILD %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 mhbuild \- translate MIME composition draft
 .SH SYNOPSIS
+.na
 .HP 5
 .B mhbuild
 .I file
@@ -14,10 +14,12 @@ mhbuild \- translate MIME composition draft
 .RB [ \-headers " | " \-noheaders ]
 .RB [ \-ebcdicsafe " | " \-noebcdicsafe ]
 .RB [ \-rfc934mode " | " \-norfc934mode ]
+.RB [ \-contentid " | " \-nocontentid ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-check " | " \-nocheck ]
 .RB [ \-version ]
 .RB [ \-help ]
+.ad
 .SH DESCRIPTION
 The
 .B mhbuild
@@ -209,6 +211,7 @@ separated accordingly.  For example,
     type=tar; \\
     conversions=compress \\
     [this is the nmh distribution] \\
+    {application; filename="nmh.tar.gz"} \\
     name="nmh.tar.gz"; \\
     directory="/pub/nmh"; \\
     site="ftp.math.gatech.edu"; \\
@@ -220,7 +223,9 @@ separated accordingly.  For example,
 You must give a description string to separate the content parameters
 from the external-parameters (although this string may be empty).
 This description string is specified by enclosing it within
-\*(lq[]\*(rq.
+\*(lq[]\*(rq.  A disposition string, to appear in a
+\*(lqContent-Disposition\*(rq header, may appear in the optional
+\*(lq{}\*(rq.
 .PP
 These parameters are of the form:
 .PP
@@ -308,11 +313,38 @@ character.  This description will be copied into the
 .fi
 .RE
 .PP
+Similarly, a disposition string may optionally be provided between
+\*(lq{\*(rq and \*(lq}\*(rq characters; it will be copied into the
+\*(lqContent-Disposition\*(rq header when the directive is processed.
+If a disposition string is provided that does not contain a filename
+parameter, and a filename is provided in the directive, it will be
+added to the \*(lqContent-Disposition\*(rq header.  For example, the
+following directive:
+.PP
+.RS 5
+.nf
+#text/plain; charset=iso-8859-1 <>{attachment} /tmp/summary.txt
+.fi
+.RE
+.PP
+creates these message part headers:
+.PP
+.RS 5
+.nf
+Content-Type: text/plain; charset="iso-8859-1"
+Content-Disposition: attachment; filename="summary.txt"
+.fi
+.RE
+.PP
 By default,
 .B mhbuild
-will generate a unique \*(lqContent-ID:\*(rq for
-each directive; however, the user may override this by defining the ID
-using the \*(lq<\*(rq and \*(lq>\*(rq characters.
+will generate a unique \*(lqContent-ID:\*(rq for each directive,
+corresponding to each message part; however, the user may override
+this by defining the ID using the \*(lq<\*(rq and \*(lq>\*(rq
+characters.  The
+.B \-nocontentid
+switch suppresses creation of all \*(lqContent-ID:\*(rq headers,
+even in the top level of the message.
 .PP
 In addition to the various directives, plaintext can be present.
 Plaintext is gathered, until a directive is found or the draft is
@@ -408,7 +440,7 @@ This third part will be text/plain
 .RE
 .SS "Integrity Check"
 If
-.B Imhbuild
+.B mhbuild
 is given the
 .B \-check
 switch, then it will also associate
@@ -548,6 +580,7 @@ directive    ::=     "#" type "/" subtype
                          [ "(" comment ")" ]
                          [ "<" id ">" ]
                          [ "[" description "]" ]
+                         [ "{" disposition "}" ]
                          [ filename ]
                          EOL
 
@@ -556,18 +589,21 @@ directive    ::=     "#" type "/" subtype
                          [ "(" comment ")" ]
                          [ "<" id ">" ]
                          [ "[" description "]" ]
+                         [ "{" disposition "}" ]
                          external-parameters
                          EOL
 
                    | "#forw"
                          [ "<" id ">" ]
                          [ "[" description "]" ]
+                         [ "{" disposition "}" ]
                          [ "+"folder ] [ 0*msg ]
                          EOL
 
                    | "#begin"
                            [ "<" id ">" ]
                            [ "[" description "]" ]
+                           [ "{" disposition "}" ]
                            [   "alternative"
                              | "parallel"
                              | something-else    ]
@@ -584,6 +620,7 @@ plaintext    ::=     [ "Content-Description:"
                          0*(";" attribute "=" value)
                          [ "(" comment ")" ]
                          [ "[" description "]" ]
+                         [ "{" disposition "}" ]
                          EOL
                          1*line
                      [ "#" EOL ]
@@ -598,10 +635,11 @@ line         ::=     "##" text EOL
 .SH FILES
 .fc ^ ~
 .nf
-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
+.ta \w'%etcdir%/ExtraBigFileName  'u
 ^$HOME/\&.mh\(ruprofile~^The user profile
 ^$MHBUILD~^Additional profile entries
 ^%etcdir%/mhn.defaults~^System default MIME profile entries
+.fi
 
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
@@ -611,6 +649,7 @@ line         ::=     "##" text EOL
 ^Path:~^To determine the user's nmh directory
 ^Current\-Folder:~^To find the default current folder
 ^mhbuild-compose-<type>*~^Template for composing contents
+.fi
 
 .SH "SEE ALSO"
 mhlist(1), mhshow(1), mhstore(1),
@@ -638,9 +677,11 @@ mhlist(1), mhshow(1), mhstore(1),
 .RB ` \-headers '
 .RB ` \-realsize '
 .RB ` \-norfc934mode '
+.RB ` \-contentid '
 .RB ` \-nocheck '
 .RB ` \-noebcdicsafe '
 .RB ` \-noverbose '
+.fi
 
 .SH CONTEXT
 If a folder is given, it will become the current folder.  The last