4 .TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
6 scan \- produce a one line per message scan listing
13 .RB [ \-clear " | " \-noclear ]
27 produces a one\-line\-per\-message listing of the specified
28 folder or messages. Each
30 line contains the message number
31 (name), the date, the \*(lqFrom:\*(rq field and the \*(lqSubject\*(rq field.
36 .ta \w'15+- 'u +\w'07/\|05x 'u +\w'Dcrocker 'u
37 15+ 10/\|05 crocker nned
38 16\- 10/\|05 crocker message id format
39 18 10/\|06 brien Re: Exit status from mkdir
40 19 10/\|07*brien \*(lqscan\*(rq listing format in nmh
44 The `+' on message 15 indicates that it is the current message.
46 The `\-' on message 16 indicates that it has been replied to, as indicated
47 by a \*(lqReplied:\*(rq component (produced by the
54 The `*' on message 19 indicates that no \*(lqDate:\*(rq header was
55 present. The time of last modification of the message is given instead.
58 actually reads each of the specified messages and parses them to extract
59 the desired fields. During parsing, appropriate error messages will be
60 produced if there are format errors in any of the messages.
64 will decode RFC-2047 (MIME) encoding in
67 will only decode these fields if your
68 terminal can natively display the character set used in the encoding.
69 You should set the MM_CHARSET environment variable to your native
70 character set, if it is not US-ASCII. See the mh-profile(5) man
71 page for details about this environment variable.
76 switch allows the user to obtain a
78 listing of a maildrop file as produced by
81 includes every message in the file (you can't scan individual messages).
86 may be used to specify the width of
87 the scan line. The default is to use the width of the terminal.
96 will consult the environment variables
100 to determine your terminal type in order
101 to find out how to clear the screen prior to exiting. If the
105 output is not directed to a terminal
106 (e.g., a pipe or a file), then
108 will send a formfeed prior
111 For example, the command:
114 (scan \-clear ; show all \-show pr \-f) | lpr
117 produces a scan listing of the current folder, followed by a formfeed,
118 followed by a formatted listing of all messages in the folder, one
120 .RB \*(lq "\-show\ pr\ \-f" \*(rq
121 will cause the messages to be
122 concatenated, separated by a one\-line header and two blank lines.
124 To override the output format used by
132 switches are used. This permits individual fields of
133 the scan listing to be extracted with ease. The string is simply a format
134 string and the file is simply a format file. See
138 In addition to the standard
142 also recognizes the following additional
148 .ta \w'Dtimenow 'u +\w'Returns 'u
149 .I Escape Returns Description
150 dtimenow date the current date
151 folder string the name of the current folder
155 If no date header is present in the message, the
160 will return values for the date of last
161 modification of the message file itself. This feature is handy for
162 scanning a draft folder, as message drafts usually aren't allowed
163 to have dates in them.
168 context prior to starting the listing,
169 so interrupting a long
171 listing preserves the new context.
173 purists hate this idea.
178 .ta \w'%etcdir%/ExtraBigFileName 'u
179 ^$HOME/.mmh/profile~^The user profile
182 .SH "PROFILE COMPONENTS"
186 .ta \w'ExtraBigProfileName 'u
187 ^Path:~^To determine the user's mail storage
188 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
189 ^Current\-Folder:~^To find the default current folder
193 inc(1), pick(1), show(1), mh\-format(5)
197 .RB ` +folder "' defaults to the current folder"
198 .RB ` msgs "' defaults to all"
199 .RB ` \-format "' defaulted as described above"
200 .RB ` \-width "' defaulted to the width of the terminal"
204 If a folder is given, it will become the current folder.
209 switch must be interpreted as a single
210 token by the shell that invokes
212 Therefore, one must usually
213 place the argument to this switch inside double\-quotes.
220 contents of the first message header
223 corresponding component name; any following headers with the same
224 component name are ignored.