Removed leading space from lines in mhbuild and rmm man pages
[mmh] / man / mhbuild.man
index 8dd7458..7bd3103 100644 (file)
@@ -1,8 +1,7 @@
+.TH MHBUILD %manext1% "May 31, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
-.TH MHBUILD %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 mhbuild \- translate MIME composition draft
 .SH SYNOPSIS
@@ -13,6 +12,7 @@ mhbuild \- translate MIME composition draft
 .RB [ \-list " | " \-nolist ]
 .RB [ \-realsize " | " \-norealsize ]
 .RB [ \-headers " | " \-noheaders ]
+.RB [ \-directives " | " \-nodirectives ]
 .RB [ \-ebcdicsafe " | " \-noebcdicsafe ]
 .RB [ \-rfc934mode " | " \-norfc934mode ]
 .RB [ \-contentid " | " \-nocontentid ]
@@ -116,12 +116,35 @@ than one line, e.g.,
 .fi
 .RE
 .PP
-There are four kinds of directives: \*(lqtype\*(rq directives, which
+There are five 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.
+more messages; the \*(lqbegin\*(rq directive (#begin), which is
+used to create a multipart content; and the \*(lqon/off/pop\*(rq
+directives (#on, #off, #pop) which control whether any other
+directives are honored at all.
+.PP
+The
+.B \-directives
+switch allows control over whether mhbuild will honor any of the
+\*(lq#\*(rq-directives.  This can also be affected with the #on or
+#off directives, and #pop, which restores the state of processing to
+that preceding the most recent #on or #off.  (The #on, #off, and #pop
+directives are always honored, of course.) This allows inclusion of
+plain text which looks like mhbuild directives, without causing
+errors:
+.PP
+.RS 5
+.nf
+#off
+#include <stdio.h>
+printf("Hello, World!);
+#pop
+.fi
+.RE
+.PP
+Currently the stack depth for the #on/off/pop directives is 32.
 .PP
 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
@@ -225,7 +248,8 @@ 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
-Content-Disposition header, may appear in the optional \*(lq{}\*(rq.
+\*(lqContent-Disposition\*(rq header, may appear in the optional
+\*(lq{}\*(rq.
 .PP
 These parameters are of the form:
 .PP
@@ -440,7 +464,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
@@ -448,7 +472,6 @@ 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
 .B mhbuild
@@ -478,11 +501,10 @@ 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
+is invoked by the
 .B whatnow
 program.  This
 command will expect the body of the draft to be formatted as an
@@ -538,7 +560,6 @@ What now? list
 .RE
 .PP
 will work as you expect.
-
 .SS "User Environment"
 Because the environment in which
 .B mhbuild
@@ -563,7 +584,6 @@ user profile, e.g.,
 .RE
 .PP
 if it exists.
-
 .SS "Syntax of Composition Files"
 The following is the formal syntax of a
 .B mhbuild
@@ -630,8 +650,6 @@ line         ::=     "##" text EOL
                    | text EOL
 .fi
 .RE
-.PP
-
 .SH FILES
 .fc ^ ~
 .nf
@@ -640,7 +658,6 @@ line         ::=     "##" text EOL
 ^$MHBUILD~^Additional profile entries
 ^%etcdir%/mhn.defaults~^System default MIME profile entries
 .fi
-
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
@@ -650,28 +667,28 @@ line         ::=     "##" text EOL
 ^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),
-.br
+.IR mhlist (1),
+.IR mhshow (1),
+.IR mhstore (1)
+.PP
 .I "Proposed Standard for Message Encapsulation"
 (RFC\-934),
-.br
+.PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies"
 (RFC\-2045),
-.br
+.PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types"
 (RFC\-2046),
-.br
+.PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Three: Message Header Extensions for Non-ASCII Text"
 (RFC\-2047),
-.br
+.PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Four: Registration Procedures"
 (RFC\-2048),
-.br
+.PP
 .I "Multipurpose Internet Mail Extensions (MIME) Part Five: Conformance Criteria and Examples"
 (RFC\-2049)
-
 .SH DEFAULTS
 .nf
 .RB ` \-headers '
@@ -682,7 +699,3 @@ mhlist(1), mhshow(1), mhstore(1),
 .RB ` \-noebcdicsafe '
 .RB ` \-noverbose '
 .fi
-
-.SH CONTEXT
-If a folder is given, it will become the current folder.  The last
-message selected will become the current message.