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