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