uip/mhshowsbr.h: Move in declarations from h/mhparse.h.

[nmh] / man / forw.man

diff --git a/man/forw.man b/man/forw.man
index 6dab969f2ea6adbf9930c25dc4bdccc8002f99f3..8b792d8f58c68190436a933fc54dc3e106899669 100644 (file)
--- a/man/forw.man
+++ b/man/forw.man
@@ -1,263 +1,498 @@
-.\"
+.TH FORW %manext1% 2013-03-22 "%nmhversion%"
+.

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

-.\" $Id$
-.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH FORW %manext1% MH.6.8 [%nmhversion%]
+.

 .SH NAME
 .SH NAME

-forw \- forward messages
+forw \- forward nmh messages

 .SH SYNOPSIS
 .SH SYNOPSIS

-.in +.5i
-.ti -.5i
-forw
-\%[+folder] \%[msgs]
-.br
-\%[\-annotate] \%[\-noannotate]
-\%[\-form\ formfile]
-.br
-\%[\-format] \%[\-noformat]
-\%[\-filter\ filterfile]
-.br
-\%[\-inplace] \%[\-noinplace]
-\%[\-mime] \%[\-nomime]
-.br
-\%[\-draftfolder\ +folder] \%[\-draftmessage\ msg]
-.br
-\%[\-nodraftfolder]
-\%[\-editor\ editor] \%[\-noedit]
-.br
-\%[\-whatnowproc\ program] \%[\-nowhatnowproc]
-.br
-\%[\-dashstuffing] \%[\-nodashstuffing]
-.br
-\%[\-build]
-\%[\-file msgfile]
-.br
-\%[\-version]
-\%[\-help]
-
-.ti .5i
-forw
-\%[+folder] \%[msgs]
-\%[\-digest\ list] \%[\-issue\ number]
-.br
-\%[\-volume\ number]
-\%[other\ switches\ for\ \fIforw\fR]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B forw
+.RB [ \-help ]
+.RB [ \-version ]
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-annotate " | " \-noannotate ]
+.RB [ \-form
+.IR formfile ]
+.RB [ \-format " | " \-noformat ]
+.RB [ \-filter
+.IR filterfile ]
+.RB [ \-inplace " | " \-noinplace ]
+.RB [ \-mime " | " \-nomime ]
+.RB [ \-draftfolder
+.IR +folder ]
+.RB [ \-draftmessage
+.IR msg ]
+.RB [ \-nodraftfolder ]
+.RB [ \-editor
+.IR editor ]
+.RB [ \-noedit ]
+.RB [ \-width
+.IR columns ]
+.RB [ \-from
+.IR address ]
+.RB [ \-to
+.IR address ]
+.RB [ \-cc
+.IR address ]
+.RB [ \-fcc
+.IR +folder ]
+.RB [ \-subject
+.IR text ]
+.RB [ \-whatnowproc
+.IR program ]
+.RB [ \-nowhatnowproc ]
+.RB [ \-dashstuffing " | " \-nodashstuffing ]
+.RB [ \-build ]
+.RB [ \-file
+.IR msgfile ]
+.HP 5
+.B forw
+.RB [ \-help ]
+.RB [ \-version ]
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-digest
+.IR list ]
+.RB [ \-issue
+.IR number ]
+.RB [ \-volume
+.IR number ]
+[other\ switches\ for\
+.BR forw ]
+.ad

 .SH DESCRIPTION
 .SH DESCRIPTION

-\fIForw\fR may be used to prepare a message containing other messages.
-
-It constructs the new message from a forms (components) file, with a
-body composed of the message(s) to be forwarded.  An editor is invoked
-as in \fIcomp\fR, and after editing is complete, the user is prompted
-before the message is sent.
-
-The default message form contains the following elements:
-
+.B forw
+constructs a new message from a forms (components) file, with a body
+composed of the message(s) to be forwarded.  An editor is invoked
+and, after editing is complete, the user is prompted before the
+message is sent.
+.PP
+The default message template will direct
+.B forw
+to construct the draft as follows:
+.PP
+.RS 5

 .nf
 .nf

