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

[nmh] / man / rcvstore.man

diff --git a/man/rcvstore.man b/man/rcvstore.man
index b0cf25265dd31de322da739d9e7c87edae470e99..79cd58acfef89a1c20748cc2dee74eba90d4f4bc 100644 (file)
--- a/man/rcvstore.man
+++ b/man/rcvstore.man
@@ -1,100 +1,142 @@
-.\"
+.TH RCVSTORE %manext1% 2013-02-19 "%nmhversion%"
+.

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

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

 .SH NAME
 .SH NAME

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

 .SH SYNOPSIS
 .SH SYNOPSIS

-.in +.5i
-.ti -.5i
-%libdir%/rcvstore
-\%[+folder]
-.br
-\%[\-create] \%[\-nocreate]
-\%[\-unseen] \%[\-nounseen]
-.br
-\%[\-zero] \%[\-nozero]
-\%[\-public] \%[\-nopublic]
-.br
-\%[\-sequence\ name\ ...]
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B %nmhlibexecdir%/rcvstore
+.RB [ \-help ]
+.RB [ \-version ]
+.RI [ +folder ]
+.RB [ \-create " | " \-nocreate ]
+.RB [ \-unseen " | " \-nounseen ]
+.RB [ \-zero " | " \-nozero ]
+.RB [ \-sequence
+.I name
+\&...]
+.RB [ \-public " | " \-nopublic ]
+.ad

 .SH DESCRIPTION
 .SH DESCRIPTION

-\fIRcvstore\fR incorporates a message from the standard input into an
-\fInmh\fR folder.  This command is typically used in conjunction with
-mail filtering programs such as \fIslocal\fR and \fIprocmail\fR, to
-filter your mail into different folders.
-
-You may specify which folder to use with `+folder'.  If no folder is
-specified, \fIrcvstore\fP 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.
-
-If the switch `\-create' is given (it is the default) and if the specified
+.B rcvstore
+incorporates a message from the standard input into an
+.B nmh
+folder.  This command is typically used in conjunction with
+mail filtering programs such as
+.B slocal
+and
+.BR procmail ,
+to filter your mail into different folders.
+.PP
+You may specify which folder to use with
+.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.
+.PP
+If the switch
+.B \-create
+is given (it is the default) and if the specified

 (or default) folder does not exist, then it will be created.  You may
 (or default) folder does not exist, then it will be created.  You may

-disable this with the `\-nocreate' option.  In this case \fIrcvstore\fP
+disable this with the
+.B \-nocreate
+option.  In this case
+.B rcvstore

 will exit if the specified folder does not exist.
 will exit if the specified folder does not exist.

-
+.PP

 When the new message is incorporated into the folder, it is assigned
 the next highest number for that folder.
 When the new message is incorporated into the folder, it is assigned
 the next highest number for that folder.

-
-\fIRcvstore\fR will incorporate anything except zero length messages
-into the user's nmh folder.  It will not change the message in any
-way.
-
-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 \fInmh\fR default of 0644 will be used.  For all subsequent operations
-on this message, this initially assigned protection will be preserved.
-
-If the switch `\-unseen' is given (it is on by default), and if the
-profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty, then
-\fIrcvstore\fR will add the newly incorporated message to each sequence
-named by this profile entry.  You may use the switch `\-nounseen' to
-disable this.  These sequences will not be zero'ed by \fIrcvstore\fR
+.PP
+.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
+If the user's profile contains a
+.RI \*(lq "Msg\-Protect: nnn" \*(rq
+entry, it will be used as the mode to use, in octal, on the newly created
+message, otherwise the
+.B nmh
+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
+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
+to disable this.  These sequences will not be zeroed by
+.B rcvstore

 prior to adding the new message.
 prior to adding the new message.

-
-Furthermore, the incoming message may be added to additional sequences
-as they arrive by the use of the `\-sequence' switch.  As with the
-commands \fIpick\fP and \fImark\fP, you may also use the switches
-`\-zero' and `\-nozero' to specify whether to zero old sequences or not.
-Similarly, use of the `\-public' and `\-nopublic switches may be used
-to force these sequences to be public or private sequences.
-
-.Fi
-^$HOME/\&.mh\(ruprofile~^The user profile
-.Pr
+.PP
+Furthermore, the incoming messages may be added to additional sequences
+as they arrive by the use of the
+.B \-sequence
+switch.  As with the commands
+.B pick
+and
+.BR mark ,
+you may also use the switches
+.B \-zero
+and
+.B \-nozero
+to specify whether to zero old sequences or not.
+Similarly, use of the
+.B \-public
+and
+.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
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^$HOME/.mh_profile~^The user profile
+.fi
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u

 ^Path:~^To determine the user's nmh directory
 ^Path:~^To determine the user's nmh directory

-.Ps

 ^Folder\-Protect:~^To set mode when creating a new folder
 ^Folder\-Protect:~^To set mode when creating a new folder

-.Ps

 ^Inbox:~^To find the default inbox
 ^Inbox:~^To find the default inbox

-.Ps

 ^Msg\-Protect:~^To set mode when creating a new message
 ^Msg\-Protect:~^To set mode when creating a new message

-.Ps

 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 ^Unseen\-Sequence:~^To name sequences denoting unseen messages

-.Sa
-rcvdist(1), rcvpack(1), rcvtty(1), mh\-sequence(5)
-.De
-`+folder' defaults to \*(lqInbox\*(rq profile entry
-.Ds
-`\-create'
-.Ds
-`\-unseen'
-.Ds
-`\-nozero'
-.Co
+.fi
+.SH "SEE ALSO"
+.IR mh\-sequence (5),
+.IR procmailex (5),
+.IR procmailrc (5),
+.IR rcvdist (1),
+.IR rcvpack (1),
+.IR rcvtty (1)
+.SH DEFAULTS
+.nf
+.RB ` +folder "' defaults to \*(lqInbox\*(rq profile entry"
+.RB ` \-create '
+.RB ` \-unseen '
+.RB ` \-nozero '
+.fi
+.SH CONTEXT

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

-.Bu
-If you use the \*(lqUnseen\-Sequence\*(rq profile entry, \fIrcvstore\fP
-could try to update the context while another \fInmh\fP process
-is also trying to do so.  This can cause the context to become
-corrupted.  To avoid this, do not use \fIrcvstore\fP if you use the
-\*(lqUnseen\-Sequence\*(rq profile entry.
-.En