Add the SASL callback; things work now!

[nmh] / man / repl.man

diff --git a/man/repl.man b/man/repl.man
index f67cee7f00e70c2d14129872328067d1b9f72783..4de6a70bcb824272431763cacdeda8244ee1b6da 100644 (file)
--- a/man/repl.man
+++ b/man/repl.man
@@ -1,7 +1,7 @@
+.TH REPL %manext1% "December 14, 2014" "%nmhversion%"

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

-.TH REPL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 repl \- reply to a message
 .SH SYNOPSIS
 .SH NAME
 repl \- reply to a message
 .SH SYNOPSIS


@@ -9,8 +9,8 @@ repl \- reply to a message
 .na
 .B repl
 .RI [ +folder ]
 .na
 .B repl
 .RI [ +folder ]

-.RI [ msgs ]
-.RB [ \-annotate " | " \-noannotate ] 
+.RI [ msg ]
+.RB [ \-annotate " | " \-noannotate ]

 .RB [ \-group " | " \-nogroup ]
 .RB [ \-cc
 all/to/cc/me]
 .RB [ \-group " | " \-nogroup ]
 .RB [ \-cc
 all/to/cc/me]


@@ -36,9 +36,16 @@ 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 ]

+.RB [ \-atfile ]
+.RB [ \-noatfile ]
+.RB [ \-fmtproc
+.IR program ]
+.RB [ \-nofmtproc ]

 .RB [ \-build ]
 .RB [ \-file
 .IR msgfile ]
 .RB [ \-build ]
 .RB [ \-file
 .IR msgfile ]


@@ -61,7 +68,7 @@ uses
 a reply template to guide its actions.  A reply template is simply a
 .B mhl
 format file (see
 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
 for details).
 .PP
 If the switch


@@ -89,7 +96,7 @@ Subject: Re: <Subject>
 In\-Reply\-To: <Message\-Id>
 References: <Message\-Id>
 Comments: In\-Reply\-To <From> or <apparently from> or <Sender>
 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
 message dated <date>
 --------
 .fi


@@ -104,8 +111,8 @@ addresses to this default with the
 .B \-cc
 .I type
 switch.  This switch takes an
 .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.
 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.


@@ -114,11 +121,12 @@ If the switch
 .B \-group
 is given, then
 .B repl
 .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
 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
 .PP
 The default group reply template \*(lqreplgroupcomps\*(rq will direct
 .B repl


@@ -206,12 +214,14 @@ skeleton; and
 will display the draft.
 .PP
 See
 will display the draft.
 .PP
 See

-.BR comp (1)
+.IR comp (1)

 for a description of the
 .B \-editor
 and
 .B \-noedit
 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
 to is available through a link named \*(lq@\*(rq (assuming the default
 .IR whatnowproc ).
 In addition, the actual pathname of the message is


@@ -220,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 .
 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
 .PP
 Although
 .B repl


@@ -247,7 +281,9 @@ 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
+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
 to which you are replying is not included in the body of the draft.
 .PP
 If the switch


@@ -306,7 +342,7 @@ the \*(lq>\*(rq character.
 You can also use an external format program to format the message body.
 The format program is specified by the
 .IR formatproc
 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
+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
 filter using an external format program would look like this:
 .PP
 .RS 5


@@ -316,8 +352,14 @@ body:component=\*(lq>\*(rq,\|nowrap,\|format
 .RE
 .PP
 See the
 .RE
 .PP
 See the

-.BR mhl(1)
-documentation for more information.
+.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
 .PP
 To use the MIME rules for encapsulation, specify the
 .B \-mime


@@ -331,16 +373,7 @@ Note that
 .B nmh
 will not invoke
 .B mhbuild
 .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
 .PP
 .RS 5
 What now? mime


@@ -384,7 +417,7 @@ can
 be named.
 .PP
 In addition to the standard
 be named.
 .PP
 In addition to the standard

-.BR mh\-format (5)
+.IR mh\-format (5)

 escapes,
 .B repl
 also recognizes the following additional
 escapes,
 .B repl
 also recognizes the following additional


@@ -394,7 +427,7 @@ escape:
 .RS 5
 .nf
 .ta \w'Escape  'u +\w'Returns  'u
 .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
 fcc    string  Any folders specified with `\-fcc\ folder'
 .fi
 .RE


@@ -417,7 +450,7 @@ the
 .B nmh
 draft folder facility.  This is an advanced (and highly
 useful) feature.  Consult 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
 man page for more
 information.
 .PP


@@ -426,7 +459,7 @@ Upon exiting from the editor,
 will invoke the
 .B whatnow
 program.  See
 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
 for a discussion of available
 options.  The invocation of this program can be inhibited by using the
 .B \-nowhatnowproc


@@ -453,32 +486,35 @@ 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 
+switch specifies the message to be replied to as an

 exact filename rather than as an
 .B nmh
 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.
 The same caveats apply to this option as to the
 .B \-build
 switch.

-

 .SH FILES
 .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
 .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
 ^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
 ^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
 ^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
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf


@@ -494,10 +530,15 @@ switch.
 ^mhlproc:~^Program to filter message being replied\-to
 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 .fi
 ^mhlproc:~^Program to filter message being replied\-to
 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 .fi

-

 .SH "SEE ALSO"
 .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"
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"


@@ -510,13 +551,12 @@ mhbuild(1), comp(1), forw(1), send(1), whatnow(1), mh\-format(5)
 .RB ` \-inplace '
 .RB ` \-nomime '
 .RB ` \-noquery '
 .RB ` \-inplace '
 .RB ` \-nomime '
 .RB ` \-noquery '

+.RB ` \-noatfile '

 .RB ` "\-width\ 72" '
 .fi
 .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 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
 .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


@@ -550,6 +590,3 @@ don't call it
 since
 .B repl
 won't run 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.