Initial revision
[mmh] / man / mhmail.man
1 .\"
2 .\" %nmhwarning%
3 .\" $Id$
4 .\"
5 .\" include the -mh macro file
6 .so %etcdir%/tmac.h
7 .\"
8 .TH MHMAIL %manext1% MH.6.8 [%nmhversion%]
9 .SH NAME
10 mhmail \- send or read mail
11 .SH SYNOPSIS
12 .in +.5i
13 .ti -.5i
14 mhmail
15 \%[
16 addrs\ ... 
17 \%[\-body\ text]
18 \%[\-cc\ addrs\ ...]
19 .br
20 \%[\-from\ addr]
21 \%[\-subject subject]]
22 .br
23 \%[\-version]
24 \%[\-help]
25 .in -.5i
26 .SH DESCRIPTION
27 \fImhmail\fR is intended as a replacement for the standard Berkeley
28 mail program (\fImail\fR(1) or \fImailx\fR(1)), which is compatible
29 with \fInmh\fR.  This program is intended for the use of programs such
30 as \fIcron\fR(1), which expect to send mail automatically to various
31 users.  It is also used by various \fInmh\fR commands to mail various
32 error notifications.  Although \fImhmail\fR can be used interactively,
33 it is recommended that \fIcomp\fR(1) and \fIsend\fR(1) be used instead
34 to send messages.
35
36 When invoked without arguments, it simply invokes \fIinc\fR(1) to
37 incorporate new messages from the user's maildrop.  When one or more users
38 is specified, a message is read from the standard input and spooled to
39 a temporary file.  \fImhmail\fR then invokes \fIpost\fR(8) with the
40 name of the temporary file as its argument to deliver the message to
41 the specified user.
42
43 The `\-subject\ subject' switch can be used to specify the
44 \*(lqSubject:\*(rq field of the message.
45
46 By default, \fImhmail\fR will read the message to be sent from the
47 standard input.  You can specify the text of the message at the command
48 line with the `\-body\ text' switch.  If the standard input has zero
49 length, \fImhmail\fR will not send the message.  You can use the switch
50 `\-body\ ""' to force an empty message.
51
52 Normally, addresses appearing as arguments are put in the \*(lqTo:\*(rq
53 field.  If the `\-cc' switch is used, all addresses following it are
54 placed in the \*(lqcc:\*(rq field.
55
56 By using `\-from\ addr', you can specify the \*(lqFrom:\*(rq header of
57 the draft.  Naturally, \fIpost\fR will fill\-in the \*(lqSender:\*(rq
58 header correctly.
59 .Fi
60 ^%bindir%/inc~^Program to incorporate maildrop into folder
61 ^%libdir%/post~^Program to deliver a message
62 ^/tmp/mhmail*~^Temporary copy of message
63 .Pr
64 None
65 .Sa
66 inc(1), post(8)
67 .De
68 None
69 .Co
70 If \fIinc\fR is invoked, then \fIinc\fR's context changes occur.
71 .En