X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fmhmail.man;h=1546d9e9cb7ebf3f217c3c39b86f07210d43aad7;hb=f2f6f08eee1d6b084221f9899c4472e6f57230b7;hp=3b382af276f1bfdb290990fb87d0edbd0830f4f2;hpb=26d1d48706344c9311fe19f3691e5c0a230da710;p=mmh diff --git a/man/mhmail.man b/man/mhmail.man index 3b382af..1546d9e 100644 --- a/man/mhmail.man +++ b/man/mhmail.man @@ -8,8 +8,9 @@ mhmail \- send or read mail .HP 5 .na .B mhmail -.RI [ addrs -\&...] +.RB [ \-to ] +.RI addrs +\&... .RB [ \-attach .IR file ] .RB [ \-body @@ -19,8 +20,8 @@ mhmail \- send or read mail \&...] .RB [ \-from .IR addr ] -.RB [ \-header\-field -.IR name:body ] +.RB [ \-headerfield +.IR name:value ] .RB [ \-subject .IR subject ] .RB [ \-resent ] @@ -34,6 +35,11 @@ mhmail \- send or read mail .RB [ \-send " | " \-nosend ] .RB [ \-version ] .RB [ \-help ] +.PP +.HP 5 +.B mhmail +with no arguments is equivalent to +.B inc .ad .SH DESCRIPTION .B mhmail @@ -46,8 +52,8 @@ which is compatible with .BR nmh . This program is intended for the use of programs such as .BR cron , -which expect to send mail automatically to various -users. It is also used by various +which expect to send mail automatically to various addresses. It is +also used by various .B nmh commands to mail various error notifications. Although @@ -61,15 +67,15 @@ be used instead to send messages. .PP When invoked without arguments, it simply invokes .B inc -to incorporate new messages from the user's maildrop. When one or more users -is specified, a message is read from the standard input and spooled to -a temporary file. +to incorporate new messages from the user's maildrop. +.PP +When one or more addresses are specified, a message is read from the +standard input and spooled to a temporary file. .B mhmail then invokes -.B post -with the -name of the temporary file as its argument to deliver the message to -the specified user. +.BR post , +by default, with the name of the temporary file as its argument to +deliver the message to the specified address. .PP The .B \-subject @@ -105,10 +111,20 @@ will not send the message and return with status 1. You can use the switch \*(lq\*(rq to force an empty message. .PP Normally, addresses appearing as arguments are put in the \*(lqTo:\*(rq -field. If the +field. At least one such address is required when sending a message, +i.e., if any other switches are supplied. If the .B \-cc switch is used, all addresses following it, even if there are -intervening switches, are placed in the \*(lqcc:\*(rq field. +intervening switches other than +.BR \-to , +are placed in the \*(lqcc:\*(rq field. The optional +.B \-to +switch can appear in front of any addresses to signify their placement +in the \*(lqTo:\*(rq field. The +.B \-to +and +.B \-cc +switches may be given multiple times. .PP By using .B \-from @@ -118,29 +134,38 @@ the draft. If no .B \-from switch is used when sending, .B mhmail -will supply a \*(lqFrom:\*(rq header field using the sender's local mailbox. +will supply a \*(lqFrom:\*(rq header field using the sender's local mailbox, +see +.I localmbox +in +.BR mh-format (5). Naturally, .B post will fill\-in the \*(lqSender:\*(rq header correctly. .PP The -.B \-header\-field -.I name:body -switch adds a header field with the specified name and body to the -message. There need not be a space after the colon that separates the -name and body in the argument to this switch. It is usually best to +.B \-headerfield +.I name:value +switch adds a header field with the specified name and value to the +message. (The +.I value +is called the +.I field body +in RFC 2822, but that's too easily confused with the message body.) +There need not be a space after the colon that separates the +name and value in the argument to this switch. It is usually best to enclose the argument in quotes to protect it from the shell. The -.B \-header\-field +.B \-headerfield switch may be given multiple times to add multiple header fields, for example, .PP .RS 5 .nf mhmail -from sender@example.com \\ --header\-field 'MIME-Version:1.0' \\ --header\-field 'Content-Type:text/plain; charset=utf-8' \\ --header\-field 'Content-Transfer-Encoding:8bit' \\ +-headerfield 'MIME-Version:1.0' \\ +-headerfield 'Content-Type:text/plain; charset=utf-8' \\ +-headerfield 'Content-Transfer-Encoding:8bit' \\ recipient@example.com .fi .RE @@ -209,15 +234,14 @@ is used. .fi .SH "SEE ALSO" -dist(1), inc(1), post(8), send(1) +dist(1), inc(1), mh-format(5), post(8), send(1) .SH DEFAULTS .nf +.RB ` \-from "' defaults to sender's local mailbox (localmbox)" +.RB ` \-profile "' is enabled by default only with " \-attach .RB ` \-send ' .fi -.RB ` \-profile' , -enabled by default only with -.B \-attach .SH CONTEXT If @@ -229,3 +253,6 @@ context changes occur. With the switch, the context of .B send is used. +.B mhmail +does not read the context file itself, so an entry for it will be +ignored.