Support for the new world format API for comp and forw.
[mmh] / man / new.man
1 .TH NEW %manext1% "January 17, 2009" "%nmhversion%"
2 .\"
3 .\" %nmhwarning%
4 .\"
5 .SH NAME
6 new \- report on folders with new messages
7 .PP
8 fnext \- set current folder to next folder with new messages
9 .PP
10 fprev \- set current folder to previous folder with new messages
11 .PP
12 unseen \- scan new messages in all folders with new messages
13 .SH SYNOPSIS
14 .HP 5
15 .na
16 .B new
17 .RI [ sequences ]
18 .RB [ \-mode
19 .IR mode ]
20 .RB [ \-folders
21 .IR foldersfile ]
22 .RB [ \-version ]
23 .RB [ \-help ]
24 .PP
25 .HP 5
26 .B fnext
27 is equivalent to
28 .B new \-mode fnext
29 .PP
30 .HP 5
31 .B fprev
32 is equivalent to
33 .B new \-mode fprev
34 .PP
35 .HP 5
36 .B unseen
37 is equivalent to
38 .B new \-mode unseen
39 .ad
40 .SH DESCRIPTION
41 .B New
42 in its default mode produces a one\-line\-per\-folder listing of all
43 folders containing messages in the listed
44 .IR sequences
45 or in the sequences listed in the profile entry
46 .RI \*(lq Unseen-Sequence \*(rq.
47 Each line contains the folder, the number of messages in the desired
48 sequences, and the message lists from the .mh_sequences file.  For example:
49 .PP
50 .RS 5
51 .nf
52 foo     11.* 40\-50
53 bar    380.  760\-772 824\-828
54  total    391.
55 .fi
56 .RE
57 .PP
58 The `*' on foo indicates that it is the current folder.  The last line shows
59 the total number of messages in the desired sequences.
60 .PP
61 .B New
62 crawls the folder hierarchy recursively to find all folders, and prints them
63 in lexicographic order.  Override this behavior by providing
64 .IR foldersfile
65 containing the pre-sorted list of folders
66 .B new
67 should check, one per line.
68 .PP
69 In
70 .B fnext
71 and
72 .B fprev
73 modes,
74 .B new
75 instead changes to the next or previous matching folder, respectively.
76 .PP
77 In
78 .B unseen
79 mode,
80 .B new
81 executes
82 .B scan sequences
83 for each matching folder.
84 .SH FILES
85 .fc ^ ~
86 .nf
87 .ta \w'%etcdir%/ExtraBigFileName  'u
88 ^$HOME/\&.mh\(ruprofile~^The user profile
89 .fi
90 .SH "PROFILE COMPONENTS"
91 .fc ^ ~
92 .nf
93 .ta 2.4i
94 .ta \w'ExtraBigProfileName  'u
95 ^Path:~^To determine the user's nmh directory
96 ^Current\-Folder:~^To find the default current folder
97 ^Unseen-Sequence:~^The name of the unseen message sequence
98 .fi
99 .SH "SEE ALSO"
100 .IR scan (1),
101 .IR mh\-format (5)