new.c: Order two return statements to match comment.

[nmh] / man / anno.man

diff --git a/man/anno.man b/man/anno.man
index e2a77c1f31e8b66555c8dd2bdf6126d63222477f..2680b4ef42dd2c955ffb701a839f55d66c69f38e 100644 (file)
--- a/man/anno.man
+++ b/man/anno.man
@@ -1,14 +1,15 @@
-.\"
+.TH ANNO %manext1% 2005-12-07 "%nmhversion%"
+.

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

-.\" $Id$
-.\"
-.TH ANNO %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.

 .SH NAME
 .SH NAME

-anno \- annotate messages
+anno \- annotate nmh messages

 .SH SYNOPSIS
 .HP 5
 .na
 .B anno
 .SH SYNOPSIS
 .HP 5
 .na
 .B anno

+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ +folder ]
 .RI [ msgs ]
 .RB [ \-component
 .RI [ +folder ]
 .RI [ msgs ]
 .RB [ \-component


@@ -22,29 +23,27 @@ anno \- annotate messages
 .RB [ \-number
 .IR [ num|all ]]
 .RB [ \-preserve " | " \-nopreserve ]
 .RB [ \-number
 .IR [ num|all ]]
 .RB [ \-preserve " | " \-nopreserve ]

-.RB [ \-version ]
-.RB [ \-help ]

 .RB [ \-text
 .IR body ]
 .ad
 .SH DESCRIPTION
 .RB [ \-text
 .IR body ]
 .ad
 .SH DESCRIPTION

-.B Anno
+.B anno

 manipulates header fields or
 .I annotations
 in messages.
 Header fields consist of a field name and an optional field body
 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.
+as defined by RFC 2822.

 The
 .B -component
 The
 .B -component

-option specifies the field name, and the
+switch specifies the field name, and the

 .B -text
 .B -text

-option specifies the field body.
+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
 .PP
 The messages are either the
 .I msgs
 in the named folder, or the draft if invoked with the
 .B -draft

-option.
+switch.

 .PP
 Usually, annotation is performed by the commands
 .BR dist ,
 .PP
 Usually, annotation is performed by the commands
 .BR dist ,


@@ -74,7 +73,7 @@ By default,
 prepends the annotations to the message.
 Annotations are instead appended if the
 .B -append
 prepends the annotations to the message.
 Annotations are instead appended if the
 .B -append

-option is specified.
+switch is specified.

 .PP
 If a
 .B \-component
 .PP
 If a
 .B \-component


@@ -83,57 +82,59 @@ is not specified when
 .B anno
 is invoked,
 .B anno
 .B anno
 is invoked,
 .B anno

-will prompt the user for the name of field for the annotation.
+will prompt the user for a field name.

 .PP
 .PP

-The field specified must be a valid 2822-style message field name,
-which means that it may only consist of alphanumerics and dashes,
-The body specified is arbitrary text.
+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
 .PP
 Normally
 .B anno

-does the annotation inplace in order to preserve
+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
 any links to the message.  You may change this by using the
 .B \-noinplace
 switch.
 .PP
 The
 .B -list

-option produces a listing of the field bodies for header fields with
+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
 names matching the specified component, one per line.
 The listing is numbered, starting at 1, if the
 .B -number

-option is also used.
+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
 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

-option is used, the contents of the text are ignored.
+switch is used; the argument to the
+.B -text
+switch is required but ignored.

 .PP
 The
 .B -delete
 .PP
 The
 .B -delete

-option removes header fields from messages.
+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
 The first header field whose name matches the component is deleted if
 no other options are specified.
 If the
 .B -text

-option is used in conjunction with the
+switch is used in conjunction with the

 .B -delete
 .B -delete

-option, the first header field whose name matches the component and
+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
 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

-option is used in conjuction with the
+switch is used in conjunction with the

 .B -delete
 .B -delete

-option, header field
+switch, header field

 .I num
 whose name matches the component is deleted.
 The number matches that which is produced by the
 .B -list
 .I num
 whose name matches the component is deleted.
 The number matches that which is produced by the
 .B -list

-option.
+switch.

 The special value
 .B all
 can be used for the number, and causes all components that match the
 The special value
 .B all
 can be used for the number, and causes all components that match the


@@ -141,43 +142,46 @@ name to be deleted.
 .PP
 By default,
 .B anno
 .PP
 By default,
 .B anno

-changes the last-accessed and last-modified times on annotate messages
-to the time at which the annotation occurs.
-.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
 preserves the original times if the
 .B -preserve

-option is used.
+switch is used.

 A matching
 .B -nopreserve
 A matching
 .B -nopreserve

-option exists that allows time preservation to be turned off if enabled
+switch allows time preservation to be turned off, if enabled

 in the profile.
 .SH FILES
 in the profile.
 .SH FILES

-.fc ^ ~
-.nf
-.ta \w'%etcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
-.fi
-
+.TP 20
+$HOME/.mh_profile
+The user's profile.

 .SH "PROFILE COMPONENTS"
 .SH "PROFILE COMPONENTS"

-.fc ^ ~
-.nf
-.ta 2.4i
-.ta \w'ExtraBigProfileName  'u
-^Path:~^To determine the user's nmh directory
-^Current\-Folder:~^To find the default current folder
-.fi
-
+.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"
 .SH "SEE ALSO"

-dist(1), forw(1), repl(1)
-
+.IR dist (1),
+.IR forw (1),
+.IR repl (1)

 .SH DEFAULTS
 .SH DEFAULTS

-.nf
-.RI ` +folder "' defaults to the current folder"
-.RI ` msgs "' defaults to cur"
-.RB ` \-inplace '
-.RB ` \-date '
-.fi
-
+.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.
 .SH CONTEXT
 If a folder is given, it will become the current folder.  The first
 message annotated will become the current message.