Added release notes for releases 1.4 and 1.3 to tail of NEWS.

[mmh] / man / forw.man

diff --git a/man/forw.man b/man/forw.man
index e0651b5..2efa541 100644 (file)
--- a/man/forw.man
+++ b/man/forw.man
@@ -1,12 +1,12 @@
+.TH FORW %manext1% "February 28, 2012" "%nmhversion%"

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

-.\" $Id$

 .\"
 .\"

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

 .SH NAME
 forw \- forward messages
 .SH SYNOPSIS
 .HP 5
 .SH NAME
 forw \- forward messages
 .SH SYNOPSIS
 .HP 5

+.na

 .B forw
 .RI [ +folder ]
 .RI [ msgs ]
 .B forw
 .RI [ +folder ]
 .RI [ msgs ]

@@ -26,6 +26,18 @@ forw \- forward messages
 .RB [ \-editor
 .IR editor ]
 .RB [ \-noedit ]
 .RB [ \-editor
 .IR editor ]
 .RB [ \-noedit ]

+.RB [ \-width
+.IR colums ]
+.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 [ \-whatnowproc
 .IR program ]
 .RB [ \-nowhatnowproc ]

@@ -50,6 +62,7 @@ forw \- forward messages
 .BR forw ]
 .RB [ \-version ]
 .RB [ \-help ]
 .BR forw ]
 .RB [ \-version ]
 .RB [ \-help ]

+.ad

 .SH DESCRIPTION
 .B Forw
 may be used to prepare a message containing other messages.
 .SH DESCRIPTION
 .B Forw
 may be used to prepare a message containing other messages.

@@ -61,11 +74,17 @@ as in
 and after editing is complete, the user is prompted
 before the message is sent.
 .PP
 and after editing is complete, the user is prompted
 before the message is sent.
 .PP

-The default message form contains the following elements:
+The default message template will direct
+.B forw
+to construct the draft as follows:

 .PP
 .RS 5
 .nf
 .PP
 .RS 5
 .nf

-%forwcomps%
+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
 .RE
 .PP
 .fi
 .RE
 .PP

@@ -76,6 +95,56 @@ it will be used instead of this default form.  You may also specify an
 alternate forms file with the switch
 .B \-form
 .IR formfile .
 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
+.IR mh\-format (5)
+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 has either the value of the
+.B Local\-Mailbox
+profile entry 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 you give to the
+.B \-subject
+switch will be placed in the \*(lqSubject:\*(rq field in the draft.

 .PP
 If the draft already exists,
 .B forw
 .PP
 If the draft already exists,
 .B forw

@@ -94,10 +163,14 @@ If the
 .B \-annotate
 switch is given, each message being forwarded will
 be annotated with the lines:
 .B \-annotate
 switch is given, each message being forwarded will
 be annotated with the lines:

-
-     Forwarded:\ date
-     Forwarded:\ addrs
-
+.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 .
 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 .

@@ -113,7 +186,7 @@ change this by using the
 switch.
 .PP
 See
 switch.
 .PP
 See

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

 for a description of the
 .B \-editor
 and
 for a description of the
 .B \-editor
 and

@@ -233,7 +306,7 @@ switches invoke 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
 The
 man page for more information.
 .PP
 The

@@ -245,7 +318,7 @@ initial edit.  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
 for a discussion of
 available options.  The invocation of this program can be inhibited
 by using the

@@ -260,18 +333,13 @@ will prevent any edit from occurring.)
 The
 .B \-build
 switch is intended to be used by the Emacs mh-e interface to
 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 <mh\-dir>/draft
 to be created, containing the draft message that would normally be presented
 to the user for editing.
 .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. 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
 .PP
 The
 .B \-file

@@ -293,8 +361,8 @@ the
 .BR \-mime ,
 and
 .B \-digest
 .BR \-mime ,
 and
 .B \-digest

-switches is bypassed, and the usual leading and trailing
-'Forwarded Message' delimiters are not added.
+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.
 The same caveats apply to this option as to the
 .B \-build
 switch.

@@ -314,7 +382,7 @@ Specifying these switches enables and/or overloads the following escapes:
 .RS 5
 .nf
 .ta \w'Component  'u +\w'Escape  'u +\w'Returns  'u
 .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'

@@ -326,11 +394,10 @@ Consult the
 section of the
 .B nmh
 User's Manual for more information on making digests.
 section of the
 .B nmh
 User's Manual for more information on making digests.

-

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
+.ta \w'%etcdir%/ExtraBigFileName  'u

 ^%etcdir%/forwcomps~^The standard message skeleton
 ^or <mh\-dir>/forwcomps~^Rather than the standard skeleton
 ^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given
 ^%etcdir%/forwcomps~^The standard message skeleton
 ^or <mh\-dir>/forwcomps~^Rather than the standard skeleton
 ^%etcdir%/digestcomps~^The message skeleton if `\-digest' is given

@@ -339,7 +406,7 @@ User's Manual for more information on making digests.
 ^or <mh\-dir>/mhl.forward~^Rather than the standard filter
 ^$HOME/\&.mh\(ruprofile~^The user profile
 ^<mh\-dir>/draft~^The draft file
 ^or <mh\-dir>/mhl.forward~^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

@@ -353,13 +420,19 @@ User's Manual for more information on making digests.
 ^fileproc:~^Program to refile the message
 ^mhlproc:~^Program to filter messages being forwarded
 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
 ^fileproc:~^Program to refile the message
 ^mhlproc:~^Program to filter messages being forwarded
 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions

-
+.fi

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

-mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5),
-.I "Proposed Standard for Message Encapsulation"
+.IR comp (1),
+.IR mhbuild (1),
+.IR repl (1),
+.IR send (1),
+.IR whatnow (1),
+.IR mh\-format (5)
+.PP
+.I
+Proposed Standard for Message Encapsulation

 (RFC\-934)
 (RFC\-934)

-
-.SH "DEFAULTS"
+.SH DEFAULTS

 .nf
 .RB ` +folder "' defaults to the current folder"
 .RB ` msgs "' defaults to cur"
 .nf
 .RB ` +folder "' defaults to the current folder"
 .RB ` msgs "' defaults to cur"

@@ -369,11 +442,10 @@ mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5),
 .RB ` \-inplace '
 .RB ` \-dashstuffing '
 .RB ` \-nomime '
 .RB ` \-inplace '
 .RB ` \-dashstuffing '
 .RB ` \-nomime '

-
+.fi

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

-

 .SH BUGS
 If
 .I whatnowproc
 .SH BUGS
 If
 .I whatnowproc