mhbuild: Removed -rfc934mode switch, which is only useful for non-MIME systems.
[mmh] / man / mhbuild.man1
index 280782e..c2614e4 100644 (file)
@@ -10,13 +10,9 @@ mhbuild \- translate MIME composition draft
 .B mhbuild
 .I file
 .RB [ \-list " | " \-nolist ]
-.RB [ \-realsize " | " \-norealsize ]
 .RB [ \-headers " | " \-noheaders ]
-.RB [ \-ebcdicsafe " | " \-noebcdicsafe ]
-.RB [ \-rfc934mode " | " \-norfc934mode ]
 .RB [ \-contentid " | " \-nocontentid ]
 .RB [ \-verbose " | " \-noverbose ]
-.RB [ \-check " | " \-nocheck ]
 .RB [ \-version ]
 .RB [ \-help ]
 .ad
@@ -65,13 +61,11 @@ to list the table of contents associated with the MIME message that is created.
 The
 .B \-headers
 switch indicates
-that a one-line banner should be displayed above the listing.  The
-.B \-realsize
-switch tells
-.B mhbuild
-to evaluate the \*(lqnative\*(rq
-(decoded) format of each content prior to listing.  This provides an
-accurate count at the expense of a small delay.  If the
+that a one-line banner should be displayed above the listing.
+The size of the \*(lqnative\*(rq
+(decoded) format of each content is evaluated.  This provides an
+accurate count at the expense of a small delay.
+If the
 .B \-verbose
 switch
 is present, then the listing will show any \*(lqextra\*(rq information
@@ -115,14 +109,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,62 +191,15 @@ 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
-given, it defaults to the current message.  Hence, the message directive
-is similar to the
-.B forw
-command, except that the former uses
-the MIME rules for encapsulation rather than those specified in RFC\-934.
+given, it defaults to the current message.  The message directive
+is used by
+.BR forw .
+.PP
 For example,
 .PP
 .RS 5
@@ -269,21 +215,8 @@ then
 will add a content of type \*(lqmultipart/digest\*(rq
 and include each message as a subpart of this content.
 .PP
-If you are using this directive to include more than one message, you
-may use the
-.B \-rfc934mode
-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
-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
-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 +371,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
@@ -457,87 +380,22 @@ including files, etc., it scans the contents of the message to determine
 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
-.B mhbuild
-to slightly change
-the way in which it performs the \*(lqquoted-printable\*(rq transfer
-encoding.  Along with encoding 8\-bit characters, it will now also encode
-certain common punctuation characters as well.  This slightly reduces the
-readability of the message, but allows the message to pass more reliably
-through mail gateways which involve the EBCDIC character encoding.
 
 .SS "Invoking mhbuild"
 Typically,
 .B mhbuild
- is invoked by the
-.B whatnow
-program.  This
-command will expect the body of the draft to be formatted as an
-.B mhbuild
-composition file.  Once you have composed this input file
-using a command such as
-.BR comp ,
-.BR repl ,
-or
-.BR forw ,
-you invoke
-.B mhbuild
-at the \*(lqWhat now\*(rq prompt with
-.PP
-.RS 5
-What now? mime
-.RE
-.PP
-prior to sending the draft.  This will cause
-.B whatnow
-to execute
-.B mhbuild
-to translate the composition file into MIME format.
-.PP
-It is also possible to have the
-.B whatnow
-program invoke
+is invoked by the
+.B send
+program.
+It expects an
 .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 .mmh/profile
-file.
-.PP
-Finally, you should consider adding this line to your profile:
-.PP
-.RS 5
-lproc: show
-.RE
-.PP
-This way, if you decide to
-.B list
-after invoking
-.BR mime ,
-the command
+composition file, which
+.B send
+will create, from the draft file, if MIME features are requested.
+This is the case with attachment headers.
 .PP
-.RS 5
-What now? list
-.RE
-.PP
-will work as you expect.
+In contrast to previous versions, the user does not need to care
+for any special actions anymore.
 
 .SS "User Environment"
 Because the environment in which
@@ -584,15 +442,6 @@ directive    ::=     "#" type "/" subtype
                          [ filename ]
                          EOL
 
-                   | "#@" type "/" subtype
-                         0*(";" attribute "=" value)
-                         [ "(" comment ")" ]
-                         [ "<" id ">" ]
-                         [ "[" description "]" ]
-                         [ "{" disposition "}" ]
-                         external-parameters
-                         EOL
-
                    | "#forw"
                          [ "<" id ">" ]
                          [ "[" description "]" ]
@@ -652,10 +501,7 @@ line         ::=     "##" text EOL
 .fi
 
 .SH "SEE ALSO"
-mhlist(1), mhshow(1), mhstore(1),
-.br
-.I "Proposed Standard for Message Encapsulation"
-(RFC\-934),
+mhlist(1), show(1), mhstore(1), forw(1),
 .br
 .I "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies"
 (RFC\-2045),
@@ -675,11 +521,7 @@ mhlist(1), mhshow(1), mhstore(1),
 .SH DEFAULTS
 .nf
 .RB ` \-headers '
-.RB ` \-realsize '
-.RB ` \-norfc934mode '
 .RB ` \-contentid '
-.RB ` \-nocheck '
-.RB ` \-noebcdicsafe '
 .RB ` \-noverbose '
 .fi