026b2cf706d61f29450e26fc7ede6f00518c8012
[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 [ \-editor
17 .IR editor ]
18 .RB [ \-noedit ]
19 .RB [ \-whatnowproc
20 .IR program ]
21 .RB [ \-nowhatnowproc ]
22 .RB [ \-build ]
23 .RB [ \-version ]
24 .RB [ \-help ]
25 .PP
26 .HP 5
27 .B forw
28 .RI [ +folder ]
29 .RI [ msgs ]
30 .RB [ \-digest
31 .IR list ]
32 .RB [ \-issue
33 .IR number ]
34 .RB [ \-volume
35 .IR number ]
36 [other\ switches\ for
37 .BR forw ]
38 .RB [ \-version ]
39 .RB [ \-help ]
40 .ad
41 .SH DESCRIPTION
42 .B Forw
43 may be used to prepare a message containing other messages.
44 .PP
45 It constructs the new message from a forms (components) file, with a
46 body composed of the message(s) to be forwarded.  An editor is invoked
47 as in
48 .BR comp ,
49 and after editing is complete, the user is prompted
50 before the message is sent.
51 .PP
52 The default message form contains the following elements:
53 .PP
54 .RS 5
55 .nf
56 %forwcomps%
57 .fi
58 .RE
59 .PP
60 If a file named
61 .RI \*(lq forwcomps \*(rq
62 exists in the user's mmh directory,
63 it will be used instead of this default form.  You may also specify an
64 alternate forms file with the switch
65 .B \-form
66 .IR formfile .
67 .PP
68 If the
69 .B \-annotate
70 switch is given, each message being forwarded will
71 be annotated with the line:
72 .PP
73 .RS 5
74 .nf
75 Forwarded:\ date
76 .fi
77 .RE
78 .PP
79 This annotation will be done only if the message is sent directly from
80 .BR forw .
81 If the message is not sent immediately from
82 .BR forw ,
83 .RB \*(lq comp
84 .BR \-use \*(rq
85 may be used to re\-edit and send the constructed
86 message, but the annotations won't take place.  Annotations
87 are always done inplace in order to preserve any links to the message.
88 .PP
89 See
90 .BR comp (1)
91 for a description of the
92 .B \-editor
93 and
94 .B \-noedit
95 switches.
96 .PP
97 .B Forw
98 generates an attachment header field for the messages to be forwarded.
99 .B Send
100 will care to encapsulate them using MIME rules.
101 .PP
102 To send non-MIME forwarded messages, compose a new message (e.g. with
103 .B comp )
104 and read in the output of:
105 .PP
106 .RS 5
107 mhl \-forwall \-form mhl.forward `mhpath
108 .I MSGS... `
109 .RE
110 .PP
111 The
112 .B \-editor
113 .I editor
114 switch indicates the editor to use for the
115 initial edit.  Upon exiting from the editor,
116 .B comp
117 will invoke the
118 .B whatnow
119 program.  See
120 .BR whatnow (1)
121 for a discussion of
122 available options.  The invocation of this program can be inhibited
123 by using the
124 .B \-nowhatnowproc
125 switch.  (In truth of fact, it is
126 the
127 .I whatnow
128 program which starts the initial edit.  Hence,
129 .B \-nowhatnowproc
130 will prevent any edit from occurring.)
131 .PP
132 The
133 .B \-build
134 switch is intended to be used by the Emacs mh-e interface to
135 .BR nmh ,
136 and is only present if
137 .B nmh
138 was compiled with support for mh-e. It implies
139 .BR \-nowhatnowproc .
140 It causes a file `draft' in the mail storage root
141 to be created, containing the draft message that would normally be presented
142 to the user for editing.
143 No mail is actually sent. Note that this switch is not guaranteed to
144 be present or to have the same effects in future versions of
145 .BR nmh :
146 it is documented here only for completeness.
147 .PP
148 The
149 .B \-digest
150 .IR list ,
151 .B \-issue
152 .IR number ,
153 and
154 .B \-volume
155 .I number
156 switches implement a digest facility for
157 .BR nmh .
158 Specifying these switches enables and/or overloads the following escapes:
159 .PP
160 .RS 5
161 .nf
162 .ta \w'Component  'u +\w'Escape  'u +\w'Returns  'u
163 .I Type Escape  Returns Description
164 component       digest  string  Argument to `\-digest'
165 function        cur     integer Argument to `\-volume'
166 function        msg     integer Argument to `\-issue'
167 .fi
168 .RE
169 .PP
170 Consult the
171 .I "Advanced Features"
172 section of the
173 .B nmh
174 User's Manual for more information on making digests.
175
176 .SH FILES
177 .fc ^ ~
178 .nf
179 .ta \w'%etcdir%/ExtraBigFileName  'u
180 ^%etcdir%/forwcomps~^The standard message skeleton
181 ^or $HOME/.mmh/forwcomps~^Rather than the standard skeleton
182 ^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given
183 ^or $HOME/.mmh/digestcomps~^Rather than the standard skeleton
184 ^$HOME/.mmh/profile~^The user profile
185 ^+drafts~^The draft folder
186 .fi
187
188 .SH "PROFILE COMPONENTS"
189 .fc ^ ~
190 .nf
191 .ta 2.4i
192 .ta \w'ExtraBigProfileName  'u
193 ^Path:~^To determine the user's mail storage
194 ^Current\-Folder:~^To find the default current folder
195 ^Draft\-Folder:~^To set the default draft\-folder
196 ^Editor:~^To override the default editor
197 ^Msg\-Protect:~^To set mode when creating a new message (draft)
198 ^fileproc:~^Program to refile the message
199 ^mhlproc:~^Program to filter messages being forwarded
200 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
201 .fi
202
203 .SH "SEE ALSO"
204 mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5),
205 .I "Proposed Standard for Message Encapsulation"
206 (RFC\-934)
207
208 .SH DEFAULTS
209 .nf
210 .RB ` +folder "' defaults to the current folder"
211 .RB ` msgs "' defaults to cur"
212 .RB ` \-noannotate '
213 .fi
214
215 .SH CONTEXT
216 If a folder is given, it will become the current folder.
217 The first message forwarded will become the current message.
218
219 .SH BUGS
220 When
221 .B forw
222 is told to annotate the messages it forwards, it
223 doesn't actually annotate them until the draft is successfully sent.
224 If from the
225 .IR whatnowproc ,
226 you
227 .B push
228 instead of
229 .BR send ,
230 it's possible to confuse
231 .B forw
232 by re\-ordering the file (e.g. by using
233 .RB \*(lq folder
234 .BR \-pack \*(rq)
235 before the message is successfully sent.
236 .B Dist
237 and
238 .B repl
239 don't have this problem.