]> diplodocus.org Git - nmh/blobdiff - man/sortm.man
Replace getcpy() with mh_xstrdup() where the string isn't NULL.
[nmh] / man / sortm.man
index 4d0344613b7157d0772b1fcca85392e010d19fa3..7e0c2dfdcfd546ab89829c37bec4eccda5c73933 100644 (file)
@@ -1,4 +1,4 @@
-.TH SORTM %manext1% "October 11, 2012" "%nmhversion%"
+.TH SORTM %manext1% "March 23, 2014" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
 .\"
 .\" %nmhwarning%
 .\"
@@ -8,9 +8,11 @@ sortm \- sort messages
 .HP 5
 .na
 .B sortm
 .HP 5
 .na
 .B sortm
+.RB [ \-help ]
+.RB [ \-version ]
 .RI [ +folder ]
 .RI [ msgs ]
 .RI [ +folder ]
 .RI [ msgs ]
-.RB [ \-all | \-noall ]
+.RB [ \-all " | " \-noall ]
 .RB [ \-datefield
 .IR field ]
 .RB [ \-textfield
 .RB [ \-datefield
 .IR field ]
 .RB [ \-textfield
@@ -19,9 +21,8 @@ sortm \- sort messages
 .RB [ \-limit
 .IR days ]
 .RB [ \-nolimit ]
 .RB [ \-limit
 .IR days ]
 .RB [ \-nolimit ]
+.RB [ \-check " | " \-nocheck ]
 .RB [ \-verbose " | " \-noverbose ]
 .RB [ \-verbose " | " \-noverbose ]
-.RB [ \-version ]
-.RB [ \-help ]
 .ad
 .SH DESCRIPTION
 .B Sortm
 .ad
 .SH DESCRIPTION
 .B Sortm
@@ -35,7 +36,7 @@ switch is enabled, then
 .B sortm
 reports that as an error and exits with non-zero status.
 .B \-noall
 .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 inadvertant sorting of
+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,
 an entire folder.  The
 .B \-all
 switch can then be used on the command line to disable it.  Of course,
@@ -97,10 +98,27 @@ the same subject on the same date together, use:
 .RS 5
 sortm -textfield subject +folder
 .RE
 .RS 5
 sortm -textfield subject +folder
 .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
 .SH FILES
 .fc ^ ~
 .nf
-.ta \w'%etcdir%/ExtraBigFileName  'u
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi
 .SH "PROFILE COMPONENTS"
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi
 .SH "PROFILE COMPONENTS"
@@ -122,6 +140,7 @@ sortm -textfield subject +folder
 .RB ` \-notextfield '
 .RB ` \-noverbose '
 .RB ` \-nolimit '
 .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
 .fi
 .SH CONTEXT
 If a folder is given, it will become the current folder.  If the current
@@ -142,18 +161,6 @@ numbering in a folder, use
 .RB \*(lq "folder\ \-pack" \*(rq
 as always.
 .SH BUGS
 .RB \*(lq "folder\ \-pack" \*(rq
 as always.
 .SH BUGS
-If
-.B sortm
-encounters a message without a date\-field, or if the
-message has a date\-field that
-.B sortm
-cannot parse, then
-.B sortm
-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.
-.PP
 When
 .B sortm
 complains about a message which it can't temporally
 When
 .B sortm
 complains about a message which it can't temporally