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

[nmh] / man / sortm.man

diff --git a/man/sortm.man b/man/sortm.man
index bb43993d5846a885102414aa5833d46873975f76..9c556417bcc13388a3534876a60e94549fcee93b 100644 (file)
--- a/man/sortm.man
+++ b/man/sortm.man
@@ -1,101 +1,172 @@
-.\"
+.TH SORTM %manext1% 2014-03-23 "%nmhversion%"
+.

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

-.\" $Id$
-.\"
-.\" include the -mh macro file
-.so %etcdir%/tmac.h
-.\"
-.TH SORTM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.

 .SH NAME
 .SH NAME

-sortm \- sort messages
+sortm \- sort nmh messages

 .SH SYNOPSIS
 .SH SYNOPSIS

-.in +.5i
-.ti -.5i
-sortm
-\%[+folder] \%[msgs]
-\%[\-datefield\ field]
-\%[\-textfield\ field]
-.br
-\%[\-notextfield]
-\%[\-limit days] \%[\-nolimit]
-\%[\-verbose]
-.br
-\%[\-noverbose]
-\%[\-version]
-\%[\-help]
-.in -.5i
+.HP 5
+.na
+.B sortm
+.RB [ \-help ]
+.RB [ \-version ]
+.RI [ +folder ]
+.RI [ msgs ]
+.RB [ \-all " | " \-noall ]
+.RB [ \-datefield
+.IR field ]
+.RB [ \-textfield
+.IR field ]
+.RB [ \-notextfield ]
+.RB [ \-limit
+.IR days ]
+.RB [ \-nolimit ]
+.RB [ \-check " | " \-nocheck ]
+.RB [ \-verbose " | " \-noverbose ]
+.ad

 .SH DESCRIPTION
 .SH DESCRIPTION

