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

   1 .TH FLIST %manext1% "December 17, 2016" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 flist, flists \- list the number of messages in given sequence(s)
   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 the
  67 .IR mh\-sequence (5)
  68 man page.
  69 .PP
  70 Typically,
  71 .B flist
  72 will produce a line for each sequence, for every folder that is searched,
  73 even those which do not contain any messages in the given sequence.
  74 Specifying
  75 .B \-noshowzero
  76 will cause
  77 .B flist
  78 to print only those folder/sequence combinations where the folder has a
  79 non-zero number of messages in the given sequence.
  80 .PP
  81 If
  82 .B \-recurse
  83 is given, then for each folder that is searched,
  84 .B flist
  85 will also recursively descend into those folders to search subfolders
  86 for the given sequence.
  87 .PP
  88 If
  89 .B \-fast
  90 is given, only the names of the folders searched will be displayed, and
  91 .B flist
  92 will suppress all other output.  If this option is used in conjunction with
  93 .BR \-noshowzero ,
  94 then
  95 .B flist
  96 will only print the names of those folders searched that contain messages in
  97 in at least one of the specified sequences.
  98 .SS "Multiple Folders"
  99 If the
 100 .B \-all
 101 switch 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 .IR 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 .SH FILES
 178 .TP 20
 179 $HOME/.mh_profile
 180 The user's profile.
 181 .SH "PROFILE COMPONENTS"
 182 .PD 0
 183 .TP 20
 184 Path:
 185 To determine the user's nmh directory.
 186 .TP
 187 mh-sequences:
 188 File that contains public sequences.
 189 .TP
 190 Unseen-Sequence:
 191 The name of the unseen message sequence.
 192 .TP
 193 Flist-Order:
 194 To sort folders by priority.
 195 .PD
 196 .SH "SEE ALSO"
 197 .IR folder (1),
 198 .IR rcvstore (1),
 199 .IR slocal (1),
 200 .IR mh\-sequence (5)
 201 .SH DEFAULTS
 202 .PD 0
 203 .TP 20
 204 -sequence
 205 The Unseen-Sequence profile entry.
 206 .TP
 207 \-showzero
 208 .TP
 209 \-noall
 210 .TP
 211 \-norecurse
 212 .TP
 213 \-noalpha
 214 .TP
 215 \-nofast
 216 .PD
 217 .SH CONTEXT
 218 If
 219 .I +folder
 220 is given, it will become the current folder.
 221 If multiple folders are given, the last one specified will
 222 become the current folder.