]> diplodocus.org Git - nmh/blob - man/mhbuild.man
Fixed three LC_ALL settings:
[nmh] / man / mhbuild.man
1 .TH MHBUILD %manext1% "March 21, 2013" "%nmhversion%"
2 .\"
3 .\" %nmhwarning%
4 .\"
5 .SH NAME
6 mhbuild \- translate MIME composition draft
7 .SH SYNOPSIS
8 .na
9 .HP 5
10 .B mhbuild
11 .I file
12 .RB [ \-auto " | " \-noauto ]
13 .RB [ \-list " | " \-nolist ]
14 .RB [ \-realsize " | " \-norealsize ]
15 .RB [ \-headers " | " \-noheaders ]
16 .RB [ \-directives " | " \-nodirectives ]
17 .RB [ \-rfc934mode " | " \-norfc934mode ]
18 .RB [ \-contentid " | " \-nocontentid ]
19 .RB [ \-verbose " | " \-noverbose ]
20 .RB [ \-check " | " \-nocheck ]
21 .RB [ \-headerencoding
22 .IR encoding\-algorithm
23 .RB " | " \-autoheaderencoding ]
24 .RB [ \-version ]
25 .RB [ \-help ]
26 .ad
27 .SH DESCRIPTION
28 The
29 .B mhbuild
30 command will translate a MIME composition draft into
31 a valid MIME message.
32 .PP
33 .B mhbuild
34 creates multi-media messages as specified in RFC 2045
35 to RFC 2049. This includes the encoding of message headers as specified
36 by RFC 2047.
37 .PP
38 If you specify the name of the composition file as \*(lq-\*(rq,
39 then
40 .B mhbuild
41 will accept the composition draft on the standard
42 input. If the translation of this input is successful,
43 .B mhbuild
44 will output the new MIME message to the standard output. This argument
45 must be the last argument on the command line.
46 .PP
47 Otherwise if the file argument to
48 .B mhbuild
49 is the name of a valid
50 composition file, and the translation is successful,
51 .B mhbuild
52 will replace the original file with the new MIME message. It will rename
53 the original file to start with the \*(lq,\*(rq character and end with the
54 string \*(lq.orig\*(rq, e.g., if you are editing the file \*(lqdraft\*(rq,
55 it will be renamed to \*(lq,draft.orig\*(rq. This allows you to easily
56 recover the
57 .B mhbuild
58 input file.
59 .SS "Listing the Contents"
60 The
61 .B \-list
62 switch tells
63 .B mhbuild
64 to list the table of contents associated with the MIME message that is created.
65 .PP
66 The
67 .B \-headers
68 switch indicates
69 that a one-line banner should be displayed above the listing. The
70 .B \-realsize
71 switch tells
72 .B mhbuild
73 to evaluate the \*(lqnative\*(rq
74 (decoded) format of each content prior to listing. This provides an
75 accurate count at the expense of a small delay. If the
76 .B \-verbose
77 switch
78 is present, then the listing will show any \*(lqextra\*(rq information
79 that is present in the message, such as comments in the
80 \*(lqContent-Type\*(rq header.
81 .SS "Translating the Composition File"
82 .B mhbuild
83 is essentially a filter to aid in the composition of MIME
84 messages.
85 .B mhbuild
86 will convert an
87 .B mhbuild
88 \*(lqcomposition file\*(rq
89 into a valid MIME message. A
90 .B mhbuild
91 \*(lqcomposition file\*(rq
92 is just a file containing plain text that is interspersed
93 with various
94 .B mhbuild
95 directives. When this file is processed
96 by
97 .BR mhbuild ,
98 the various directives will be expanded to the
99 appropriate content, and will be encoded according to the MIME standards.
100 The resulting MIME message can then be sent by electronic mail.
101 .PP
102 The formal syntax for a
103 .B mhbuild
104 composition file is defined at the
105 end of this document, but the ideas behind this format are not complex.
106 Basically, the body contains one or more contents. A content consists of
107 either a directive, indicated with a \*(lq#\*(rq as the first character
108 of a line; or, plaintext (one or more lines of text). The continuation
109 character, \*(lq\\\*(lq, may be used to enter a single directive on more
110 than one line, e.g.,
111 .PP
112 .RS 5
113 .nf
114 #image/png \\
115 /home/foobar/junk/picture.png
116 .fi
117 .RE
118 .PP
119 There are five kinds of directives: \*(lqtype\*(rq directives, which
120 name the type and subtype of the content; \*(lqexternal-type\*(rq
121 directives, which also name the type and subtype of the content; the
122 \*(lqmessage\*(rq directive (#forw), which is used to forward one or
123 more messages; the \*(lqbegin\*(rq directive (#begin), which is
124 used to create a multipart content; and the \*(lqon/off/pop\*(rq
125 directives (#on, #off, #pop) which control whether any other
126 directives are honored at all.
127 .PP
128 The
129 .B \-directives
130 switch allows control over whether mhbuild will honor any of the
131 \*(lq#\*(rq-directives. This can also be affected with the #on or
132 #off directives, and #pop, which restores the state of processing to
133 that preceding the most recent #on or #off. (The #on, #off, and #pop
134 directives are always honored, of course.) This allows inclusion of
135 plain text which looks like mhbuild directives, without causing
136 errors:
137 .PP
138 .RS 5
139 .nf
140 #off
141 #include <stdio.h>
142 printf("Hello, World!);
143 #pop
144 .fi
145 .RE
146 .PP
147 Currently the stack depth for the #on/off/pop directives is 32.
148 .PP
149 The \*(lqtype\*(rq directive is used to directly specify the type and
150 subtype of a content. You may only specify discrete types in this manner
151 (can't specify the types multipart or message with this directive).
152 You may optionally specify the name of a file containing the contents
153 in \*(lqnative\*(rq (decoded) format. If this filename starts with the
154 \*(lq|\*(rq character, then it represents a command to execute whose
155 output is captured accordingly.
156 For example,
157 .PP
158 .RS 5
159 .nf
160 #audio/basic |raw2audio -F < /usr/lib/sound/giggle.au
161 .fi
162 .RE
163 .PP
164 If a filename is not given,
165 .B mhbuild
166 will look for information in the
167 user's profile to determine how the different contents should be composed.
168 This is accomplished by consulting a composition string, and executing
169 it under
170 .BR /bin/sh ,
171 with the standard output set to the content.
172 If the
173 .B \-verbose
174 switch is given,
175 .B mhbuild
176 will echo any commands that are used to create contents in this way.
177 .PP
178 The composition string may contain the following escapes:
179 .PP
180 .RS 5
181 .nf
182 .ta \w'%P 'u
183 %a Insert parameters from directive
184 %f Insert filename containing content
185 %F %f, and stdout is not re-directed
186 %s Insert content subtype
187 %% Insert character %
188 .fi
189 .RE
190 .PP
191 First,
192 .B mhbuild
193 will look for an entry of the form:
194 .PP
195 .RS 5
196 mhbuild-compose-<type>/<subtype>
197 .RE
198 .PP
199 to determine the command to use to compose the content. If this isn't
200 found,
201 .B mhbuild
202 will look for an entry of the form:
203 .PP
204 .RS 5
205 mhbuild-compose-<type>
206 .RE
207 .PP
208 to determine the composition command. If this isn't found,
209 .B mhbuild
210 will complain.
211 .PP
212 An example entry might be:
213 .PP
214 .RS 5
215 mhbuild-compose-audio/basic: record | raw2audio -F
216 .RE
217 .PP
218 Because commands like these will vary, depending on the display
219 environment used for login, composition strings for different
220 contents should probably be put in the file specified by the
221 .B $MHBUILD
222 environment variable, instead of directly in your
223 user profile.
224 .PP
225 The \*(lqexternal-type\*(rq directives are used to provide a MIME
226 reference to a content, rather than enclosing the contents itself
227 (for instance, by specifying an ftp site). Hence, instead of
228 providing a filename as with the type directives, external-parameters
229 are supplied. These look like regular parameters, so they must be
230 separated accordingly. For example,
231 .PP
232 .RS 5
233 .nf
234 #@application/octet-stream; \\
235 type=tar; \\
236 conversions=compress \\
237 [this is the nmh distribution] \\
238 {attachment; filename="nmh.tar.gz"} \\
239 name="nmh.tar.gz"; \\
240 directory="/pub/nmh"; \\
241 site="ftp.math.gatech.edu"; \\
242 access-type=anon-ftp; \\
243 mode="image"
244 .fi
245 .RE
246 .PP
247 You must give a description string to separate the content parameters
248 from the external-parameters (although this string may be empty).
249 This description string is specified by enclosing it within
250 \*(lq[]\*(rq. A disposition string, to appear in a
251 \*(lqContent-Disposition\*(rq header, may appear in the optional
252 \*(lq{}\*(rq.
253 .PP
254 These parameters are of the form:
255 .PP
256 .RS 5
257 .nf
258 .ta \w'access-type= 'u
259 access-type= usually \fIanon-ftp\fR, \fImail-server\fR, or \fIurl\fR
260 name= filename
261 permission= read-only or read-write
262 site= hostname
263 directory= directoryname (optional)
264 mode= usually \fIascii\fR or \fIimage\fR (optional)
265 size= number of octets
266 server= mailbox
267 subject= subject to send
268 body= command to send for retrieval
269 url= URL of content
270 .fi
271 .RE
272 .PP
273 A mimimum \*(lqexternal\-type\*(rq directive for the
274 .B url
275 .I access\-type
276 would be as follows:
277 .PP
278 .RS 3
279 .nf
280 #@application/octet-stream [] access-type=url; \\
281 url="http://download.savannah.gnu.org/releases/nmh/nmh-1.5.tar.gz"
282 .fi
283 .RE
284 .PP
285 Any long URLs will be wrapped according to RFC 2017 rules.
286 .PP
287 The \*(lqmessage\*(rq directive (#forw) is used to specify a message or
288 group of messages to include. You may optionally specify the name of
289 the folder and which messages are to be forwarded. If a folder is not
290 given, it defaults to the current folder. Similarly, if a message is not
291 given, it defaults to the current message. Hence, the message directive
292 is similar to the
293 .B forw
294 command, except that the former uses
295 the MIME rules for encapsulation rather than those specified in RFC 934.
296 For example,
297 .PP
298 .RS 5
299 .nf
300 #forw +inbox 42 43 99
301 .fi
302 .RE
303 .PP
304 If you include a single message, it will be included directly as a content
305 of type \*(lqmessage/rfc822\*(rq. If you include more than one message,
306 then
307 .B mhbuild
308 will add a content of type \*(lqmultipart/digest\*(rq
309 and include each message as a subpart of this content.
310 .PP
311 If you are using this directive to include more than one message, you
312 may use the
313 .B \-rfc934mode
314 switch. This switch will indicate that
315 .B mhbuild
316 should attempt to utilize the MIME encapsulation rules
317 in such a way that the \*(lqmultipart/digest\*(rq that is created
318 is (mostly) compatible with the encapsulation specified in RFC 934.
319 If given, then RFC 934 compliant user-agents should be able to burst the
320 message on reception\0--\0providing that the messages being encapsulated
321 do not contain encapsulated messages themselves. The drawback of this
322 approach is that the encapsulations are generated by placing an extra
323 newline at the end of the body of each message.
324 .PP
325 The \*(lqbegin\*(rq directive is used to create a multipart content.
326 When using the \*(lqbegin\*(rq directive, you must specify at least one
327 content between the begin and end pairs.
328 .PP
329 .RS 5
330 .nf
331 #begin
332 This will be a multipart with only one part.
333 #end
334 .fi
335 .RE
336 .PP
337 If you use multiple directives in a composition draft,
338 .B mhbuild
339 will
340 automatically encapsulate them inside a multipart content. Therefore the
341 \*(lqbegin\*(rq directive is only necessary if you wish to use nested
342 multiparts, or create a multipart message containing only one part.
343 .PP
344 For all of these directives, the user may include a brief description
345 of the content between the \*(lq[\*(rq character and the \*(lq]\*(rq
346 character. This description will be copied into the
347 \*(lqContent-Description\*(rq header when the directive is processed.
348 .PP
349 .RS 5
350 .nf
351 #forw [important mail from Bob] +bob 1 2 3 4 5
352 .fi
353 .RE
354 .PP
355 Similarly, a disposition string may optionally be provided between
356 \*(lq{\*(rq and \*(lq}\*(rq characters; it will be copied into the
357 \*(lqContent-Disposition\*(rq header when the directive is processed.
358 If a disposition string is provided that does not contain a filename
359 parameter, and a filename is provided in the directive, it will be
360 added to the \*(lqContent-Disposition\*(rq header. For example, the
361 following directive:
362 .PP
363 .RS 5
364 .nf
365 #text/plain; charset=iso-8859-1 <>{attachment} /tmp/summary.txt
366 .fi
367 .RE
368 .PP
369 creates these message part headers:
370 .PP
371 .RS 5
372 .nf
373 Content-Type: text/plain; charset="iso-8859-1"
374 Content-Disposition: attachment; filename="summary.txt"
375 .fi
376 .RE
377 .PP
378 By default,
379 .B mhbuild
380 will generate a unique \*(lqContent-ID:\*(rq for each directive,
381 corresponding to each message part; however, the user may override
382 this by defining the ID using the \*(lq<\*(rq and \*(lq>\*(rq
383 characters. The
384 .B \-nocontentid
385 switch suppresses creation of all \*(lqContent-ID:\*(rq headers,
386 even in the top level of the message.
387 .PP
388 In addition to the various directives, plaintext can be present.
389 Plaintext is gathered, until a directive is found or the draft is
390 exhausted, and this is made to form a text content. If the plaintext
391 must contain a \*(lq#\*(rq at the beginning of a line, simply double it,
392 e.g.,
393 .PP
394 .RS 5
395 ##when sent, this line will start with only one #
396 .RE
397 .PP
398 If you want to end the plaintext prior to a directive, e.g., to have two
399 plaintext contents adjacent, simply insert a line containing a single
400 \*(lq#\*(rq character, e.g.,
401 .PP
402 .RS 5
403 .nf
404 this is the first content
405 #
406 and this is the second
407 .fi
408 .RE
409 .PP
410 Finally, if the plaintext starts with a line of the form:
411 .PP
412 .RS 5
413 Content-Description: text
414 .RE
415 .PP
416 then this will be used to describe the plaintext content.
417 You MUST follow this line with a blank line before starting
418 your text.
419 .PP
420 By default, plaintext is captured as a text/plain content. You can
421 override this by starting the plaintext with \*(lq#<\*(rq followed by
422 a content-type specification. For example, e.g.,
423 .PP
424 .RS 5
425 .nf
426 #<text/enriched
427 this content will be tagged as text/enriched
428 #
429 and this content will be tagged as text/plain
430 #
431 #<application/x-patch [this is a patch]
432 and this content will be tagged as application/x-patch
433 .fi
434 .RE
435 .PP
436 Note that if you use the \*(lq#<\*(rq plaintext-form, then the
437 content-description must be on the same line which identifies the content
438 type of the plaintext.
439 .PP
440 When composing a text content, you may indicate the relevant character
441 set by adding the \*(lqcharset\*(rq parameter to the directive.
442 .PP
443 .RS 5
444 #<text/plain; charset=iso-8859-5
445 .RE
446 .PP
447 If a text content contains any 8\-bit characters (characters with the
448 high bit set) and the character set is not specified as above, then
449 .B mhbuild
450 will assume the character set is of the type given by the
451 standard
452 .IR locale (1)
453 environment variables. If these environment variables are not
454 set, then the character set will be labeled as \*(lqx-unknown\*(rq.
455 .PP
456 If a text content contains only 7\-bit characters and the character set
457 is not specified as above, then the character set will be labeled as
458 \*(lqus-ascii\*(rq.
459 .PP
460 The
461 .B \-headerencoding
462 switch will indicate which algorithm to use when encoding any message headers
463 that contain 8\-bit characters. The valid arguments are
464 .I base64
465 for based\-64 encoding and
466 .I quoted
467 for quoted\-printable encoding. The
468 .B \-autoheaderencoding
469 switch will instruct
470 .B mhbuild
471 to automatically pick the algorithm that results in a shorter encoded string.
472 .PP
473 Putting this all together,
474 here is an example of a more complicated message draft. The
475 following draft will expand into a multipart/mixed message
476 containing five parts:
477 .PP
478 .RS 5
479 .nf
480 To: nobody@nowhere.org
481 cc:
482 Subject: Look and listen to me!
483 --------
484 The first part will be text/plain
485 #<text/enriched
486 The second part will be text/enriched
487 #
488 This third part will be text/plain
489 #audio/basic [silly giggle] \\
490 |raw2audio -F < /usr/lib/sounds/giggle.au
491 #image/gif [photo of foobar] \\
492 /home/foobar/lib/picture.gif
493 .fi
494 .RE
495 .SS "Integrity Check"
496 If
497 .B mhbuild
498 is given the
499 .B \-check
500 switch, then it will also associate an integrity check with each
501 \*(lqleaf\*(rq content. This will add a Content-MD5 header field to
502 the content, along with the md5 sum of the unencoded contents, per RFC
503 1864. This may be used by the receiver of the message to verify that
504 the contents of the message were not changed in transport.
505 .SS "Transfer Encodings"
506 After
507 .B mhbuild
508 constructs the new MIME message by parsing directives,
509 including files, etc., it scans the contents of the message to determine
510 which transfer encoding to use. It will check for 8bit data, long lines,
511 spaces at the end of lines, and clashes with multipart boundaries. It will
512 then choose a transfer encoding appropriate for each content type.
513 .PP
514 If an integrity check is being associated with each content by using
515 the
516 .B \-check
517 switch, then
518 .B mhbuild
519 will encode each content with
520 a transfer encoding, even it the content contains only 7\-bit data. This
521 is to increase the likelihood that the content is not changed while in
522 transport.
523 .SS "Invoking mhbuild"
524 Typically,
525 .B mhbuild
526 is invoked by the
527 .B whatnow
528 program. This
529 command will expect the body of the draft to be formatted as an
530 .B mhbuild
531 composition file. Once you have composed this input file
532 using a command such as
533 .BR comp ,
534 .BR repl ,
535 or
536 .BR forw ,
537 you invoke
538 .B mhbuild
539 at the \*(lqWhat now\*(rq prompt with
540 .PP
541 .RS 5
542 What now? mime
543 .RE
544 .PP
545 prior to sending the draft. This will cause
546 .B whatnow
547 to execute
548 .B mhbuild
549 to translate the composition file into MIME format.
550 .PP
551 Normally it is an error to invoke
552 .B mhbuild
553 on file that already in MIME format. The
554 .B \-auto
555 switch will cause
556 .B mhbuild
557 to exit without error if the input file already has valid MIME headers.
558 .PP
559 It is also possible to have the
560 .B whatnow
561 program invoke
562 .B mhbuild
563 automatically when a message is sent. To do this, you must add the line
564 .PP
565 .RS 5
566 automimeproc: 1
567 .RE
568 .PP
569 to your
570 .I \&.mh\(ruprofile
571 file.
572 .PP
573 Finally, you should consider adding this line to your profile:
574 .PP
575 .RS 5
576 lproc: show
577 .RE
578 .PP
579 This way, if you decide to
580 .B list
581 after invoking
582 .BR mime ,
583 the command
584 .PP
585 .RS 5
586 What now? list
587 .RE
588 .PP
589 will work as you expect.
590 .SS "User Environment"
591 Because the environment in which
592 .B mhbuild
593 operates may vary for a
594 user,
595 .B mhbuild
596 will look for the environment variable
597 .BR $MHBUILD .
598 If present, this specifies the name of an additional user profile which
599 should be read. Hence, when a user logs in on a particular machine,
600 this environment variable should be set to refer to a file containing
601 definitions useful for that machine.
602 .PP
603 Finally,
604 .B mhbuild
605 will attempt to consult a global
606 .B mhbuild
607 user profile, e.g.,
608 .PP
609 .RS 5
610 %etcdir%/mhn.defaults
611 .RE
612 .PP
613 if it exists.
614 .SS "Syntax of Composition Files"
615 The following is the formal syntax of a
616 .B mhbuild
617 \*(lqcomposition file\*(rq.
618 .PP
619 .RS 5
620 .nf
621 body ::= 1*(content | EOL)
622
623 content ::= directive | plaintext
624
625 directive ::= "#" type "/" subtype
626 0*(";" attribute "=" value)
627 [ "(" comment ")" ]
628 [ "<" id ">" ]
629 [ "[" description "]" ]
630 [ "{" disposition "}" ]
631 [ filename ]
632 EOL
633
634 | "#@" type "/" subtype
635 0*(";" attribute "=" value)
636 [ "(" comment ")" ]
637 [ "<" id ">" ]
638 [ "[" description "]" ]
639 [ "{" disposition "}" ]
640 external-parameters
641 EOL
642
643 | "#forw"
644 [ "<" id ">" ]
645 [ "[" description "]" ]
646 [ "{" disposition "}" ]
647 [ "+"folder ] [ 0*msg ]
648 EOL
649
650 | "#begin"
651 [ "<" id ">" ]
652 [ "[" description "]" ]
653 [ "{" disposition "}" ]
654 [ "alternative"
655 | "parallel"
656 | something-else ]
657 EOL
658 1*body
659 "#end" EOL
660
661 plaintext ::= [ "Content-Description:"
662 description EOL EOL ]
663 1*line
664 [ "#" EOL ]
665
666 | "#<" type "/" subtype
667 0*(";" attribute "=" value)
668 [ "(" comment ")" ]
669 [ "[" description "]" ]
670 [ "{" disposition "}" ]
671 EOL
672 1*line
673 [ "#" EOL ]
674
675 line ::= "##" text EOL
676 -- interpreted as "#"text EOL
677 | text EOL
678 .fi
679 .RE
680 .SH FILES
681 .B mhbuild
682 looks for additional user profile files and mhn.defaults in multiple
683 locations: absolute pathnames are accessed directly, tilde expansion
684 is done on usernames, and files are searched for in the user's
685 .I Mail
686 directory as specified in their profile. If not found there, the directory
687 .RI \*(lq %etcdir% \*(rq
688 is checked.
689 .PP
690 .fc ^ ~
691 .nf
692 .ta \w'%etcdir%/ExtraBigFileName 'u
693 ^$HOME/\&.mh\(ruprofile~^The user profile
694 ^$MHBUILD~^Additional profile entries
695 ^%etcdir%/mhn.defaults~^System default MIME profile entries
696 .fi
697 .SH "PROFILE COMPONENTS"
698 .fc ^ ~
699 .nf
700 .ta 2.4i
701 .ta \w'ExtraBigProfileName 'u
702 ^Path:~^To determine the user's nmh directory
703 ^Current\-Folder:~^To find the default current folder
704 ^mhbuild-compose-<type>*~^Template for composing contents
705 .fi
706 .SH "SEE ALSO"
707 .IR mhlist (1),
708 .IR mhshow (1),
709 .IR mhstore (1)
710 .PP
711 .I "Proposed Standard for Message Encapsulation"
712 (RFC 934),
713 .PP
714 .I "The Content-MD5 Header Field"
715 (RFC 1864),
716 .PP
717 .I "Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies"
718 (RFC 2045),
719 .PP
720 .I "Multipurpose Internet Mail Extensions (MIME) Part Two: Media Types"
721 (RFC 2046),
722 .PP
723 .I "Multipurpose Internet Mail Extensions (MIME) Part Three: Message Header Extensions for Non-ASCII Text"
724 (RFC 2047),
725 .PP
726 .I "Multipurpose Internet Mail Extensions (MIME) Part Four: Registration Procedures"
727 (RFC 2048),
728 .PP
729 .I "Multipurpose Internet Mail Extensions (MIME) Part Five: Conformance Criteria and Examples"
730 (RFC 2049)
731 .I "Definition of the URL MIME External-Body Access-Type"
732 (RFC 2017)
733 .SH DEFAULTS
734 .nf
735 .RB ` \-headers '
736 .RB ` \-realsize '
737 .RB ` \-norfc934mode '
738 .RB ` \-contentid '
739 .RB ` \-nocheck '
740 .RB ` \-noverbose '
741 .RB ` \-autoheaderencoding '
742 .fi