Added all of the MH sources, including RCS files, in
[mmh] / docs / historical / mh-6.8.5 / conf / doc / anno.rf
1 .\"     @(MHWARNING)
2 .\" @(#)$Id: anno.rf,v 2.4 90/04/05 15:08:00 sources Exp $
3 .SC ANNO 1
4 .NA
5 anno \- annotate messages
6 .SY
7 anno
8 \%[+folder] \%[msgs]
9 \%[\-component\ field]
10 \%[\-inplace] \%[\-noinplace]
11 \%[\-date] \%[\-nodate]
12 \%[\-text\ body]
13 \%[\-help]
14 .DE
15 \fIAnno\fR annotates the specified messages in the named folder using
16 the field and body.
17 Annotation is optionally performed by \fIdist\fR, \fIforw\fR, and
18 \fIrepl\fR,
19 to keep track of your distribution of, forwarding of, and replies to a
20 message.
21 By using \fIanno\fR,
22 you can perform arbitrary annotations of your own.
23 Each message selected will be annotated with the lines
24
25     field:\ date
26     field:\ body
27
28 The `\-nodate' switch inhibits the date annotation,
29 leaving only the body annotation.
30 The `\-inplace' switch causes annotation to be done in place in order
31 to preserve links to the annotated message.
32
33 The field specified should be a valid 822-style message field name,
34 which means that it should consist of alphanumerics (or dashes) only.
35 The body specified is arbitrary text.
36
37 If a `\-component\ field' is not specified when \fIanno\fR is invoked,
38 \fIanno\fR will prompt the user for the name of field for the annotation.
39 .Fi
40 ^$HOME/\&.mh\(ruprofile~^The user profile
41 .Pr
42 ^Path:~^To determine the user's MH directory
43 .Ps
44 ^Current\-Folder:~^To find the default current folder
45 .Sa
46 dist (1), forw (1), repl (1)
47 .De
48 `+folder' defaults to the current folder
49 .Ds
50 `msgs' defaults to cur
51 .Ds
52 `\-noinplace'
53 .Ds
54 `\-date'
55 .Co
56 If a folder is given, it will become the current folder.
57 The first message annotated will become the current message.
58 .En