git.marmaro.de Git - mmh/blob - man/rcvstore.man

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