5 .\" include the -mh macro file
8 .TH FORW %manext1% MH.6.8 [%nmhversion%]
10 forw \- forward messages
17 \%[\-annotate] \%[\-noannotate]
20 \%[\-format] \%[\-noformat]
21 \%[\-filter\ filterfile]
23 \%[\-inplace] \%[\-noinplace]
24 \%[\-mime] \%[\-nomime]
26 \%[\-draftfolder\ +folder] \%[\-draftmessage\ msg]
29 \%[\-editor\ editor] \%[\-noedit]
31 \%[\-whatnowproc\ program] \%[\-nowhatnowproc]
33 \%[\-dashstuffing] \%[\-nodashstuffing]
40 \%[\-digest\ list] \%[\-issue\ number]
43 \%[other\ switches\ for\ \fIforw\fR]
47 \fIForw\fR may be used to prepare a message containing other messages.
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 \fIcomp\fR, and after editing is complete, the user is prompted
52 before the message is sent.
54 The default message form contains the following elements:
60 .so %etcdir%/forwcomps
65 If a file named \*(lqforwcomps\*(rq exists in the user's nmh directory,
66 it will be used instead of this default form. You may also specify an
67 alternate forms file with the switch `\-form\ formfile'.
69 When If the draft already exists, \fIforw\fR will ask you as to the disposition
70 of the draft. A reply of \fBquit\fR will abort \fIforw\fR, leaving the
71 draft intact; \fBreplace\fR will replace the existing draft with a blank
72 skeleton; and \fBlist\fR will display the draft.
74 If the `\-annotate' switch is given, each message being forwarded will
75 be annotated with the lines
80 where each address list contains as many lines as required. This
81 annotation will be done only if the message is sent directly from
82 \fIforw\fR. If the message is not sent immediately from \fIforw\fR,
83 \*(lqcomp\ \-use\*(rq may be used to re\-edit and send the constructed
84 message, but the annotations won't take place. Normally annotations
85 are done inplace in order to preserve any links to the message. You may
86 change this by using the '\-noinplace' switch.
88 See \fIcomp\fR\0(1) for a description of the `\-editor' and `\-noedit'
91 Although \fIforw\fR uses a forms (components) file to direct it how to
92 construct the beginning of the draft, it uses a message filter file to
93 direct it as to how each forwarded message should be formatted in the
94 body of the draft. The filter file for \fIforw\fR should be a standard
95 form file for \fImhl\fR, as \fIforw\fR will invoke \fImhl\fR to filter
96 (re\-format) the forwarded messages prior to being output to the body
99 The switches `\-noformat', `\-format', and `\-filter\ filterfile' specify
100 which message filter file to use.
102 If `\-noformat' is specified (this is the default), then each forwarded
103 message is output into the draft exactly as it appears with no \fImhl\fR
106 If `\-format' is specified, then a default message filter file is used.
107 This default message filter should be adequate for most users.
108 This default filter \*(lqmhl.forward\*(rq is:
114 .so %etcdir%/mhl.forward
119 If a file named \*(lqmhl.forward\*(rq exists in the user's nmh
120 directory, it will be used instead of this form. You may specify an
121 alternate message filter file with the switch `\-filter\ filterfile'.
123 Each forwarded message is separated with an encapsulation delimiter.
124 By default, any dashes in the first column of the forwarded messages
125 will be prepended with `\-\ ' so that when received, the message is
126 suitable for bursting by \fIburst\fR\0(1). This follows the Internet
127 RFC\-934 guidelines. You may use the flag `\-nodashstuffing' in order
128 to suppress this form of quoting to the forwarded messages.
130 For users of \fIprompter\fR\0(1), by specifying prompter's `-prepend'
131 switch in the \&.mh\(ruprofile file, any commentary text is entered
132 before the forwarded messages. (A major win!)
134 To use the MIME rules for encapsulation, specify the `\-mime' switch.
135 This directs \fIforw\fR to generate an \fImhbuild\fR composition file.
136 Note that nmh will not invoke \fImhbuild\fR automatically, unless you
137 add this line to your \&.mh\(ruprofile file:
144 you must specifically give the command
150 prior to sending the draft.
152 The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke
153 the \fInmh\fR draft folder facility. This is an advanced (and highly
154 useful) feature. Consult the \fImh-draft\fR(5) man page for more
157 Upon exiting from the editor, \fIforw\fR will invoke the \fIwhatnow\fR
158 program. See \fIwhatnow\fR\0(1) for a discussion of available
159 options. The invocation of this program can be inhibited by using the
160 `\-nowhatnowproc' switch. (In truth of fact, it is the \fIwhatnow\fR
161 program which starts the initial edit. Hence, `\-nowhatnowproc' will
162 prevent any edit from occurring.)
164 The `\-digest\ list', `\-issue\ number', and `\-volume\ number' switches
165 implement a digest facility for \fInmh\fR. Specifying these switches
166 enables and/or overloads the following escapes:
170 .ta \w'Component 'u +\w'Escape 'u +\w'Returns 'u
171 \fIType\fR \fIEscape\fR \fIReturns\fR \fIDescription\fR
172 \fIcomponent\fR \fIdigest\fR string Argument to `\-digest'
173 \fIfunction\fR \fIcur\fR integer Argument to `\-volume'
174 \fIfunction\fR \fImsg\fR integer Argument to `\-issue'
178 Consult the \fBAdvanced Features\fR section of
179 the \fInmh\fR User's Manual for more information on making digests.
181 ^%etcdir%/forwcomps~^The standard message skeleton
182 ^or <mh\-dir>/forwcomps~^Rather than the standard skeleton
183 ^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given
184 ^or <mh\-dir>/digestcomps~^Rather than the standard skeleton
185 ^%etcdir%/mhl.forward~^The standard message filter
186 ^or <mh\-dir>/mhl.forward~^Rather than the standard filter
187 ^$HOME/\&.mh\(ruprofile~^The user profile
188 ^<mh\-dir>/draft~^The draft file
190 ^Path:~^To determine the user's nmh directory
192 ^Current\-Folder:~^To find the default current folder
194 ^Draft\-Folder:~^To find the default draft\-folder
196 ^Editor:~^To override the default editor
198 ^Msg\-Protect:~^To set mode when creating a new message (draft)
200 ^fileproc:~^Program to refile the message
202 ^mhlproc:~^Program to filter messages being forwarded
204 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
206 \fIProposed Standard for Message Encapsulation\fR (RFC\-934),
208 mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5)
210 `+folder' defaults to the current folder
211 `msgs' defaults to cur
225 If a folder is given, it will become the current folder.
226 The first message forwarded will become the current message.
229 If \fIwhatnowproc\fR is \fIwhatnow\fR, then \fIforw\fR uses a built\-in
230 \fIwhatnow\fR, it does not actually run the \fIwhatnow\fR program.
231 Hence, if you define your own \fIwhatnowproc\fR, don't call it
232 \fIwhatnow\fR since \fIforw\fR won't run it.
234 When \fIforw\fR is told to annotate the messages it forwards, it
235 doesn't actually annotate them until the draft is successfully sent.
236 If from the \fIwhatnowproc\fR, you \fIpush\fR instead of \fIsend\fR,
237 it's possible to confuse \fIforw\fR by re\-ordering the file (e.g.,
238 by using `folder\0\-pack') before the message is successfully sent.
239 \fIDist\fR and \fIrepl\fR don't have this problem.