Factor trim format function out

[mmh] / man / forw.man1

diff --git a/man/forw.man1 b/man/forw.man1
index 46dd70b..220a7f0 100644 (file)
--- a/man/forw.man1
+++ b/man/forw.man1
@@ -13,22 +13,12 @@ forw \- forward messages
 .RB [ \-annotate " | " \-noannotate ]
 .RB [ \-form
 .IR formfile ]
 .RB [ \-annotate " | " \-noannotate ]
 .RB [ \-form
 .IR formfile ]

-.RB [ \-format " | " \-noformat ]
-.RB [ \-filter
-.IR filterfile ]
-.RB [ \-inplace " | " \-noinplace ]
-.RB [ \-mime " | " \-nomime ]

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

-.RB [ \-noedit ]

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

-.RB [ \-nowhatnowproc ]
-.RB [ \-dashstuffing " | " \-nodashstuffing ]

 .RB [ \-build ]
 .RB [ \-build ]

-.RB [ \-file
-.IR msgfile ]
-.RB [ \-version ]
+.RB [ \-Version ]

 .RB [ \-help ]
 .PP
 .HP 5
 .RB [ \-help ]
 .PP
 .HP 5

@@ -41,9 +31,9 @@ forw \- forward messages
 .IR number ]
 .RB [ \-volume
 .IR number ]
 .IR number ]
 .RB [ \-volume
 .IR number ]

-[other\ switches\ for\
+[other\ switches\ for

 .BR forw ]
 .BR forw ]

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

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

@@ -66,7 +56,7 @@ The default message form contains the following elements:
 .RE
 .PP
 If a file named
 .RE
 .PP
 If a file named

