annotate doc/send.me @ 0:bce86c4163a3

Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
1 .\" This file is automatically generated. Do not edit!
bce86c4163a3 Initial revision
kono
parents:
diff changeset
2 .\" @(#)$Id$
bce86c4163a3 Initial revision
kono
parents:
diff changeset
3 .SC SEND 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 send \- send a message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 send
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[\-alias\ aliasfile]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-draft]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[\-draftfolder\ +folder] \%[\-draftmessage\ msg] \%[\-nodraftfolder]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 \%[\-filter\ filterfile] \%[\-nofilter]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 \%[\-format] \%[\-noformat]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 \%[\-forward] \%[\-noforward]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 \%[\-mime] \%[\-nomime]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 \%[\-msgid] \%[\-nomsgid]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 \%[\-push] \%[\-nopush]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 \%[\-split\ seconds]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 \%[\-verbose] \%[\-noverbose]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19 \%[\-watch] \%[\-nowatch]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 \%[\-width\ columns]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 \%[file\ ...]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 \fISend\fR will cause each of the specified files to
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 be delivered (via \fIpost\fR\0(8)) to each of the destinations
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 in the \*(lqTo:\*(rq, \*(lqcc:\*(rq, \*(lqBcc:\*(rq, and \*(lqFcc:\*(rq
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 fields of the message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 If \fIsend\fR is re\-distributing a message, as invoked from \fIdist\fR,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 then the corresponding \*(lqResent\-xxx\*(rq fields are examined
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 instead.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 If `\-push' is specified,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 \fIsend\fR will detach itself from the user's terminal and perform its
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 actions in the background.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35 If \fIpush\fR\0'd and the draft can't be sent,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 then the `\-forward' switch says that draft should be forwarded with
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 the failure notice sent to the user.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38 This differs from putting \fIsend\fR in the background because the output is
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 trapped and analyzed by \fIMH\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 If `\-verbose' is specified, \fIsend\fR will indicate the interactions
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 occurring with the transport system, prior to actual delivery.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43 If `\-watch' is specified \fIsend\fR will monitor the delivery of local and
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 network mail. Hence, by specifying both switches, a large detail of
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45 information can be gathered about each step of the message's entry into the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 transport system.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48 The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 \fIMH\fR draft folder facility.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 This is an advanced (and highly useful) feature.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 Consult the \fBAdvanced Features\fR section of the \fIMH\fR manual for more
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 information.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54 If `\-split' is specified,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 \fIsend\fR will split the draft into one or more partial messages
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 prior to sending.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 This makes use of the multi-media content feature in MH.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 Note however that if \fIsend\fR is invoked under \fIdist\fR\0(1),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 then this switch is ignored\0--\0it makes no sense to redistribute a
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 message in this fashion.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 Sometimes you want \fIsend\fR to pause after posting a partial message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 This is usually the case when you are running \fIsendmail\fR and
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 expect to generate a lot of partial messages.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64 The argument to `\-split' tells it how long to pause between postings.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 \fISend\fR with no \fIfile\fR
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 argument will query whether the draft is the intended file, whereas
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 `\-draft' will suppress this question.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69 Once the transport system has successfully accepted custody of the message,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 the file will be renamed
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 with a leading comma, which allows it to be retrieved until the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 next draft message is sent.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 If there are errors in the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74 formatting of the message, \fIsend\fR will abort with a (hopefully)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 helpful error message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 If a \*(lqBcc:\*(rq field is encountered,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 its addresses will be used for delivery,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 and the \*(lqBcc:\*(rq field will be removed from the message sent to sighted
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80 recipients.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 The blind recipients will receive an entirely new message with
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82 a minimal set of headers.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 Included in the body of the message will be a copy of the message sent to the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84 sighted recipients.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 If `\-filter\ filterfile' is specified,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 then this copy is filtered (re\-formatted)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87 prior to being sent to the blind recipients.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
88 Otherwise,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
89 to use the MIME rules for encapsulation,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
90 specify the `-mime' switch.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
91
bce86c4163a3 Initial revision
kono
parents:
diff changeset
92 Prior to sending the message, the fields \*(lqFrom:\ user@local\*(rq, and
bce86c4163a3 Initial revision
kono
parents:
diff changeset
93 \*(lqDate:\ now\*(rq will be appended to the headers in the message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
94 If the envariable \fB$SIGNATURE\fR is set,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
95 then its value is used as your personal name when
bce86c4163a3 Initial revision
kono
parents:
diff changeset
96 constructing the \*(lqFrom:\*(rq line of the message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
97 If this envariable is not set,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
98 then \fIsend\fR will consult the profile entry \*(lqSignature\*(rq
bce86c4163a3 Initial revision
kono
parents:
diff changeset
99 for this information.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
100 On hosts where \fIMH\fR was configured with the UCI option,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
101 if \fB$SIGNATURE\fR is not set and the \*(lqSignature\*(rq profile entry
bce86c4163a3 Initial revision
kono
parents:
diff changeset
102 is not present,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
103 then the file \fB$HOME\fR/.signature is consulted.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
104 If `\-msgid' is
bce86c4163a3 Initial revision
kono
parents:
diff changeset
105 specified, then a \*(lqMessage\-ID:\*(rq field will also be added to the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
106 message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
107
bce86c4163a3 Initial revision
kono
parents:
diff changeset
108 If \fIsend\fR is re\-distributing a message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
109 (when invoked by \fIdist\fR\0),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
110 then \*(lqResent\-\*(rq will be prepended to each of these fields:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
111 \*(lqFrom:\*(rq, \*(lqDate:\*(rq, and \*(lqMessage\-ID:\*(rq.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
112 If the message already contains a \*(lqFrom:\*(rq field, then a
bce86c4163a3 Initial revision
kono
parents:
diff changeset
113 \*(lqSender: user@local\*(rq field will be added as well.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
114 (An already existing
bce86c4163a3 Initial revision
kono
parents:
diff changeset
115 \*(lqSender:\*(rq field is an error!)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
116
bce86c4163a3 Initial revision
kono
parents:
diff changeset
117 By using the `\-format' switch,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
118 each of the entries in
bce86c4163a3 Initial revision
kono
parents:
diff changeset
119 the \*(lqTo:\*(rq and \*(lqcc:\*(rq fields will be replaced
bce86c4163a3 Initial revision
kono
parents:
diff changeset
120 with \*(lqstandard\*(rq format entries.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
121 This standard format is designed to be usable by all
bce86c4163a3 Initial revision
kono
parents:
diff changeset
122 of the message handlers on the various systems around the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
123 Internet.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
124 If `\-noformat' is given,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
125 then headers are output exactly as they appear in the message draft.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
126
bce86c4163a3 Initial revision
kono
parents:
diff changeset
127 If an \*(lqFcc:\ folder\*(rq is encountered, the message will be copied
bce86c4163a3 Initial revision
kono
parents:
diff changeset
128 to the specified folder for the sender in the format in which it will appear
bce86c4163a3 Initial revision
kono
parents:
diff changeset
129 to any non\-Bcc receivers of the message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
130 That is, it will have the appended
bce86c4163a3 Initial revision
kono
parents:
diff changeset
131 fields and field reformatting.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
132 The \*(lqFcc:\*(rq fields will be removed from all outgoing copies of the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
133 message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
134
bce86c4163a3 Initial revision
kono
parents:
diff changeset
135 By using the `\-width\ columns' switch, the user can direct \fIsend\fR as to
bce86c4163a3 Initial revision
kono
parents:
diff changeset
136 how long it should make header lines containing addresses.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
137
bce86c4163a3 Initial revision
kono
parents:
diff changeset
138 The files specified by the profile entry \*(lqAliasfile:\*(rq and any
bce86c4163a3 Initial revision
kono
parents:
diff changeset
139 additional alias files given by the `\-alias aliasfile' switch will be read
bce86c4163a3 Initial revision
kono
parents:
diff changeset
140 (more than one file, each preceeded by `\-alias', can be named).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
141 See \fImh\-alias\fR\0(5) for more information.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
142 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
143 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
144 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
145 ^Path:~^To determine the user's MH directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
146 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
147 ^Draft\-Folder:~^To find the default draft\-folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
148 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
149 ^Aliasfile:~^For a default alias file
bce86c4163a3 Initial revision
kono
parents:
diff changeset
150 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
151 ^Signature:~^To determine the user's mail signature
bce86c4163a3 Initial revision
kono
parents:
diff changeset
152 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
153 ^mailproc:~^Program to post failure notices
bce86c4163a3 Initial revision
kono
parents:
diff changeset
154 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
155 ^postproc:~^Program to post the message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
156 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
157 comp(1), dist(1), forw(1), repl(1), mh\-alias(5), post(8)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
158 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
159 `file' defaults to <mh\-dir>/draft
bce86c4163a3 Initial revision
kono
parents:
diff changeset
160 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
161 `\-alias /usr/local/mh/lib/MailAliases'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
162 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
163 `\-nodraftfolder'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
164 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
165 `\-nofilter'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
166 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
167 `\-format'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
168 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
169 `\-forward'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
170 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
171 `\-nomime'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
172 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
173 `\-nomsgid'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
174 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
175 `\-nopush'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
176 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
177 `\-noverbose'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
178 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
179 `\-nowatch'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
180 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
181 `\-width\ 72'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
182 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
183 None
bce86c4163a3 Initial revision
kono
parents:
diff changeset
184 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
185 Under some configurations, it is not possible to mointor the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
186 mail delivery transaction; `\-watch' is a no-op on those systems.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
187 .sp
bce86c4163a3 Initial revision
kono
parents:
diff changeset
188 Using `\-split\00' doesn't work correctly.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
189 .En