Removed unused fail label.

[nmh] / man / repl.man

diff --git a/man/repl.man b/man/repl.man
index fe87c856597517fba1ff7e83edf05f65b868e35a..216238f5127c4b2daffc21ea75bbc4c612b70f46 100644 (file)
--- a/man/repl.man
+++ b/man/repl.man
@@ -1,15 +1,17 @@
-.TH REPL %manext1% "April 18, 2014" "%nmhversion%"
-.\"
+.TH REPL %manext1% 2014-12-15 "%nmhversion%"
+.

 .\" %nmhwarning%
 .\" %nmhwarning%

-.\"
+.

 .SH NAME
 .SH NAME

-repl \- reply to a message
+repl \- reply to an nmh message

 .SH SYNOPSIS
 .HP 5
 .na
 .B repl
 .SH SYNOPSIS
 .HP 5
 .na
 .B repl

+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ +folder ]
 .RI [ +folder ]

-.RI [ msgs ]
+.RI [ msg ]

 .RB [ \-annotate " | " \-noannotate ]
 .RB [ \-group " | " \-nogroup ]
 .RB [ \-cc
 .RB [ \-annotate " | " \-noannotate ]
 .RB [ \-group " | " \-nogroup ]
 .RB [ \-cc


@@ -36,6 +38,8 @@ all/to/cc/me]
 .RB [ \-editor
 .IR editor ]
 .RB [ \-noedit ]
 .RB [ \-editor
 .IR editor ]
 .RB [ \-noedit ]

+.RB [ \-convertargs
+.IR "type argstring" ]

 .RB [ \-whatnowproc
 .IR program ]
 .RB [ \-nowhatnowproc ]
 .RB [ \-whatnowproc
 .IR program ]
 .RB [ \-nowhatnowproc ]


@@ -47,23 +51,21 @@ all/to/cc/me]
 .RB [ \-build ]
 .RB [ \-file
 .IR msgfile ]
 .RB [ \-build ]
 .RB [ \-file
 .IR msgfile ]

-.RB [ \-version ]
-.RB [ \-help ]

 .ad
 .SH DESCRIPTION
 .ad
 .SH DESCRIPTION

-.B Repl
-may be used to produce a reply to an existing message.
+.B repl
+may be used to reply to a message.

 .PP
 In its simplest form (with no arguments),
 .B repl
 .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.
+will set up a message-form skeleton in reply to the current message
+in the current folder, and invoke the
+.B whatnow
+shell.

 .PP
 .PP

-In order to construct the message draft of the reply,

 .B repl
 .B repl