-.RI \*(lq forwcomps \*(rq
+.RI ` forwcomps '

 exists in the user's mmh directory,
 it will be used instead of this default form.  You may also specify an
 alternate forms file with the switch
 exists in the user's mmh directory,
 it will be used instead of this default form.  You may also specify an
 alternate forms file with the switch

@@ -76,144 +66,44 @@ alternate forms file with the switch
 If the
 .B \-annotate
 switch is given, each message being forwarded will
 If the
 .B \-annotate
 switch is given, each message being forwarded will

-be annotated with the lines:
+be annotated with the line:

 .PP
 .RS 5
 .nf
 Forwarded:\ date
 .PP
 .RS 5
 .nf
 Forwarded:\ date

-Forwarded:\ addrs

 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

-where each address list contains as many lines as required.  This
-annotation will be done only if the message is sent directly from
+This annotation will be done only if the message is sent directly from

 .BR forw .
 If the message is not sent immediately from
 .BR forw ,
 .BR forw .
 If the message is not sent immediately from
 .BR forw ,

-.RB \*(lq comp
-.BR \-use \*(rq
+.RB ` comp
+.BR \-use '

 may be used to re\-edit and send the constructed
 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
-change this by using the
-.B \-noinplace
-switch.
+message, but the annotations won't take place.  Annotations
+are always done inplace in order to preserve any links to the message.

 .PP
 See
 .BR comp (1)
 for a description of the
 .B \-editor
 .PP
 See
 .BR comp (1)
 for a description of the
 .B \-editor

-and
-.B \-noedit
-switches.
-.PP
-Although
-.B forw
-uses a forms (components) file to direct it how to
-construct the beginning of the draft, it uses a message filter file to
-direct it as to how each forwarded message should be formatted in the
-body of the draft.  The filter file for \fIforw\fR should be a standard
-form file for
-.BR mhl ,
-as
-.B forw
-will invoke
-.B mhl
-to filter (re\-format) the forwarded messages prior to being output to
-the body of the draft.
-.PP
-The switches
-.BR \-noformat ,
-.BR \-format ,
-and
-.B \-filter
-.I filterfile
-specify which message filter file to use.
-.PP
-If
-.B \-noformat
-is specified (this is the default), then each forwarded
-message is output into the draft exactly as it appears with no
-.B mhl
-filtering.
-.PP
-If
-.B \-format
-is specified, then a default message filter file is used.
-This default message filter should be adequate for most users.
-This default filter
-.RI \*(lq mhl.forward \*(rq
-is:
-.PP
-.RS 5
-.nf
-%mhl_forward%
-.fi
-.RE
-.PP
-If a file named
-.RI \*(lq mhl.forward \*(rq
-exists in the user's mmh
-directory, it will be used instead of this form.  You may specify an
-alternate message filter file with the switch
-.B \-filter
-.IR filterfile .
-.PP
-Each forwarded message is separated with an encapsulation delimiter.
-By default, any dashes in the first column of the forwarded messages
-will be prepended with `\-\ ' so that when received, the message is
-suitable for bursting by
-.BR burst .
-This follows the Internet RFC\-934 guidelines.  You may use the flag
-.B \-nodashstuffing
-in order
-to suppress this form of quoting to the forwarded messages.
-.PP
-For users of
-.BR prompter ,
-by specifying
-.BR prompter 's
-.B \-prepend
-switch in the
-.I .mmh/profile
-file, any commentary text is entered
-before the forwarded messages.  (A major win!)
-.PP
-To use the MIME rules for encapsulation, specify the
-.B \-mime
-switch. This directs
-.B forw
-to generate an
-.B mhbuild
-composition file. Note that
-.B nmh
-will not invoke
-.B mhbuild
-automatically, unless you
-add this line to your
-.I .mmh/profile
-file:
+switch.

 .PP
 .PP

-.RS 5
-.nf
-automimeproc: 1
-.fi
-.RE
+.B Forw
+generates an attachment header field for the messages to be forwarded.
+.B Send
+will care to encapsulate them using MIME rules.

 .PP
 .PP

-Otherwise, you must specifically give the command
+To send non-MIME forwarded messages, compose a new message (e.g. with
+.B comp )
+and read in the output of:

 .PP
 .RS 5
 .PP
 .RS 5

-.nf
-What now? mime
-.fi
+mhl \-forwall \-form mhl.forward `mhpath
+.I MSGS... `

 .RE
 .PP
 .RE
 .PP

-prior to sending the draft.
-.PP
-Consult the
-.BR mh-draft (7)
-man page for more information.
-.PP

 The
 .B \-editor
 .I editor
 The
 .B \-editor
 .I editor

@@ -225,57 +115,19 @@ will invoke the
 program.  See
 .BR whatnow (1)
 for a discussion of
 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
-.I whatnow
-program which starts the initial edit.  Hence,
-.B \-nowhatnowproc
-will prevent any edit from occurring.)
+available 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 `draft' 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 `draft' 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.
-.PP
-The
-.B \-file
-.I msgfile
-switch specifies the message to be forwarded 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 .
-This switch implies
-.BR \-noannotate .
-The forwarded message is simply
-copied verbatim into the draft; the processing implied by
-the
-.BR \-filter ,
-.BR \-mime ,
-and
-.B \-digest
-switches is bypassed, and the usual leading and
-trailing 'Forwarded Message' delimiters are not added.
-The same caveats apply to this option as to the
-.B \-build
-switch.
+No
+.B whatnow
+program is invoked.
+No mail is actually sent.

 .PP
 The
 .B \-digest
 .PP
 The
 .B \-digest

@@ -286,13 +138,13 @@ and
 .B \-volume
 .I number
 switches implement a digest facility for
 .B \-volume
 .I number
 switches implement a digest facility for

-.BR nmh .
+.BR mmh .

 Specifying these switches enables and/or overloads the following escapes:
 .PP
 .RS 5
 .nf
 .ta \w'Component  'u +\w'Escape  'u +\w'Returns  'u
 Specifying these switches enables and/or overloads the following escapes:
 .PP
 .RS 5
 .nf
 .ta \w'Component  'u +\w'Escape  'u +\w'Returns  'u

-.I Type        Escape  Returns Description
+.I "Type       Escape  Returns Description

 component      digest  string  Argument to `\-digest'
 function       cur     integer Argument to `\-volume'
 function       msg     integer Argument to `\-issue'
 component      digest  string  Argument to `\-digest'
 function       cur     integer Argument to `\-volume'
 function       msg     integer Argument to `\-issue'

@@ -313,8 +165,6 @@ User's Manual for more information on making digests.
 ^or $HOME/.mmh/forwcomps~^Rather than the standard skeleton
 ^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given
 ^or $HOME/.mmh/digestcomps~^Rather than the standard skeleton
 ^or $HOME/.mmh/forwcomps~^Rather than the standard skeleton
 ^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given
 ^or $HOME/.mmh/digestcomps~^Rather than the standard skeleton

-^%etcdir%/mhl.forward~^The standard message filter
-^or $HOME/.mmh/mhl.forward~^Rather than the standard filter

 ^$HOME/.mmh/profile~^The user profile
 ^+drafts~^The draft folder
 .fi
 ^$HOME/.mmh/profile~^The user profile
 ^+drafts~^The draft folder
 .fi

@@ -329,9 +179,7 @@ User's Manual for more information on making digests.
 ^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 messages being forwarded
-^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"

@@ -342,12 +190,8 @@ mhbuild(1), comp(1), repl(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 ` msgs "' defaults to cur"
+.RB ` msgs "' defaults to the current message"

 .RB ` \-noannotate '
 .RB ` \-noannotate '

-.RB ` \-noformat '
-.RB ` \-inplace '
-.RB ` \-dashstuffing '
-.RB ` \-nomime '

 .fi
 
 .SH CONTEXT
 .fi
 
 .SH CONTEXT

@@ -355,25 +199,6 @@ If a folder is given, it will become the current folder.
 The first message forwarded will become the current message.
 
 .SH BUGS
 The first message forwarded will become the current message.
 
 .SH BUGS

-If
-.I whatnowproc
-is
-.BR whatnow ,
-then
-.B forw
-uses a built\-in
-.BR whatnow ,
-it does not actually run the
-.B whatnow
-program.
-Hence, if you define your own
-.IR whatnowproc ,
-don't call it
-.B whatnow
-since
-.B forw
-won't run it.
-.PP

 When
 .B forw
 is told to annotate the messages it forwards, it
 When
 .B forw
 is told to annotate the messages it forwards, it

@@ -387,8 +212,8 @@ instead of
 it's possible to confuse
 .B forw
 by re\-ordering the file (e.g. by using
 it's possible to confuse
 .B forw
 by re\-ordering the file (e.g. by using

-.RB \*(lq folder
-.BR \-pack \*(rq)
+.RB ` folder
+.BR \-pack ')

 before the message is successfully sent.
 .B Dist
 and
 before the message is successfully sent.
 .B Dist
 and