]> diplodocus.org Git - nmh/blobdiff - man/repl.man
Added context_find_prefix().
[nmh] / man / repl.man
index 41f587095e4cad5c299928476af1ee101b066a04..4de6a70bcb824272431763cacdeda8244ee1b6da 100644 (file)
@@ -1,8 +1,7 @@
+.TH REPL %manext1% "December 14, 2014" "%nmhversion%"
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
-.TH REPL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 repl \- reply to a message
 .SH SYNOPSIS
@@ -10,8 +9,8 @@ repl \- reply to a message
 .na
 .B repl
 .RI [ +folder ]
-.RI [ msgs ]
-.RB [ \-annotate " | " \-noannotate ] 
+.RI [ msg ]
+.RB [ \-annotate " | " \-noannotate ]
 .RB [ \-group " | " \-nogroup ]
 .RB [ \-cc
 all/to/cc/me]
@@ -37,9 +36,16 @@ all/to/cc/me]
 .RB [ \-editor
 .IR editor ]
 .RB [ \-noedit ]
+.RB [ \-convertargs
+.IR "type argstring" ]
 .RB [ \-whatnowproc
 .IR program ]
 .RB [ \-nowhatnowproc ]
+.RB [ \-atfile ]
+.RB [ \-noatfile ]
+.RB [ \-fmtproc
+.IR program ]
+.RB [ \-nofmtproc ]
 .RB [ \-build ]
 .RB [ \-file
 .IR msgfile ]
@@ -62,7 +68,7 @@ uses
 a reply template to guide its actions.  A reply template is simply a
 .B mhl
 format file (see
-.BR mh\-format (5)
+.IR mh\-format (5)
 for details).
 .PP
 If the switch
@@ -90,7 +96,7 @@ Subject: Re: <Subject>
 In\-Reply\-To: <Message\-Id>
 References: <Message\-Id>
 Comments: In\-Reply\-To <From> or <apparently from> or <Sender>
-.ti +3 
+.ti +3
 message dated <date>
 --------
 .fi
@@ -105,8 +111,8 @@ addresses to this default with the
 .B \-cc
 .I type
 switch.  This switch takes an
-argument (
-.IR all / to / cc / me )
+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
 different arguments) if you wish to add multiple types of addresses.
@@ -115,11 +121,12 @@ If the switch
 .B \-group
 is given, then
 .B repl
-will use the the
+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.
+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
@@ -207,12 +214,14 @@ skeleton; and
 will display the draft.
 .PP
 See
-.BR comp (1)
+.IR comp (1)
 for a description of the
 .B \-editor
 and
 .B \-noedit
-switches.  Note that while in the editor, the message being replied
+switches.  Note that while in the editor, with
+.B \-atfile
+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
@@ -221,6 +230,30 @@ 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
+and
+.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.
+.I %docdir%/contrib/replaliases
+shows the use of
+.BR "repl \-convertargs" .
 .PP
 Although
 .B repl
@@ -248,7 +281,9 @@ which message filter file to use.
 .PP
 If the switch
 .B \-noformat
