Removed obsolete comment about use of getcpy().

[nmh] / man / anno.man

diff --git a/man/anno.man b/man/anno.man
index 5cf583139c88898e6375804822fca9e3139c64fd..3c556260ff7883bb83cbd2a98c89aa690b2e9fb0 100644 (file)
--- a/man/anno.man
+++ b/man/anno.man
@@ -1,73 +1,187 @@
+.TH ANNO %manext1% "December 13, 2016" "%nmhversion%"

 .\"
 .\" %nmhwarning%
 .\"
 .\" %nmhwarning%

-.\" $Id$

 .\"
 .\"

-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH ANNO %manext1% MH.6.8 [%nmhversion%]

 .SH NAME
 anno \- annotate messages
 .SH SYNOPSIS
 .SH NAME
 anno \- annotate messages
 .SH SYNOPSIS

-.in +.5i
-.ti -.5i
-anno
-\%[+folder] \%[msgs]
-\%[\-component\ field]
-\%[\-inplace]
-.br
-\%[\-noinplace]
-\%[\-date] \%[\-nodate]
-\%[\-text\ body]
-.br
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B anno
+.RB [ \-help ]
+.RB [ \-version ]
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-component
+.IR field ]
+.RB [ \-inplace " | " \-noinplace ]
+.RB [ \-date " | " \-nodate ]
+.RB [ \-draft ]
+.RB [ \-append ]
+.RB [ \-list ]
+.RB [ \-delete ]
+.RB [ \-number
+.IR [ num|all ]]
+.RB [ \-preserve " | " \-nopreserve ]
+.RB [ \-text
+.IR body ]
+.ad

 .SH DESCRIPTION
 .SH DESCRIPTION

-\fIAnno\fR annotates the specified messages in the named folder using
-the field and body.
-
-Usually, annotation is performed by the commands \fIdist\fR, \fIforw\fR,
-and \fIrepl\fR, if they are given the `\-anno' switch.  This allows you
-to keep track of your distribution of, forwarding of, and replies to
-a message.
-
-By using \fIanno\fR, you can perform arbitrary annotations of your own.
+.B anno
+manipulates header fields or
+.I annotations
+in messages.
+Header fields consist of a field name and an optional field body
+as defined by RFC 2822.
+The
+.B -component
+switch specifies the field name, and the
+.B -text
+switch specifies the field body.
+.PP
+The messages are either the
+.I msgs
+in the named folder, or the draft if invoked with the
+.B -draft
+switch.
+.PP
+Usually, annotation is performed by the commands
+.BR dist ,
+.BR forw ,
+and
+.BR repl ,
+if they are given the
+.B \-anno
+switch.  This allows you to keep track of your distribution of,
+forwarding of, and replies to a message.
+.PP
+By using
+.BR anno ,
+you can perform arbitrary annotations of your own.

 Each message selected will be annotated with the lines
 Each message selected will be annotated with the lines

-
+.PP

     field:\ date
     field:\ body
     field:\ date
     field:\ body

-
-The `\-nodate' switch inhibits the date annotation, leaving only the
+.PP
+The
+.B \-nodate
+switch inhibits the date annotation, leaving only the

 body annotation.
 body annotation.

-
-If a `\-component\ field' is not specified when \fIanno\fR is invoked,
-\fIanno\fR will prompt the user for the name of field for the annotation.
-
-The field specified should be a valid 822-style message field name,
-which means that it should consist of alphanumerics (or dashes) only.
-The body specified is arbitrary text.
-
-Normally \fIanno\fR does the annotation inplace in order to preserve
-any links to the message.  You may change this by using the `\-noinplace'
+.PP
+By default,
+.B anno
+prepends the annotations to the message.
+Annotations are instead appended if the
+.B -append
+switch is specified.
+.PP
+If a
+.B \-component
+.I field
+is not specified when
+.B anno
+is invoked,
+.B anno
+will prompt the user for a field name.
+.PP
+The field specified must be a valid RFC 2822-style message field name,
+consisting only of alphanumeric characters and dashes.
+The body may consist of arbitrary text.
+.PP
+Normally
+.B anno
+does the annotation in place in order to preserve
+any links to the message.  You may change this by using the
+.B \-noinplace
+switch.
+.PP
+The
+.B -list
+switch produces a listing of the field bodies for header fields with
+names matching the specified component, one per line.
+The listing is numbered, starting at 1, if the
+.B -number
+switch is also used.
+A tab character separates the number and the field body.
+The field body is treated as if it is a file name, and only the final
+path name component is listed.
+The complete field body is listed if the
+.B -text
+switch is used; the argument to the
+.B -text
+switch is required but ignored.
+.PP
+The
+.B -delete
+switch removes header fields from messages.
+The first header field whose name matches the component is deleted if
+no other options are specified.
+If the
+.B -text
+switch is used in conjunction with the
+.B -delete
+switch, the first header field whose name matches the component and
+whose body matches the text is deleted.
+The text is treated as if it was a file name; if it begins with a
+slash, the entire field body must match the text, otherwise just the
+last path name component of the field body must match.
+If the
+.B -number
+switch is used in conjunction with the
+.B -delete
+switch, header field
+.I num
+whose name matches the component is deleted.
+The number matches that which is produced by the
+.B -list

 switch.
 switch.

-.Fi
-^$HOME/\&.mh\(ruprofile~^The user profile
-.Pr
-^Path:~^To determine the user's nmh directory
-.Ps
-^Current\-Folder:~^To find the default current folder
-.Sa
-dist (1), forw (1), repl (1)
-.De
-`+folder' defaults to the current folder
-.Ds
-`msgs' defaults to cur
-.Ds
-`\-inplace'
-.Ds
-`\-date'
-.Co
+The special value
+.B all
+can be used for the number, and causes all components that match the
+name to be deleted.
+.PP
+By default,
+.B anno
+changes the last-accessed and last-modified times on annotated messages
+to the time of the annotation.
+.B anno
+preserves the original times if the
+.B -preserve
+switch is used.
+A matching
+.B -nopreserve
+switch allows time preservation to be turned off, if enabled
+in the profile.
+.SH FILES
+.TP 20
+$HOME/\&.mh\(ruprofile
+The user's profile.
+.SH "PROFILE COMPONENTS"
+.PD 0
+.TP 20
+Path:
+To determine the user's nmh directory.
+.TP
+Current\-Folder:
+To find the default current folder.
+.PD
+.SH "SEE ALSO"
+.IR dist (1),
+.IR forw (1),
+.IR repl (1)
+.SH DEFAULTS
+.PD 0
+.TP 20
++folder
+The current folder.
+.TP
+msgs
+The current message.
+.TP
+-inplace
+.TP
+-date
+.PD
+.SH CONTEXT

 If a folder is given, it will become the current folder.  The first
 message annotated will become the current message.
 If a folder is given, it will become the current folder.  The first
 message annotated will become the current message.

-.En