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

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH FLIST %manext1% MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 flist, flists \- list the number of messages in given sequence(s)
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 flist
  15 \%[+folder1 [+folder2 ...]]
  16 .br
  17 \%[\-sequence\ name1 [\-sequence\ name2 ...]]
  18 .br
  19 \%[\-all] \%[\-noall]
  20 \%[\-showzero] \%[\-noshowzero]
  21 .br
  22 \%[\-recurse] \%[\-norecurse]
  23 \%[\-alpha] \%[\-noalpha]
  24 .br
  25 \%[\-fast] \%[\-nofast]
  26 \%[\-version]
  27 \%[\-help]
  28
  29 .ti .5i
  30 flists is equivalent to flist -all
  31 .in -.5i
  32 .SH DESCRIPTION
  33 This program is used to search a list of folders and display the number
  34 of messages in these folders that are in a given sequence or set of
  35 sequences (for example the \*(lqunseen\*(rq sequence). This is especially
  36 useful if you use some mechanism such as \fIslocal\fP or \fIprocmail\fP
  37 (typically in conjunction with \fIrcvstore\fP) to pre-sort your mail into
  38 different folders before you view it.
  39
  40 By default, the command \fIflist\fR will search the current folder for
  41 the given sequence or sequences (usually \*(lqunseen\*(rq).  If (possibly
  42 multiple) folders are specified on the command line with `+folder', then
  43 all these folders are searched for the given sequence(s).  \fIFlist\fR will
  44 display for each folder searched, the number of messages in each of the
  45 specified sequences, and the total number of messages.
  46
  47 The option `\-sequence' is used to specify the name of a sequence in
  48 which to search for.  This option may be used multiple times to specify
  49 multiple sequences.  If this is not given, then the default is to search
  50 for all the sequences specified by the "Unseen-Sequence" profile component.
  51 For more details about sequences, read the mh\-sequence(5) man page.
  52
  53 Typically, \fIflist\fR will produce a line for each sequence, for every
  54 folder that is searched, even those which do not contain any messages in
  55 the given sequence.  Specifying `\-noshowzero' will cause \fIflist\fR to
  56 print only those folder/sequence combinations such the folder has a non-zero
  57 number of messages in the given specified sequence.
  58
  59 If `\-recurse' is given, then for each folder that is search, \fIflist\fR
  60 will also recursively descend into those folders to search subfolders
  61 for the given sequence.
  62
  63 If `\-fast' is given, only the names of the folders searched will
  64 be displayed, and \fIflist\fR will suppress all other output.  If this
  65 option is used in conjunction with `\-noshowzero', then \fIflist\fR will
  66 only print the names of those folders searched that contain messages in
  67 in at least one of the specified sequences.
  68
  69 .Uh "Multiple Folders"
  70 If the option `\-all' is given (and no folders are specified with
  71 `+folder'), then \fIflist\fR will search all the folders in the top
  72 level of the users nmh directory.  These folders are all preceded by
  73 the read\-only folders, which occur as \*(lqatr\-cur\-\*(rq entries
  74 in the user's \fInmh\fR context.
  75
  76 An example of the output of `flist \-all' is:
  77
  78 .nf
  79 .if t .in +.5i
  80 .ta \w'/rnd/phyl/Mail/EP 'u +\w'ddd 'u +\w'new out of 'u +\w'ddd 'u
  81 /work/Mail  has  5 in sequence unseen (private); out of  46
  82 inbox+      has 10 in sequence unseen          ; out of 153
  83 junklist    has  0 in sequence unseen          ; out of  63
  84 postmaster  has  1 in sequence unseen          ; out of   3
  85 .re
  86 .if t .in -.5i
  87 .fi
  88
  89 The \*(lq+\*(rq after inbox indicates that it is the current folder.
  90
  91 The \*(lqprivate\*(rq flag indicates that the given sequence for
  92 that folder is private.  See the mh\-sequence(5) man page for details
  93 about private sequences.
  94
  95 If the option `\-all' and `+folder' are both specified, then \fIflist\fR
  96 will search this folder, and all its first level subfolders for the
  97 given sequence.  You may specify multiple folders in this way.
  98
  99 If \fIflist\fR is invoked by a name ending with \*(lqs\*(rq
 100 (e.g., \fIflists\fR\0), then the switch `\-all' is assumed by
 101 default.
 102
 103 The sorting order for the listing is alphabetical (with '\-alpha'),
 104 or in a priority order defined by the Flist-Order profile entry (with
 105 '\-noalpha').  Each item in the Flist-Order is a folder name or a
 106 folder name pattern that uses * to match zero or more characters.
 107 Longer matching patterns have precedence over shorter matching patterns.
 108 For example:
 109
 110 .nf
 111 Flist-Order: personal petproject mh* * admin *junk
 112 .fi
 113
 114 This order puts a few interesting folders first, such as those with mail
 115 addressed to you personally, those about a pet project, and those about
 116 mh-related things.  It places uninteresting folders at the end, and it
 117 puts everything else in the middle in alphabetical order.
 118 .Fi
 119 ^$HOME/\&.mh\(ruprofile~^The user profile
 120 .Pr
 121 ^Path:~^To determine the user's nmh directory
 122 .Ps
 123 ^mh-sequences:~^File that contains public sequences
 124 .Ps
 125 ^Unseen-Sequence:~^The name of the unseen message sequence
 126 .Ps
 127 ^Flist-Order:~^To sort folders by priority
 128 .Sa
 129 folder(1), rcvstore(1), slocal(1), mh\-sequence(5)
 130 .De
 131 `-sequence' defaults to Unseen-Sequence profile entry
 132 .Ds
 133 `\-showzero'
 134 .Ds
 135 `\-noall'
 136 .Ds
 137 `\-norecurse'
 138 .Ds
 139 `\-noalpha'
 140 .Ds
 141 `\-nofast'
 142 .Co
 143 If `+folder' is given, it will become the current folder.
 144 If multiple folders are given, the last one specified will
 145 become the current folder.
 146 .En