Mercurial > hg > Applications > mh

comparison doc/forw.me @ 0:bce86c4163a3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:bce86c4163a3
1 .\" This file is automatically generated. Do not edit!
2 .\" @(#)$Id$
3 .SC FORW 1
4 .NA
5 forw \- forward messages
6 .SY
7 forw
8 \%[+folder] \%[msgs]
9 \%[\-annotate] \%[\-noannotate]
10 \%[\-draftfolder\ +folder] \%[\-draftmessage\ msg] \%[\-nodraftfolder]
11 \%[\-editor\ editor] \%[\-noedit]
12 \%[\-filter\ filterfile]
13 \%[\-form\ formfile]
14 \%[\-format] \%[\-noformat]
15 \%[\-inplace] \%[\-noinplace]
16 \%[\-mime] \%[\-nomime]
17 \%[\-whatnowproc\ program] \%[\-nowhatnowproc]
18 \%[\-help]
19
20 .ti .5i
21 forw
22 \%[+folder] \%[msgs]
23 \%[\-digest\ list] \%[\-issue\ number] \%[\-volume\ number]
24 \%[other\ switches\ for\ \fIforw\fR]
25 \%[\-help]
26 .DE
27 \fIForw\fR may be used to prepare a message containing other
28 messages.
29 It constructs the new message from the components file
30 or `\-form\ formfile' (see \fIcomp\fR\0), with a body composed of the
31 message(s) to be forwarded.
32 An editor is invoked as in \fIcomp\fR,
33 and after editing is complete, the user is prompted before the message
34 is sent.
35
36 The default message form contains the following elements:
37
38 .nf
39 .in +.5i
40 .ne 10
41 .eo
42 .so /usr/local/mh/lib/forwcomps
43 .ec
44 .in -.5i
45 .fi
46
47 If the file named \*(lqforwcomps\*(rq exists in the user's MH directory,
48 it will be used instead of this form.
49 In either case, the file specified by `\-form\ formfile' will be
50 used if given.
51
52 If the draft already exists,
53 \fIforw\fR will ask you as to the disposition of the draft.
54 A reply of \fBquit\fR will abort \fIforw\fR, leaving the draft intact;
55 \fBreplace\fR will replace the existing draft with a blank skeleton;
56 and \fBlist\fR will display the draft.
57
58 If the `\-annotate' switch is given, each message being
59 forwarded will be annotated with the lines
60
61 Forwarded:\ date
62 Forwarded:\ addrs
63
64 where each address list contains as many lines as required.
65 This annotation
66 will be done only if the message is sent directly from \fIforw\fR.
67 If the message is not sent immediately from \fIforw\fR,
68 \*(lqcomp\ \-use\*(rq may be used to re\-edit and send the constructed message,
69 but
70 the annotations won't take place.
71 The '\-inplace' switch causes annotation to
72 be done in place in order to preserve links to the annotated message.
73
74 See \fIcomp\fR\0(1) for a description of the `\-editor' and `\-noedit'
75 switches.
76
77 Although \fIforw\fR uses the `\-form\ formfile' switch to direct it how to
78 construct the beginning of the draft, the `\-filter\ filterfile',
79 `\-format', and `\-noformat'
80 switches direct \fIforw\fR as to how each forwarded message should be
81 formatted in the body of the draft.
82 If `\-noformat' is specified,
83 then each forwarded message is output exactly as it appears.
84 If `\-format' or `\-filter\ filterfile' is specified,
85 then each forwarded message is filtered (re\-formatted) prior to being
86 output to the body of the draft.
87 The filter file for \fIforw\fR should be a standard form file for
88 \fImhl\fR,
89 as \fIforw\fR will invoke \fImhl\fR to format the forwarded messages.
90 The default message filter (what you get with `\-format') is:
91
92 .nf
93 .in +.5i
94 .ne 10
95 .eo
96 .so /usr/local/mh/lib/mhl.forward
97 .ec
98 .in -.5i
99 .fi
100
101 If the file named \*(lqmhl.forward\*(rq exists in the user's MH directory,
102 it will be used instead of this form.
103 In either case, the file specified by `\-filter\ filterfile' will be
104 used if given.
105 To summarize:
106 `\-noformat' will reproduce each forwarded message exactly,
107 `\-format' will use \fImhl\fR and a default filterfile, \*(lqmhl.forward\*(rq,
108 to format each forwarded message, and
109 `\-filter\ filterfile' will use the named filterfile to format each
110 forwarded message with \fImhl\fR.
111
112 Each forwarded message is separated with an encapsulation delimiter
113 and
114 dashes in the first column of the forwarded messages will be prepended
115 with `\-\ ' so that
116 when received, the message is suitable for bursting by \fIburst\fR\0(1).
117 This follows the Internet RFC\-934 guidelines.
118
119 For users of \fIprompter\fR\0(1), by specifying prompter's `-prepend'
120 switch in the \&.mh\(ruprofile file, any commentary text is entered before
121 the forwarded messages. (A major win!)
122
123 To use the MIME rules for encapsulation,
124 specify the `\-mime' switch.
125 This directs \fIforw\fR to generate an \fImhn\fR composition file.
126 Note that MH will not invoke \fImhn\fR automatically,
127 unless you add this line to your \&.mh\(ruprofile file:
128 .sp
129 .in +.5i
130 automhnproc: mhn
131 .in -.5i
132 .sp
133 Otherwise,
134 you must specifically give the command
135 .sp
136 .in +.5i
137 What now? edit mhn
138 .in -.5i
139 .sp
140 prior to sending the draft.
141
142 To automate this somewhat,
143 create a link to \fIprompter\fR called \fIrapid\fR
144 and put these lines in your \&.mh\(ruprofile file:
145 .sp
146 .in +.5i
147 .nf
148 forw: -editor rapid -mime
149 rapid: -rapid
150 rapid-next: mhn
151 .fi
152 .in -.5i
153 .sp
154 Then,
155 you can simply do:
156 .sp
157 .in +.5i
158 .nf
159 \fIforw msgs\fR
160 To: \fImailbox\fR
161 cc:
162 Subject: \fIwhatever\fR
163
164 --------Enter initial text
165
166 \fIblah, blah, blah.\fR
167 <CTRL-D>
168 --------
169
170 What now? \fIedit\fR
171 What now? \fIsend\fR
172 ...
173 .fi
174 .in -.5i
175 .sp
176 The \fIedit\fR command invokes \fImhn\fR automatically.
177
178 The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke the
179 \fIMH\fR draft folder facility.
180 This is an advanced (and highly useful) feature.
181 Consult the \fBAdvanced Features\fR section of the \fIMH\fR manual for more
182 information.
183
184 Upon exiting from the editor,
185 \fIforw\fR will invoke the \fIwhatnow\fR program.
186 See \fIwhatnow\fR\0(1) for a discussion of available options.
187 The invocation of this program can be inhibited by using the `\-nowhatnowproc'
188 switch.
189 (In truth of fact,
190 it is the \fIwhatnow\fR program which starts the initial edit.
191 Hence, `\-nowhatnowproc' will prevent any edit from occurring.)
192
193 The `\-digest\ list', `\-issue\ number', and `\-volume\ number' switches
194 implement a digest facility for \fIMH\fR. Specifying these switches
195 enables and/or overloads the following escapes:
196 .sp 1
197 .nf
198 .ta \w'Component 'u +\w'Escape 'u +\w'Returns 'u
199 \fIType\fR \fIEscape\fR \fIReturns\fR \fIDescription\fR
200 \fIcomponent\fR \fIdigest\fR string Argument to `\-digest'
201 \fIfunction\fR \fIcur\fR integer Argument to `\-volume'
202 \fIfunction\fR \fImsg\fR integer Argument to `\-issue'
203 .re
204 .fi
205
206 Consult the \fBAdvanced Features\fR section of
207 the \fIMH\fR User's Manual for more information on making digests.
208 .Fi
209 ^/usr/local/mh/lib/forwcomps~^The message skeleton
210 ^or <mh\-dir>/forwcomps~^Rather than the standard skeleton
211 ^/usr/local/mh/lib/digestcomps~^The message skeleton if `\-digest' is given
212 ^or <mh\-dir>/digestcomps~^Rather than the standard skeleton
213 ^/usr/local/mh/lib/mhl.forward~^The message filter
214 ^or <mh\-dir>/mhl.forward~^Rather than the standard filter
215 ^$HOME/\&.mh\(ruprofile~^The user profile
216 ^<mh\-dir>/draft~^The draft file
217 .Pr
218 ^Path:~^To determine the user's MH directory
219 .Ps
220 ^Current\-Folder:~^To find the default current folder
221 .Ps
222 ^Draft\-Folder:~^To find the default draft\-folder
223 .Ps
224 ^Editor:~^To override the default editor
225 .Ps
226 ^Msg\-Protect:~^To set mode when creating a new message (draft)
227 .Ps
228 ^fileproc:~^Program to refile the message
229 .Ps
230 ^mhlproc:~^Program to filter messages being forwarded
231 .Ps
232 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
233 .Sa
234 \fIProposed Standard for Message Encapsulation\fR (aka RFC\-934),
235 .br
236 comp(1), dist(1), repl(1), send(1), whatnow(1), mh\-format(5)
237 .De
238 `+folder' defaults to the current folder
239 `msgs' defaults to cur
240 .Ds
241 `\-noannotate'
242 .Ds
243 `\-nodraftfolder'
244 .Ds
245 `\-noformat'
246 .Ds
247 `\-noinplace'
248 .Ds
249 `\-nomime'
250 .Co
251 If a folder is given, it will become the current folder.
252 The first message forwarded will become the current message.
253 .Bu
254 If \fIwhatnowproc\fR is \fIwhatnow\fR,
255 then \fIforw\fR uses a built\-in \fIwhatnow\fR,
256 it does not actually run the \fIwhatnow\fR program.
257 Hence, if you define your own \fIwhatnowproc\fR,
258 don't call it \fIwhatnow\fR since \fIforw\fR won't run it.
259
260 When \fIforw\fR is told to annotate the messages it forwards,
261 it doesn't actually annotate them until the draft is successfully sent.
262 If from the \fIwhatnowproc\fR,
263 you \fIpush\fR instead of \fIsend\fR,
264 it's possible to confuse \fIforw\fR by re\-ordering the file
265 (e.g., by using `folder\0\-pack') before the message is successfully sent.
266 \fIDist\fR and \fIrepl\fR don't have this problem.
267
268 To avoid prepending the leading dash characters in forwarded messages,
269 there is a `\-nodashmunging' option. See the \*(lqHidden Features\*(rq
270 section of the \fIMH Administrator's Guide\fR for more details.
271 .En