indentation fix in uip/pick.c
[mmh] / man / repl.man1
1 .\"
2 .\" %nmhwarning%
3 .\"
4 .TH REPL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
5 .SH NAME
6 repl \- reply to a message
7 .SH SYNOPSIS
8 .HP 5
9 .na
10 .B repl
11 .RI [ +folder ]
12 .RI [ msgs ]
13 .RB [ \-annotate " | " \-noannotate ]
14 .RB [ \-group " | " \-nogroup ]
15 .RB [ \-cc
16 all/to/cc/me]
17 .RB [ \-nocc
18 all/to/cc/me]
19 .RB [ \-query " | " \-noquery ]
20 .RB [ \-form
21 .IR formfile ]
22 .RB [ \-filter
23 .IR filterfile
24 .RB " | " \-nofilter ]
25 .RB [ \-mime " | " \-nomime ]
26 .RB [ \-editor
27 .IR editor ]
28 .RB [ \-whatnowproc
29 .IR program ]
30 .RB [ \-build ]
31 .RB [ \-file
32 .IR msgfile ]
33 .RB [ \-Version ]
34 .RB [ \-help ]
35 .ad
36 .SH DESCRIPTION
37 .B Repl
38 may be used to produce a reply to an existing message.
39 .PP
40 In its simplest form (with no arguments),
41 .B repl
42 will set up a
43 message\-form skeleton in reply to the current message in the current
44 folder, and invoke the whatnow shell.
45 .PP
46 In order to construct the message draft of the reply,
47 .B repl
48 uses
49 a reply template to guide its actions.  A reply template is simply a
50 .B mhl
51 format file (see
52 .BR mh\-format (5)
53 for details).
54 .PP
55 If the switch
56 .B \-nogroup
57 is given (it is on by default), then
58 .B repl
59 will use the standard forms file `replcomps'.  This will construct
60 a draft message that is intended to be sent only to the author of the
61 message to which you are replying.  If a file named `replcomps'
62 exists in the user's
63 .B mmh
64 directory, it will be used instead of this
65 default forms file.
66 .PP
67 The default reply template `replcomps' will direct
68 .B repl
69 to construct the reply message draft as follows:
70 .PP
71 .RS 5
72 .nf
73 To: <Mail\-Reply\-To> or <Reply\-To> or <From>
74 Cc: <To> and <Cc> and <personal address>
75 Fcc: +sent
76 Subject: Re: <Subject>
77 In\-Reply\-To: <Message\-Id>
78 References: <Message\-Id>
79 Comments: In\-Reply\-To <From> or <apparently from> or <Sender>
80 .ti +3
81 message dated <date>
82 --------
83 .fi
84 .RE
85 .PP
86 where field names enclosed in angle brackets (<\ >) indicate the
87 contents of the named field from the message to which the reply is
88 being made.
89 .PP
90 By default, the `Cc:' field is empty.  You may selectively add
91 addresses to this default with the
92 .B \-cc
93 .I type
94 switch.  This switch takes an
95 argument (
96 .IR all / to / cc / me )
97 which specifies who gets added to the default
98 `Cc:' list of the reply.  You may give this switch multiple times (with
99 different arguments) if you wish to add multiple types of addresses.
100 .PP
101 If the switch
102 .B \-group
103 is given, then
104 .B repl
105 will use the the
106 standard forms file `replgroupcomps'.  This will construct a
107 draft message that is intended as a group or followup reply.  If a file
108 named `replgroupcomps' exists in the user's mmh directory, it
109 will be used instead of this default forms file.
110 .PP
111 The default group reply template `replgroupcomps' will direct
112 .B repl
113 to construct the reply message draft as follows:
114 .PP
115 .RS 5
116 .nf
117 To: <Mail\-Followup\-To>
118 Subject: Re: <Subject>
119 In\-Reply\-To: Message from <From> of <Date>.
120 .ti +\w'In\-Reply\-To: 'u
121 <Message\-Id>
122 --------
123 .fi
124 .RE
125 .PP
126 or if the field <Mail\-Followup\-To> is not available:
127 .PP
128 .RS 5
129 .nf
130 To: <Mail\-Reply\-To> or <Reply\-To> or <From>
131 Cc: <To> and <Cc> and <personal address>
132 Subject: Re: <Subject>
133 In\-Reply\-To: Message from <From> of <Date>.
134 .ti +\w'In\-Reply\-To: 'u
135 <Message\-Id>
136 --------
137 .fi
138 .RE
139 .PP
140 By default, the `Cc:' contains all the addresses shown.  You may
141 selectively remove addresses from this default with the
142 .B \-nocc
143 .I type
144 switch.
145 This switch takes an argument (
146 .IR all / to / cc / me )
147 which specifies who gets removed
148 from the default `Cc:' list of the reply.  You may give this switch
149 multiple times (with different arguments) if you wish to remove multiple types
150 of addresses.
151 .PP
152 In any case, you may specify an alternate forms file with the switch
153 .B \-form
154 .IR formfile .
155 .PP
156 The
157 .B \-query
158 switch modifies the action of
159 .B \-nocc
160 .I type
161 switch by
162 interactively asking you if each address that normally would be placed in
163 the `To:' and `Cc:' list should actually be sent a copy.
164 This is useful for special\-purpose replies.  Note that the position of
165 the
166 .B \-cc
167 and
168 .B \-nocc
169 switches, like all other switches which take a
170 positive and negative form, is important.
171 .PP
172 Lines beginning with the fields `To:', `Cc:', and
173 `Bcc:' will be standardized and have duplicate addresses removed.
174 In addition, these fields will be wrapped at a reasonable length.
175 .PP
176 See
177 .BR comp (1)
178 for a description of the
179 .B \-editor
180 switch.  Note that while in the editor,
181 the actual pathname of the message being replied to is
182 stored in the environment variable
183 .BR $mhaltmsg ,
184 and the pathname of
185 the folder containing the message is stored in the environment variable
186 .BR $mhfolder .
187 .PP
188 Although
189 .B repl
190 uses a forms file to direct it how to construct
191 the beginning of the draft, it uses a message filter file to direct
192 it as to how the message to which you are replying should be filtered
193 (re\-formatted) in the body of the draft.  The filter file for
194 .B repl
195 should be a standard form file for
196 .BR mhl ,
197 as
198 .B repl
199 will invoke
200 .B mhl
201 to format the message to which you are replying.
202 .PP
203 By default, the original message gets filtered
204 through a default message filter file and then included into the draft body
205 as quotation.
206 This should be adequate for most users.
207 This default filter
208 .RI ` mhl.reply '
209 is:
210 .PP
211 .RS 5
212 .nf
213 %mhl_reply%
214 .fi
215 .RE
216 .PP
217 which outputs each line of the body of the message prefaced with the
218 `>' character and a space.
219 If a file named
220 .RI ` mhl.reply '
221 exists in the user's
222 .B mmh
223 directory,
224 it will be used instead of this form.
225 .PP
226 You may specify an alternate message filter file with the switch
227 .B \-filter
228 .IR filterfile .
229 .PP
230 Other reply filters are commonly used, such as:
231 .PP
232 .RS 5
233 .nf
234 :
235 body:nocomponent,compwidth=9,offset=9
236 .fi
237 .RE
238 .PP
239 which says to output a blank line and then the body of the message
240 being replied\-to, indented by one tab\-stop.  Another popular format
241 is:
242 .PP
243 .RS 5
244 .nf
245 message-id:nocomponent,\|nonewline,\\
246 formatfield=`In message %{text},\ '
247 from:nocomponent,\|formatfield=`%(decode(friendly{text})) writes:'
248 body:component=`>',\|overflowtext=`>',\|overflowoffset=0
249 .fi
250 .RE
251 .PP
252 This message filter file cites the Message-ID and author of the message
253 being replied\-to, and then outputs each line of the body prefaced with
254 the `>' character.
255 .PP
256 If the switch
257 .B \-nofilter
258 is given, then the message
259 to which you are replying will not be formatted and thus not included in
260 the body of the draft.
261 (It may be added as MIME attachment with
262 .B \-mime
263 though.)
264 .PP
265 To MIME-attach the original message, specify the
266 .B \-mime
267 switch.
268 Note: In mmh, the \-mime switch is unrelated to
269 the \-filter and \-nofilter switches.
270 It is therefore possible to have the original message quoted in the body
271 .B and
272 attached as MIME part.
273 However, using the \-mime switch is discouraged.
274 It may get removed in the future.
275 .PP
276 If the
277 .B \-annotate
278 switch is given, the message being replied\-to will
279 be annotated with the line:
280 .PP
281 .RS 5
282 .nf
283 Replied:\ date
284 .fi
285 .RE
286 .PP
287 The annotation will be done only if the message is sent directly from
288 .BR repl .
289 If the message is not sent immediately from
290 .BR repl ,
291 .RB ` "comp\ \-use" '
292 may be used to re\-edit and send the constructed
293 message, but the annotations won't take place.  Annotations are always
294 done inplace in order to preserve any links to the message.
295 .PP
296 The default template specifies that a copy of the reply will be
297 put in
298 the folder 'sent'.
299 .PP
300 To avoid reiteration,
301 .B repl
302 strips any leading `Re: ' strings from
303 the
304 .I subject
305 component.
306 .PP
307 Consult the
308 .BR mh-draft (7)
309 man page for more
310 information.
311 .PP
312 Upon exiting from the editor,
313 .B repl
314 will invoke the
315 .B whatnow
316 program.  See
317 .BR whatnow (1)
318 for a discussion of available
319 options.
320 .PP
321 The
322 .B \-build
323 switch is intended to be used by the Emacs mh-e interface
324 to
325 .BR nmh .
326 It causes a file
327 .I reply (in the mail storage root)
328 to be created, containing the draft message that would normally be presented
329 to the user for editing.
330 No
331 .B whatnow
332 program is invoked.
333 No mail is actually sent.
334 .PP
335 The
336 .B \-file
337 .I msgfile
338 switch specifies the message to be replied to as an
339 exact filename rather than as an
340 .B mh
341 folder and message number. It is
342 intended to be used by the
343 .B msh
344 interface to
345 .BR nmh .
346 The same caveats apply to this option as to the
347 .B \-build
348 switch.
349
350 .SH FILES
351 .fc ^ ~
352 .nf
353 .ta \w'%etcdir%/ExtraBigFileName  'u
354 ^%etcdir%/replcomps~^The standard reply template
355 ^or $HOME/.mmh/replcomps~^Rather than the standard template
356 ^%etcdir%/replgroupcomps~^The standard `reply \-group' template
357 ^or $HOME/.mmh/replgroupcomps~^Rather than the standard template
358 ^%etcdir%/mhl.reply~^The standard message filter
359 ^or $HOME/.mmh/mhl.reply~^Rather than the standard filter
360 ^$HOME/.mmh/profile~^The user profile
361 ^+drafts~^The draft folder
362 .fi
363
364 .SH "PROFILE COMPONENTS"
365 .fc ^ ~
366 .nf
367 .ta 2.4i
368 .ta \w'ExtraBigProfileName  'u
369 ^Path:~^To determine the user's mail storage
370 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
371 ^Current\-Folder:~^To find the default current folder
372 ^Draft\-Folder:~^To set the default draft\-folder
373 ^Editor:~^To override the default editor
374 ^Msg\-Protect:~^To set mode when creating a new message (draft)
375 ^whatnowproc:~^Program to ask the `What now?' questions
376 .fi
377
378 .SH "SEE ALSO"
379 mhbuild(1), comp(1), forw(1), send(1), whatnow(1), mh\-format(5)
380
381 .SH DEFAULTS
382 .nf
383 .RB ` +folder "' defaults to the current folder"
384 .RB ` msg "' defaults to the current message"
385 .RB ` \-nogroup '
386 .RB ` "\-nocc\ all" "' with `\-nogroup', `\-cc\ all' with `\-group'"
387 .RB ` \-noannotate '
388 .RB ` \-nomime '
389 .RB ` \-noquery '
390 .fi
391
392 .SH CONTEXT
393 If a folder is given, it will become the current folder.  The message
394 replied\-to will become the current message.
395
396 .SH BUGS
397 If any addresses occur in the reply template, addresses in the template
398 that do not contain hosts are defaulted incorrectly.  Instead of using
399 the localhost for the default,
400 .B repl
401 uses the sender's host.
402 Moral of the story: if you're going to include addresses in a reply
403 template, include the host portion of the address.
404 .PP
405 The quotation of the original message does not get transfer-decoded, yet.