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 .B %libdir%/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 .SH DESCRIPTION
  22 .B Rcvstore
  23 incorporates a message from the standard input into an
  24 .B nmh
  25 folder.  This command is typically used in conjunction with
  26 mail filtering programs such as
  27 .B slocal
  28 and
  29 .BR procmail ,
  30 to filter your mail into different folders.
  31 .PP
  32 You may specify which folder to use with
  33 .IR +folder .
  34 If no folder is specified,
  35 .B rcvstore
  36 will use the folder given by a non\-empty
  37 \*(lqInbox:\*(rq entry in the user's profile, else it will use the folder
  38 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
  55 into the user's
  56 .B nmh
  57 folder.  It will not change the message in any
  58 way.
  59 .PP
  60 If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
  61 will be used as the protection on the newly created message, otherwise
  62 the
  63 .B nmh
  64 default of 0644 will be used.  For all subsequent operations
  65 on this message, this initially assigned protection will be preserved.
  66 .PP
  67 If the switch
  68 .B \-unseen
  69 is given (it is on by default), and if the
  70 profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty, then
  71 .B rcvstore
  72 will add the newly incorporated message to each sequence
  73 named by this profile entry.  You may use the switch
  74 .B \-nounseen
  75 to disable this.  These sequences will not be zero'ed by
  76 .B rcvstore
  77 prior to adding the new message.
  78 .PP
  79 Furthermore, the incoming message may be added to additional sequences
  80 as they arrive by the use of the
  81 .B \-sequence
  82 switch.  As with the
  83 commands
  84 .B pick
  85 and
  86 .BR mark ,
  87 you may also use the switches
  88 .B \-zero
  89 and
  90 .B \-nozero
  91 to specify whether to zero old sequences or not.
  92 Similarly, use of the
  93 .B \-public
  94 and
  95 .B \-nopublic
  96 switches may be used
  97 to force these sequences to be public or private sequences.
  98
  99 .SH FILES
 100 .fc ^ ~
 101 .nf
 102 .ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
 103 ^$HOME/\&.mh\(ruprofile~^The user profile
 104 .fi
 105
 106 .SH "PROFILE COMPONENTS"
 107 .fc ^ ~
 108 .nf
 109 .ta 2.4i
 110 .ta \w'ExtraBigProfileName  'u
 111 ^Path:~^To determine the user's nmh directory
 112 ^Folder\-Protect:~^To set mode when creating a new folder
 113 ^Inbox:~^To find the default inbox
 114 ^Msg\-Protect:~^To set mode when creating a new message
 115 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
 116 .fi
 117
 118 .SH "SEE ALSO"
 119 rcvdist(1), rcvpack(1), rcvtty(1), mh\-sequence(5)
 120
 121 .SH DEFAULTS
 122 .nf
 123 .RB ` +folder "' defaults to \*(lqInbox\*(rq profile entry"
 124 .RB ` \-create '
 125 .RB ` \-unseen '
 126 .RB ` \-nozero '
 127 .fi
 128
 129 .SH CONTEXT
 130 No context changes will be attempted, with the exception of
 131 sequence manipulation.
 132
 133 .SH BUGS
 134 If you use the \*(lqUnseen\-Sequence\*(rq profile entry,
 135 .B rcvstore
 136 could try to update the context while another
 137 .B nmh
 138 process
 139 is also trying to do so.  This can cause the context to become
 140 corrupted.  To avoid this, do not use
 141 .B rcvstore
 142 if you use the
 143 \*(lqUnseen\-Sequence\*(rq profile entry.