diplodocus.org Git - nmh/blob - man/flist.man

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