diplodocus.org Git - nmh/blob - man/rcvstore.man

   1 .TH RCVSTORE %manext1% 2013-02-19 "%nmhversion%"
   2 .
   3 .\" %nmhwarning%
   4 .
   5 .SH NAME
   6 rcvstore \- asynchronously incorporate mail into an nmh folder
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B %nmhlibexecdir%/rcvstore
  11 .RB [ \-help ]
  12 .RB [ \-version ]
  13 .RI [ +folder ]
  14 .RB [ \-create " | " \-nocreate ]
  15 .RB [ \-unseen " | " \-nounseen ]
  16 .RB [ \-zero " | " \-nozero ]
  17 .RB [ \-sequence
  18 .I name
  19 \&...]
  20 .RB [ \-public " | " \-nopublic ]
  21 .ad
  22 .SH DESCRIPTION
  23 .B rcvstore
  24 incorporates a message from the standard input into an
  25 .B nmh
  26 folder.  This command is typically used in conjunction with
  27 mail filtering programs such as
  28 .B slocal
  29 and
  30 .BR procmail ,
  31 to filter your mail into different folders.
  32 .PP
  33 You may specify which folder to use with
  34 .IR +folder .
  35 If no folder is specified,
  36 .B rcvstore
  37 will use the folder given by a non-empty \*(lqInbox:\*(rq entry in
  38 the user's profile, else it will use the folder named \*(lqinbox\*(rq.
  39 .PP
  40 If the switch
  41 .B \-create
  42 is given (it is the default) and if the specified
  43 (or default) folder does not exist, then it will be created.  You may
  44 disable this with the
  45 .B \-nocreate
  46 option.  In this case
  47 .B rcvstore
  48 will exit if the specified folder does not exist.
  49 .PP
  50 When the new message is incorporated into the folder, it is assigned
  51 the next highest number for that folder.
  52 .PP
  53 .B rcvstore
  54 will incorporate anything except zero length messages into the user's
  55 .B nmh
  56 folder.  It will not change the message in any way.
  57 .PP
  58 If the user's profile contains a
  59 .RI \*(lq "Msg\-Protect: nnn" \*(rq
  60 entry, it will be used as the mode to use, in octal, on the newly created
  61 message, otherwise the
  62 .B nmh
  63 default mode of 0600, see
  64 .IR chmod (1),
  65 will be used (on filesystems that support it).
  66 For all subsequent operations on this message, this initially assigned
  67 mode will be preserved.
  68 .PP
  69 If the switch
  70 .B \-unseen
  71 is given (it is on by default), and if the profile entry
  72 \*(lqUnseen\-Sequence\*(rq is present and non-empty, then
  73 .B rcvstore
  74 will add the newly incorporated message to each sequence
  75 named by this profile entry.  You may use the switch
  76 .B \-nounseen
  77 to disable this.  These sequences will not be zeroed by
  78 .B rcvstore
  79 prior to adding the new message.
  80 .PP
  81 Furthermore, the incoming messages may be added to additional sequences
  82 as they arrive by the use of the
  83 .B \-sequence
  84 switch.  As with the commands
  85 .B pick
  86 and
  87 .BR mark ,
  88 you may also use the switches
  89 .B \-zero
  90 and
  91 .B \-nozero
  92 to specify whether to zero old sequences or not.
  93 Similarly, use of the
  94 .B \-public
  95 and
  96 .B \-nopublic
  97 switches may be used to force these sequences to be public or
  98 private sequences.
  99 .SS Locking and \-unseen
 100 If you use the \*(lqUnseen-Sequence\*(rq profile entry, rcvstore could
 101 try to read and update its sequence state while another
 102 .B nmh
 103 process is also trying to do so.  This can cause the sequence state to
 104 lose track.  To avoid this, just between asynchronous invocations of
 105 .BR rcvstore ,
 106 do not use it without an external locking mechanism, for example, a
 107 .IR procmailrc (5)
 108 local lockfile, if you use the \*(lqUnseen-Sequence\*(rq profile entry.
 109 .SH FILES
 110 .fc ^ ~
 111 .nf
 112 .ta \w'%nmhetcdir%/ExtraBigFileName  'u
 113 ^$HOME/.mh_profile~^The user profile
 114 .fi
 115 .SH "PROFILE COMPONENTS"
 116 .fc ^ ~
 117 .nf
 118 .ta 2.4i
 119 .ta \w'ExtraBigProfileName  'u
 120 ^Path:~^To determine the user's nmh directory
 121 ^Folder\-Protect:~^To set mode when creating a new folder
 122 ^Inbox:~^To find the default inbox
 123 ^Msg\-Protect:~^To set mode when creating a new message
 124 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 125 .fi
 126 .SH "SEE ALSO"
 127 .IR mh\-sequence (5),
 128 .IR procmailex (5),
 129 .IR procmailrc (5),
 130 .IR rcvdist (1),
 131 .IR rcvpack (1),
 132 .IR rcvtty (1)
 133 .SH DEFAULTS
 134 .nf
 135 .RB ` +folder "' defaults to \*(lqInbox\*(rq profile entry"
 136 .RB ` \-create '
 137 .RB ` \-unseen '
 138 .RB ` \-nozero '
 139 .fi
 140 .SH CONTEXT
 141 No context changes will be attempted, with the exception of
 142 sequence manipulation.