-.in +.5i
-.ne 10
-.eo
-.so %etcdir%/forwcomps
-.ec
-.in -.5i
+From: {from switch} or <Local-Mailbox> or <username@hostname>
+To: {to switch} or blank
+Fcc: {fcc switch} or +outbox
+Subject: {subject switch} or "{original subject} (fwd)"
+--------

 .fi
 .fi

-
-If a file named \*(lqforwcomps\*(rq exists in the user's nmh directory,
+.RE
+.PP
+If a file named
+.RI \*(lq forwcomps \*(rq
+exists in the user's nmh directory,

 it will be used instead of this default form.  You may also specify an
 it will be used instead of this default form.  You may also specify an

-alternate forms file with the switch `\-form\ formfile'.
-
-When If the draft already exists, \fIforw\fR will ask you as to the disposition
-of the draft.  A reply of \fBquit\fR will abort \fIforw\fR, leaving the
-draft intact; \fBreplace\fR will replace the existing draft with a blank
-skeleton; and \fBlist\fR will display the draft.
-
-If the `\-annotate' switch is given, each message being forwarded will
-be annotated with the lines
-
-     Forwarded:\ date
-     Forwarded:\ addrs
-
-where each address list contains as many lines as required.  This
-annotation will be done only if the message is sent directly from
-\fIforw\fR.  If the message is not sent immediately from \fIforw\fR,
-\*(lqcomp\ \-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
-change this by using the '\-noinplace' switch.
-
-See \fIcomp\fR\0(1) for a description of the `\-editor' and `\-noedit'
+alternate forms file with the switch
+.B \-form
+.IR formfile .
+Forms are processed via the
+.B nmh
+template system; see
+.IR mh\-format (5)
+for details.  Components from the first forwarded message are available
+as standard component escapes in the forms file.
+.PP
+In addition to the standard
+.I mh\-format
+escapes, the following
+.I component
+escapes are also supported:
+.PP
+.RS 5
+.nf
+.ta \w'nmh\-subject    'u +\w'Returns  'u
+.I "Escape     Returns Description"
+fcc    string  Any folders specified with `\-fcc\ folder'
+nmh\-from      string  Addresses specified with `\-from\ address'
+nmh\-to        string  Addresses specified with `\-to\ address'
+nmh\-cc        string  Addresses specified with `\-cc\ address'
+nmh\-subject   string  Any text specified with `\-subject\ text'
+.fi
+.RE
+.PP
+By default, the \*(lqTo:\*(rq and \*(lqcc:\*(rq fields are empty.  You may
+add addresses to these fields with the
+.B \-to
+.I address
+and
+.B \-cc
+.I address
+switches.  You may give these switches multiple times to add multiple
+addresses.
+.PP
+By default, the \*(lqFrom:\*(rq field contains either the value of the
+.B Local\-Mailbox
+profile entry, or a system default email address.
+This default can be overridden by using the
+.B \-from
+.I address
+switch.  The default mailbox in the \*(lqFcc:\*(rq field is
+.IR +outbox .
+This can be overridden by the
+.B \-fcc
+switch.
+.PP
+Any text given to the
+.B \-subject
+switch will be placed in the \*(lqSubject:\*(rq field in the draft.
+.PP
+If the draft already exists,
+.B forw
+will ask you as to the disposition of the draft.  A reply of
+.B quit
+will abort
+.BR forw ,
+leaving the draft intact;
+.B replace
+will replace the existing draft with a blank skeleton; and
+.B list
+will display the draft.
+.PP
+If the
+.B \-annotate
+switch is given, each message being forwarded will be annotated
+with the lines:
+.PP
+.RS 5
+.nf
+Forwarded:\ date
+Forwarded:\ addrs
+.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
+.BR forw .
+If the message is not sent immediately from
+.BR forw ,
+.RB \*(lq comp
+.BR \-use \*(rq
+may be used to re-edit and send the constructed message, but the
+annotations won't take place.  Normally, annotations are done in place
+in order to preserve any links to the message.
+You may change this by using the
+.B \-noinplace
+switch.
+.PP
+See
+.IR comp (1)
+for a description of the
+.B \-editor
+and
+.B \-noedit

 switches.
 switches.

-
-Although \fIforw\fR 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 \fImhl\fR, as \fIforw\fR will invoke \fImhl\fR to filter
-(re\-format) the forwarded messages prior to being output to the body
-of the draft.
-
-The switches `\-noformat', `\-format', and `\-filter\ filterfile' specify
-which message filter file to use.
-
-If `\-noformat' is specified (this is the default), then each forwarded
-message is output into the draft exactly as it appears with no \fImhl\fR
-filtering.
-
-If `\-format' is specified, then a default message filter file is used.
-This default message filter should be adequate for most users.
-This default filter \*(lqmhl.forward\*(rq is:
-
+.PP
+Although
+.B forw
+uses a forms (components) file to construct the initial draft,
+a message filter file is used to format each forwarded message in the
+body of the draft.
+The filter file for \fIforw\fR should be a standard form file for
+.IR mhl (1),
+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.  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.  If
+.B \-format
+is specified, then the following default message filter file,
+.RI \*(lq mhl.forward \*(rq ,
+which should be adequate for most users, is used:
+.PP
+.RS 5

 .nf
 .nf

-.in +.5i
-.ne 10
-.eo
-.so %etcdir%/mhl.forward
-.ec
-.in -.5i
+%mhl_forward%

 .fi
 .fi

-
-If a file named \*(lqmhl.forward\*(rq exists in the user's nmh
-directory, it will be used instead of this form.  You may specify an
-alternate message filter file with the switch `\-filter\ filterfile'.
-
+.RE
+.PP
+If a file named
+.RI \*(lq mhl.forward \*(rq
+exists in the user's nmh
+directory, it will be used instead.  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
 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 \fIburst\fR\0(1).  This follows the Internet
-RFC\-934 guidelines.  You may use the flag `\-nodashstuffing' in order
-to suppress this form of quoting to the forwarded messages.
-
-For users of \fIprompter\fR\0(1), by specifying prompter's `-prepend'
-switch in the \&.mh\(ruprofile file, any commentary text is entered
-before the forwarded messages.  (A major win!)
-
-To use the MIME rules for encapsulation, specify the `\-mime' switch.
-This directs \fIforw\fR to generate an \fImhbuild\fR composition file.
-Note that nmh will not invoke \fImhbuild\fR automatically, unless you
-add this line to your \&.mh\(ruprofile file:
-.sp
-.in +.5i
-automimeproc: 1
-.in -.5i
-.sp
-Otherwise,
-you must specifically give the command
-.sp
-.in +.5i
+suitable for bursting by
+.IR burst (1).
+This follows the guidelines in RFC 934.  You may use the
+.B \-nodashstuffing
+switch to suppress this form of quoting.
+.PP
+Users of
+.IR prompter (1)
+can, by specifying
+.BR prompter 's
+.B \-prepend
+switch in the
+.I \&.mh_profile
+file, prepend any commentary text before the forwarded messages.
+.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; you must specifically give the command
+.PP
+.RS 5
+.nf

 What now? mime
 What now? mime

-.in -.5i
-.sp
+.fi
+.RE
+.PP

 prior to sending the draft.
 prior to sending the draft.

-
-The `\-draftfolder\ +folder' and `\-draftmessage\ msg' switches invoke
-the \fInmh\fR draft folder facility.  This is an advanced (and highly
-useful) feature.  Consult the \fImh-draft\fR(5) man page for more
-information.
-
-Upon exiting from the editor, \fIforw\fR will invoke the \fIwhatnow\fR
-program.  See \fIwhatnow\fR\0(1) for a discussion of available
-options.  The invocation of this program can be inhibited by using the
-`\-nowhatnowproc' switch.  (In truth of fact, it is the \fIwhatnow\fR
-program which starts the initial edit.  Hence, `\-nowhatnowproc' will
-prevent any edit from occurring.)
-
-The `\-build' switch is intended to be used by the Emacs mh-e interface
-to \fInmh\fR, and is only present if \fInmh\fR was compiled with support
-for mh-e. It implies `\-nowhatnowproc'. It causes a file <mh\-dir>/draft
-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 \fInmh\fR:
-it is documented here only for completeness.
-
-The `\-file\ msgfile' switch specifies the message to be forwarded as an 
-exact filename rather than as an \fInmh\fR folder and message number. It is 
-intended to be used by the \fImsh\fR\0(1) interface to \fInmh\fR. 
-This switch implies `-noannotate'. The forwarded message is simply
-copied verbatim into the draft; the processing implied by
-the `-filter', `-mime' and `-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 `\-build' switch.
-
-The `\-digest\ list', `\-issue\ number', and `\-volume\ number' switches
-implement a digest facility for \fInmh\fR.  Specifying these switches
-enables and/or overloads the following escapes:
-
-.sp 1
+.PP
+The
+.B \-draftfolder
+.I +folder
+and
+.B \-draftmessage
+.I msg
+switches invoke the
+.B nmh
+draft folder facility.  This is an advanced (and highly useful) feature.
+Consult the
+.IR mh-draft (5)
+man page for more information.
+.PP
+The
+.B \-editor
+.I editor
+switch indicates the editor to use for the initial edit.
+Upon exiting from the editor,
+.B comp
+will invoke the
+.B whatnow
+program.  See
+.IR whatnow (1)
+for a discussion of
+available options.
+The invocation of this program can be inhibited by using the
+.B \-nowhatnowproc
+switch.  (In fact, it is the
+.I whatnow
+program which starts the initial edit.  Hence,
+.B \-nowhatnowproc
+will prevent any edit from occurring.)
+.PP
+The
+.B \-build
+switch is intended to be used by the Emacs mh-e interface to
+.BR nmh .
+It implies
+.BR \-nowhatnowproc .
+It causes a file <mh-dir>/draft
+to be created, containing the draft message that would normally be
+presented to the user for editing.  No mail is actually sent.
+.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.  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.
+.PP
+The
+.B \-digest
+.IR list ,
+.B \-issue
+.IR number ,
+and
+.B \-volume
+.I number
+switches implement a digest facility for
+.BR nmh .
+Specifying these switches enables and/or overloads the following escapes:
+.PP
+.RS 5

 .nf
 .ta \w'Component  'u +\w'Escape  'u +\w'Returns  'u
 .nf
 .ta \w'Component  'u +\w'Escape  'u +\w'Returns  'u

-\fIType\fR     \fIEscape\fR    \fIReturns\fR   \fIDescription\fR
-\fIcomponent\fR        \fIdigest\fR    string  Argument to `\-digest'
-\fIfunction\fR \fIcur\fR       integer Argument to `\-volume'
-\fIfunction\fR \fImsg\fR       integer Argument to `\-issue'
-.re
+.I "Type       Escape  Returns Description"
+component      digest  string  Argument to `\-digest'
+function       cur     integer Argument to `\-volume'
+function       msg     integer Argument to `\-issue'

 .fi
 .fi

-
-Consult the \fBAdvanced Features\fR section of 
-the \fInmh\fR User's Manual for more information on making digests.
-.Fi
-^%etcdir%/forwcomps~^The standard message skeleton
-^or <mh\-dir>/forwcomps~^Rather than the standard skeleton
-^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given
-^or <mh\-dir>/digestcomps~^Rather than the standard skeleton
-^%etcdir%/mhl.forward~^The standard message filter
-^or <mh\-dir>/mhl.forward~^Rather than the standard filter
-^$HOME/\&.mh\(ruprofile~^The user profile
-^<mh\-dir>/draft~^The draft file
-.Pr
-^Path:~^To determine the user's nmh directory
-.Ps
-^Current\-Folder:~^To find the default current folder
-.Ps
-^Draft\-Folder:~^To find the default draft\-folder
-.Ps
-^Editor:~^To override the default editor
-.Ps
-^Msg\-Protect:~^To set mode when creating a new message (draft)
-.Ps
-^fileproc:~^Program to refile the message
-.Ps
-^mhlproc:~^Program to filter messages being forwarded
-.Ps
-^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
-.Sa
-\fIProposed Standard for Message Encapsulation\fR (RFC\-934),
-.br
-mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5)
-.De
-`+folder' defaults to the current folder
-`msgs' defaults to cur
-.Ds
-`\-noannotate'
-.Ds
-`\-nodraftfolder'
-.Ds
-`\-noformat'
-.Ds
-`\-inplace'
-.Ds
-`\-dashstuffing'
-.Ds
-`\-nomime'
-.Co
+.RE
+.SH FILES
+.B forw
+looks for format and filter 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
+.PD 0
+.TP 25
+%nmhetcdir%/forwcomps
+The default message skeleton.
+.TP
+<mh-dir>/forwcomps
+The user's message skeleton.
+.TP
+%nmhetcdir%/digestcomps
+The default message skeleton if
+.B \-digest
+is given.
+.TP
+<mh-dir>/digestcomps
+The user's
+.B \-digest
+skeleton.
+.TP
+^%nmhetcdir%/mhl.forward
+The default message filter.
+.TP
+<mh-dir>/mhl.forward
+The user's message filter.
+.TP
+^$HOME/.mh_profile
+The user's profile.
+.PD
+.SH "PROFILE COMPONENTS"
+.PD 0
+.TP 25
+Path:
+To determine the user's nmh directory.
+.TP
+Current\-Folder:
+To find the default current folder.
+.TP
+Draft\-Folder:
+To find the default draft-folder.
+.TP
+Editor:
+To override the default editor.
+.TP
+Msg\-Protect:
+To set mode when creating a new message (draft).
+.TP
+fileproc:
+Program to refile the message.
+.TP
+mhlproc:
+Program to filter messages being forwarded.
+.TP
+whatnowproc:
+Program to ask the \*(lqWhat now?\*(rq questions.
+.PD
+.SH "SEE ALSO"
+.IR burst (1),
+.IR comp (1),
+.IR mh\-format (5)
+.IR mhbuild (1),
+.IR mhl (1),
+.IR prompter (1),
+.IR repl (1),
+.IR send (1),
+.IR whatnow (1),
+.PP
+.I
+Proposed Standard for Message Encapsulation
+(RFC 934)
+.SH DEFAULTS
+.PD 0
+.TP 25
++folder
+The current folder.
+.TP
+msgs
+The current message.
+.TP
+\-noannotate
+.TP
+\-nodraftfolder
+.TP
+\-noformat
+.TP
+\-inplace
+.TP
+\-dashstuffing
+.TP
+\-nomime
+.PD
+.SH CONTEXT

 If a folder is given, it will become the current folder.
 The first message forwarded will become the current message.
 If a folder is given, it will become the current folder.
 The first message forwarded will become the current message.

-.Bu
-
-If \fIwhatnowproc\fR is \fIwhatnow\fR, then \fIforw\fR uses a built\-in
-\fIwhatnow\fR, it does not actually run the \fIwhatnow\fR program.
-Hence, if you define your own \fIwhatnowproc\fR, don't call it
-\fIwhatnow\fR since \fIforw\fR won't run it.
-
-When \fIforw\fR is told to annotate the messages it forwards, it
-doesn't actually annotate them until the draft is successfully sent.
-If from the \fIwhatnowproc\fR, you \fIpush\fR instead of \fIsend\fR,
-it's possible to confuse \fIforw\fR by re\-ordering the file (e.g.,
-by using `folder\0\-pack') before the message is successfully sent.
-\fIDist\fR and \fIrepl\fR don't have this problem.
-.En
+.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 doesn't actually
+annotate them until the draft is successfully sent.
+If, from the
+.IR whatnowproc ,
+you
+.B push
+instead of
+.BR send ,
+it is possible to confuse
+.B forw
+by re-ordering the file (e.g.\& by using
+.RB \*(lq folder
+.BR \-pack \*(rq)
+before the message is successfully sent.
+.B dist
+and
+.B repl
+don't have this problem.