X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/95e9c4e6befb17ca3e691c26f024fb55eeae5e31..c576ad2674c37a1c63f004c71049998f38854c64:/man/flist.man diff --git a/man/flist.man b/man/flist.man index 64998b96..04f2fb1f 100644 --- a/man/flist.man +++ b/man/flist.man @@ -1,13 +1,15 @@ -.TH FLIST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] -.\" +.TH FLIST %manext1% 1999-04-30 "%nmhversion%" +. .\" %nmhwarning% -.\" +. .SH NAME -flist, flists \- list the number of messages in given sequence(s) +flist, flists \- list the number of nmh messages in given sequences .SH SYNOPSIS .HP 5 .na .B flist +.RB [ \-help ] +.RB [ \-version ] .RI [ +folder1 .RI [ +folder2 \&...]] @@ -21,8 +23,6 @@ flist, flists \- list the number of messages in given sequence(s) .RB [ \-recurse " | " \-norecurse ] .RB [ \-fast " | " \-nofast ] .RB [ \-alpha " | " \-noalpha ] -.RB [ \-version ] -.RB [ \-help ] .PP .HP 5 .B flists @@ -31,12 +31,12 @@ is equivalent to .B \-all .ad .SH DESCRIPTION -.B Flist +.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 +sequence). This is especially useful if you use some mechanism such as .B slocal or @@ -52,35 +52,34 @@ will search the current folder for the given sequence or sequences (usually 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 +.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 +The .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 +switch specifies the sequence to which messages should belong. +This switch may be given multiple times to specify multiple sequences. +If it 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 -.IR mh\-sequence (5) -man page. +profile component. For more details about sequences, read +.IR mh\-sequence (5). .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 +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. +to print only those folder/sequence combinations where the folder has a +non-zero number of messages in the given sequence. .PP If .B \-recurse -is given, then for each folder that is search, +is given, then for each folder that is searched, .B flist will also recursively descend into those folders to search subfolders for the given sequence. @@ -94,16 +93,17 @@ will suppress all other output. If this option is used in conjunction with 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 +in at least one of the specified sequences. +.SS "Multiple Folders" +If the .B \-all -is given (and no folders are specified with +switch 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 nmh directory. These folders are all preceded by -the read\-only folders, which occur as +the read-only folders, which occur as .RI \*(lq atr\-cur\- \*(rq entries in the user's .B nmh @@ -128,9 +128,9 @@ The \*(lq+\*(rq after indicates that it is the current folder. .PP The \*(lqprivate\*(rq flag indicates that the given sequence for -that folder is private. See the +that folder is private. See .IR mh\-sequence (5) -man page for details about private sequences. +for details about private sequences. .PP If the option .B \-all @@ -174,35 +174,45 @@ 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/\&.mh\(ruprofile~^The user profile -.fi +.TP 20 +$HOME/.mh_profile +The user's profile. .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^mh-sequences:~^File that contains public sequences -^Unseen-Sequence:~^The name of the unseen message sequence -^Flist-Order:~^To sort folders by priority -.fi +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory. +.TP +mh-sequences: +File that contains public sequences. +.TP +Unseen-Sequence: +The name of the unseen message sequence. +.TP +Flist-Order: +To sort folders by priority. +.PD .SH "SEE ALSO" .IR folder (1), .IR rcvstore (1), .IR slocal (1), .IR mh\-sequence (5) .SH DEFAULTS -.nf -.RB ` -sequence "' defaults to Unseen-Sequence profile entry" -.RB ` \-showzero ' -.RB ` \-noall ' -.RB ` \-norecurse ' -.RB ` \-noalpha ' -.RB ` \-nofast ' -.fi +.PD 0 +.TP 20 +-sequence +The Unseen-Sequence profile entry. +.TP +\-showzero +.TP +\-noall +.TP +\-norecurse +.TP +\-noalpha +.TP +\-nofast +.PD .SH CONTEXT If .I +folder