annotate conf/doc/mark.rf @ 12:441a2190cfae

Lion fix
author Shinji KONO <kono@ie.u-ryukyu.ac.jp>
date Sat, 21 Apr 2012 13:10:49 +0900
parents bce86c4163a3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
1 .\" @(MHWARNING)
12
441a2190cfae Lion fix
Shinji KONO <kono@ie.u-ryukyu.ac.jp>
parents: 0
diff changeset
2 .\" @(#)$Id: mark.rf,v 1.1.1.1 2005/04/18 14:46:03 kono Exp $
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
3 .SC MARK 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 mark \- mark messages
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 mark
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[+folder] \%[msgs]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-sequence\ name\ ...]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[\-add] \%[\-delete] \%[\-list]
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 The \fImark\fR command manipulates message sequences by adding or
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 deleting message numbers from folder\-specific message sequences,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17 or by listing those sequences and messages.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 A message sequence is a keyword, just like one of the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19 \*(lqreserved\*(rq message names,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20 such as \*(lqfirst\*(rq or \*(lqnext\*(rq.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 Unlike the \*(lqreserved\*(rq message names,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 which have a fixed semantics on a per\-folder basis,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 the semantics of a message sequence may be defined, modified, and
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 removed by the user.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 Message sequences are folder\-specific, e.g.,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 the sequence name \*(lqseen\*(rq in the context of folder \*(lq+inbox\*(rq
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27 need not have any relation whatsoever to the sequence of the same name
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 in a folder of a different name.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 Three action switches direct the operation of \fImark\fR.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 These switches are mutually exclusive:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 the last occurrence of any of them overrides any previous occurrence of the
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 other two.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35 The `\-add' switch tells \fImark\fR to add messages to sequences
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36 or to create a new sequence.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 For each sequence named via the `\-sequence\ name' argument
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38 (which must occur at least once)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 the messages named via `msgs'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40 (which defaults to \*(lqcur\*(rq if no `msgs' are given),
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 are added to the sequence.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42 The messages to be added need not be absent from the sequence.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43 If the `\-zero' switch is specified,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 the sequence will be emptied prior to adding the messages.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45 Hence, `\-add\ \-zero' means that each sequence should be initialized
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 to the indicated messages,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47 while `\-add\ \-nozero' means that each sequence should be appended to
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48 by the indicated messages.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 The `\-delete' switch tells \fImark\fR to delete messages from
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 sequences, and is the dual of `\-add'.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 For each of the named sequences,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53 the named messages are removed from the sequence.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54 These messages need not be already present in the sequence.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 If the `\-zero' switch is specified,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 then all messages in the folder are appended to the sequence prior to
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 removing the messages.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 Hence, `\-delete\ \-zero' means that each sequence should contain all
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 messages except those indicated,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 while `\-delete\ \-nozero' means that only the indicated messages
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 should be removed from each sequence.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 As expected, the command `mark\0\-sequence\0seen\0\-delete\0all'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 deletes the sequence \*(lqseen\*(rq from the current folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 When creating (or modifying) a sequence,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 the `\-public' switch indicates that the sequence should be made readable
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 for other \fIMH\fR users.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 In contrast, the `\-nopublic' switch indicates that the sequence should be
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69 private to the user's \fIMH\fR environment.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 The `\-list' switch tells \fImark\fR to list both the sequences defined
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 for the folder and the messages associated with those sequences.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 \fIMark\fR will list the name of each sequence given by
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74 `\-sequence\ name' and the messages associated with that sequence.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 If `\-sequence' isn't used, all sequences will be listed,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76 with private sequences being so indicated.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 The `\-zero' switch does not affect the operation of `\-list'.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 The current restrictions on sequences are:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 .in +.25i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82 The name used to denote a message sequence must consist of
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 an alphabetic character followed by zero or more
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84 alphanumeric characters, and cannot be one of the (reserved)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 message names \*(lqnew\*(rq, \*(lqfirst\*(rq,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 \*(lqlast\*(rq, \*(lqall\*(rq, \*(lqnext\*(rq, or \*(lqprev\*(rq.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87
bce86c4163a3 Initial revision
kono
parents:
diff changeset
88 Only a certain number of sequences may be defined for a given folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
89 This number is usually limited to 26 (10 on small systems).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
90
bce86c4163a3 Initial revision
kono
parents:
diff changeset
91 Message ranges with user\-defined
bce86c4163a3 Initial revision
kono
parents:
diff changeset
92 sequence names are restricted to the form \*(lqname:n\*(rq or
bce86c4163a3 Initial revision
kono
parents:
diff changeset
93 \*(lqname:-n\*(rq, and refer to the first or last `n' messages
bce86c4163a3 Initial revision
kono
parents:
diff changeset
94 of the sequence `name', respectively.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
95 Constructs of the form \*(lqname1\-name2\*(rq are forbidden.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
96 .in -.25i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
97 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
98 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
99 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
100 ^Path:~^To determine the user's MH directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
101 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
102 ^Current\-Folder:~^To find the default current folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
103 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
104 pick (1), mh-sequence (5)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
105 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
106 `+folder' defaults to the current folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
107 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
108 `\-add' if `\-sequence' is specified, `\-list' otherwise
bce86c4163a3 Initial revision
kono
parents:
diff changeset
109 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
110 `msgs' defaults to cur (or all if `\-list' is specified)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
111 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
112 `\-nopublic' if the folder is read\-only, `\-public' otherwise
bce86c4163a3 Initial revision
kono
parents:
diff changeset
113 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
114 `\-nozero'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
115 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
116 If a folder is given, it will become the current folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
117 .Hh
bce86c4163a3 Initial revision
kono
parents:
diff changeset
118 Use \*(lqpick sequence \-list\*(rq
bce86c4163a3 Initial revision
kono
parents:
diff changeset
119 to enumerate the messages in a sequence (such as for use
bce86c4163a3 Initial revision
kono
parents:
diff changeset
120 by a shell script).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
121 .En