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

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .TH FLIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
   6 .SH NAME
   7 flist, flists \- list the number of messages in given sequence(s)
   8 .SH SYNOPSIS
   9 .HP 5
  10 .B flist
  11 .RI [ +folder1
  12 .RI [ +folder2
  13 \&...]]
  14 .RB [ \-sequence
  15 .I name1
  16 .RB [ \-sequence
  17 .I name2
  18 \&...]]
  19 .RB [ \-all " | " \-noall ]
  20 .RB [ \-showzero " | " \-noshowzero ]
  21 .RB [ \-recurse " | " \-norecurse ]
  22 .RB [ \-alpha " | " \-noalpha ]
  23 .RB [ \-fast " | " \-nofast ]
  24 .RB [ \-version ]
  25 .RB [ \-help ]
  26
  27 .PP
  28 .HP 5
  29 .B flists
  30 is equivalent to
  31 .B flist -all
  32 .SH DESCRIPTION
  33 .B Flist
  34 is used to search a list of folders and display the number
  35 of messages in these folders that are in a given sequence or set of
  36 sequences (for example the
  37 .RI \*(lq unseen \*(rq
  38 sequence). This is especially
  39 useful if you use some mechanism such as
  40 .B slocal
  41 or
  42 .B procmail
  43 (typically in conjunction with
  44 .BR rcvstore )
  45 to pre-sort your mail into different folders before you view it.
  46 .PP
  47 By default, the command
  48 .B flist
  49 will search the current folder for the given sequence or sequences (usually
  50 .RI \*(lq unseen \*(rq).
  51 If (possibly multiple) folders are specified on the command line with
  52 .IR +folder ,
  53 then all these folders are searched for the given sequence(s).
  54 .B Flist
  55 will display for each folder searched, the number of messages in each of the
  56 specified sequences, and the total number of messages.
  57 .PP
  58 The option
  59 .B \-sequence
  60 is used to specify the name of a sequence in
  61 which to search for.  This option may be used multiple times to specify
  62 multiple sequences.  If this is not given, then the default is to search
  63 for all the sequences specified by the
  64 .RI \*(lq Unseen-Sequence \*(rq
  65 profile component. For more details about sequences, read the
  66 .BR mh\-sequence (5)
  67 man page.
  68 .PP
  69 Typically,
  70 .B flist
  71 will produce a line for each sequence, for every
  72 folder that is searched, even those which do not contain any messages in
  73 the given sequence.  Specifying
  74 .B \-noshowzero
  75 will cause
  76 .B flist
  77 to print only those folder/sequence combinations such the folder has a non-zero
  78 number of messages in the given specified sequence.
  79 .PP
  80 If
  81 .B \-recurse
  82 is given, then for each folder that is search,
  83 .B flist
  84 will also recursively descend into those folders to search subfolders
  85 for the given sequence.
  86 .PP
  87 If
  88 .B \-fast
  89 is given, only the names of the folders searched will be displayed, and
  90 .B flist
  91 will suppress all other output.  If this option is used in conjunction with
  92 .BR \-noshowzero ,
  93 then
  94 .B flist
  95 will only print the names of those folders searched that contain messages in
  96 in at least one of the specified sequences.
  97
  98 .SS "Multiple Folders"
  99 If the option
 100 .B \-all
 101 is given (and no folders are specified with
 102 .IR +folder ),
 103 then
 104 .B flist
 105 will search all the folders in the top
 106 level of the users nmh directory.  These folders are all preceded by
 107 the read\-only folders, which occur as
 108 .RI \*(lq atr\-cur\- \*(rq
 109 entries in the user's
 110 .B nmh
 111 context.
 112 .PP
 113 An example of the output of
 114 .B flist
 115 .B \-all
 116 is:
 117 .PP
 118 .RS 5
 119 .nf
 120 /work/Mail  has  5 in sequence unseen (private); out of  46
 121 inbox+      has 10 in sequence unseen          ; out of 153
 122 junklist    has  0 in sequence unseen          ; out of  63
 123 postmaster  has  1 in sequence unseen          ; out of   3
 124 .fi
 125 .RE
 126 .PP
 127 The \*(lq+\*(rq after
 128 .I inbox
 129 indicates that it is the current folder.
 130 .PP
 131 The \*(lqprivate\*(rq flag indicates that the given sequence for
 132 that folder is private.  See the
 133 .BR mh\-sequence (5)
 134 man page for details about private sequences.
 135 .PP
 136 If the option
 137 .B \-all
 138 and
 139 .I +folder
 140 are both specified, then
 141 .B flist
 142 will search this folder, and all its first level subfolders for the
 143 given sequence.  You may specify multiple folders in this way.
 144 .PP
 145 If
 146 .B flist
 147 is invoked by a name ending with \*(lqs\*(rq
 148 (e.g.
 149 .BR flists ),
 150 then the switch
 151 .B \-all
 152 is assumed by default.
 153 .PP
 154 The sorting order for the listing is alphabetical (with
 155 .BR \-alpha ),
 156 or in a priority order defined by the
 157 .RI \*(lq Flist-Order \*(rq
 158 profile entry (with
 159 .BR \-noalpha ).
 160 Each item in the
 161 .RI \*(lq Flist-Order \*(rq
 162 is a folder name or a
 163 folder name pattern that uses * to match zero or more characters.
 164 Longer matching patterns have precedence over shorter matching patterns.
 165 For example:
 166 .PP
 167 .RS 5
 168 .nf
 169 Flist-Order: personal petproject mh* * admin *junk
 170 .fi
 171 .RE
 172 .PP
 173 This order puts a few interesting folders first, such as those with mail
 174 addressed to you personally, those about a pet project, and those about
 175 mh-related things.  It places uninteresting folders at the end, and it
 176 puts everything else in the middle in alphabetical order.
 177
 178 .SH FILES
 179 .fc ^ ~
 180 .nf
 181 .ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
 182 ^$HOME/\&.mh\(ruprofile~^The user profile
 183
 184 .SH "PROFILE COMPONENTS"
 185 .fc ^ ~
 186 .nf
 187 .ta 2.4i
 188 .ta \w'ExtraBigProfileName  'u
 189 ^Path:~^To determine the user's nmh directory
 190 ^mh-sequences:~^File that contains public sequences
 191 ^Unseen-Sequence:~^The name of the unseen message sequence
 192 ^Flist-Order:~^To sort folders by priority
 193
 194 .SH "SEE ALSO"
 195 folder(1), rcvstore(1), slocal(1), mh\-sequence(5)
 196
 197 .SH "DEFAULTS"
 198 .nf
 199 .RB ` -sequence "' defaults to Unseen-Sequence profile entry"
 200 .RB ` \-showzero '
 201 .RB ` \-noall '
 202 .RB ` \-norecurse '
 203 .RB ` \-noalpha '
 204 .RB ` \-nofast '
 205
 206 .SH CONTEXT
 207 If
 208 .I +folder
 209 is given, it will become the current folder.
 210 If multiple folders are given, the last one specified will
 211 become the current folder.