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

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