Factor trim format function out

[mmh] / man / repl.man1

diff --git a/man/repl.man1 b/man/repl.man1
index 05a9736..7cc4110 100644 (file)
--- a/man/repl.man1
+++ b/man/repl.man1
@@ -19,22 +19,18 @@ all/to/cc/me]
 .RB [ \-query " | " \-noquery ]
 .RB [ \-form
 .IR formfile ]
 .RB [ \-query " | " \-noquery ]
 .RB [ \-form
 .IR formfile ]

-.RB [ \-format " | " \-noformat ]

 .RB [ \-filter
 .RB [ \-filter

-.IR filterfile ]
+.IR filterfile
+.RB " | " \-nofilter ]

 .RB [ \-mime " | " \-nomime ]
 .RB [ \-mime " | " \-nomime ]

-.RB [ \-fcc
-.IR +folder ]

 .RB [ \-editor
 .IR editor ]
 .RB [ \-editor
 .IR editor ]

-.RB [ \-noedit ]

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

-.RB [ \-nowhatnowproc ]

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

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

 .RB [ \-help ]
 .ad
 .SH DESCRIPTION
 .RB [ \-help ]
 .ad
 .SH DESCRIPTION

@@ -60,15 +56,15 @@ If the switch
 .B \-nogroup
 is given (it is on by default), then
 .B repl
 .B \-nogroup
 is given (it is on by default), then
 .B repl

