Dropped old show(1) and renamed mhshow(1) to show(1).
[mmh] / man / mhbuild.man1
index 3d3260f..4fa75b5 100644 (file)
@@ -16,7 +16,6 @@ mhbuild \- translate MIME composition draft
 .RB [ \-rfc934mode " | " \-norfc934mode ]
 .RB [ \-contentid " | " \-nocontentid ]
 .RB [ \-verbose " | " \-noverbose ]
-.RB [ \-check " | " \-nocheck ]
 .RB [ \-version ]
 .RB [ \-help ]
 .ad
@@ -115,14 +114,13 @@ than one line, e.g.,
 .fi
 .RE
 .PP
-There are four kinds of directives: \*(lqtype\*(rq directives, which
-name the type and subtype of the content; \*(lqexternal-type\*(rq
-directives, which also name the type and subtype of the content; the
-\*(lqmessage\*(rq directive (#forw), which is used to forward one or
-more messages; and, the \*(lqbegin\*(rq directive (#begin), which is
-used to create a multipart content.
+There are three kinds of directives:
+\*(lqtype\*(rq,
+\*(lqmessage\*(rq (#forw),
+and \*(lqbegin\*(rq (#begin).
 .PP
-The \*(lqtype\*(rq directive is used to directly specify the type and
+.B "(1) The \*(lqtype\*(rq directive
+is used to directly specify the type and
 subtype of a content.  You may only specify discrete types in this manner
 (can't specify the types multipart or message with this directive).
 You may optionally specify the name of a file containing the contents
@@ -198,54 +196,8 @@ contents should probably be put in the file specified by the
 environment variable, instead of directly in your
 user profile.
 .PP
-The \*(lqexternal-type\*(rq directives are used to provide a MIME
-reference to a content, rather than enclosing the contents itself
-(for instance, by specifying an ftp site).  Hence, instead of
-providing a filename as with the type directives, external-parameters
-are supplied.  These look like regular parameters, so they must be
-separated accordingly.  For example,
-.PP
-.RS 5
-.nf
-#@application/octet-stream; \\
-    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"; \\
-    access-type=anon-ftp; \\
-    mode="image"
-.fi
-.RE
-.PP
-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.  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
-.RS 5
-.nf
-.ta \w'access-type=  'u
-access-type=   usually \fIanon-ftp\fR or \fImail-server\fR
-name=  filename
-permission=    read-only or read-write
-site=  hostname
-directory=     directoryname (optional)
-mode=  usually \fIascii\fR or \fIimage\fR (optional)
-size=  number of octets
-server=        mailbox
-subject=       subject to send
-body=  command to send for retrieval
-.fi
-.RE
-.PP
-The \*(lqmessage\*(rq directive (#forw) is used to specify a message or
+.B "(2) 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
 given, it defaults to the current folder.  Similarly, if a message is not
@@ -283,7 +235,8 @@ do not contain encapsulated messages themselves.  The drawback of this
 approach is that the encapsulations are generated by placing an extra
 newline at the end of the body of each message.
 .PP
-The \*(lqbegin\*(rq directive is used to create a multipart content.
+.B "(3) The \*(lqbegin\*(rq directive
+is used to create a multipart content.
 When using the \*(lqbegin\*(rq directive, you must specify at least one
 content between the begin and end pairs.
 .PP
@@ -438,16 +391,6 @@ This third part will be text/plain
                     /home/foobar/lib/picture.gif
 .fi
 .RE
-.SS "Integrity Check"
-If
-.B mhbuild
-is given the
-.B \-check
-switch, then it will also associate
-an integrity check with each \*(lqleaf\*(rq content.  This will add a
-Content-MD5 header field to the content, along with the md5 sum of the
-unencoded contents.  This may be used by the receiver of the message to
-verify that the contents of the message were not changed in transport.
 
 .SS "Transfer Encodings"
 After
@@ -458,16 +401,6 @@ which transfer encoding to use.  It will check for 8bit data, long lines,
 spaces at the end of lines, and clashes with multipart boundaries.  It will
 then choose a transfer encoding appropriate for each content type.
 .PP
-If an integrity check is being associated with each content by using
-the
-.B \-check
-switch, then
-.B mhbuild
-will encode each content with
-a transfer encoding, even it the content contains only 7\-bit data.  This
-is to increase the likelihood that the content is not changed while in
-transport.
-.PP
 The switch
 .B \-ebcdicsafe
 will cause
@@ -540,15 +473,6 @@ directive    ::=     "#" type "/" subtype
                          [ filename ]
                          EOL
 
-                   | "#@" type "/" subtype
-                         0*(";" attribute "=" value)
-                         [ "(" comment ")" ]
-                         [ "<" id ">" ]
-                         [ "[" description "]" ]
-                         [ "{" disposition "}" ]
-                         external-parameters
-                         EOL
-
                    | "#forw"
                          [ "<" id ">" ]
                          [ "[" description "]" ]
@@ -608,7 +532,7 @@ line         ::=     "##" text EOL
 .fi
 
 .SH "SEE ALSO"
-mhlist(1), mhshow(1), mhstore(1),
+mhlist(1), show(1), mhstore(1),
 .br
 .I "Proposed Standard for Message Encapsulation"
 (RFC\-934),
@@ -634,7 +558,6 @@ mhlist(1), mhshow(1), mhstore(1),
 .RB ` \-realsize '
 .RB ` \-norfc934mode '
 .RB ` \-contentid '
-.RB ` \-nocheck '
 .RB ` \-noebcdicsafe '
 .RB ` \-noverbose '
 .fi