Added etcdir and libdir. And added mention that component name

[mmh] / man / dist.man

diff --git a/man/dist.man b/man/dist.man
index 1e43712..b332604 100644 (file)
--- a/man/dist.man
+++ b/man/dist.man
@@ -1,15 +1,15 @@
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
 .TH DIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 dist \- redistribute a message to additional addresses
 .SH SYNOPSIS
 .HP 5
+.na
 .B dist
 .RI [ +folder ]
-.RI [ msgs ]
+.RI [ msg ]
 .RB [ \-form
 .IR formfile ]
 .RB [ \-annotate " | " \-noannotate ] 
@@ -22,11 +22,24 @@ dist \- redistribute a message to additional addresses
 .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 [ \-whatnowproc
 .IR program ]
 .RB [ \-nowhatnowproc ]
+.RB [ \-atfile ]
+.RB [ \-noatfile ]
 .RB [ \-version ]
 .RB [ \-help ]
+.ad
 .SH DESCRIPTION
 .B Dist
 is similar to
@@ -39,7 +52,10 @@ The default message form contains the following elements:
 .PP
 .RS 5
 .nf
-%distcomps%
+Resent-From: {from switch} or <Local-Mailbox> or <username@hostname>
+Resent-To: {to switch} or blank
+Resent-cc: {cc switch} or blank
+Resent-fcc: {fcc switch} or blank
 .fi
 .RE
 .PP
@@ -50,7 +66,39 @@ will be used instead of this default form.  You may specify an alternate
 forms file with the switch
 .B \-form
 .IR formfile .
-The form used will be prepended to the message being resent.
+Forms are processed via the
+.B nmh
+template system; see
+.BR mh\-format (5)
+for details.  Components from the redistributed 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'Escape  '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'
+.fi
+.RE
+.PP
+See the
+.BR forw (1)
+man page for descriptions of the
+.BR \-from ,
+.BR \-to ,
+.BR \-cc ,
+and
+.B \-fcc
+switches.
 .PP
 If the draft already exists,
 .B dist
@@ -86,8 +134,8 @@ If the
 switch is given, the  message being distributed will
 be annotated with the lines:
 
-     Resent: date
-     Resent: addrs
+     Resent:\ date
+     Resent:\ addrs
 
 where each address list contains as many lines as required.  This
 annotation will be done only if the message is sent directly from
@@ -118,6 +166,12 @@ stored in the environment variable
 and the pathname of
 the folder containing the message is stored in the environment variable
 .BR $mhfolder .
+The creation of the \*(lq@\*(rq file and associated environment variables
+can be controlled via the
+.B \-atfile
+and
+.B \-noatfile
+options.
 .PP
 The
 .B \-draftfolder
@@ -150,11 +204,12 @@ will prevent any edit from occurring.)
 .SH FILES
 .fc ^ ~
 .nf
-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
+.ta \w'%etcdir%/ExtraBigFileName  'u
 ^%etcdir%/distcomps~^The standard message skeleton
 ^or <mh\-dir>/distcomps~^Rather than the standard skeleton
 ^$HOME/\&.mh\(ruprofile~^The user profile
 ^<mh\-dir>/draft~^The draft file
+.fi
 
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
@@ -167,16 +222,20 @@ will prevent any edit from occurring.)
 ^Editor:~^To override the default editor
 ^fileproc:~^Program to refile the message
 ^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
+.fi
 
 .SH "SEE ALSO"
 comp(1), forw(1), repl(1), send(1), whatnow(1)
 
 .SH DEFAULTS
+.nf
 .RB ` +folder "' defaults to the current folder"
 .RB ` msg "' defaults to cur"
 .RB ` \-noannotate '
 .RB ` \-nodraftfolder '
 .RB ` \-inplace '
+.RB ` \-noatfile '
+.fi
 
 .SH CONTEXT
 If a folder is given, it will become the current folder.  The message