Display the command when reporting timing.

[nmh] / man / dist.man

diff --git a/man/dist.man b/man/dist.man
index f0c16aa880665adb88c48d212dcbd13cc6b3b63d..8f4673d9d619fd6dc16f6e1ffb2fa326264a6752 100644 (file)
--- a/man/dist.man
+++ b/man/dist.man
@@ -1,150 +1,317 @@
-.\"
+.TH DIST %manext1% 2012-12-04 "%nmhversion%"
+.

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

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

 .SH NAME
 .SH NAME

-dist \- redistribute a message to additional addresses
+dist \- distribute an nmh message to additional addresses

 .SH SYNOPSIS
 .SH SYNOPSIS

-.in +.5i
-.ti -.5i
-dist
-\%[+folder] \%[msg] 
-\%[\-annotate] \%[\-noannotate] 
-.br
-\%[\-inplace] \%[\-noinplace] 
-\%[\-form\ formfile] 
-.br
-\%[\-draftfolder\ +folder] \%[\-draftmessage\ msg]
-.br
-\%[\-nodraftfolder]
-\%[\-editor\ editor] \%[\-noedit]
-.br
-\%[\-whatnowproc\ program] \%[\-nowhatnowproc]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B dist
+.RB [ \-help ]
+.RB [ \-version ]
+.RI [ +folder ]
+.RI [ msg ]
+.RB [ \-form
+.IR formfile ]
+.RB [ \-annotate " | " \-noannotate ]
+.RB [ \-inplace " | " \-noinplace ]
+.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 [ \-whatnowproc
+.IR program ]
+.RB [ \-nowhatnowproc ]
+.RB [ \-atfile ]
+.RB [ \-noatfile ]
+.ad

 .SH DESCRIPTION
 .SH DESCRIPTION

-\fIDist\fR is similar to \fIforw\fR.  It prepares the specified message
+.B dist
+is similar to
+.BR forw .
+It prepares the specified message

 for redistribution to addresses that (presumably) are not on the original
 address list.
 for redistribution to addresses that (presumably) are not on the original
 address list.

-
+.PP

 The default message form contains the following elements:
 The default message form contains the following elements:

-
+.PP
+.RS 5

 .nf
 .nf

-.in +.5i
-.ne 10
-.eo
-.so %etcdir%/distcomps
-.ec
-.in -.5i
+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
 .fi

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

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

-forms file with the switch `\-form\ formfile'.  The form used will be
-prepended to the message being resent.
-
-If the draft already exists, \fIdist\fR will ask you as to the disposition
-of the draft.  A reply of \fBquit\fR will abort \fIdist\fR, leaving the
-draft intact; \fBreplace\fR will replace the existing draft with a blank
-skeleton; and \fBlist\fR will display the draft.
-
-Only those addresses in \*(lqResent\-To:\*(rq, \*(lqResent\-cc:\*(rq,
-and \*(lqResent\-Bcc:\*(rq will be sent.  Also, a
-\*(lqResent\-Fcc:\ folder\*(rq will be honored (see \fIsend\fR\0(1)).
-Note that with \fIdist\fR, the draft should contain only
-\*(lqResent\-xxx:\*(rq fields and no body.  The headers and the body of
+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 redistributed 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'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
+.IR forw (1)
+for descriptions of the
+.BR \-from ,
+.BR \-to ,
+.BR \-cc ,
+and
+.B \-fcc
+switches.
+.PP
+If the draft already exists,
+.B dist
+will ask you as to the disposition of the draft.  A reply of
+.B quit
+will abort
+.BR dist ,
+leaving the draft intact;
+.B replace
+will replace the existing draft with a blank skeleton; and
+.B list
+will display the draft.
+.PP
+Only those addresses in
+.RI \*(lq Resent\-To: \*(rq,
+.RI \*(lq Resent\-cc: \*(rq,
+and
+.RI \*(lq Resent\-Bcc: \*(rq
+will be sent.  Also, a
+.RI \*(lq "Resent\-Fcc: folder" \*(rq
+will be honored (see
+.IR send (1)).
+Note that with
+.BR dist ,
+the draft should contain only
+.RI \*(lq Resent\-xxx: \*(rq
+fields and no body.  The headers and the body of

 the original message are copied to the draft when the message is sent.
 Use care in constructing the headers for the redistribution.
 the original message are copied to the draft when the message is sent.
 Use care in constructing the headers for the redistribution.

-
-If the `\-annotate' switch is given, the  message being distributed will
+.PP
+Because the draft is minimal, the
+.IR prompter (1)
+editor is quite useful with
+.BR dist .
+.PP
+If the
+.B \-annotate
+switch is given, the  message being distributed will

 be annotated with the lines:
 be annotated with the lines:

-
-     Resent:\ date
-     Resent:\ addrs
-
+.RS
+Resent:\ date
+.br
+Resent:\ addrs
+.RE

 where each address list contains as many lines as required.  This
 annotation will be done only if the message is sent directly from
 where each address list contains as many lines as required.  This
 annotation will be done only if the message is sent directly from

