X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/c897634e1c28697a6df572de00e66579567ad2a6..9f8418e870a70c264eda1598f2d470e5428c216d:/man/sortm.man diff --git a/man/sortm.man b/man/sortm.man index 73b23bb1..7e0c2dfd 100644 --- a/man/sortm.man +++ b/man/sortm.man @@ -1,16 +1,18 @@ +.TH SORTM %manext1% "March 23, 2014" "%nmhversion%" .\" .\" %nmhwarning% .\" -.TH SORTM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME sortm \- sort messages .SH SYNOPSIS .HP 5 .na .B sortm +.RB [ \-help ] +.RB [ \-version ] .RI [ +folder ] .RI [ msgs ] -.RB [ \-all | \-noall ] +.RB [ \-all " | " \-noall ] .RB [ \-datefield .IR field ] .RB [ \-textfield @@ -19,9 +21,8 @@ sortm \- sort messages .RB [ \-limit .IR days ] .RB [ \-nolimit ] +.RB [ \-check " | " \-nocheck ] .RB [ \-verbose " | " \-noverbose ] -.RB [ \-version ] -.RB [ \-help ] .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 -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, @@ -97,14 +98,29 @@ the same subject on the same date together, use: .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 -.ta \w'%etcdir%/ExtraBigFileName 'u +.ta \w'%nmhetcdir%/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile .fi - .SH "PROFILE COMPONENTS" .fc ^ ~ .nf @@ -113,10 +129,8 @@ sortm -textfield subject +folder ^Path:~^To determine the user's nmh directory ^Current\-Folder:~^To find the default current folder .fi - .SH "SEE ALSO" -folder(1) - +.IR folder (1) .SH DEFAULTS .nf .RB ` +folder "' defaults to the current folder" @@ -126,14 +140,13 @@ folder(1) .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 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. .PP @@ -147,20 +160,7 @@ sorting). This was a bug, and has been fixed. To compress the message numbering in a folder, use .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