4 .TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
6 scan \- produce a one line per message scan listing
24 produces a one\-line\-per\-message listing of the specified
25 folder or messages. Each
27 line contains the message number
28 (name), the date, the `From:' field and the `Subject' field.
33 .ta \w'15+- 'u +\w'07/\|05x 'u +\w'Dcrocker 'u
34 15+ 10/\|05 crocker nned
35 16\- 10/\|05 crocker message id format
36 18 10/\|06 brien Re: Exit status from mkdir
37 19 10/\|07*brien `scan' listing format in nmh
41 The `+' on message 15 indicates that it is the current message.
43 The `\-' on message 16 indicates that it has been replied to, as indicated
44 by a `Replied:' component (produced by the
51 The `*' on message 19 indicates that no `Date:' header was
52 present. The time of last modification of the message is given instead.
55 actually reads each of the specified messages and parses them to extract
56 the desired fields. During parsing, appropriate error messages will be
57 produced if there are format errors in any of the messages.
61 will decode RFC-2047 (MIME) encoding in
64 will only decode these fields if your
65 terminal can natively display the character set used in the encoding.
66 You should set the MM_CHARSET environment variable to your native
67 character set, if it is not US-ASCII. See the mh-profile(5) man
68 page for details about this environment variable.
73 switch allows the user to obtain a
75 listing of a maildrop file as produced by
78 includes every message in the file (you can't scan individual messages).
83 may be used to specify the width of
84 the scan line. The default is to use the width of the terminal.
89 (scan | pr ; show a \-showproc pr) | lpr
92 produces a scan listing of the current folder,
93 followed by a formatted listing of all messages in the folder, one
95 .RB ` "\-showproc\ pr" '
96 will cause the messages to be
97 concatenated, separated by a one\-line header and two blank lines.
99 To override the output format used by
104 switch is used. This permits individual fields of
105 the scan listing to be extracted with ease.
107 is either the name of a format file or a format string directly,
108 if prepended with an equal sign `='.
113 In addition to the standard
117 also recognizes the following additional
123 .ta \w'Dtimenow 'u +\w'Returns 'u
124 .I "Escape Returns Description
125 dtimenow date the current date
126 folder string the name of the current folder
130 If no date header is present in the message, the
135 will return values for the date of last
136 modification of the message file itself. This feature is handy for
137 scanning a draft folder, as message drafts usually aren't allowed
138 to have dates in them.
143 context prior to starting the listing,
144 so interrupting a long
146 listing preserves the new context.
148 purists hate this idea.
153 .ta \w'%etcdir%/ExtraBigFileName 'u
154 ^$HOME/.mmh/profile~^The user profile
157 .SH "PROFILE COMPONENTS"
161 .ta \w'ExtraBigProfileName 'u
162 ^Path:~^To determine the user's mail storage
163 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
164 ^Current\-Folder:~^To find the default current folder
168 inc(1), pick(1), show(1), mh\-format(5)
172 .RB ` +folder "' defaults to the current folder"
173 .RB ` msgs "' defaults to all"
174 .RB ` \-form "' defaulted as described above"
175 .RB ` \-width "' defaulted to the width of the terminal"
179 If a folder is given, it will become the current folder.
187 contents of the first message header
190 corresponding component name; any following headers with the same
191 component name are ignored.