-\fIdist\fR.  If the message is not sent immediately from \fIdist\fR,
-\*(lqcomp \-use\*(rq may be used to re\-edit and send the constructed
+.BR dist .
+If the message is not sent immediately from
+.BR dist ,
+.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
 message, but the annotations won't take place.  Normally annotations are

-done inplace in order to preserve any links to the message.  You may use
-the '\-noinplace' switch to change this.
-
-See \fIcomp\fR\0(1) for a description of the `\-editor' and `\-noedit'
-switches.  Note that while in the editor, the message being resent
+done in place in order to preserve any links to the message.  You may use
+the
+.B \-noinplace
+switch to change this.
+.PP
+See
+.IR comp (1)
+for a description of the
+.B \-editor
+and
+.B \-noedit
+switches.  Note that while in the editor, with
+.B \-atfile
+and if the current directory is writable, the message being resent

 is available through a link named \*(lq@\*(rq (assuming the default
 is available through a link named \*(lq@\*(rq (assuming the default

-\fIwhatnowproc\fR\0).  In addition, the actual pathname of the message is
-stored in the environment variable \fB$editalt\fR, and the pathname of
+.IR whatnowproc ).
+In addition, the actual pathname of the message is
+stored in the environment variable
+.BR $editalt ,
+and the pathname of

 the folder containing the message is stored in the environment variable
 the folder containing the message is stored in the environment variable

-\fB$mhfolder\fR.
-
-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, \fIdist\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.)
-.Fi
-^%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
-.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
-^fileproc:~^Program to refile the message
-.Ps
-^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
-.Sa
-comp(1), forw(1), repl(1), send(1), whatnow(1)
-.De
-`+folder' defaults to the current folder
-.Ds
-`msg' defaults to cur
-.Ds
-`\-noannotate'
-.Ds
-`\-nodraftfolder'
-.Ds
-`\-inplace'
-.Co
-
+.BR $mhfolder .
+The creation of the \*(lq@\*(rq file is controlled via the
+.B \-atfile
+and
+.B \-noatfile
+options.
+.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
+.IR mh-draft (5)
+for more information.
+.PP
+Upon exiting from the editor,
+.B dist
+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
+.B whatnow
+program which starts the initial edit.  Hence,
+.B \-nowhatnowproc
+will prevent any edit from occurring.)
+.SH FILES
+.PD 0
+.TP 20
+%nmhetcdir%/distcomps
+The default message skeleton.
+.TP 20
+<mh-dir>/distcomps
+The user's message skeleton.
+.TP 20
+$HOME/.mh_profile
+The user's profile.
+.TP 20
+<mh-dir>/draft
+The draft file.
+.PD
+.SH "PROFILE COMPONENTS"
+.PD 0
+.TP 20
+Path:
+To determine the user's nmh directory.
+.TP 20
+Current\-Folder:
+To find the default current folder.
+.TP 20
+Draft\-Folder:
+To find the default draft-folder.
+.TP 20
+Editor:
+To override the default editor.
+.TP 20
+fileproc:
+Program to refile the message.
+.TP 20
+whatnowproc:
+Program to ask the \*(lqWhat now?\*(rq questions.
+.PD
+.SH "SEE ALSO"
+.IR comp (1),
+.IR forw (1),
+.IR prompter (1),
+.IR repl (1),
+.IR send (1),
+.IR whatnow (1)
+.SH DEFAULTS
+.PD 0
+.TP 20
++folder
+The current folder.
+.TP 20
+msg
+The current message.
+.TP 20
+\-noannotate
+.TP 20
+\-nodraftfolder
+.TP 20
+\-inplace
+.TP 20
+\-noatfile
+.PD
+.SH CONTEXT

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

-.Hi
-\fIDist\fR originally used headers of the form \*(lqDistribute\-xxx:\*(rq
-instead of \*(lqResent\-xxx:\*(rq.  In order to conform with the ARPA
-Internet standard, RFC\-822, the \*(lqResent\-xxx:\*(rq form is now used.
-\fIDist\fR will recognize \*(lqDistribute\-xxx:\*(rq type headers and
-automatically convert them to \*(lqResent\-xxx:\*(rq.
-.Bu
-\fIDist\fR does not \fIrigorously\fR check the message being distributed
-for adherence to the transport standard, but \fIpost\fR called by
-\fIsend\fR does.  The \fIpost\fR program will balk (and rightly so) at
-poorly formatted messages, and \fIdist\fR won't correct things for you.
-
-If \fIwhatnowproc\fR is \fIwhatnow\fR, then \fIdist\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 \fIdist\fR won't run it.
-
-If your current working directory is not writable, the link named
-\*(lq@\*(rq is not available.
-.En
+.SH HISTORY
+.B dist
+originally used headers of the form
+.RI \*(lq Distribute\-xxx: \*(rq
+instead of
+.RI \*(lq Resent\-xxx: \*(rq.
+In order to conform with the ARPA Internet standard, RFC 822, the
+.RI \*(lq Resent\-xxx: \*(rq
+form is now used.
+.B dist
+will recognize
+.RI \*(lq Distribute\-xxx: \*(rq
+type headers and automatically convert them to
+.RI \*(lq Resent\-xxx: \*(rq.
+.SH BUGS
+.B dist
+does not rigorously check the message being distributed
+for adherence to the transport standard, but
+.B post
+called by
+.B send
+does.  The
+.B post
+program will balk (and rightly so) at poorly formatted messages, and
+.B dist
+won't correct things for you.
+.PP
+If
+.I whatnowproc
+is
+.BR whatnow ,
+then
+.B comp
+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 comp
+won't run it.