-is given (it is the default), then the message
+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
@@ -304,6 +339,28 @@ 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 \*(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
+profile entry, and is enabled by the \*(lqformat\*(rq flag.  A message
+filter using an external format program would look like this:
+.PP
+.RS 5
+.nf
+body:component=\*(lq>\*(rq,\|nowrap,\|format
+.fi
+.RE
+.PP
+See the
+.IR mhl(1)
+documentation for more information.  The format program can be changed by
+the
+.B \-fmtproc
+.I program
+and
+.B \-nofmtproc
+switches.
+.PP
 To use the MIME rules for encapsulation, specify the
 .B \-mime
 switch.
@@ -316,16 +373,7 @@ Note that
 .B nmh
 will not invoke
 .B mhbuild
-automatically, unless you
-add this line to your
-.I \&.mh\(ruprofile
-file:
-.PP
-.RS 5
-automimeproc: 1
-.RE
-.PP
-Otherwise, you must specifically give the command
+automatically; you must specifically give the command
 .PP
 .RS 5
 What now? mime
@@ -369,7 +417,7 @@ can
 be named.
 .PP
 In addition to the standard
-.BR mh\-format (5)
+.IR mh\-format (5)
 escapes,
 .B repl
 also recognizes the following additional
@@ -379,7 +427,7 @@ escape:
 .RS 5
 .nf
 .ta \w'Escape  'u +\w'Returns  'u
-.I Escape      Returns Description
+.I "Escape     Returns Description"
 fcc    string  Any folders specified with `\-fcc\ folder'
 .fi
 .RE
@@ -402,7 +450,7 @@ the
 .B nmh
 draft folder facility.  This is an advanced (and highly
 useful) feature.  Consult the
-.BR mh-draft (5)
+.IR mh-draft (5)
 man page for more
 information.
 .PP
@@ -411,7 +459,7 @@ Upon exiting from the editor,
 will invoke the
 .B whatnow
 program.  See
-.BR whatnow (1)
+.IR whatnow (1)
 for a discussion of available
 options.  The invocation of this program can be inhibited by using the
 .B \-nowhatnowproc
@@ -426,50 +474,47 @@ The
 .B \-build
 switch is intended to be used by the Emacs mh-e interface
 to
-.BR nmh ,
-and is only present if
-.B nmh
-was compiled with support
-for mh-e. It implies
+.BR nmh .
+It implies
 .BR \-nowhatnowproc .
 It causes a file
 .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. Note that this switch is not guaranteed to
-be present or to have the same effects in future versions of
-.BR nmh :
-it is documented here only for completeness.
+No mail is actually sent.
 .PP
 The
 .B \-file
 .I msgfile
-switch specifies the message to be replied to as an 
+switch specifies the message to be replied to as an
 exact filename rather than as an
 .B nmh
-folder and message number. It is 
-intended to be used by the
-.B msh
-interface to
-.BR nmh . 
+folder and message number.
 The same caveats apply to this option as to the
 .B \-build
 switch.
-
 .SH FILES
+.B repl
+looks for all format, filter and template files in multiple locations:
+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
+.RI \*(lq %nmhetcdir% \*(rq
+is checked.
+.PP
 .fc ^ ~
 .nf
-.ta \w'%etcdir%/ExtraBigFileName  'u
-^%etcdir%/replcomps~^The standard reply template
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^%nmhetcdir%/replcomps~^The standard reply template
 ^or <mh\-dir>/replcomps~^Rather than the standard template
-^%etcdir%/replgroupcomps~^The standard `reply -group' template
+^%nmhetcdir%/replgroupcomps~^The standard `reply -group' template
 ^or <mh\-dir>/replgroupcomps~^Rather than the standard template
-^%etcdir%/mhl.reply~^The standard message filter
+^%nmhetcdir%/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
 .fi
-
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
@@ -485,10 +530,15 @@ switch.
 ^mhlproc:~^Program to filter message being replied\-to
 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 .fi
-
 .SH "SEE ALSO"
-mhbuild(1), comp(1), forw(1), send(1), whatnow(1), mh\-format(5)
-
+.IR comp (1),
+.IR forw (1),
+.IR mhbuild (1),
+.IR send (1),
+.IR whatnow (1),
+.IR mh\-format (5)
+.PP
+.I %docdir%/contrib/replaliases
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
@@ -501,13 +551,12 @@ mhbuild(1), comp(1), forw(1), send(1), whatnow(1), mh\-format(5)
 .RB ` \-inplace '
 .RB ` \-nomime '
 .RB ` \-noquery '
+.RB ` \-noatfile '
 .RB ` "\-width\ 72" '
 .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
@@ -541,6 +590,3 @@ don't call it
 since
 .B repl
 won't run it.
-.PP
-If your current working directory is not writable, the link named
-\*(lq@\*(rq is not available.