File: repl.man1

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

.SH FILES
.fc ^ ~
.nf
.ta \w'%etcdir%/ExtraBigFileName  'u
^%etcdir%/replcomps~^The standard reply template
^or $HOME/.mmh/replcomps~^Rather than the standard template
^%etcdir%/replgroupcomps~^The standard `reply \-group' template
^or $HOME/.mmh/replgroupcomps~^Rather than the standard template
^%etcdir%/mhl.reply~^The standard message filter
^or $HOME/.mmh/mhl.reply~^Rather than the standard filter
^$HOME/.mmh/profile~^The user profile
^+drafts~^The draft folder
.fi

.SH "PROFILE COMPONENTS"
.fc ^ ~
.nf
.ta 2.4i
.ta \w'ExtraBigProfileName  'u
^Path:~^To determine the user's mail storage
^Alternate\-Mailboxes:~^To determine the user's mailboxes
^Current\-Folder:~^To find the default current folder
^Draft\-Folder:~^To set the default draft\-folder
^Editor:~^To override the default editor
^Msg\-Protect:~^To set mode when creating a new message (draft)
^whatnowproc:~^Program to ask the `What now?' questions
.fi

.SH "SEE ALSO"
mhbuild(1), comp(1), forw(1), send(1), whatnow(1), mh\-format(5)

.SH DEFAULTS
.nf
.RB ` +folder "' defaults to the current folder"
.RB ` msg "' defaults to the current message"
.RB ` \-nogroup '
.RB ` "\-nocc\ all" "' with `\-nogroup', `\-cc\ all' with `\-group'"
.RB ` \-noannotate '
.RB ` \-nomime '
.RB ` \-noquery '
.fi

.SH CONTEXT
If a folder is given, it will become the current folder.  The message
replied\-to will become the current message.

.SH BUGS
If any addresses occur in the reply template, addresses in the template
that do not contain hosts are defaulted incorrectly.  Instead of using
the localhost for the default,
.B repl
uses the sender's host.
Moral of the story: if you're going to include addresses in a reply
template, include the host portion of the address.
.PP
The quotation of the original message does not get transfer-decoded, yet.