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