X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fmhbuild.man;h=b0af8810877886c4dd44af2ed49ff50bb112a86d;hp=497ff3ddbdec6bd5928eb7e0ba557d5149e0c347;hb=5dd6771b28c257af405d7248639ed0e3bcdce38b;hpb=1691e80890e5d8ba258c51c214a3e91880e1db2b diff --git a/man/mhbuild.man b/man/mhbuild.man index 497ff3d..b0af881 100644 --- a/man/mhbuild.man +++ b/man/mhbuild.man @@ -1,99 +1,127 @@ .\" .\" %nmhwarning% -.\" $Id$ .\" -.\" include the -mh macro file -.so %etcdir%/tmac.h -.\" -.TH MHBUILD %manext1% MH.6.8 [%nmhversion%] +.TH MHBUILD %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mhbuild \- translate MIME composition draft .SH SYNOPSIS -.in +.5i -.ti -.5i -mhbuild file -.br -\%[\-list] \%[-nolist] -\%[\-realsize] \%[\-norealsize] -.br -\%[\-headers] \%[\-noheaders] -\%[\-ebcdicsafe] \%[\-noebcdicsafe] -.br -\%[\-rfc934mode] \%[\-norfc934mode] -\%[\-verbose] \%[\-noverbose] -.br -\%[\-check] \%[\-nocheck] -\%[\-version] -\%[\-help] -.in -.5i +.na +.HP 5 +.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 .SH DESCRIPTION -The \fImhbuild\fR command will translate a MIME composition draft into +The +.B mhbuild +command will translate a MIME composition draft into a valid MIME message. - -\fImhbuild\fR creates multi-media messages as specified in RFC\-2045 -thru RFC\-2049. Currently \fImhbuild\fR only supports encodings in +.PP +.B mhbuild +creates multi-media messages as specified in RFC\-2045 +thru RFC\-2049. Currently +.B mhbuild +only supports encodings in message bodies, and does not support the encoding of message headers as specified in RFC\-2047. - +.PP If you specify the name of the composition file as \*(lq-\*(rq, -then \fImhbuild\fR will accept the composition draft on the standard -input. If the translation of this input is successful, \fImhbuild\fR +then +.B mhbuild +will accept the composition draft on the standard +input. If the translation of this input is successful, +.B mhbuild will output the new MIME message to the standard output. This argument must be the last argument on the command line. - -Otherwise if the file argument to \fImhbuild\fR is the name of a valid -composition file, and the translation is successful, \fImhbuild\fR will -replace the original file with the new MIME message. It will rename +.PP +Otherwise if the file argument to +.B mhbuild +is the name of a valid +composition file, and the translation is successful, +.B mhbuild +will replace the original file with the new MIME message. It will rename the original file to start with the \*(lq,\*(rq character and end with the string \*(lq.orig\*(rq, e.g., if you are editing the file \*(lqdraft\*(rq, it will be renamed to \*(lq,draft.orig\*(rq. This allows you to easily -recover the \fImhbuild\fR input file. - -.Uh "Listing the Contents" -The `\-list' switch tells \fImhbuild\fR to list the table of contents -associated with the MIME message that is created. - -The `\-headers' switch indicates +recover the +.B mhbuild +input file. +.SS "Listing the Contents" +The +.B \-list +switch tells +.B mhbuild +to list the table of contents associated with the MIME message that is created. +.PP +The +.B \-headers +switch indicates that a one-line banner should be displayed above the listing. The -`\-realsize' switch tells \fImhbuild\fR to evaluate the \*(lqnative\*(rq +.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 `\-verbose' switch +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 -that is present in the message, such as comments in the Content-Type header. - -.Uh "Translating the Composition File" -\fImhbuild\fR is essentially a filter to aid in the composition of MIME -messages. \fImhbuild\fR will convert an -\fImhbuild\fR \*(lqcomposition file\*(rq -into a valid MIME message. A \fImhbuild\fR \*(lqcomposition file\*(rq +that is present in the message, such as comments in the +\*(lqContent-Type\*(rq header. +.SS "Translating the Composition File" +.B mhbuild +is essentially a filter to aid in the composition of MIME +messages. +.B mhbuild +will convert an +.B mhbuild +\*(lqcomposition file\*(rq +into a valid MIME message. A +.B mhbuild +\*(lqcomposition file\*(rq is just a file containing plain text that is interspersed -with various \fImhbuild\fR directives. When this file is processed -by \fImhbuild\fR, the various directives will be expanded to the +with various +.B mhbuild +directives. When this file is processed +by +.BR mhbuild , +the various directives will be expanded to the appropriate content, and will be encoded according to the MIME standards. The resulting MIME message can then be sent by electronic mail. - -The formal syntax for a \fImhbuild\fR composition file is defined at the +.PP +The formal syntax for a +.B mhbuild +composition file is defined at the end of this document, but the ideas behind this format are not complex. Basically, the body contains one or more contents. A content consists of either a directive, indicated with a \*(lq#\*(rq as the first character of a line; or, plaintext (one or more lines of text). The continuation character, \*(lq\\\*(lq, may be used to enter a single directive on more than one line, e.g., -.sp +.PP +.RS 5 .nf -.in +.5i #image/png \\ /home/foobar/junk/picture.png -.in -.5i .fi -.sp +.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. - +.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 (can't specify the types multipart or message with this directive). @@ -102,96 +130,107 @@ in \*(lqnative\*(rq (decoded) format. If this filename starts with the \*(lq|\*(rq character, then it represents a command to execute whose output is captured accordingly. For example, -.sp +.PP +.RS 5 .nf -.in +.5i #audio/basic |raw2audio -F < /usr/lib/sound/giggle.au -.in -.5i .fi -.sp -If a filename is not given, \fImhbuild\fR will look for information in the +.RE +.PP +If a filename is not given, +.B mhbuild +will look for information in the user's profile to determine how the different contents should be composed. This is accomplished by consulting a composition string, and executing -it under \fB/bin/sh\fR, with the standard output set to the content. -If the `\-verbose' switch is given, \fImhbuild\fR will echo any commands -that are used to create contents in this way. -.ne 13 +it under +.BR /bin/sh , +with the standard output set to the content. +If the +.B \-verbose +switch is given, +.B mhbuild +will echo any commands that are used to create contents in this way. +.PP The composition string may contain the following escapes: -.sp +.PP +.RS 5 .nf -.in +.5i .ta \w'%P 'u %a Insert parameters from directive %f Insert filename containing content %F %f, and stdout is not re-directed %s Insert content subtype %% Insert character % -.re -.in -.5i .fi -.sp - +.RE +.PP First, -\fImhbuild\fR will look for an entry of the form: -.sp -.in +.5i +.B mhbuild +will look for an entry of the form: +.PP +.RS 5 mhbuild-compose-/ -.in -.5i -.sp +.RE +.PP to determine the command to use to compose the content. If this isn't -found, \fImhbuild\fR will look for an entry of the form: -.sp -.in +.5i +found, +.B mhbuild +will look for an entry of the form: +.PP +.RS 5 mhbuild-compose- -.in -.5i -.sp -to determine the composition command. - -If this isn't found, \fImhbuild\fR +.RE +.PP +to determine the composition command. If this isn't found, +.B mhbuild will complain. - +.PP An example entry might be: -.sp -.in +.5i +.PP +.RS 5 mhbuild-compose-audio/basic: record | raw2audio -F -.in -.5i -.sp +.RE +.PP Because commands like these will vary, depending on the display environment used for login, composition strings for different contents should probably be put in the file specified by the -\fB$MHBUILD\fR environment variable, instead of directly in your +.B $MHBUILD +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, -.sp +.PP +.RS 5 .nf -.in +.5i #@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" -.in -.5i .fi -.sp +.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. -.ne 19 +\*(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: -.sp +.PP +.RS 5 .nf -.in +.5i .ta \w'access-type= 'u access-type= usually \fIanon-ftp\fR or \fImail-server\fR name= filename @@ -203,34 +242,39 @@ size= number of octets server= mailbox subject= subject to send body= command to send for retrieval -.re -.in -.5i .fi -.sp - +.RE +.PP 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 \fIforw\fR\0(1) command, except that the former uses +is similar to the +.B forw +command, except that the former uses the MIME rules for encapsulation rather than those specified in RFC\-934. For example, -.sp +.PP +.RS 5 .nf -.in +.5i #forw +inbox 42 43 99 -.in -.5i .fi -.sp +.RE +.PP If you include a single message, it will be included directly as a content of type \*(lqmessage/rfc822\*(rq. If you include more than one message, -then \fImhbuild\fR will add a content of type \*(lqmultipart/digest\*(rq +then +.B mhbuild +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 `\-rfc934mode' switch. This switch will indicate that -\fImhbuild\fR should attempt to utilize the MIME encapsulation rules +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 @@ -238,83 +282,108 @@ 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. When using the \*(lqbegin\*(rq directive, you must specify at least one content between the begin and end pairs. -.sp +.PP +.RS 5 .nf -.in +.5i #begin This will be a multipart with only one part. #end -.in -.5i .fi -.sp -If you use multiple directives in a composition draft, \fImhbuild\fR will +.RE +.PP +If you use multiple directives in a composition draft, +.B mhbuild +will automatically encapsulate them inside a multipart content. Therefore the \*(lqbegin\*(rq directive is only necessary if you wish to use nested multiparts, or create a multipart message containing only one part. - +.PP For all of these directives, the user may include a brief description of the content between the \*(lq[\*(rq character and the \*(lq]\*(rq character. This description will be copied into the \*(lqContent-Description\*(rq header when the directive is processed. -.sp +.PP +.RS 5 .nf -.in +.5i #forw [important mail from Bob] +bob 1 2 3 4 5 -.in -.5i .fi -.sp -By default, \fImhbuild\fR 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. - +.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, +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 exhausted, and this is made to form a text content. If the plaintext must contain a \*(lq#\*(rq at the beginning of a line, simply double it, -.ne 6 e.g., -.sp -.in +.5i +.PP +.RS 5 ##when sent, this line will start with only one # -.in -.5i -.sp +.RE +.PP If you want to end the plaintext prior to a directive, e.g., to have two plaintext contents adjacent, simply insert a line containing a single -\*(lq#\*(rq character, -.ne 10 -e.g., -.sp +\*(lq#\*(rq character, e.g., +.PP +.RS 5 .nf -.in +.5i this is the first content # and this is the second -.in -.5i .fi -.sp -Finally, -if the plaintext starts with a line of the form: -.sp -.in +.5i +.RE +.PP +Finally, if the plaintext starts with a line of the form: +.PP +.RS 5 Content-Description: text -.in -.5i -.sp +.RE +.PP then this will be used to describe the plaintext content. You MUST follow this line with a blank line before starting your text. - +.PP By default, plaintext is captured as a text/plain content. You can override this by starting the plaintext with \*(lq#<\*(rq followed by -a content-type specification. For example, -.ne 11 -e.g., -.sp +a content-type specification. For example, e.g., +.PP +.RS 5 .nf -.in +.5i #" ] - [ "[" description "]" ] - [ filename ] - EOL - - | "#@" type "/" subtype - 0*(";" attribute "=" value) - [ "(" comment ")" ] - [ "<" id ">" ] - [ "[" description "]" ] - external-parameters - EOL - - | "#forw" - [ "<" id ">" ] - [ "[" description "]" ] - [ "+"folder ] [ 0*msg ] - EOL - - | "#begin" - [ "<" id ">" ] - [ "[" description "]" ] - [ "alternative" - | "parallel" - | something-else ] - EOL - 1*body - "#end" EOL - - plaintext ::= [ "Content-Description:" - description EOL EOL ] - 1*line - [ "#" EOL ] - - | "#<" type "/" subtype - 0*(";" attribute "=" value) - [ "(" comment ")" ] - [ "[" description "]" ] - EOL - 1*line - [ "#" EOL ] - - line ::= "##" text EOL - -- interpreted as "#"text EOL - | text EOL -.in -.5i +body ::= 1*(content | EOL) + +content ::= directive | plaintext + +directive ::= "#" type "/" subtype + 0*(";" attribute "=" value) + [ "(" comment ")" ] + [ "<" id ">" ] + [ "[" description "]" ] + [ "{" disposition "}" ] + [ filename ] + EOL + + | "#@" type "/" subtype + 0*(";" attribute "=" value) + [ "(" comment ")" ] + [ "<" id ">" ] + [ "[" description "]" ] + [ "{" disposition "}" ] + external-parameters + EOL + + | "#forw" + [ "<" id ">" ] + [ "[" description "]" ] + [ "{" disposition "}" ] + [ "+"folder ] [ 0*msg ] + EOL + + | "#begin" + [ "<" id ">" ] + [ "[" description "]" ] + [ "{" disposition "}" ] + [ "alternative" + | "parallel" + | something-else ] + EOL + 1*body + "#end" EOL + +plaintext ::= [ "Content-Description:" + description EOL EOL ] + 1*line + [ "#" EOL ] + + | "#<" type "/" subtype + 0*(";" attribute "=" value) + [ "(" comment ")" ] + [ "[" description "]" ] + [ "{" disposition "}" ] + EOL + 1*line + [ "#" EOL ] + +line ::= "##" text EOL + -- interpreted as "#"text EOL + | text EOL .fi -.sp -.Fi +.RE +.PP + +.SH FILES +.fc ^ ~ +.nf +.ta \w'%etcdir%/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile ^$MHBUILD~^Additional profile entries ^%etcdir%/mhn.defaults~^System default MIME profile entries -.Pr +.fi + +.SH "PROFILE COMPONENTS" +.fc ^ ~ +.nf +.ta 2.4i +.ta \w'ExtraBigProfileName 'u ^Path:~^To determine the user's nmh directory -.Ps ^Current\-Folder:~^To find the default current folder -.Ps ^mhbuild-compose-*~^Template for composing contents -.Sa -mhlist(1), mhshow(1), mhstore(1) -.br -RFC\-934: -.br - \fIProposed Standard for Message Encapsulation\fR, -.br -RFC\-2045: -.br - \fIMultipurpose Internet Mail Extensions (MIME) Part One: -.br - Format of Internet Message Bodies\fR, -.br -RFC\-2046: -.br - \fIMultipurpose Internet Mail Extensions (MIME) Part Two: -.br - Media Types\fR, -.br -RFC\-2047: -.br - \fIMultipurpose Internet Mail Extensions (MIME) Part Three: -.br - Message Header Extensions for Non-ASCII Text\fR, +.fi + +.SH "SEE ALSO" +mhlist(1), mhshow(1), mhstore(1), .br -RFC\-2048: +.I "Proposed Standard for Message Encapsulation" +(RFC\-934), .br - \fIMultipurpose Internet Mail Extensions (MIME) Part Four: +.I "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies" +(RFC\-2045), .br - Registration Procedures\fR, +.I "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types" +(RFC\-2046), .br -RFC\-2049: +.I "Multipurpose Internet Mail Extensions (MIME) Part Three: Message Header Extensions for Non-ASCII Text" +(RFC\-2047), .br - \fIMultipurpose Internet Mail Extensions (MIME) Part Five: +.I "Multipurpose Internet Mail Extensions (MIME) Part Four: Registration Procedures" +(RFC\-2048), .br - Conformance Criteria and Examples\fR. -.De -`\-headers' -.Ds -`\-realsize' -.Ds -`\-norfc934mode' -.Ds -`\-nocheck' -.Ds -`\-noebcdicsafe' -.Ds -`\-noverbose' -.Co +.I "Multipurpose Internet Mail Extensions (MIME) Part Five: Conformance Criteria and Examples" +(RFC\-2049) + +.SH DEFAULTS +.nf +.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 message selected will become the current message. -.En