[mmh] / man / forw.man1

.\"
.\" %nmhwarning%
.\"
.TH FORW %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
forw \- forward messages
.SH SYNOPSIS
.HP 5
.na
.B forw
.RI [ +folder ]
.RI [ msgs ]
.RB [ \-annotate " | " \-noannotate ]
.RB [ \-form
.IR formfile ]
.RB [ \-editor
.IR editor ]
.RB [ \-noedit ]
.RB [ \-whatnowproc
.IR program ]
.RB [ \-nowhatnowproc ]
.RB [ \-build ]
.RB [ \-version ]
.RB [ \-help ]
.PP
.HP 5
.B forw
.RI [ +folder ]
.RI [ msgs ]
.RB [ \-digest
.IR list ]
.RB [ \-issue
.IR number ]
.RB [ \-volume
.IR number ]
[other\ switches\ for
.BR forw ]
.RB [ \-version ]
.RB [ \-help ]
.ad
.SH DESCRIPTION
.B Forw
may be used to prepare a message containing other messages.
.PP
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
.BR comp ,
and after editing is complete, the user is prompted
before the message is sent.
.PP
The default message form contains the following elements:
.PP
.RS 5
.nf
%forwcomps%
.fi
.RE
.PP
If a file named
.RI \*(lq forwcomps \*(rq
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
.B \-form
.IR formfile .
.PP
If the
.B \-annotate
switch is given, each message being forwarded will
be annotated with the line:
.PP
.RS 5
.nf
Forwarded:\ date
.fi
.RE
.PP
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.  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
and
.B \-noedit
switches.
.PP
.B Forw
generates an attachment header field for the messages to be forwarded.
.B Send
will care to encapsulate them using MIME rules.
.PP
To send non-MIME forwarded messages, compose a new message (e.g. with
.B comp )
and read in the output of:
.PP
.RS 5
mhl \-forwall \-form mhl.forward `mhpath
.I MSGS... `
.RE
.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
.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.)
.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 .
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 \-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
.I Type Escape  Returns Description
component       digest  string  Argument to `\-digest'
function        cur     integer Argument to `\-volume'
function        msg     integer Argument to `\-issue'
.fi
.RE
.PP
Consult the
.I "Advanced Features"
section of the
.B nmh
User's Manual for more information on making digests.

.SH FILES
.fc ^ ~
.nf
.ta \w'%etcdir%/ExtraBigFileName  'u
^%etcdir%/forwcomps~^The standard message 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
^$HOME/.mmh/profile~^The user profile
^+drafts~^The draft folder
.fi

.SH "PROFILE COMPONENTS"
.fc ^ ~
.nf
.ta 2.4i
.ta \w'ExtraBigProfileName  'u
^Path:~^To determine the user's mail storage
^Current\-Folder:~^To find the default current folder
^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
^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
.fi

.SH "SEE ALSO"
mhbuild(1), comp(1), repl(1), send(1), whatnow(1), mh\-format(5),
.I "Proposed Standard for Message Encapsulation"
(RFC\-934)

.SH DEFAULTS
.nf
.RB ` +folder "' defaults to the current folder"
.RB ` msgs "' defaults to cur"
.RB ` \-noannotate '
.fi

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

.SH BUGS
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's 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.