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