annotate doc/sortm.me @ 0:bce86c4163a3

Initial revision
author kono
date Mon, 18 Apr 2005 23:46:02 +0900
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
bce86c4163a3 Initial revision
kono
parents:
diff changeset
1 .\" This file is automatically generated. Do not edit!
bce86c4163a3 Initial revision
kono
parents:
diff changeset
2 .\" @(#)$Id$
bce86c4163a3 Initial revision
kono
parents:
diff changeset
3 .SC SORTM 1
bce86c4163a3 Initial revision
kono
parents:
diff changeset
4 .NA
bce86c4163a3 Initial revision
kono
parents:
diff changeset
5 sortm \- sort messages
bce86c4163a3 Initial revision
kono
parents:
diff changeset
6 .SY
bce86c4163a3 Initial revision
kono
parents:
diff changeset
7 sortm
bce86c4163a3 Initial revision
kono
parents:
diff changeset
8 \%[+folder] \%[msgs]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
9 \%[\-datefield\ field]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
10 \%[\-textfield\ field] \%[\-notextfield]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
11 \%[\-limit days] \%[\-nolimit]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
12 \%[\-verbose] \%[\-noverbose]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
13 \%[\-help]
bce86c4163a3 Initial revision
kono
parents:
diff changeset
14 .DE
bce86c4163a3 Initial revision
kono
parents:
diff changeset
15 \fISortm\fR sorts the specified messages in the named folder according
bce86c4163a3 Initial revision
kono
parents:
diff changeset
16 to the chronological order of the \*(lqDate:\*(rq field of each message.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
17
bce86c4163a3 Initial revision
kono
parents:
diff changeset
18 The `\-verbose' switch directs \fIsortm\fR to tell the user the general
bce86c4163a3 Initial revision
kono
parents:
diff changeset
19 actions that it is taking to place the folder in sorted order.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
20
bce86c4163a3 Initial revision
kono
parents:
diff changeset
21 The `\-datefield\ field' switch tells \fIsortm\fR the name of the field
bce86c4163a3 Initial revision
kono
parents:
diff changeset
22 to use when making the date comparison.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
23 If the user has a special field in each message,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
24 such as \*(lqBB\-Posted:\*(rq or \*(lqDelivery\-Date:\*(rq,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
25 then the `\-datefield' switch can be used to direct \fIsortm\fR which
bce86c4163a3 Initial revision
kono
parents:
diff changeset
26 field to examine.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
27
bce86c4163a3 Initial revision
kono
parents:
diff changeset
28 The `\-textfield\ field' switch causes \fIsortm\fR to sort messages by
bce86c4163a3 Initial revision
kono
parents:
diff changeset
29 the specified text field.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
30 If this field is \*(lqsubject\*(rq,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
31 any leading "re:" is stripped off.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
32 In any case, all characters except letters and numbers are stripped
bce86c4163a3 Initial revision
kono
parents:
diff changeset
33 and the resulting strings are sorted
bce86c4163a3 Initial revision
kono
parents:
diff changeset
34 datefield\-major, textfield\-minor,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
35 using a case insensitive comparison.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
36
bce86c4163a3 Initial revision
kono
parents:
diff changeset
37 With `\-textfield\ field',
bce86c4163a3 Initial revision
kono
parents:
diff changeset
38 if `\-limit\ days' is specified, messages with similar textfields
bce86c4163a3 Initial revision
kono
parents:
diff changeset
39 that are dated within `days' of each other appear together.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
40 Specifying `\-nolimit' makes the limit infinity.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
41 With `\-limit 0', the sort is instead made textfield\-major, date\-minor.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
42
bce86c4163a3 Initial revision
kono
parents:
diff changeset
43 .\"Ex
bce86c4163a3 Initial revision
kono
parents:
diff changeset
44 For example, to order a folder by date-major, subject-minor, use:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
45
bce86c4163a3 Initial revision
kono
parents:
diff changeset
46 .ti +.5i
bce86c4163a3 Initial revision
kono
parents:
diff changeset
47 sortm -textfield subject +folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
48
bce86c4163a3 Initial revision
kono
parents:
diff changeset
49 .Fi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
50 ^$HOME/\&.mh\(ruprofile~^The user profile
bce86c4163a3 Initial revision
kono
parents:
diff changeset
51 .Pr
bce86c4163a3 Initial revision
kono
parents:
diff changeset
52 ^Path:~^To determine the user's MH directory
bce86c4163a3 Initial revision
kono
parents:
diff changeset
53 .Ps
bce86c4163a3 Initial revision
kono
parents:
diff changeset
54 ^Current\-Folder:~^To find the default current folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
55 .Sa
bce86c4163a3 Initial revision
kono
parents:
diff changeset
56 folder (1)
bce86c4163a3 Initial revision
kono
parents:
diff changeset
57 .De
bce86c4163a3 Initial revision
kono
parents:
diff changeset
58 `+folder' defaults to the current folder
bce86c4163a3 Initial revision
kono
parents:
diff changeset
59 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
60 `msgs' defaults to all
bce86c4163a3 Initial revision
kono
parents:
diff changeset
61 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
62 `\-datefield date'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
63 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
64 `\-notextfield'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
65 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
66 `\-noverbose'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
67 .Ds
bce86c4163a3 Initial revision
kono
parents:
diff changeset
68 `\-nolimit'
bce86c4163a3 Initial revision
kono
parents:
diff changeset
69 .Co
bce86c4163a3 Initial revision
kono
parents:
diff changeset
70 If a folder is given, it will become the current folder.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
71 If the current message is moved, \fIsortm\fR will preserve its status
bce86c4163a3 Initial revision
kono
parents:
diff changeset
72 as current.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
73 .Hi
bce86c4163a3 Initial revision
kono
parents:
diff changeset
74 Timezones used to be ignored when comparing dates:
bce86c4163a3 Initial revision
kono
parents:
diff changeset
75 they aren't any more.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
76
bce86c4163a3 Initial revision
kono
parents:
diff changeset
77 Messages which were in the folder, but not specified by `msgs',
bce86c4163a3 Initial revision
kono
parents:
diff changeset
78 used to be moved to the end of the folder;
bce86c4163a3 Initial revision
kono
parents:
diff changeset
79 now such messages are left untouched.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
80
bce86c4163a3 Initial revision
kono
parents:
diff changeset
81 \fISortm\fP sometimes did not preserve the message
bce86c4163a3 Initial revision
kono
parents:
diff changeset
82 numbering in a folder (e.g., messages
bce86c4163a3 Initial revision
kono
parents:
diff changeset
83 1, 3, and 5, might have been renumbered
bce86c4163a3 Initial revision
kono
parents:
diff changeset
84 to 1, 2, 3 after sorting).
bce86c4163a3 Initial revision
kono
parents:
diff changeset
85 This was a bug, and has been fixed.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
86 To compress the message numbering in a folder, use
bce86c4163a3 Initial revision
kono
parents:
diff changeset
87 \*(lq\fIfolder\ \-pack\fR\|\*(rq as always.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
88 .Bu
bce86c4163a3 Initial revision
kono
parents:
diff changeset
89 If \fIsortm\fR encounters a message without a date\-field,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
90 or if the message has a date\-field that \fIsortm\fR cannot parse,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
91 then \fIsortm\fR attempts to keep the message in the same relative
bce86c4163a3 Initial revision
kono
parents:
diff changeset
92 position.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
93 This does not always work.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
94 For instance, if the first message encountered lacks a date which can be
bce86c4163a3 Initial revision
kono
parents:
diff changeset
95 parsed,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
96 then it will usually be placed at the end of the messages being sorted.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
97
bce86c4163a3 Initial revision
kono
parents:
diff changeset
98 When \fIsortm\fR complains about a message which it can't temporally order,
bce86c4163a3 Initial revision
kono
parents:
diff changeset
99 it complains about the message number \fIprior\fR to sorting.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
100 It should indicate what the message number will be \fIafter\fR sorting.
bce86c4163a3 Initial revision
kono
parents:
diff changeset
101 .En