4 .TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
6 scan \- produce a one line per message scan listing
13 .RB [ \-clear " | " \-noclear ]
25 produces a one\-line\-per\-message listing of the specified
26 folder or messages. Each
28 line contains the message number
29 (name), the date, the \*(lqFrom:\*(rq field and the \*(lqSubject\*(rq field.
34 .ta \w'15+- 'u +\w'07/\|05x 'u +\w'Dcrocker 'u
35 15+ 10/\|05 crocker nned
36 16\- 10/\|05 crocker message id format
37 18 10/\|06 brien Re: Exit status from mkdir
38 19 10/\|07*brien \*(lqscan\*(rq listing format in nmh
42 The `+' on message 15 indicates that it is the current message.
44 The `\-' on message 16 indicates that it has been replied to, as indicated
45 by a \*(lqReplied:\*(rq component (produced by the
52 The `*' on message 19 indicates that no \*(lqDate:\*(rq header was
53 present. The time of last modification of the message is given instead.
56 actually reads each of the specified messages and parses them to extract
57 the desired fields. During parsing, appropriate error messages will be
58 produced if there are format errors in any of the messages.
62 will decode RFC-2047 (MIME) encoding in
65 will only decode these fields if your
66 terminal can natively display the character set used in the encoding.
67 You should set the MM_CHARSET environment variable to your native
68 character set, if it is not US-ASCII. See the mh-profile(5) man
69 page for details about this environment variable.
74 switch allows the user to obtain a
76 listing of a maildrop file as produced by
79 includes every message in the file (you can't scan individual messages).
84 may be used to specify the width of
85 the scan line. The default is to use the width of the terminal.
94 will consult the environment variables
98 to determine your terminal type in order
99 to find out how to clear the screen prior to exiting. If the
103 output is not directed to a terminal
104 (e.g., a pipe or a file), then
106 will send a formfeed prior
109 For example, the command:
112 (scan \-clear ; show all \-show pr \-f) | lpr
115 produces a scan listing of the current folder, followed by a formfeed,
116 followed by a formatted listing of all messages in the folder, one
118 .RB \*(lq "\-show\ pr\ \-f" \*(rq
119 will cause the messages to be
120 concatenated, separated by a one\-line header and two blank lines.
122 To override the output format used by
127 switch is used. This permits individual fields of
128 the scan listing to be extracted with ease.
130 is either the name of a format file or a format string directly,
131 if prepended with an equal sign `='.
136 In addition to the standard
140 also recognizes the following additional
146 .ta \w'Dtimenow 'u +\w'Returns 'u
147 .I Escape Returns Description
148 dtimenow date the current date
149 folder string the name of the current folder
153 If no date header is present in the message, the
158 will return values for the date of last
159 modification of the message file itself. This feature is handy for
160 scanning a draft folder, as message drafts usually aren't allowed
161 to have dates in them.
166 context prior to starting the listing,
167 so interrupting a long
169 listing preserves the new context.
171 purists hate this idea.
176 .ta \w'%etcdir%/ExtraBigFileName 'u
177 ^$HOME/.mmh/profile~^The user profile
180 .SH "PROFILE COMPONENTS"
184 .ta \w'ExtraBigProfileName 'u
185 ^Path:~^To determine the user's mail storage
186 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
187 ^Current\-Folder:~^To find the default current folder
191 inc(1), pick(1), show(1), mh\-format(5)
195 .RB ` +folder "' defaults to the current folder"
196 .RB ` msgs "' defaults to all"
197 .RB ` \-form "' defaulted as described above"
198 .RB ` \-width "' defaulted to the width of the terminal"
202 If a folder is given, it will become the current folder.
207 switch must be interpreted as a single
208 token by the shell that invokes
210 Therefore, one must usually
211 place the argument to this switch inside double\-quotes.
218 contents of the first message header
221 corresponding component name; any following headers with the same
222 component name are ignored.