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

   1 .TH RCVSTORE %manext1% "January 18, 2001" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 rcvstore \- asynchronously incorporate mail into a folder
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  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 .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
  62 .RI \*(lq "Msg\-Protect: nnn" \*(rq
  63 entry, it will be used as the protection on the newly created
  64 message, otherwise the
  65 .B nmh
  66 default of 0600 will be used (on filesystems that support it).  For
  67 all subsequent operations on this message, this initially assigned
  68 protection will be preserved.
  69 .PP
  70 If the switch
  71 .B \-unseen
  72 is given (it is on by default), and if the
  73 profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty, then
  74 .B rcvstore
  75 will add the newly incorporated message to each sequence
  76 named by this profile entry.  You may use the switch
  77 .B \-nounseen
  78 to disable this.  These sequences will not be zero'ed by
  79 .B rcvstore
  80 prior to adding the new message.
  81 .PP
  82 Furthermore, the incoming message may be added to additional sequences
  83 as they arrive by the use of the
  84 .B \-sequence
  85 switch.  As with the
  86 commands
  87 .B pick
  88 and
  89 .BR mark ,
  90 you may also use the switches
  91 .B \-zero
  92 and
  93 .B \-nozero
  94 to specify whether to zero old sequences or not.
  95 Similarly, use of the
  96 .B \-public
  97 and
  98 .B \-nopublic
  99 switches may be used
 100 to force these sequences to be public or private sequences.
 101 .SH FILES
 102 .fc ^ ~
 103 .nf
 104 .ta \w'%etcdir%/ExtraBigFileName  'u
 105 ^$HOME/\&.mh\(ruprofile~^The user profile
 106 .fi
 107 .SH "PROFILE COMPONENTS"
 108 .fc ^ ~
 109 .nf
 110 .ta 2.4i
 111 .ta \w'ExtraBigProfileName  'u
 112 ^Path:~^To determine the user's nmh directory
 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 .SH "SEE ALSO"
 119 .IR rcvdist (1),
 120 .IR rcvpack (1),
 121 .IR rcvtty (1),
 122 .IR mh\-sequence (5)
 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 .SH CONTEXT
 131 No context changes will be attempted, with the exception of
 132 sequence manipulation.