annotate conf/doc/rcvstore.rf @ 0:bce86c4163a3

Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children 441a2190cfae
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
1 .\" @(MHWARNING)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
2 .\" @(#)$Id$
bce86c4163a3 Initial revision
kono
parents:
diff changeset
3 .SC RCVSTORE 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 rcvstore \- incorporate new mail asynchronously
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 @(MHETCPATH)/rcvstore
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[+folder]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-create] \%[\-nocreate]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[\-sequence\ name\ ...]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 \%[\-public] \%[\-nopublic]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 \%[\-zero] \%[\-nozero]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 \fIRcvstore\fR incorporates a message from the standard input
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 into an \fIMH\fR folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 If `+folder' isn't specified,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 a folder in the user's \fIMH\fR directory will be used, either that
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19 specified by the \*(lqInbox:\*(rq entry in the user's profile, or
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 the folder named \*(lqinbox\*(rq.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 The new message being incorporated is assigned the next highest
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 number in the folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 If the specified (or default) folder doesn't exist,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 then it will be created if the `\-create' option is specified,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 otherwise \fIrcvstore\fP will exit.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 If the user's profile contains a \*(lqMsg\-Protect: nnn\*(rq entry, it
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 will be used as the protection on the newly created messages,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 otherwise the \fIMH\fR default of 0644 will be used.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 During all operations on messages,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 this initially assigned protection will
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 be preserved for each message, so \fIchmod\fR(1) may be used to set a
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 protection on an individual message, and its protection will be
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 preserved thereafter.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 \fIRcvstore\fR will incorporate anything except zero length messages
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 into the user's MH folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 If the profile entry \*(lqUnseen\-Sequence\*(rq is present and non\-empty,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40 then \fIrcvstore\fR will add the newly incorporated message to each
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 sequence named by the profile entry.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 This is similar to the \*(lqPrevious\-Sequence\*(rq profile entry supported
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43 by all \fIMH\fR commands which take `msgs' or `msg' arguments.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 Note that \fIrcvstore\fR will not zero each sequence prior to adding messages.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 Furthermore,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47 the incoming messages may be added to user-defined sequences as
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48 they arrive by appropriate use of the `\-sequence' option.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 As with \fIpick\fP,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 use of the `\-zero' and `\-nozero' switches can also be used to zero
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 old sequences or not.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 Similarly,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53 use of the `\-public' and `\-nopublic switches
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54 may be used to force additions to public and private sequences.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 ^Path:~^To determine the user's MH directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 ^Folder\-Protect:~^To set mode when creating a new folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 ^Inbox:~^To find the default inbox
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64 ^Msg\-Protect:~^To set mode when creating a new message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 ^Unseen\-Sequence:~^To name sequences denoting unseen messages
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 inc(1), pick(1), mh\-mail(5)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 `+folder' defaults to \*(lqinbox\*(rq
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 `\-create'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74 `\-nopublic' if the folder is read\-only, `\-public' otherwise
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76 `\-nozero'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 No context changes will be attempted,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 with the exception of sequence manipulation.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 If you use the \*(lqUnseen\-Sequence\*(rq profile entry,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82 \fIrcvstore\fP could try to update the context while another
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 \fIMH\fP process is also trying to do so.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84 This can cause the context to become corrupted.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 To avoid this, do not use \fIrcvstore\fP
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 if you use the \*(lqUnseen\-Sequence\*(rq profile entry.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87 .En