Reworked the man page system and some man page contents (mmh-intro).
[mmh] / man / flist.man1
diff --git a/man/flist.man1 b/man/flist.man1
new file mode 100644 (file)
index 0000000..f505ba8
--- /dev/null
@@ -0,0 +1,215 @@
+.\"
+.\" %nmhwarning%
+.\"
+.TH FLIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.SH NAME
+flist, flists \- list the number of messages in given sequence(s)
+.SH SYNOPSIS
+.HP 5
+.na
+.B flist
+.RI [ +folder1
+.RI [ +folder2
+\&...]]
+.RB [ \-sequence
+.I name1
+.RB [ \-sequence
+.I name2
+\&...]]
+.RB [ \-all " | " \-noall ]
+.RB [ \-showzero " | " \-noshowzero ]
+.RB [ \-recurse " | " \-norecurse ]
+.RB [ \-fast " | " \-nofast ]
+.RB [ \-alpha " | " \-noalpha ]
+.RB [ \-version ]
+.RB [ \-help ]
+.PP
+.HP 5
+.B flists
+is equivalent to
+.B flist
+.B \-all
+.ad
+.SH DESCRIPTION
+.B Flist
+is used to search a list of folders and display the number
+of messages in these folders that are in a given sequence or set of
+sequences (for example the
+.RI \*(lq unseen \*(rq
+sequence). This is especially
+useful if you use some mechanism such as
+.B slocal
+or
+.B procmail
+(typically in conjunction with
+.BR rcvstore )
+to pre-sort your mail into different folders before you view it.
+.PP
+By default, the command
+.B flist
+will search the current folder for the given sequence or sequences (usually
+.RI \*(lq unseen \*(rq).
+If (possibly multiple) folders are specified on the command line with
+.IR +folder ,
+then all these folders are searched for the given sequence(s).
+.B Flist
+will display for each folder searched, the number of messages in each of the
+specified sequences, and the total number of messages.
+.PP
+The option
+.B \-sequence
+is used to specify the name of a sequence in
+which to search for.  This option may be used multiple times to specify
+multiple sequences.  If this is not given, then the default is to search
+for all the sequences specified by the
+.RI \*(lq Unseen-Sequence \*(rq
+profile component. For more details about sequences, read the
+.BR mh\-sequence (7)
+man page.
+.PP
+Typically,
+.B flist
+will produce a line for each sequence, for every
+folder that is searched, even those which do not contain any messages in
+the given sequence.  Specifying
+.B \-noshowzero
+will cause
+.B flist
+to print only those folder/sequence combinations such the folder has a non-zero
+number of messages in the given specified sequence.
+.PP
+If
+.B \-recurse
+is given, then for each folder that is search,
+.B flist
+will also recursively descend into those folders to search subfolders
+for the given sequence.
+.PP
+If
+.B \-fast
+is given, only the names of the folders searched will be displayed, and
+.B flist
+will suppress all other output.  If this option is used in conjunction with
+.BR \-noshowzero ,
+then
+.B flist
+will only print the names of those folders searched that contain messages in
+in at least one of the specified sequences.
+
+.SS "Multiple Folders"
+If the option
+.B \-all
+is given (and no folders are specified with
+.IR +folder ),
+then
+.B flist
+will search all the folders in the top
+level of the users mmh directory.  These folders are all preceded by
+the read\-only folders, which occur as
+.RI \*(lq atr\-cur\- \*(rq
+entries in the user's
+.B mmh
+context.
+.PP
+An example of the output of
+.B flist
+.B \-all
+is:
+.PP
+.RS 5
+.nf
+/work/Mail  has  5 in sequence unseen (private); out of  46
+inbox+      has 10 in sequence unseen          ; out of 153
+junklist    has  0 in sequence unseen          ; out of  63
+postmaster  has  1 in sequence unseen          ; out of   3
+.fi
+.RE
+.PP
+The \*(lq+\*(rq after
+.I inbox
+indicates that it is the current folder.
+.PP
+The \*(lqprivate\*(rq flag indicates that the given sequence for
+that folder is private.  See the
+.BR mh\-sequence (7)
+man page for details about private sequences.
+.PP
+If the option
+.B \-all
+and
+.I +folder
+are both specified, then
+.B flist
+will search this folder, and all its first level subfolders for the
+given sequence.  You may specify multiple folders in this way.
+.PP
+If
+.B flist
+is invoked by a name ending with \*(lqs\*(rq
+(e.g.
+.BR flists ),
+then the switch
+.B \-all
+is assumed by default.
+.PP
+The sorting order for the listing is alphabetical (with
+.BR \-alpha ),
+or in a priority order defined by the
+.RI \*(lq Flist-Order \*(rq
+profile entry (with
+.BR \-noalpha ).
+Each item in the
+.RI \*(lq Flist-Order \*(rq
+is a folder name or a
+folder name pattern that uses * to match zero or more characters.
+Longer matching patterns have precedence over shorter matching patterns.
+For example:
+.PP
+.RS 5
+.nf
+Flist-Order: personal petproject mh* * admin *junk
+.fi
+.RE
+.PP
+This order puts a few interesting folders first, such as those with mail
+addressed to you personally, those about a pet project, and those about
+mh-related things.  It places uninteresting folders at the end, and it
+puts everything else in the middle in alphabetical order.
+
+.SH FILES
+.fc ^ ~
+.nf
+.ta \w'%etcdir%/ExtraBigFileName  'u
+^$HOME/.mmh/profile~^The user profile
+.fi
+
+.SH "PROFILE COMPONENTS"
+.fc ^ ~
+.nf
+.ta 2.4i
+.ta \w'ExtraBigProfileName  'u
+^Path:~^To determine the user's mail storage
+^Mh-Sequences:~^File that contains public sequences
+^Unseen-Sequence:~^The name of the unseen message sequence
+^Flist-Order:~^To sort folders by priority
+.fi
+
+.SH "SEE ALSO"
+folder(1), rcvstore(1), slocal(1), mh\-sequence(7)
+
+.SH DEFAULTS
+.nf
+.RB ` -sequence "' defaults to Unseen-Sequence profile entry"
+.RB ` \-showzero '
+.RB ` \-noall '
+.RB ` \-norecurse '
+.RB ` \-noalpha '
+.RB ` \-nofast '
+.fi
+
+.SH CONTEXT
+If
+.I +folder
+is given, it will become the current folder.
+If multiple folders are given, the last one specified will
+become the current folder.