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