git.marmaro.de Git - mmh/blob - man/sortm.man

   1 .\"
   2 .\" %nmhwarning%
   3 .\"
   4 .TH SORTM %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   5 .SH NAME
   6 sortm \- sort messages
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B sortm
  11 .RI [ +folder ]
  12 .RI [ msgs ]
  13 .RB [ \-datefield
  14 .IR field ]
  15 .RB [ \-textfield
  16 .IR field ]
  17 .RB [ \-notextfield ]
  18 .RB [ \-limit
  19 .IR days ]
  20 .RB [ \-nolimit ]
  21 .RB [ \-verbose " | " \-noverbose ]
  22 .RB [ \-version ]
  23 .RB [ \-help ]
  24 .ad
  25 .SH DESCRIPTION
  26 .B Sortm
  27 sorts the specified messages in the named folder according
  28 to the chronological order of the \*(lqDate:\*(rq field of each message.
  29 .PP
  30 The
  31 .B \-verbose
  32 switch directs
  33 .B sortm
  34 to tell the user the general
  35 actions that it is taking to place the folder in sorted order.
  36 .PP
  37 The
  38 .B \-datefield
  39 .I field
  40 switch tells
  41 .B sortm
  42 the name of the field to
  43 use when making the date comparison.  If the user has a special field in
  44 each message, such as \*(lqBB\-Posted:\*(rq or \*(lqDelivery\-Date:\*(rq,
  45 then the
  46 .B \-datefield
  47 switch can be used to direct
  48 .B sortm
  49 which field to examine.
  50 .PP
  51 The
  52 .B \-textfield
  53 .I field
  54 switch causes
  55 .B sortm
  56 to sort messages by the specified text field.  All characters except
  57 letters and numbers are stripped and the resulting strings are sorted
  58 datefield\-major, textfield\-minor, using a case insensitive
  59 comparison.  If this field is \*(lqsubject\*(rq, any leading "re:" is
  60 stripped off.
  61 .PP
  62 With
  63 .B \-textfield
  64 .IR field ,
  65 if
  66 .B \-limit
  67 .I days
  68 is specified, messages
  69 with the same textfields that are dated within `days' of each other
  70 appear together.  Specifying
  71 .B \-nolimit
  72 makes the limit infinity.
  73 With
  74 .B \-limit
  75 .IR 0 ,
  76 the sort is instead made textfield\-major, date\-minor.
  77 .PP
  78 For example, to order a folder by date-major, grouping messages with
  79 the same subject on the same date together, use:
  80 .PP
  81 .RS 5
  82 sortm -textfield subject +folder
  83 .RE
  84
  85 .SH FILES
  86 .fc ^ ~
  87 .nf
  88 .ta \w'%etcdir%/ExtraBigFileName  'u
  89 ^$HOME/\&.mh\(ruprofile~^The user profile
  90 .fi
  91
  92 .SH "PROFILE COMPONENTS"
  93 .fc ^ ~
  94 .nf
  95 .ta 2.4i
  96 .ta \w'ExtraBigProfileName  'u
  97 ^Path:~^To determine the user's nmh directory
  98 ^Current\-Folder:~^To find the default current folder
  99 .fi
 100
 101 .SH "SEE ALSO"
 102 folder(1)
 103
 104 .SH DEFAULTS
 105 .nf
 106 .RB ` +folder "' defaults to the current folder"
 107 .RB ` msgs"' defaults to all"
 108 .RB ` \-datefield "' defaults to date"
 109 .RB ` \-notextfield '
 110 .RB ` \-noverbose '
 111 .RB ` \-nolimit '
 112 .fi
 113
 114 .SH CONTEXT
 115 If a folder is given, it will become the current folder.  If the current
 116 message is moved,
 117 .B sortm
 118 will preserve its status as current.
 119
 120 .SH HISTORY
 121 Timezones used to be ignored when comparing dates: they aren't any more.
 122 .PP
 123 Messages which were in the folder, but not specified by `msgs', used to
 124 be moved to the end of the folder; now such messages are left untouched.
 125 .PP
 126 .B Sortm
 127 sometimes did not preserve the message numbering in a folder
 128 (e.g., messages 1, 3, and 5, might have been renumbered to 1, 2, 3 after
 129 sorting).  This was a bug, and has been fixed.  To compress the message
 130 numbering in a folder, use
 131 .RB \*(lq "folder\ \-pack" \*(rq
 132 as always.
 133
 134 .SH BUGS
 135 If
 136 .B sortm
 137 encounters a message without a date\-field, or if the
 138 message has a date\-field that
 139 .B sortm
 140 cannot parse, then
 141 .B sortm
 142 attempts to keep the message in the same relative position.  This does
 143 not always work.  For instance, if the first message encountered lacks
 144 a date which can be parsed, then it will usually be placed at the end
 145 of the messages being sorted.
 146 .PP
 147 When
 148 .B sortm
 149 complains about a message which it can't temporally
 150 order, it complains about the message number
 151 .B prior
 152 to sorting.
 153 It should indicate what the message number will be
 154 .B after
 155 sorting.