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

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH RCVSTORE %manext1% MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 rcvstore \- asynchronously incorporate mail into a folder
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 %libdir%/rcvstore
  15 \%[+folder]
  16 .br
  17 \%[\-create] \%[\-nocreate]
  18 \%[\-unseen] \%[\-nounseen]
  19 .br
  20 \%[\-zero] \%[\-nozero]
  21 \%[\-public] \%[\-nopublic]
  22 .br
  23 \%[\-sequence\ name\ ...]
  24 \%[\-version]
  25 \%[\-help]
  26 .in -.5i
  27 .SH DESCRIPTION
  28 \fIRcvstore\fR incorporates a message from the standard input into an
  29 \fInmh\fR folder.  This command is typically used in conjunction with
  30 mail filtering programs such as \fIslocal\fR and \fIprocmail\fR, to
  31 filter your mail into different folders.
  32
  33 You may specify which folder to use with `+folder'.  If no folder is
  34 specified, \fIrcvstore\fP will use the folder given by a non\-empty
  35 \*(lqInbox:\*(rq entry in the user's profile, else it will use the folder
  36 named \*(lqinbox\*(rq.
  37
  38 If the switch `\-create' is given (it is the default) and if the specified
  39 (or default) folder does not exist, then it will be created.  You may
  40 disable this with the `\-nocreate' option.  In this case \fIrcvstore\fP
  41 will exit if the specified folder does not exist.
  42
  43 When the new message is incorporated into the folder, it is assigned
  44 the next highest number for that folder.
  45
  46 \fIRcvstore\fR will incorporate anything except zero length messages
  47 into the user's nmh folder.  It will not change the message in any
  48 way.
  49
  50 If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
  51 will be used as the protection on the newly created message, otherwise
  52 the \fInmh\fR default of 0644 will be used.  For all subsequent operations
  53 on this message, this initially assigned protection will be preserved.
  54
  55 If the switch `\-unseen' is given (it is on by default), and if the
  56 profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty, then
  57 \fIrcvstore\fR will add the newly incorporated message to each sequence
  58 named by this profile entry.  You may use the switch `\-nounseen' to
  59 disable this.  These sequences will not be zero'ed by \fIrcvstore\fR
  60 prior to adding the new message.
  61
  62 Furthermore, the incoming message may be added to additional sequences
  63 as they arrive by the use of the `\-sequence' switch.  As with the
  64 commands \fIpick\fP and \fImark\fP, you may also use the switches
  65 `\-zero' and `\-nozero' to specify whether to zero old sequences or not.
  66 Similarly, use of the `\-public' and `\-nopublic switches may be used
  67 to force these sequences to be public or private sequences.
  68
  69 .Fi
  70 ^$HOME/\&.mh\(ruprofile~^The user profile
  71 .Pr
  72 ^Path:~^To determine the user's nmh directory
  73 .Ps
  74 ^Folder\-Protect:~^To set mode when creating a new folder
  75 .Ps
  76 ^Inbox:~^To find the default inbox
  77 .Ps
  78 ^Msg\-Protect:~^To set mode when creating a new message
  79 .Ps
  80 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
  81 .Sa
  82 rcvdist(1), rcvpack(1), rcvtty(1), mh\-sequence(5)
  83 .De
  84 `+folder' defaults to \*(lqInbox\*(rq profile entry
  85 .Ds
  86 `\-create'
  87 .Ds
  88 `\-unseen'
  89 .Ds
  90 `\-nozero'
  91 .Co
  92 No context changes will be attempted, with the exception of
  93 sequence manipulation.
  94 .Bu
  95 If you use the \*(lqUnseen\-Sequence\*(rq profile entry, \fIrcvstore\fP
  96 could try to update the context while another \fInmh\fP process
  97 is also trying to do so.  This can cause the context to become
  98 corrupted.  To avoid this, do not use \fIrcvstore\fP if you use the
  99 \*(lqUnseen\-Sequence\*(rq profile entry.
 100 .En