new.c: Order two return statements to match comment.

[nmh] / man / rcvstore.man

diff --git a/man/rcvstore.man b/man/rcvstore.man
index 8e23aae262ff62d2c37da65712a9b841943d4c9e..79cd58acfef89a1c20748cc2dee74eba90d4f4bc 100644 (file)
--- a/man/rcvstore.man
+++ b/man/rcvstore.man
@@ -1,13 +1,15 @@
-.TH RCVSTORE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
-.\"
+.TH RCVSTORE %manext1% 2013-02-19 "%nmhversion%"
+.

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

-.\"
+.

 .SH NAME
 .SH NAME

-rcvstore \- asynchronously incorporate mail into a folder
+rcvstore \- asynchronously incorporate mail into an nmh folder

 .SH SYNOPSIS
 .HP 5
 .na
 .SH SYNOPSIS
 .HP 5
 .na

-.B %libdir%/rcvstore
+.B %nmhlibexecdir%/rcvstore
+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ +folder ]
 .RB [ \-create " | " \-nocreate ]
 .RB [ \-unseen " | " \-nounseen ]
 .RI [ +folder ]
 .RB [ \-create " | " \-nocreate ]
 .RB [ \-unseen " | " \-nounseen ]


@@ -16,11 +18,9 @@ rcvstore \- asynchronously incorporate mail into a folder
 .I name
 \&...]
 .RB [ \-public " | " \-nopublic ]
 .I name
 \&...]
 .RB [ \-public " | " \-nopublic ]

-.RB [ \-version ]
-.RB [ \-help ]

 .ad
 .SH DESCRIPTION
 .ad
 .SH DESCRIPTION

-.B Rcvstore
+.B rcvstore

 incorporates a message from the standard input into an
 .B nmh
 folder.  This command is typically used in conjunction with
 incorporates a message from the standard input into an
 .B nmh
 folder.  This command is typically used in conjunction with


@@ -34,9 +34,8 @@ You may specify which folder to use with
 .IR +folder .
 If no folder is specified,
 .B rcvstore
 .IR +folder .
 If no folder is specified,
 .B rcvstore

-will use the folder given by a non\-empty
-\*(lqInbox:\*(rq entry in the user's profile, else it will use the folder
-named \*(lqinbox\*(rq.
+will use the folder given by a non-empty \*(lqInbox:\*(rq entry in
+the user's profile, else it will use the folder named \*(lqinbox\*(rq.

 .PP
 If the switch
 .B \-create
 .PP
 If the switch
 .B \-create


@@ -51,39 +50,38 @@ will exit if the specified folder does not exist.
 When the new message is incorporated into the folder, it is assigned
 the next highest number for that folder.
 .PP
 When the new message is incorporated into the folder, it is assigned
 the next highest number for that folder.
 .PP

-.B Rcvstore
-will incorporate anything except zero length messages
-into the user's
+.B rcvstore
+will incorporate anything except zero length messages into the user's

 .B nmh
 .B nmh

-folder.  It will not change the message in any
-way.
+folder.  It will not change the message in any way.

 .PP
 If the user's profile contains a
 .RI \*(lq "Msg\-Protect: nnn" \*(rq
 .PP
 If the user's profile contains a
 .RI \*(lq "Msg\-Protect: nnn" \*(rq

-entry, it will be used as the protection on the newly created
+entry, it will be used as the mode to use, in octal, on the newly created

 message, otherwise the
 .B nmh
 message, otherwise the
 .B nmh

-default of 0600 will be used (on filesystems that support it).  For
-all subsequent operations on this message, this initially assigned
-protection will be preserved.
+default mode of 0600, see
+.IR chmod (1),
+will be used (on filesystems that support it).
+For all subsequent operations on this message, this initially assigned
+mode will be preserved.

 .PP
 If the switch
 .B \-unseen
 .PP
 If the switch
 .B \-unseen

-is given (it is on by default), and if the
-profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty, then
+is given (it is on by default), and if the profile entry
+\*(lqUnseen\-Sequence\*(rq is present and non-empty, then

 .B rcvstore
 will add the newly incorporated message to each sequence
 named by this profile entry.  You may use the switch
 .B \-nounseen
 .B rcvstore
 will add the newly incorporated message to each sequence
 named by this profile entry.  You may use the switch
 .B \-nounseen

-to disable this.  These sequences will not be zero'ed by
+to disable this.  These sequences will not be zeroed by

 .B rcvstore
 prior to adding the new message.
 .PP
 .B rcvstore
 prior to adding the new message.
 .PP

-Furthermore, the incoming message may be added to additional sequences
+Furthermore, the incoming messages may be added to additional sequences

 as they arrive by the use of the
 .B \-sequence
 as they arrive by the use of the
 .B \-sequence

-switch.  As with the
-commands
+switch.  As with the commands

 .B pick
 and
 .BR mark ,
 .B pick
 and
 .BR mark ,


@@ -96,13 +94,23 @@ Similarly, use of the
 .B \-public
 and
 .B \-nopublic
 .B \-public
 and
 .B \-nopublic

-switches may be used
-to force these sequences to be public or private sequences.
+switches may be used to force these sequences to be public or
+private sequences.
+.SS Locking and \-unseen
+If you use the \*(lqUnseen-Sequence\*(rq profile entry, rcvstore could
+try to read and update its sequence state while another
+.B nmh
+process is also trying to do so.  This can cause the sequence state to
+lose track.  To avoid this, just between asynchronous invocations of
+.BR rcvstore ,
+do not use it without an external locking mechanism, for example, a
+.IR procmailrc (5)
+local lockfile, if you use the \*(lqUnseen-Sequence\*(rq profile entry.

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'%etcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^$HOME/.mh_profile~^The user profile

 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~


@@ -116,10 +124,12 @@ to force these sequences to be public or private sequences.
 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 .fi
 .SH "SEE ALSO"
 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 .fi
 .SH "SEE ALSO"

+.IR mh\-sequence (5),
+.IR procmailex (5),
+.IR procmailrc (5),

 .IR rcvdist (1),
 .IR rcvpack (1),
 .IR rcvdist (1),
 .IR rcvpack (1),

-.IR rcvtty (1),
-.IR mh\-sequence (5)
+.IR rcvtty (1)

 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to \*(lqInbox\*(rq profile entry"
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to \*(lqInbox\*(rq profile entry"