Mercurial > hg > Applications > mh

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