]> diplodocus.org Git - nmh/blobdiff - man/dist.man
lock_file.c: close(2) file descriptor on failure, avoiding leak.
[nmh] / man / dist.man
index add2e8e094c7209bb72d71a5fc1f6a7e5566852b..8f4673d9d619fd6dc16f6e1ffb2fa326264a6752 100644 (file)
@@ -1,13 +1,15 @@
-.\"
+.TH DIST %manext1% 2012-12-04 "%nmhversion%"
+.
 .\" %nmhwarning%
-.\"
-.TH DIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.
 .SH NAME
-dist \- redistribute a message to additional addresses
+dist \- distribute an nmh message to additional addresses
 .SH SYNOPSIS
 .HP 5
 .na
 .B dist
+.RB [ \-help ]
+.RB [ \-version ]
 .RI [ +folder ]
 .RI [ msg ]
 .RB [ \-form
@@ -37,11 +39,9 @@ dist \- redistribute a message to additional addresses
 .RB [ \-nowhatnowproc ]
 .RB [ \-atfile ]
 .RB [ \-noatfile ]
-.RB [ \-version ]
-.RB [ \-help ]
 .ad
 .SH DESCRIPTION
-.B Dist
+.B dist
 is similar to
 .BR forw .
 It prepares the specified message
@@ -69,12 +69,12 @@ forms file with the switch
 Forms are processed via the
 .B nmh
 template system; see
-.BR mh\-format (5)
+.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
-.BR mh\-format (5)
+.IR mh\-format (5)
 escapes, the following
 .I component
 escapes are also supported:
@@ -90,9 +90,9 @@ nmh\-cc       string  Addresses specified with `\-cc\ address'
 .fi
 .RE
 .PP
-See the
-.BR forw (1)
-man page for descriptions of the
+See
+.IR forw (1)
+for descriptions of the
 .BR \-from ,
 .BR \-to ,
 .BR \-cc ,
@@ -120,7 +120,7 @@ and
 will be sent.  Also, a
 .RI \*(lq "Resent\-Fcc: folder" \*(rq
 will be honored (see
-.BR send (1)).
+.IR send (1)).
 Note that with
 .BR dist ,
 the draft should contain only
@@ -130,7 +130,7 @@ the original message are copied to the draft when the message is sent.
 Use care in constructing the headers for the redistribution.
 .PP
 Because the draft is minimal, the
-.BR prompter (1)
+.IR prompter (1)
 editor is quite useful with
 .BR dist .
 .PP
@@ -138,10 +138,11 @@ If the
 .B \-annotate
 switch is given, the  message being distributed will
 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
 .BR dist .
@@ -149,20 +150,22 @@ 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
+may be used to re-edit and send the constructed
 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
+done in place in order to preserve any links to the message.  You may use
 the
 .B \-noinplace
 switch to change this.
 .PP
 See
-.BR comp (1)
+.IR comp (1)
 for a description of the
 .B \-editor
 and
 .B \-noedit
-switches.  Note that while in the editor, the message being resent
+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
 .IR whatnowproc ).
 In addition, the actual pathname of the message is
@@ -171,8 +174,7 @@ 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
+The creation of the \*(lq@\*(rq file is controlled via the
 .B \-atfile
 and
 .B \-noatfile
@@ -187,82 +189,103 @@ and
 switches invoke the
 .B nmh
 draft folder facility.  This is an advanced (and highly
-useful) feature.  Consult the
-.BR mh-draft (5)
-man page for more information.
+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
-.BR whatnow (1)
+.IR 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
+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
-.fc ^ ~
-.nf
-.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
-
+.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"
-.fc ^ ~
-.nf
-.ta 2.4i
-.ta \w'ExtraBigProfileName  'u
-^Path:~^To determine the user's nmh directory
-^Current\-Folder:~^To find the default current folder
-^Draft\-Folder:~^To find the default draft\-folder
-^Editor:~^To override the default editor
-^fileproc:~^Program to refile the message
-^whatnowproc:~^Program to ask the \*(lqWhat now?\*(rq questions
-.fi
-
+.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"
-comp(1), forw(1), prompter(1), repl(1), send(1), whatnow(1)
-
+.IR comp (1),
+.IR forw (1),
+.IR prompter (1),
+.IR repl (1),
+.IR send (1),
+.IR 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
-
+.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.
-
 .SH HISTORY
-.B Dist
+.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
+In order to conform with the ARPA Internet standard, RFC 822, the
 .RI \*(lq Resent\-xxx: \*(rq
 form is now used.
-.B Dist
+.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
+.B dist
 does not rigorously check the message being distributed
 for adherence to the transport standard, but
 .B post
@@ -280,7 +303,7 @@ is
 .BR whatnow ,
 then
 .B comp
-uses a built\-in
+uses a built-in
 .BR whatnow ,
 it does not actually run the
 .B whatnow
@@ -292,6 +315,3 @@ don't call it
 since
 .B comp
 won't run it.
-.PP
-If your current working directory is not writable, the link named
-\*(lq@\*(rq is not available.