X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fsortm.man;h=73b23bb113c158d6f3f2c8463602e14661e5ba15;hb=c897634e1c28697a6df572de00e66579567ad2a6;hp=64d66546ff42e845b89635a09abb7c7ad1d879bd;hpb=e1b3eb2cfcc2823fb2bb429aa54d9d6c296fc16b;p=mmh diff --git a/man/sortm.man b/man/sortm.man index 64d6654..73b23bb 100644 --- a/man/sortm.man +++ b/man/sortm.man @@ -1,15 +1,16 @@ .\" .\" %nmhwarning% -.\" $Id$ .\" .TH SORTM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME sortm \- sort messages .SH SYNOPSIS .HP 5 +.na .B sortm .RI [ +folder ] .RI [ msgs ] +.RB [ \-all | \-noall ] .RB [ \-datefield .IR field ] .RB [ \-textfield @@ -21,11 +22,27 @@ sortm \- sort messages .RB [ \-verbose " | " \-noverbose ] .RB [ \-version ] .RB [ \-help ] +.ad .SH DESCRIPTION .B Sortm sorts the specified messages in the named folder according to the chronological order of the \*(lqDate:\*(rq field of each message. .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 inadvertant 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 @@ -52,11 +69,11 @@ The .I field switch causes .B sortm -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 +to sort messages by the specified text field. All characters except letters and numbers are stripped and the resulting strings are sorted -datefield\-major, textfield\-minor, using a case insensitive comparison. +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 @@ -65,16 +82,17 @@ if .B \-limit .I days is specified, messages -with similar textfields that are dated within `days' of each other +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 made textfield\-major, date\-minor. +the sort is instead simply textfield\-major. .PP -For example, to order a folder by date-major, subject-minor, use: +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 @@ -83,7 +101,7 @@ sortm -textfield subject +folder .SH FILES .fc ^ ~ .nf -.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u +.ta \w'%etcdir%/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile .fi @@ -102,7 +120,8 @@ folder(1) .SH DEFAULTS .nf .RB ` +folder "' defaults to the current folder" -.RB ` msgs"' defaults to all" +.RB ` msgs"' defaults to all without -noall, no default with -noall" +.RB ` \-all ' .RB ` \-datefield "' defaults to date" .RB ` \-notextfield ' .RB ` \-noverbose ' @@ -113,7 +132,7 @@ folder(1) 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. +will preserve its status as current. .SH HISTORY Timezones used to be ignored when comparing dates: they aren't any more.