From: Ken Hornstein <kenh@pobox.com>
Date: Mon, 27 Feb 2012 19:13:02 +0000 (-0500)
Subject: Document changes to forw(1).
X-Git-Url: http://git.marmaro.de/?a=commitdiff_plain;h=3cc586b1fdcef6cecc89386e885175577535e10f;p=mmh

Document changes to forw(1).
---

diff --git a/man/forw.man b/man/forw.man
index 5b7dc6d..d4edc2f 100644
--- a/man/forw.man
+++ b/man/forw.man
@@ -26,6 +26,18 @@ forw \- forward messages
 .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 ]
@@ -62,11 +74,17 @@ as in
 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
-%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
@@ -77,6 +95,30 @@ it will be used instead of this default form.  You may also specify an
 alternate forms file with the switch
 .B \-form
 .IR formfile .
+Forms are processed via the
+.B nmh
+template system; see
+.BR 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
+.BR 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
 If the draft already exists,
 .B forw