-\fISortm\fR sorts the specified messages in the named folder according
+.B sortm
+sorts the specified messages in the named folder according

 to the chronological order of the \*(lqDate:\*(rq field of each message.
 to the chronological order of the \*(lqDate:\*(rq field of each message.

-
-The `\-verbose' switch directs \fIsortm\fR to tell the user the general
+.PP
+If no messages are specified, the default is all messages in the folder.
+However, if no messages are specified and the
+.B \-noall
+switch is enabled, then
+.B sortm
+reports that as an error and exits with non-zero status.
+.B \-noall
+is most useful in the user's profile, to avoid inadvertent sorting of
+an entire folder.  The
+.B \-all
+switch can then be used on the command line to disable it.  Of course,
+a message specification of
+.I all
+can be used in any case.
+.PP
+The
+.B \-verbose
+switch directs
+.B sortm
+to tell the user the general

 actions that it is taking to place the folder in sorted order.
 actions that it is taking to place the folder in sorted order.

-
-The `\-datefield\ field' switch tells \fIsortm\fR the name of the field to
+.PP
+The
+.B \-datefield
+.I field
+switch tells
+.B sortm
+the name of the field to

 use when making the date comparison.  If the user has a special field in
 each message, such as \*(lqBB\-Posted:\*(rq or \*(lqDelivery\-Date:\*(rq,
 use when making the date comparison.  If the user has a special field in
 each message, such as \*(lqBB\-Posted:\*(rq or \*(lqDelivery\-Date:\*(rq,

-then the `\-datefield' switch can be used to direct \fIsortm\fR which
-field to examine.
-
-The `\-textfield\ field' switch causes \fIsortm\fR to sort messages
-by the specified text field.  If this field is \*(lqsubject\*(rq, any
-leading "re:" is stripped off.  In any case, all characters except
+then the
+.B \-datefield
+switch can be used to direct
+.B sortm
+which field to examine.
+.PP
+The
+.B \-textfield
+.I field
+switch causes
+.B sortm
+to sort messages by the specified text field.  All characters except

 letters and numbers are stripped and the resulting strings are sorted
 letters and numbers are stripped and the resulting strings are sorted

-datefield\-major, textfield\-minor, using a case insensitive comparison.
-
-With `\-textfield\ field', if `\-limit\ days' is specified, messages
-with similar textfields that are dated within `days' of each other
-appear together.  Specifying `\-nolimit' makes the limit infinity.
-With `\-limit 0', the sort is instead made textfield\-major, date\-minor.
-
-.\"Ex
-For example, to order a folder by date-major, subject-minor, use:
-
-.ti +.5i
+datefield-major, textfield-minor, using a case insensitive
+comparison.  If this field is \*(lqsubject\*(rq, any leading "re:" is
+stripped off.
+.PP
+With
+.B \-textfield
+.IR field ,
+if
+.B \-limit
+.I days
+is specified, messages
+with the same textfields that are dated within `days' of each other
+appear together.  Specifying
+.B \-nolimit
+makes the limit infinity.
+With
+.B \-limit
+.IR 0 ,
+the sort is instead simply textfield-major.
+.PP
+For example, to order a folder by date-major, grouping messages with
+the same subject on the same date together, use:
+.PP
+.RS 5

 sortm -textfield subject +folder
 sortm -textfield subject +folder

-
-.Fi
-^$HOME/\&.mh\(ruprofile~^The user profile
-.Pr
+.RE
+.PP
+.B sortm
+always issues a warning for each message that is missing a
+\*(lqDate:\*(rq field, has a \*(lqDate:\*(rq field that cannot be
+parsed, or has a format error in any header field.  With the
+.B \-check
+switch,
+.B sortm
+inhibits all modifications to the folder if there are any such
+messages, and exits with non-zero status.  With the default of
+.BR \-nocheck ,
+.B sortm
+sorts messages with a missing or invalid
+\*(lqDate:\*(rq field using their file modification times.
+.PP
+When ordering messages based on their dates, if they have the same
+dates, their original message order is preserved.
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^$HOME/.mh_profile~^The user profile
+.fi
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u

 ^Path:~^To determine the user's nmh directory
 ^Path:~^To determine the user's nmh directory

-.Ps

 ^Current\-Folder:~^To find the default current folder
 ^Current\-Folder:~^To find the default current folder

-.Sa
-folder (1)
-.De
-`+folder' defaults to the current folder
-.Ds
-`msgs' defaults to all
-.Ds
-`\-datefield date'
-.Ds
-`\-notextfield'
-.Ds
-`\-noverbose'
-.Ds
-`\-nolimit'
-.Co
+.fi
+.SH "SEE ALSO"
+.IR folder (1)
+.SH DEFAULTS
+.nf
+.RB ` +folder "' defaults to the current folder"
+.RB ` msgs"' defaults to all without -noall, no default with -noall"
+.RB ` \-all '
+.RB ` \-datefield "' defaults to date"
+.RB ` \-notextfield '
+.RB ` \-noverbose '
+.RB ` \-nolimit '
+.RB ` \-nocheck '
+.fi
+.SH CONTEXT

 If a folder is given, it will become the current folder.  If the current
 If a folder is given, it will become the current folder.  If the current

-message is moved, \fIsortm\fR will preserve its status as current.
-.Hi
+message is moved,
+.B sortm
+will preserve its status as current.
+.SH HISTORY

 Timezones used to be ignored when comparing dates: they aren't any more.
 Timezones used to be ignored when comparing dates: they aren't any more.

-
+.PP

 Messages which were in the folder, but not specified by `msgs', used to
 be moved to the end of the folder; now such messages are left untouched.
 Messages which were in the folder, but not specified by `msgs', used to
 be moved to the end of the folder; now such messages are left untouched.

-
-\fISortm\fP sometimes did not preserve the message numbering in a folder
+.PP
+.B sortm
+sometimes did not preserve the message numbering in a folder

 (e.g., messages 1, 3, and 5, might have been renumbered to 1, 2, 3 after
 sorting).  This was a bug, and has been fixed.  To compress the message
 (e.g., messages 1, 3, and 5, might have been renumbered to 1, 2, 3 after
 sorting).  This was a bug, and has been fixed.  To compress the message

-numbering in a folder, use \*(lq\fIfolder\ \-pack\fR\|\*(rq as always.
-.Bu
-If \fIsortm\fR encounters a message without a date\-field, or if the
-message has a date\-field that \fIsortm\fR cannot parse, then \fIsortm\fR
-attempts to keep the message in the same relative position.  This does
-not always work.  For instance, if the first message encountered lacks
-a date which can be parsed, then it will usually be placed at the end
-of the messages being sorted.
-
-When \fIsortm\fR complains about a message which it can't temporally
-order, it complains about the message number \fIprior\fR to sorting.
-It should indicate what the message number will be \fIafter\fR sorting.
-.En
+numbering in a folder, use
+.RB \*(lq "folder\ \-pack" \*(rq
+as always.
+.SH BUGS
+When
+.B sortm
+complains about a message which it can't temporally
+order, it complains about the message number
+.I prior
+to sorting.
+It should indicate what the message number will be
+.B after
+sorting.