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