-will use the standard forms file \*(lqreplcomps\*(rq.  This will construct
+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
 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
+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
 exists in the user's
 .B mmh
 directory, it will be used instead of this
 default forms file.
 .PP

-The default reply template \*(lqreplcomps\*(rq will direct
+The default reply template `replcomps' will direct

 .B repl
 to construct the reply message draft as follows:
 .PP
 .B repl
 to construct the reply message draft as follows:
 .PP

@@ -76,7 +72,7 @@ to construct the reply message draft as follows:
 .nf
 To: <Mail\-Reply\-To> or <Reply\-To> or <From>
 Cc: <To> and <Cc> and <personal address>
 .nf
 To: <Mail\-Reply\-To> or <Reply\-To> or <From>
 Cc: <To> and <Cc> and <personal address>

-Fcc: {fcc switch} or +sent
+Fcc: +sent

 Subject: Re: <Subject>
 In\-Reply\-To: <Message\-Id>
 References: <Message\-Id>
 Subject: Re: <Subject>
 In\-Reply\-To: <Message\-Id>
 References: <Message\-Id>

@@ -91,7 +87,7 @@ 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
 contents of the named field from the message to which the reply is
 being made.
 .PP

-By default, the \*(lqCc:\*(rq field is empty.  You may selectively add
+By default, the `Cc:' 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

@@ -99,7 +95,7 @@ switch.  This switch takes an
 argument (
 .IR all / to / cc / me )
 which specifies who gets added to the default
 argument (
 .IR 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
+`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
 different arguments) if you wish to add multiple types of addresses.
 .PP
 If the switch

@@ -107,12 +103,12 @@ If the switch
 is given, then
 .B repl
 will use the the
 is given, then
 .B repl
 will use the the

-standard forms file \*(lqreplgroupcomps\*(rq.  This will construct a
+standard forms file `replgroupcomps'.  This will construct a

 draft message that is intended as a group or followup reply.  If a file
 draft message that is intended as a group or followup reply.  If a file

-named \*(lqreplgroupcomps\*(rq exists in the user's mmh directory, it
+named `replgroupcomps' exists in the user's mmh directory, it

 will be used instead of this default forms file.
 .PP
 will be used instead of this default forms file.
 .PP

-The default group reply template \*(lqreplgroupcomps\*(rq will direct
+The default group reply template `replgroupcomps' will direct

 .B repl
 to construct the reply message draft as follows:
 .PP
 .B repl
 to construct the reply message draft as follows:
 .PP

@@ -141,7 +137,7 @@ In\-Reply\-To: Message from <From> of <Date>.
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-By default, the \*(lqCc:\*(rq contains all the addresses shown.  You may
+By default, the `Cc:' contains all the addresses shown.  You may

 selectively remove addresses from this default with the
 .B \-nocc
 .I type
 selectively remove addresses from this default with the
 .B \-nocc
 .I type

@@ -149,7 +145,7 @@ switch.
 This switch takes an argument (
 .IR all / to / cc / me )
 which specifies who gets removed
 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
+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
 multiple times (with different arguments) if you wish to remove multiple types
 of addresses.
 .PP

@@ -164,7 +160,7 @@ switch modifies the action of
 .I type
 switch by
 interactively asking you if each address that normally would be placed in
 .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.
+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
 This is useful for special\-purpose replies.  Note that the position of
 the
 .B \-cc

@@ -173,22 +169,18 @@ and
 switches, like all other switches which take a
 positive and negative form, is important.
 .PP
 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.
+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
 In addition, these fields will be wrapped at a reasonable length.
 .PP
 See
 .BR comp (1)
 for a description of the
 .B \-editor

-and
-.B \-noedit
-switches.  Note that while in the editor, 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
+switch.  Note that while in the editor,
+the actual pathname of the message being replied to is

 stored in the environment variable
 stored in the environment variable

-.BR $editalt ,
+.BR $mhaltmsg ,

 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 .

@@ -208,26 +200,12 @@ will invoke
 .B mhl
 to format the message to which you are replying.
 .PP
 .B mhl
 to format the message to which you are replying.
 .PP

-The switches
-.BR \-noformat ,
-.BR \-format ,
-and
-.B \-filter
-.I filterfile
-specify
-which message filter file to use.
-.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.
-.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.
+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
 This default filter

-.RI \*(lq mhl.reply \*(rq
+.RI ` mhl.reply '

 is:
 .PP
 .RS 5
 is:
 .PP
 .RS 5

@@ -237,15 +215,15 @@ is:
 .RE
 .PP
 which outputs each line of the body of the message prefaced with the
 .RE
 .PP
 which outputs each line of the body of the message prefaced with the

-\*(lq>\*(rq character and a space.
-.PP
+`>' character and a space.

 If a file named
 If a file named

-.RI \*(lq mhl.reply \*(rq
+.RI ` mhl.reply '

 exists in the user's
 .B mmh
 directory,
 exists in the user's
 .B mmh
 directory,

-it will be used instead of this form.  You may specify an alternate
-message filter file with the switch
+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
 .B \-filter
 .IR filterfile .
 .PP

@@ -265,24 +243,35 @@ is:
 .RS 5
 .nf
 message-id:nocomponent,\|nonewline,\\
 .RS 5
 .nf
 message-id:nocomponent,\|nonewline,\\

-formatfield=\*(lqIn message %{text},\ \*(rq
-from:nocomponent,\|formatfield=\*(lq%(decode(friendly{text})) writes:\*(rq
-body:component=\*(lq>\*(rq,\|overflowtext=\*(lq>\*(rq,\|overflowoffset=0
+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
 .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 \*(lq>\*(rq character.
+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
 .PP

-To use the MIME rules for encapsulation, specify the
+To MIME-attach the original message, specify the

 .B \-mime
 switch.
 .B \-mime
 switch.

-This directs
-.B repl
-to add an attachment header field, for which
-.B send
-will care.
+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
 .PP
 If the
 .B \-annotate

@@ -299,38 +288,14 @@ 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 ,
 .BR repl .
 If the message is not sent immediately from
 .BR repl ,

-.RB \*(lq "comp\ \-use" \*(rq
+.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
 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

-Although the default template specifies that a copy of the reply will be
+The default template specifies that a copy of the reply will be

 put in
 put in

-the folder 'sent',
-if the
-.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.
-.PP
-In addition to the standard
-.BR mh\-format (5)
-escapes,
-.B repl
-also recognizes the following additional
-.I component
-escape:
-.PP
-.RS 5
-.nf
-.ta \w'Escape  'u +\w'Returns  'u
-.I Escape      Returns Description
-fcc    string  Any folders specified with `\-fcc\ folder'
-.fi
-.RE
+the folder 'sent'.

 .PP
 To avoid reiteration,
 .B repl
 .PP
 To avoid reiteration,
 .B repl

@@ -351,40 +316,28 @@ will invoke the
 program.  See
 .BR whatnow (1)
 for a discussion of available
 program.  See
 .BR whatnow (1)
 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
-.B whatnow
-program which starts the initial edit.  Hence,
-.B \-nowhatnowproc
-will
-prevent any edit from occurring.)
+options.

 .PP
 The
 .B \-build
 switch is intended to be used by the Emacs mh-e interface
 to
 .PP
 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 \-nowhatnowproc .
+.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.
 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 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
+.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
 .PP
 The
 .B \-file
 .I msgfile
 switch specifies the message to be replied to as an
 exact filename rather than as an

-.B nmh
+.B mh

 folder and message number. It is
 intended to be used by the
 .B msh
 folder and message number. It is
 intended to be used by the
 .B msh

@@ -400,7 +353,7 @@ switch.
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^%etcdir%/replcomps~^The standard reply template
 ^or $HOME/.mmh/replcomps~^Rather than the standard template
 .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
+^%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
 ^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

@@ -419,9 +372,7 @@ switch.
 ^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)
 ^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)

-^fileproc:~^Program to refile the message
-^mhlproc:~^Program to filter message being replied\-to
-^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
+^whatnowproc:~^Program to ask the `What now?' questions

 .fi
 
 .SH "SEE ALSO"
 .fi
 
 .SH "SEE ALSO"

@@ -430,11 +381,10 @@ mhbuild(1), comp(1), forw(1), send(1), whatnow(1), mh\-format(5)
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"

-.RB ` msg "' defaults to cur"
+.RB ` msg "' defaults to the current message"

 .RB ` \-nogroup '
 .RB ` "\-nocc\ all" "' with `\-nogroup', `\-cc\ all' with `\-group'"
 .RB ` \-noannotate '
 .RB ` \-nogroup '
 .RB ` "\-nocc\ all" "' with `\-nogroup', `\-cc\ all' with `\-group'"
 .RB ` \-noannotate '

-.RB ` \-noformat '

 .RB ` \-nomime '
 .RB ` \-noquery '
 .fi
 .RB ` \-nomime '
 .RB ` \-noquery '
 .fi

@@ -452,5 +402,4 @@ 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
 Moral of the story: if you're going to include addresses in a reply
 template, include the host portion of the address.
 .PP

-If your current working directory is not writable, the link named
-\*(lq@\*(rq is not available.
+The quotation of the original message does not get transfer-decoded, yet.