Added exit to test-ali, temporarily, to isolate failure on

[nmh] / man / mhbuild.man

diff --git a/man/mhbuild.man b/man/mhbuild.man
index 72ce28106c4ffe1f32af7d95d579885e6416f93d..57441dad268d84f708497c01886887bbb67a3ab1 100644 (file)
--- a/man/mhbuild.man
+++ b/man/mhbuild.man
@@ -1,8 +1,7 @@
+.TH MHBUILD %manext1% "January 4, 2013" "%nmhversion%"

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

-.\" $Id$

 .\"
 .\"

-.TH MHBUILD %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 mhbuild \- translate MIME composition draft
 .SH SYNOPSIS
 .SH NAME
 mhbuild \- translate MIME composition draft
 .SH SYNOPSIS


@@ -13,7 +12,7 @@ mhbuild \- translate MIME composition draft
 .RB [ \-list " | " \-nolist ]
 .RB [ \-realsize " | " \-norealsize ]
 .RB [ \-headers " | " \-noheaders ]
 .RB [ \-list " | " \-nolist ]
 .RB [ \-realsize " | " \-norealsize ]
 .RB [ \-headers " | " \-noheaders ]

-.RB [ \-ebcdicsafe " | " \-noebcdicsafe ]
+.RB [ \-directives " | " \-nodirectives ]

 .RB [ \-rfc934mode " | " \-norfc934mode ]
 .RB [ \-contentid " | " \-nocontentid ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-rfc934mode " | " \-norfc934mode ]
 .RB [ \-contentid " | " \-nocontentid ]
 .RB [ \-verbose " | " \-noverbose ]


@@ -116,12 +115,35 @@ than one line, e.g.,
 .fi
 .RE
 .PP
 .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
 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
 .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


@@ -444,12 +466,11 @@ If
 .B mhbuild
 is given the
 .B \-check
 .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.
-
+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, per RFC
+1864.  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
 .SS "Transfer Encodings"
 After
 .B mhbuild


@@ -468,22 +489,10 @@ 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.
 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
 .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
 .B whatnow
 program.  This
 command will expect the body of the draft to be formatted as an


@@ -539,7 +548,6 @@ What now? list
 .RE
 .PP
 will work as you expect.
 .RE
 .PP
 will work as you expect.

-

 .SS "User Environment"
 Because the environment in which
 .B mhbuild
 .SS "User Environment"
 Because the environment in which
 .B mhbuild


@@ -564,7 +572,6 @@ user profile, e.g.,
 .RE
 .PP
 if it exists.
 .RE
 .PP
 if it exists.

-

 .SS "Syntax of Composition Files"
 The following is the formal syntax of a
 .B mhbuild
 .SS "Syntax of Composition Files"
 The following is the formal syntax of a
 .B mhbuild


@@ -631,8 +638,6 @@ line         ::=     "##" text EOL
                    | text EOL
 .fi
 .RE
                    | text EOL
 .fi
 .RE

-.PP
-

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf


@@ -641,7 +646,6 @@ line         ::=     "##" text EOL
 ^$MHBUILD~^Additional profile entries
 ^%etcdir%/mhn.defaults~^System default MIME profile entries
 .fi
 ^$MHBUILD~^Additional profile entries
 ^%etcdir%/mhn.defaults~^System default MIME profile entries
 .fi

-

 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf


@@ -651,28 +655,31 @@ line         ::=     "##" text EOL
 ^Current\-Folder:~^To find the default current folder
 ^mhbuild-compose-<type>*~^Template for composing contents
 .fi
 ^Current\-Folder:~^To find the default current folder
 ^mhbuild-compose-<type>*~^Template for composing contents
 .fi

-

 .SH "SEE ALSO"
 .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),
 .I "Proposed Standard for Message Encapsulation"
 (RFC\-934),

-.br
+.PP
+.I "The Content-MD5 Header Field"
+(RFC\-1864),
+.PP

 .I "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies"
 (RFC\-2045),
 .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),
 .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),
 .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),
 .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)
 .I "Multipurpose Internet Mail Extensions (MIME) Part Five: Conformance Criteria and Examples"
 (RFC\-2049)

-

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


@@ -680,10 +687,5 @@ mhlist(1), mhshow(1), mhstore(1),
 .RB ` \-norfc934mode '
 .RB ` \-contentid '
 .RB ` \-nocheck '
 .RB ` \-norfc934mode '
 .RB ` \-contentid '
 .RB ` \-nocheck '

-.RB ` \-noebcdicsafe '

 .RB ` \-noverbose '
 .fi
 .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.