2f3fa6e0a57798cbf82a1af9b67557ed0561e73f
[mmh] / man / forw.man1
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH FORW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 forw \- forward messages
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B forw
11 .RI [ +folder ]
12 .RI [ msgs ]
13 .RB [ \-annotate " | " \-noannotate ]
14 .RB [ \-form
15 .IR formfile ]
16 .RB [ \-format " | " \-noformat ]
17 .RB [ \-filter
18 .IR filterfile ]
19 .RB [ \-inplace " | " \-noinplace ]
20 .RB [ \-mime " | " \-nomime ]
21 .RB [ \-editor
22 .IR editor ]
23 .RB [ \-noedit ]
24 .RB [ \-whatnowproc
25 .IR program ]
26 .RB [ \-nowhatnowproc ]
27 .RB [ \-build ]
28 .RB [ \-file
29 .IR msgfile ]
30 .RB [ \-version ]
31 .RB [ \-help ]
32 .PP
33 .HP 5
34 .B forw
35 .RI [ +folder ]
36 .RI [ msgs ]
37 .RB [ \-digest
38 .IR list ]
39 .RB [ \-issue
40 .IR number ]
41 .RB [ \-volume
42 .IR number ]
43 [other\ switches\ for\
44 .BR forw ]
45 .RB [ \-version ]
46 .RB [ \-help ]
47 .ad
48 .SH DESCRIPTION
49 .B Forw
50 may be used to prepare a message containing other messages.
51 .PP
52 It constructs the new message from a forms (components) file, with a
53 body composed of the message(s) to be forwarded.  An editor is invoked
54 as in
55 .BR comp ,
56 and after editing is complete, the user is prompted
57 before the message is sent.
58 .PP
59 The default message form contains the following elements:
60 .PP
61 .RS 5
62 .nf
63 %forwcomps%
64 .fi
65 .RE
66 .PP
67 If a file named
68 .RI \*(lq forwcomps \*(rq
69 exists in the user's mmh directory,
70 it will be used instead of this default form.  You may also specify an
71 alternate forms file with the switch
72 .B \-form
73 .IR formfile .
74 .PP
75 If the
76 .B \-annotate
77 switch is given, each message being forwarded will
78 be annotated with the line:
79 .PP
80 .RS 5
81 .nf
82 Forwarded:\ date
83 .fi
84 .RE
85 .PP
86 This annotation will be done only if the message is sent directly from
87 .BR forw .
88 If the message is not sent immediately from
89 .BR forw ,
90 .RB \*(lq comp
91 .BR \-use \*(rq
92 may be used to re\-edit and send the constructed
93 message, but the annotations won't take place.  Normally annotations
94 are done inplace in order to preserve any links to the message.  You may
95 change this by using the
96 .B \-noinplace
97 switch.
98 .PP
99 See
100 .BR comp (1)
101 for a description of the
102 .B \-editor
103 and
104 .B \-noedit
105 switches.
106 .PP
107 Although
108 .B forw
109 uses a forms (components) file to direct it how to
110 construct the beginning of the draft, it uses a message filter file to
111 direct it as to how each forwarded message should be formatted in the
112 body of the draft.  The filter file for \fIforw\fR should be a standard
113 form file for
114 .BR mhl ,
115 as
116 .B forw
117 will invoke
118 .B mhl
119 to filter (re\-format) the forwarded messages prior to being output to
120 the body of the draft.
121 .PP
122 The switches
123 .BR \-noformat ,
124 .BR \-format ,
125 and
126 .B \-filter
127 .I filterfile
128 specify which message filter file to use.
129 .PP
130 If
131 .B \-noformat
132 is specified (this is the default), then each forwarded
133 message is output into the draft exactly as it appears with no
134 .B mhl
135 filtering.
136 .PP
137 If
138 .B \-format
139 is specified, then a default message filter file is used.
140 This default message filter should be adequate for most users.
141 This default filter
142 .RI \*(lq mhl.forward \*(rq
143 is:
144 .PP
145 .RS 5
146 .nf
147 %mhl_forward%
148 .fi
149 .RE
150 .PP
151 If a file named
152 .RI \*(lq mhl.forward \*(rq
153 exists in the user's mmh
154 directory, it will be used instead of this form.  You may specify an
155 alternate message filter file with the switch
156 .B \-filter
157 .IR filterfile .
158 .PP
159 Each forwarded message is separated with an encapsulation delimiter.
160 By default, any dashes in the first column of the forwarded messages
161 will be prepended with `\-\ ' so that when received, the message is
162 suitable for bursting by
163 .BR burst .
164 This follows the Internet RFC\-934 guidelines.
165 .PP
166 For users of
167 .BR prompter ,
168 by specifying
169 .BR prompter 's
170 .B \-prepend
171 switch in the
172 .I .mmh/profile
173 file, any commentary text is entered
174 before the forwarded messages.  (A major win!)
175 .PP
176 To use the MIME rules for encapsulation, specify the
177 .B \-mime
178 switch. This directs
179 .B forw
180 to generate an attachment header field.
181 .B send
182 will care for everything else.
183 .PP
184 The
185 .B \-editor
186 .I editor
187 switch indicates the editor to use for the
188 initial edit.  Upon exiting from the editor,
189 .B comp
190 will invoke the
191 .B whatnow
192 program.  See
193 .BR whatnow (1)
194 for a discussion of
195 available options.  The invocation of this program can be inhibited
196 by using the
197 .B \-nowhatnowproc
198 switch.  (In truth of fact, it is
199 the
200 .I whatnow
201 program which starts the initial edit.  Hence,
202 .B \-nowhatnowproc
203 will prevent any edit from occurring.)
204 .PP
205 The
206 .B \-build
207 switch is intended to be used by the Emacs mh-e interface to
208 .BR nmh ,
209 and is only present if
210 .B nmh
211 was compiled with support for mh-e. It implies
212 .BR \-nowhatnowproc .
213 It causes a file `draft' in the mail storage root
214 to be created, containing the draft message that would normally be presented
215 to the user for editing.
216 No mail is actually sent. Note that this switch is not guaranteed to
217 be present or to have the same effects in future versions of
218 .BR nmh :
219 it is documented here only for completeness.
220 .PP
221 The
222 .B \-file
223 .I msgfile
224 switch specifies the message to be forwarded as an
225 exact filename rather than as an
226 .B nmh
227 folder and message number. It is
228 intended to be used by the
229 .B msh
230 interface to
231 .BR nmh .
232 This switch implies
233 .BR \-noannotate .
234 The forwarded message is simply
235 copied verbatim into the draft; the processing implied by
236 the
237 .BR \-filter ,
238 .BR \-mime ,
239 and
240 .B \-digest
241 switches is bypassed, and the usual leading and
242 trailing 'Forwarded Message' delimiters are not added.
243 The same caveats apply to this option as to the
244 .B \-build
245 switch.
246 .PP
247 The
248 .B \-digest
249 .IR list ,
250 .B \-issue
251 .IR number ,
252 and
253 .B \-volume
254 .I number
255 switches implement a digest facility for
256 .BR nmh .
257 Specifying these switches enables and/or overloads the following escapes:
258 .PP
259 .RS 5
260 .nf
261 .ta \w'Component  'u +\w'Escape  'u +\w'Returns  'u
262 .I Type Escape  Returns Description
263 component       digest  string  Argument to `\-digest'
264 function        cur     integer Argument to `\-volume'
265 function        msg     integer Argument to `\-issue'
266 .fi
267 .RE
268 .PP
269 Consult the
270 .I "Advanced Features"
271 section of the
272 .B nmh
273 User's Manual for more information on making digests.
274
275 .SH FILES
276 .fc ^ ~
277 .nf
278 .ta \w'%etcdir%/ExtraBigFileName  'u
279 ^%etcdir%/forwcomps~^The standard message skeleton
280 ^or $HOME/.mmh/forwcomps~^Rather than the standard skeleton
281 ^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given
282 ^or $HOME/.mmh/digestcomps~^Rather than the standard skeleton
283 ^%etcdir%/mhl.forward~^The standard message filter
284 ^or $HOME/.mmh/mhl.forward~^Rather than the standard filter
285 ^$HOME/.mmh/profile~^The user profile
286 ^+drafts~^The draft folder
287 .fi
288
289 .SH "PROFILE COMPONENTS"
290 .fc ^ ~
291 .nf
292 .ta 2.4i
293 .ta \w'ExtraBigProfileName  'u
294 ^Path:~^To determine the user's mail storage
295 ^Current\-Folder:~^To find the default current folder
296 ^Draft\-Folder:~^To set the default draft\-folder
297 ^Editor:~^To override the default editor
298 ^Msg\-Protect:~^To set mode when creating a new message (draft)
299 ^fileproc:~^Program to refile the message
300 ^mhlproc:~^Program to filter messages being forwarded
301 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
302 .fi
303
304 .SH "SEE ALSO"
305 mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5),
306 .I "Proposed Standard for Message Encapsulation"
307 (RFC\-934)
308
309 .SH DEFAULTS
310 .nf
311 .RB ` +folder "' defaults to the current folder"
312 .RB ` msgs "' defaults to cur"
313 .RB ` \-noannotate '
314 .RB ` \-noformat '
315 .RB ` \-inplace '
316 .RB ` \-nomime '
317 .fi
318
319 .SH CONTEXT
320 If a folder is given, it will become the current folder.
321 The first message forwarded will become the current message.
322
323 .SH BUGS
324 If
325 .I whatnowproc
326 is
327 .BR whatnow ,
328 then
329 .B forw
330 uses a built\-in
331 .BR whatnow ,
332 it does not actually run the
333 .B whatnow
334 program.
335 Hence, if you define your own
336 .IR whatnowproc ,
337 don't call it
338 .B whatnow
339 since
340 .B forw
341 won't run it.
342 .PP
343 When
344 .B forw
345 is told to annotate the messages it forwards, it
346 doesn't actually annotate them until the draft is successfully sent.
347 If from the
348 .IR whatnowproc ,
349 you
350 .B push
351 instead of
352 .BR send ,
353 it's possible to confuse
354 .B forw
355 by re\-ordering the file (e.g. by using
356 .RB \*(lq folder
357 .BR \-pack \*(rq)
358 before the message is successfully sent.
359 .B Dist
360 and
361 .B repl
362 don't have this problem.