1FLIST(1)                     [nmh-1.2-20070115cvs]                    FLIST(1)
2
3
4

NAME

6       flist, flists - list the number of messages in given sequence(s)
7

SYNOPSIS

9       flist [+folder1 [+folder2 ...]]  [-sequence name1 [-sequence name2
10            ...]]  [-all | -noall] [-showzero | -noshowzero] [-recurse |
11            -norecurse] [-fast | -nofast] [-alpha | -noalpha] [-version]
12            [-help]
13
14       flists is equivalent to flist -all
15

DESCRIPTION

17       Flist is used to search a list of folders and  display  the  number  of
18       messages  in  these  folders  that  are  in  a given sequence or set of
19       sequences (for example the “unseen” sequence). This is especially  use‐
20       ful  if you use some mechanism such as slocal or procmail (typically in
21       conjunction with rcvstore) to pre-sort your mail into different folders
22       before you view it.
23
24       By  default,  the  command flist will search the current folder for the
25       given sequence or sequences (usually “unseen”).  If (possibly multiple)
26       folders  are specified on the command line with +folder, then all these
27       folders are searched for the given sequence(s).  Flist will display for
28       each  folder  searched, the number of messages in each of the specified
29       sequences, and the total number of messages.
30
31       The option -sequence is used to specify the name of a sequence in which
32       to  search for.  This option may be used multiple times to specify mul‐
33       tiple sequences.  If this is not given, then the default is  to  search
34       for all the sequences specified by the “Unseen-Sequence” profile compo‐
35       nent. For more details about sequences,  read  the  mh-sequence(5)  man
36       page.
37
38       Typically,  flist  will  produce  a  line  for each sequence, for every
39       folder that is searched, even those which do not contain  any  messages
40       in  the  given  sequence.   Specifying  -noshowzero will cause flist to
41       print only those folder/sequence combinations such  the  folder  has  a
42       non-zero number of messages in the given specified sequence.
43
44       If  -recurse  is given, then for each folder that is search, flist will
45       also recursively descend into those folders to  search  subfolders  for
46       the given sequence.
47
48       If  -fast is given, only the names of the folders searched will be dis‐
49       played, and flist will suppress all other output.  If  this  option  is
50       used  in  conjunction  with -noshowzero, then flist will only print the
51       names of those folders searched that contain messages in  in  at  least
52       one of the specified sequences.
53
54
55   Multiple Folders
56       If  the  option  -all  is  given  (and  no  folders  are specified with
57       +folder), then flist will search all the folders in the  top  level  of
58       the  users  nmh  directory.   These  folders  are  all  preceded by the
59       read-only folders, which occur as “atr-cur-” entries in the user's  nmh
60       context.
61
62       An example of the output of flist -all is:
63
64            /work/Mail  has  5 in sequence unseen (private); out of  46
65            inbox+      has 10 in sequence unseen          ; out of 153
66            junklist    has  0 in sequence unseen          ; out of  63
67            postmaster  has  1 in sequence unseen          ; out of   3
68
69       The “+” after inbox indicates that it is the current folder.
70
71       The “private” flag indicates that the given sequence for that folder is
72       private.  See the mh-sequence(5) man page  for  details  about  private
73       sequences.
74
75       If  the  option  -all  and  +folder are both specified, then flist will
76       search this folder, and all its first level subfolders  for  the  given
77       sequence.  You may specify multiple folders in this way.
78
79       If  flist is invoked by a name ending with “s” (e.g.  flists), then the
80       switch -all is assumed by default.
81
82       The sorting order for the listing is alphabetical (with -alpha), or  in
83       a  priority  order  defined  by  the  “Flist-Order” profile entry (with
84       -noalpha).  Each item in the “Flist-Order” is a folder name or a folder
85       name  pattern  that  uses  *  to match zero or more characters.  Longer
86       matching patterns have precedence over shorter matching patterns.   For
87       example:
88
89            Flist-Order: personal petproject mh* * admin *junk
90
91       This  order  puts  a  few interesting folders first, such as those with
92       mail addressed to you personally, those about a pet project, and  those
93       about  mh-related  things.  It places uninteresting folders at the end,
94       and it puts everything else in the middle in alphabetical order.
95
96

FILES

98       $HOME/.mh_profile          The user profile
99
100

PROFILE COMPONENTS

102       Path:                To determine the user's nmh directory
103       mh-sequences:        File that contains public sequences
104       Unseen-Sequence:     The name of the unseen message sequence
105       Flist-Order:         To sort folders by priority
106
107

SEE ALSO

109       folder(1), rcvstore(1), slocal(1), mh-sequence(5)
110
111

DEFAULTS

113       `-sequence' defaults to Unseen-Sequence profile entry
114       `-showzero'
115       `-noall'
116       `-norecurse'
117       `-noalpha'
118       `-nofast'
119
120

CONTEXT

122       If +folder is given, it will become the current  folder.   If  multiple
123       folders  are  given,  the  last  one  specified will become the current
124       folder.
125
126
127
128MH.6.8                            1 Jul 2003                          FLIST(1)
Impressum