Changes to anno.man.

[nmh] / man / rcvstore.man

diff --git a/man/rcvstore.man b/man/rcvstore.man
index 010e23814ca0845af1461e2eb0f843394e975c8f..e1f23decb4ad33f77921c5d0cfbde1a9bd5b619b 100644 (file)
--- a/man/rcvstore.man
+++ b/man/rcvstore.man
@@ -1,13 +1,15 @@
+.TH RCVSTORE %manext1% "February 18, 2013" "%nmhversion%"

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

-.TH RCVSTORE %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 rcvstore \- asynchronously incorporate mail into a folder
 .SH SYNOPSIS
 .HP 5
 .na
 .SH NAME
 rcvstore \- asynchronously incorporate mail into a folder
 .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


@@ -51,19 +51,21 @@ 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
+.B rcvstore

 will incorporate anything except zero length messages
 into the user's
 .B nmh
 folder.  It will not change the message in any
 way.
 .PP
 will incorporate anything except zero length messages
 into the user's
 .B nmh
 folder.  It will not change the message in any
 way.
 .PP

-If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
-will be used as the protection on the newly created message, otherwise
-the
+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
+message, otherwise the

 .B nmh
 .B nmh

-default of 0644 will be used.  For all subsequent operations
-on this message, this initially assigned protection will be preserved.
+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.

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


@@ -96,14 +98,23 @@ and
 .B \-nopublic
 switches may be used
 to force these sequences to be public or private sequences.
 .B \-nopublic
 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
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u

 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi

-

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


@@ -115,10 +126,13 @@ to force these sequences to be public or private sequences.
 ^Msg\-Protect:~^To set mode when creating a new message
 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 .fi
 ^Msg\-Protect:~^To set mode when creating a new message
 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 .fi

-

 .SH "SEE ALSO"
 .SH "SEE ALSO"

-rcvdist(1), rcvpack(1), rcvtty(1), mh\-sequence(5)
-
+.IR rcvdist (1),
+.IR rcvpack (1),
+.IR rcvtty (1),
+.IR mh\-sequence (5),
+.IR procmailex (5),
+.IR procmailrc (5)

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


@@ -126,19 +140,6 @@ rcvdist(1), rcvpack(1), rcvtty(1), mh\-sequence(5)
 .RB ` \-unseen '
 .RB ` \-nozero '
 .fi
 .RB ` \-unseen '
 .RB ` \-nozero '
 .fi

-

 .SH CONTEXT
 No context changes will be attempted, with the exception of
 sequence manipulation.
 .SH CONTEXT
 No context changes will be attempted, with the exception of
 sequence manipulation.

-
-.SH BUGS
-If you use the \*(lqUnseen\-Sequence\*(rq profile entry,
-.B rcvstore
-could try to update the context while another
-.B nmh
-process
-is also trying to do so.  This can cause the context to become
-corrupted.  To avoid this, do not use
-.B rcvstore
-if you use the
-\*(lqUnseen\-Sequence\*(rq profile entry.