-uses
-a reply template to guide its actions.  A reply template is simply a
+uses a reply template to construct the draft of the reply.
+A reply template is simply an

 .B mhl
 format file (see
 .IR mh\-format (5)
 .B mhl
 format file (see
 .IR mh\-format (5)


@@ -78,8 +80,7 @@ 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 \*(lqreplcomps\*(rq
 exists in the user's
 .B nmh
 message to which you are replying.  If a file named \*(lqreplcomps\*(rq
 exists in the user's
 .B nmh

-directory, it will be used instead of this
-default forms file.
+directory, it will be used instead of this default forms file.

 .PP
 The default reply template \*(lqreplcomps\*(rq will direct
 .B repl
 .PP
 The default reply template \*(lqreplcomps\*(rq will direct
 .B repl


@@ -108,23 +109,22 @@ By default, the \*(lqcc:\*(rq field is empty.  You may selectively add
 addresses to this default with the
 .B \-cc
 .I type
 addresses to this default with the
 .B \-cc
 .I type

-switch.  This switch takes an
-argument
+switch.  This switch takes an argument

 .RI ( all / to / cc / me )
 which specifies who gets added to the default
 \*(lqcc:\*(rq list of the reply.  You may give this switch multiple times (with
 .RI ( all / to / cc / me )
 which specifies who gets added to the default
 \*(lqcc:\*(rq list of the reply.  You may give this switch multiple times (with

-different arguments) if you wish to add multiple types of addresses.
+different arguments) if you wish to add multiple types of address.

 .PP
 If the switch
 .B \-group
 is given, then
 .B repl
 .PP
 If the switch
 .B \-group
 is given, then
 .B repl

-will use the
-standard forms file \*(lqreplgroupcomps\*(rq.  This will construct a
-draft message that is intended as a group or followup reply.  If a file
-named \*(lqreplgroupcomps\*(rq exists in the user's nmh directory, it
-will be used instead of this default forms file, unless you specify
-another forms file on the command line or in your profile.
+will use the standard forms file \*(lqreplgroupcomps\*(rq.
+This will construct a draft message that is intended as a group or
+followup reply.  If a file named \*(lqreplgroupcomps\*(rq exists
+in the user's nmh directory, it will be used instead of this default
+forms file, unless you specify another forms file on the command line
+or in your profile.

 .PP
 The default group reply template \*(lqreplgroupcomps\*(rq will direct
 .B repl
 .PP
 The default group reply template \*(lqreplgroupcomps\*(rq will direct
 .B repl


@@ -162,12 +162,11 @@ selectively remove addresses from this default with the
 switch.
 This switch takes an argument (
 .IR all / to / cc / me )
 switch.
 This switch takes an argument (
 .IR all / to / cc / me )

-which specifies who gets removed
-from the default \*(lqcc:\*(rq list of the reply.  You may give this switch
-multiple times (with different arguments) if you wish to remove multiple types
-of addresses.
+which specifies who gets removed from the default \*(lqcc:\*(rq list of
+the reply.  You may give this switch multiple times (with different arguments)
+if you wish to remove multiple types of address.

 .PP
 .PP

-In any case, you may specify an alternate forms file with the switch
+In any case, you may specify an alternative forms file with the switch

 .B \-form
 .IR formfile .
 .PP
 .B \-form
 .IR formfile .
 .PP


@@ -176,16 +175,15 @@ The
 switch modifies the action of
 .B \-nocc
 .I type
 switch modifies the action of
 .B \-nocc
 .I type

-switch by
-interactively asking you if each address that normally would be placed in
-the \*(lqTo:\*(rq and \*(lqcc:\*(rq list should actually be sent a copy.
-This is useful for special\-purpose replies.  Note that the position of
+switch by interactively asking you if each address that normally would be
+placed in the \*(lqTo:\*(rq and \*(lqcc:\*(rq 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
 the
 .B \-cc
 and
 .B \-nocc

-switches, like all other switches which take a
-positive and negative form, is important.
+switches, like all other switches which take a positive and negative form,
+is important.

 .PP
 Lines beginning with the fields \*(lqTo:\*(rq, \*(lqcc:\*(rq, and
 \*(rqBcc:\*(rq will be standardized and have duplicate addresses removed.
 .PP
 Lines beginning with the fields \*(lqTo:\*(rq, \*(lqcc:\*(rq, and
 \*(rqBcc:\*(rq will be standardized and have duplicate addresses removed.


@@ -198,16 +196,14 @@ formatting of these fields.
 .PP
 If the draft already exists,
 .B repl
 .PP
 If the draft already exists,
 .B repl

-will ask you as to the disposition
-of the draft.  A reply of
+will ask you as to the disposition of the draft.  A reply of

 .B quit
 will abort
 .BR repl ,
 leaving the
 draft intact;
 .B replace
 .B quit
 will abort
 .BR repl ,
 leaving the
 draft intact;
 .B replace

-will replace the existing draft with a blank
-skeleton; and
+will replace the existing draft with a blank skeleton; and

 .B list
 will display the draft.
 .PP
 .B list
 will display the draft.
 .PP


@@ -222,11 +218,11 @@ switches.  Note that while in the editor, with
 and if the current directory is writable, the message being replied
 to is available through a link named \*(lq@\*(rq (assuming the default
 .IR whatnowproc ).
 and if the current directory is writable, the message being replied
 to is available through a link named \*(lq@\*(rq (assuming the default
 .IR whatnowproc ).

-In addition, the actual pathname of the message is
-stored in the environment variable
+In addition, the actual pathname of the message is stored in the
+environment variable

 .BR $editalt ,
 .BR $editalt ,

-and the pathname of
-the folder containing the message is stored in the environment variable
+and the pathname of the folder containing the message is stored in
+the environment variable

 .BR $mhfolder .
 The creation of the \*(lq@\*(rq file is controlled via the
 .B \-atfile
 .BR $mhfolder .
 The creation of the \*(lq@\*(rq file is controlled via the
 .B \-atfile


@@ -234,12 +230,33 @@ and
 .B \-noatfile
 options.
 .PP
 .B \-noatfile
 options.
 .PP

+The
+.B \-convertargs
+switch directs
+.B repl
+to pass the arguments for
+.I type
+to
+.BR mhbuild .
+Both arguments are required;
+.I type
+must be non-empty while
+.I argstring
+can be empty, e.g., '' in a shell command line.  The
+.B \-convertargs
+switch can be used multiple times.
+See the Convert Interface section of
+.IR mhbuild (1)
+for a description of the convert mechanism, and
+.I %docdir%/contrib/replaliases
+for examples of its use.
+.PP

 Although
 .B repl
 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
+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 ,
 .B repl
 should be a standard form file for
 .BR mhl ,


@@ -255,18 +272,19 @@ The switches
 and
 .B \-filter
 .I filterfile
 and
 .B \-filter
 .I filterfile

-specify
-which message filter file to use.
+specify which message filter file to use.

 .PP
 If the switch
 .B \-noformat
 .PP
 If the switch
 .B \-noformat

-is given (it is the default), then the message
-to which you are replying is not included in the body of the draft.
+is given (it is the default) and the
+.B \-filter
+switch is not used, then the message to which you are replying is not
+included in the body of the draft.

 .PP
 If the switch
 .B \-format
 .PP
 If the switch
 .B \-format

-is given, then a default message filter file
-is used.  This default message filter should be adequate for most users.
+is given, then a default message filter file is used.
+This default message filter should be adequate for most users.

 This default filter
 .RI \*(lq mhl.reply \*(rq
 is:
 This default filter
 .RI \*(lq mhl.reply \*(rq
 is:


@@ -299,8 +317,8 @@ body:nocomponent,compwidth=9,offset=9
 .fi
 .RE
 .PP
 .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
+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
 is:
 .PP
 .RS 5


@@ -313,12 +331,12 @@ body:component=\*(lq>\*(rq,\|overflowtext=\*(lq>\*(rq,\|overflowoffset=0
 .RE
 .PP
 This message filter file cites the Message-ID and author of the message
 .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
+being replied to, and then outputs each line of the body prefaced with

 the \*(lq>\*(rq character.
 .PP
 You can also use an external format program to format the message body.
 The format program is specified by the
 the \*(lq>\*(rq character.
 .PP
 You can also use an external format program to format the message body.
 The format program is specified by the

-.IR formatproc
+.I formatproc

 profile entry, and is enabled by the \*(lqformat\*(rq flag.  A message
 filter using an external format program would look like this:
 .PP
 profile entry, and is enabled by the \*(lqformat\*(rq flag.  A message
 filter using an external format program would look like this:
 .PP


@@ -329,9 +347,9 @@ body:component=\*(lq>\*(rq,\|nowrap,\|format
 .RE
 .PP
 See the
 .RE
 .PP
 See the

-.IR mhl(1)
-documentation for more information.  The format program can be changed by
-the
+.IR mhl (1)
+documentation for more information.
+The format program can be changed by the

 .B \-fmtproc
 .I program
 and
 .B \-fmtproc
 .I program
 and


@@ -360,8 +378,8 @@ prior to sending the draft.
 .PP
 If the
 .B \-annotate
 .PP
 If the
 .B \-annotate

-switch is given, the message being replied\-to will
-be annotated with the lines
+switch is given, the message being replied to will be annotated with
+the lines

 .PP
 .RS 5
 Replied:\ date
 .PP
 .RS 5
 Replied:\ date


@@ -374,24 +392,22 @@ The annotation will be done only if the message is sent directly from
 If the message is not sent immediately from
 .BR repl ,
 .RB \*(lq "comp\ \-use" \*(rq
 If the message is not sent immediately from
 .BR repl ,
 .RB \*(lq "comp\ \-use" \*(rq

-may be used to re\-edit and send the constructed
-message, but the annotations won't take place.  Normally annotations are
-done inplace in order to preserve any links to the message.  You may use
-the
+may be used to re-edit and send the constructed message, but the
+annotations won't take place.
+Normally annotations are done inplace in order to preserve any links
+to the message.
+You may use the

 .B \-noinplace
 switch to change this.
 .PP
 Although the default template specifies that a copy of the reply will be
 .B \-noinplace
 switch to change this.
 .PP
 Although the default template specifies that a copy of the reply will be

-put in
-the folder 'outbox',
-if the
+put in the folder 'outbox', if the

 .B \-fcc
 .I +folder
 switch is given it will override the default value.
 More than one folder, each preceded by
 .B \-fcc
 .B \-fcc
 .I +folder
 switch is given it will override the default value.
 More than one folder, each preceded by
 .B \-fcc

-can
-be named.
+can be named.

 .PP
 In addition to the standard
 .IR mh\-format (5)
 .PP
 In addition to the standard
 .IR mh\-format (5)


@@ -411,8 +427,7 @@ fcc string  Any folders specified with `\-fcc\ folder'
 .PP
 To avoid reiteration,
 .B repl
 .PP
 To avoid reiteration,
 .B repl

-strips any leading `Re: ' strings from
-the
+strips any leading `Re: ' strings from the

 .I subject
 component.
 .PP
 .I subject
 component.
 .PP


@@ -422,14 +437,12 @@ The
 and
 .B \-draftmessage
 .I msg
 and
 .B \-draftmessage
 .I msg

-switches invoke
-the
+switches invoke the

 .B nmh
 .B nmh

-draft folder facility.  This is an advanced (and highly
-useful) feature.  Consult the
+draft folder facility.  This is an advanced (and highly useful) feature.
+Consult

 .IR mh-draft (5)
 .IR mh-draft (5)

-man page for more
-information.
+for more information.

 .PP
 Upon exiting from the editor,
 .B repl
 .PP
 Upon exiting from the editor,
 .B repl


@@ -440,12 +453,11 @@ program.  See
 for a discussion of available
 options.  The invocation of this program can be inhibited by using the
 .B \-nowhatnowproc
 for a discussion of available
 options.  The invocation of this program can be inhibited by using the
 .B \-nowhatnowproc

-switch.  (In truth of fact, it is the
+switch.  (In fact, it is the

 .B whatnow
 program which starts the initial edit.  Hence,
 .B \-nowhatnowproc
 .B whatnow
 program which starts the initial edit.  Hence,
 .B \-nowhatnowproc

-will
-prevent any edit from occurring.)
+will prevent any edit from occurring.)

 .PP
 The
 .B \-build
 .PP
 The
 .B \-build


@@ -455,7 +467,7 @@ to
 It implies
 .BR \-nowhatnowproc .
 It causes a file
 It implies
 .BR \-nowhatnowproc .
 It causes a file

-.I <mh\-dir>/reply
+.I <mh-dir>/reply

 to be created, containing the draft message that would normally be presented
 to the user for editing.
 No mail is actually sent.
 to be created, containing the draft message that would normally be presented
 to the user for editing.
 No mail is actually sent.


@@ -463,8 +475,8 @@ No mail is actually sent.
 The
 .B \-file
 .I msgfile
 The
 .B \-file
 .I msgfile

-switch specifies the message to be replied to as an
-exact filename rather than as an
+switch specifies the message to be replied to as an exact filename rather
+than as an

 .B nmh
 folder and message number.
 The same caveats apply to this option as to the
 .B nmh
 folder and message number.
 The same caveats apply to this option as to the


@@ -477,20 +489,20 @@ absolute pathnames are accessed directly, tilde expansion is done on
 usernames, and files are searched for in the user's
 .I Mail
 directory as specified in their profile.  If not found there, the directory
 usernames, and files are searched for in the user's
 .I Mail
 directory as specified in their profile.  If not found there, the directory

-.RI \*(lq %etcdir% \*(rq
+.RI \*(lq %nmhetcdir% \*(rq

 is checked.
 .PP
 .fc ^ ~
 .nf
 is checked.
 .PP
 .fc ^ ~
 .nf

-.ta \w'%etcdir%/ExtraBigFileName  'u
-^%etcdir%/replcomps~^The standard reply template
-^or <mh\-dir>/replcomps~^Rather than the standard template
-^%etcdir%/replgroupcomps~^The standard `reply -group' template
-^or <mh\-dir>/replgroupcomps~^Rather than the standard template
-^%etcdir%/mhl.reply~^The standard message filter
-^or <mh\-dir>/mhl.reply~^Rather than the standard filter
-^$HOME/\&.mh\(ruprofile~^The user profile
-^<mh\-dir>/draft~^The draft file
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^%nmhetcdir%/replcomps~^The standard reply template
+^or <mh-dir>/replcomps~^Rather than the standard template
+^%nmhetcdir%/replgroupcomps~^The standard `reply -group' template
+^or <mh-dir>/replgroupcomps~^Rather than the standard template
+^%nmhetcdir%/mhl.reply~^The standard message filter
+^or <mh-dir>/mhl.reply~^Rather than the standard filter
+^$HOME/.mh_profile~^The user profile
+^<mh-dir>/draft~^The draft file

 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~


@@ -500,20 +512,22 @@ is checked.
 ^Path:~^To determine the user's nmh directory
 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 ^Current\-Folder:~^To find the default current folder
 ^Path:~^To determine the user's nmh directory
 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 ^Current\-Folder:~^To find the default current folder

-^Draft\-Folder:~^To find the default draft\-folder
+^Draft\-Folder:~^To find the default draft-folder

 ^Editor:~^To override the default editor
 ^Msg\-Protect:~^To set mode when creating a new message (draft)
 ^fileproc:~^Program to refile the message
 ^Editor:~^To override the default editor
 ^Msg\-Protect:~^To set mode when creating a new message (draft)
 ^fileproc:~^Program to refile the message

-^mhlproc:~^Program to filter message being replied\-to
+^mhlproc:~^Program to filter message being replied-to

 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 .fi
 .SH "SEE ALSO"
 .IR comp (1),
 .IR forw (1),
 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 .fi
 .SH "SEE ALSO"
 .IR comp (1),
 .IR forw (1),

+.IR mh\-format (5),

 .IR mhbuild (1),
 .IR send (1),
 .IR mhbuild (1),
 .IR send (1),

-.IR whatnow (1),
-.IR mh\-format (5)
+.IR whatnow (1)
+.PP
+.I %docdir%/contrib/replaliases

 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"


@@ -531,7 +545,7 @@ is checked.
 .fi
 .SH CONTEXT
 If a folder is given, it will become the current folder.  The message
 .fi
 .SH CONTEXT
 If a folder is given, it will become the current folder.  The message

-replied\-to will become the current 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
 .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


@@ -544,8 +558,7 @@ template, include the host portion of the address.
 The
 .B \-width
 .I columns
 The
 .B \-width
 .I columns

-switch is only used to do address-folding; other
-headers are not line\-wrapped.
+switch is only used to do address-folding; other headers are not line-wrapped.

 .PP
 If
 .I whatnowproc
 .PP
 If
 .I whatnowproc


@@ -553,7 +566,7 @@ is
 .BR whatnow ,
 then
 .B repl
 .BR whatnow ,
 then
 .B repl

-uses a built\-in
+uses a built-in

 .BR whatnow ,
 it does not actually run the
 .B whatnow
 .BR whatnow ,
 it does not actually run the
 .B whatnow