source: trunk/third/nmh/man/repl.man @ 14729

Revision 14729, 10.9 KB checked in by ghudson, 25 years ago (diff)
Document -group changes we made to be compatible with old mh.
RevLine 
[12454]1.\"
2.\" %nmhwarning%
[14729]3.\" $Id: repl.man,v 1.2 2000-05-08 17:37:31 ghudson Exp $
[12454]4.\"
5.\" include the -mh macro file
6.so %etcdir%/tmac.h
7.\"
8.TH REPL %manext1% MH.6.8 [%nmhversion%]
9.SH NAME
10repl \- reply to a message
11.SH SYNOPSIS
12.in +.5i
13.ti -.5i
14repl
15\%[+folder] \%[msg]
16.br
17\%[\-group] \%[\-nogroup]
18\%[\-annotate] \%[\-noannotate]
19.br
20\%[\-cc\ all/to/cc/me] \%[\-nocc\ all/to/cc/me]
21.br
22\%[\-query] \%[\-noquery]
23\%[\-form\ formfile]
24.br
25\%[\-format] \%[\-noformat]
26\%[\-filter\ filterfile]
27.br
28\%[\-inplace] \%[\-noinplace]
29\%[\-mime] \%[\-nomime]
30.br
31\%[\-fcc\ +folder]
32\%[\-width\ columns]
33.br
34\%[\-draftfolder\ +folder] \%[\-draftmessage\ msg]
35.br
36\%[\-nodraftfolder]
37\%[\-editor\ editor] \%[\-noedit]
38.br
39\%[\-whatnowproc\ program] \%[\-nowhatnowproc]
40.br
41\%[\-version]
42\%[\-help]
43.in -.5i
44.SH DESCRIPTION
45\fIRepl\fR may be used to produce a reply to an existing message.
46
47In its simplest form (with no arguments), \fIrepl\fR will set up a
48message\-form skeleton in reply to the current message in the current
49folder, and invoke the whatnow shell.
50
51In order to construct the message draft of the reply, \fIrepl\fR uses
52a reply template to guide its actions.  A reply template is simply a
53\fImhl\fR format file (see \fImh\-format\fR\0(5) for details).
54
55If the switch `\-nogroup' is given (it is on by default), then \fIrepl\fR
56will use the standard forms file \*(lqreplcomps\*(rq.  This will construct
57a draft message that is intended to be sent only to the author of the
58message to which you are replying.  If a file named \*(lqreplcomps\*(rq
59exists in the user's nmh directory, it will be used instead of this
60default forms file.
61
62The default reply template \*(lqreplcomps\*(rq will direct \fIrepl\fR
63to construct the reply message draft as follows:
64
65.nf
66.in 1i
67To: <Mail\-Reply\-To> or <Reply\-To> or <From>
68Subject: Re: <Subject>
69In\-Reply\-To: Your message of <Date>.
70.ti +\w'In\-Reply\-To: 'u
71<Message\-Id>
72.in .5i
73.fi
74
75where field names enclosed in angle brackets (<\ >) indicate the
76contents of the named field from the message to which the reply is
77being made.
78
79If the switch `\-group' is given, then \fIrepl\fR will use the the
80standard forms file \*(lqreplgroupcomps\*(rq.  This will construct a
81draft message that is intended as a group or followup reply.  If a file
82named \*(lqreplgroupcomps\*(rq exists in the user's nmh directory, it
[14729]83will be used instead of this default forms file.  `\-group' also implies
84`\-cc all'.
[12454]85
86The default group reply template \*(lqreplgroupcomps\*(rq will direct
87\fIrepl\fR to construct the reply message draft as follows:
88
89.nf
90.in 1i
91To: <Mail\-Followup\-To>
92Subject: Re: <Subject>
93In\-Reply\-To: Message from <From> of <Date>.
94.ti +\w'In\-Reply\-To: 'u
95<Message\-Id>
96.in .5i
97.fi
98
99or if the field <Mail\-Followup\-To> is not available:
100
101.nf
102.in 1i
103To: <Mail\-Reply\-To> or <Reply\-To> or <From>
104cc: <To> and <cc> and <personal address>
105Subject: Re: <Subject>
106In\-Reply\-To: Message from <From> of <Date>.
107.ti +\w'In\-Reply\-To: 'u
108<Message\-Id>
109.in .5i
110.fi
111
112In any case, you may specify an alternate forms file with the switch
113`\-form\ formfile'.
114
115You may selectively remove addresses from this default with the
116`\-nocc\ type' switch.  This switch takes an argument (all/to/cc/me)
117which specifies who gets removed from the default \*(lqcc:\*(rq list of
118the reply.  You may give this switch multiple times (with different
119arguments) if you wish to remove multiple types of addresses.
120
121The `\-query' switch modifies the action of `\-nocc\ type' switch by
122interactively asking you if each address that normally would be placed in
123the \*(lqTo:\*(rq and \*(lqcc:\*(rq list should actually be sent a copy.
124This is useful for special\-purpose replies.  Note that the position of
125the `\-cc' and `\-nocc' switches, like all other switches which take a
[14729]126positive and negative form, is important.  A `\-cc' switch implies
127`\-group'.
[12454]128
129Lines beginning with the fields \*(lqTo:\*(rq, \*(lqcc:\*(rq, and
130\*(rqBcc:\*(rq will be standardized and have duplicate addresses removed.
131In addition, the `\-width\ columns' switch will guide \fIrepl\fR's
132formatting of these fields.
133
134If the draft already exists, \fIrepl\fR will ask you as to the disposition
135of the draft.  A reply of \fBquit\fR will abort \fIrepl\fR, leaving the
136draft intact; \fBreplace\fR will replace the existing draft with a blank
137skeleton; and \fBlist\fR will display the draft.
138
139See \fIcomp\fR\0(1) for a description of the `\-editor' and `\-noedit'
140switches.  Note that while in the editor, the message being replied
141to is available through a link named \*(lq@\*(rq (assuming the default
142\fIwhatnowproc\fR\0).  In addition, the actual pathname of the message is
143stored in the environment variable \fB$editalt\fR, and the pathname of
144the folder containing the message is stored in the environment variable
145\fB$mhfolder\fR.
146
147Although \fIrepl\fR uses a forms file to direct it how to construct
148the beginning of the draft, it uses a message filter file to direct
149it as to how the message to which you are replying should be filtered
150(re\-formatted) in the body of the draft.  The filter file for \fIrepl\fR
151should be a standard form file for \fImhl\fR, as \fIrepl\fR will invoke
152\fImhl\fR to format the message to which you are replying.
153
154The switches `\-noformat', `\-format', and `\-filter\ filterfile' specify
155which message filter file to use.
156
157If the switch `\-noformat' is given (it is the default), then the message
158to which you are replying is not included in the body of the draft.
159
160If the switch `\-format' is given, then a default message filter file
161is used.  This default message filter should be adequate for most users.
162This default filter \*(lqmhl.reply\*(rq is:
163
164.nf
165.in +.5i
166.ne 10
167.eo
168.so %etcdir%/mhl.reply
169.ec
170.in -.5i
171.fi
172
173which outputs each line of the body of the message prefaced with the
174\*(lq>\*(rq character and a space.
175
176If a file named \*(lqmhl.reply\*(rq exists in the user's nmh directory,
177it will be used instead of this form.  You may specify an alternate
178message filter file with the switch `\-filter\ filterfile'.
179
180Other reply filters are commonly used, such as:
181
182.nf
183.in +.5i
184:
185body:nocomponent,compwidth=9,offset=9
186.in -.5i
187.fi
188
189which says to output a blank line and then the body of the message
190being replied\-to, indented by one tab\-stop.  Another popular format
191is:
192
193.nf
194.in +.5i
195.ie n \{
196message-id:nocomponent,\|nonewline,\\
197formatfield=\*(lqIn message %{text},\ \*(rq \}
198.el message-id:nocomponent,\|nonewline,\|formatfield=\*(lqIn message %{text},\ \*(rq
199from:nocomponent,\|formatfield=\*(lq%(friendly{text}) writes:\*(rq
200body:component=\*(lq>\*(rq,\|overflowtext=\*(lq>\*(rq,\|overflowoffset=0
201.in -.5i
202.fi
203
204This message filter file cites the Message-ID and author of the message
205being replied\-to, and then outputs each line of the body prefaced with
206the \*(lq>\*(rq character.
207
208To use the MIME rules for encapsulation, specify the `\-mime' switch.
209This directs \fIreply\fR to generate an \fImhbuild\fR composition file.
210Note that nmh will not invoke \fImhbuild\fR automatically, unless you
211add this line to your \&.mh\(ruprofile file:
212.sp
213.in +.5i
214automimeproc: 1
215.in -.5i
216.sp
217Otherwise, you must specifically give the command
218.sp
219.in +.5i
220What now? mime
221.in -.5i
222.sp
223prior to sending the draft.
224
225If the `\-annotate' switch is given, the message being replied\-to will
226be annotated with the lines
227
228     Replied:\ date
229     Replied:\ addrs
230
231where the address list contains one line for each addressee.
232The annotation will be done only if the message is sent directly from
233\fIrepl\fR.  If the message is not sent immediately from \fIrepl\fR,
234\*(lqcomp\ \-use\*(rq may be used to re\-edit and send the constructed
235message, but the annotations won't take place.  Normally annotations are
236done inplace in order to preserve any links to the message.  You may use
237the `\-noinplace' switch to change this.
238
239The `\-fcc\ +folder' switch can be used to automatically specify a folder
240to receive Fcc:s.  More than one folder, each preceded by `\-fcc' can
241be named.
242
243In addition to the standard \fImh\-format\fR\0(5) escapes, \fIrepl\fR
244also recognizes the following additional \fIcomponent\fR escape:
245.sp 1
246.nf
247.ta \w'Escape  'u +\w'Returns  'u
248\fIEscape\fR    \fIReturns\fR   \fIDescription\fR
249\fIfcc\fR       string  Any folders specified with `\-fcc\ folder'
250.re
251.fi
252
253To avoid reiteration, \fIrepl\fR strips any leading `Re: ' strings from
254the \fIsubject\fR component.
255
256The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke
257the \fInmh\fR draft folder facility.  This is an advanced (and highly
258useful) feature.  Consult the \fImh-draft\fR(5) man page for more
259information.
260
261Upon exiting from the editor, \fIrepl\fR will invoke the \fIwhatnow\fR
262program.  See \fIwhatnow\fR\0(1) for a discussion of available
263options.  The invocation of this program can be inhibited by using the
264`\-nowhatnowproc' switch.  (In truth of fact, it is the \fIwhatnow\fR
265program which starts the initial edit.  Hence, `\-nowhatnowproc' will
266prevent any edit from occurring.)
267
268.Fi
269^%etcdir%/replcomps~^The standard reply template
270^or <mh\-dir>/replcomps~^Rather than the standard template
271^%etcdir%/replgroupcomps~^The standard `reply -group' template
272^or <mh\-dir>/replgroupcomps~^Rather than the standard template
273^%etcdir%/mhl.reply~^The standard message filter
274^or <mh\-dir>/mhl.reply~^Rather than the standard filter
275^$HOME/\&.mh\(ruprofile~^The user profile
276^<mh\-dir>/draft~^The draft file
277.Pr
278^Path:~^To determine the user's nmh directory
279.Ps
280^Alternate\-Mailboxes:~^To determine the user's mailboxes
281.Ps
282^Current\-Folder:~^To find the default current folder
283.Ps
284^Draft\-Folder:~^To find the default draft\-folder
285.Ps
286^Editor:~^To override the default editor
287.Ps
288^Msg\-Protect:~^To set mode when creating a new message (draft)
289.Ps
290^fileproc:~^Program to refile the message
291.Ps
292^mhlproc:~^Program to filter message being replied\-to
293.Ps
294^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
295.Sa
296mhbuild(1), comp(1), forw(1), send(1), whatnow(1), mh\-format(5)
297.De
298`+folder' defaults to the current folder
299.Ds
300`msg' defaults to cur
301.Ds
302`\-nogroup'
303.Ds
304`\-cc\ all'
305.Ds
306`\-noannotate'
307.Ds
308`\-nodraftfolder'
309.Ds
310`\-noformat'
311.Ds
312`\-inplace'
313.Ds
314`\-nomime'
315.Ds
316`\-noquery'
317.Ds
318`\-width\ 72'
319.Co
320If a folder is given, it will become the current folder.  The message
321replied\-to will become the current message.
322.Bu
323If any addresses occur in the reply template, addresses in the template
324that do not contain hosts are defaulted incorrectly.  Instead of using
325the localhost for the default, \fIrepl\fR uses the sender's host.
326Moral of the story: if you're going to include addresses in a reply
327template, include the host portion of the address.
328
329The `\-width columns' switch is only used to do address-folding; other
330headers are not line\-wrapped.
331
332If \fIwhatnowproc\fR is \fIwhatnow\fR, then \fIrepl\fR uses a built\-in
333\fIwhatnow\fR, it does not actually run the \fIwhatnow\fR program.
334Hence, if you define your own \fIwhatnowproc\fR, don't call it
335\fIwhatnow\fR since \fIrepl\fR won't run it.
336
337If your current working directory is not writable, the link named
338\*(lq@\*(rq is not available.
339.En
Note: See TracBrowser for help on using the repository browser.