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