4 .TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
6 scan \- produce a one line per message scan listing
13 .RB [ \-clear " | " \-noclear ]
18 .RB [ \-header " | " \-noheader ]
21 .RB [ \-reverse " | " \-noreverse ]
29 produces a one\-line\-per\-message listing of the specified
30 folder or messages. Each
32 line contains the message number
33 (name), the date, the \*(lqFrom:\*(rq field, the \*(lqSubject\*(rq field,
34 and, if room allows, some of the body of the message. For example:
38 .ta \w'15+- 'u +\w'07/\|05x 'u +\w'Dcrocker 'u
39 15+ 10/\|05 crocker nned\0\0<<Last week I asked some of
40 16\- 10/\|05 crocker message id format\0\0\<<I recommend
41 18 10/\|06 brien Re: Exit status from mkdir
42 19 10/\|07*brien \*(lqscan\*(rq listing format in nmh
46 The `+' on message 15 indicates that it is the current message.
48 The `\-' on message 16 indicates that it has been replied to, as indicated
49 by a \*(lqReplied:\*(rq component (produced by the
56 The `*' on message 19 indicates that no \*(lqDate:\*(rq header was
57 present. The time of last modification of the message is given instead.
59 If there is sufficient room left on the
62 subject, the line will be filled with text from the body, preceded by
63 \*(lq<<\*(rq, and terminated by \*(lq>>\*(rq if the body is sufficiently short.
65 actually reads each of the specified messages and parses them to extract
66 the desired fields. During parsing, appropriate error messages will be
67 produced if there are format errors in any of the messages.
71 will decode RFC-2047 (MIME) encoding in
74 will only decode these fields if your
75 terminal can natively display the character set used in the encoding.
76 You should set the MM_CHARSET environment variable to your native
77 character set, if it is not US-ASCII. See the mh-profile(5) man
78 page for details about this environment variable.
84 list the messages in reverse
90 switch allows the user to obtain a
92 listing of a maildrop file as produced by
95 includes every message in the file (you can't scan individual messages).
98 is ignored with this option.
103 may be used to specify the width of
104 the scan line. The default is to use the width of the terminal.
108 switch produces a header line prior to the
110 listing. Currently, the name of the folder and the current date and
111 time are output (see the
113 section for more information).
122 will consult the environment variables
126 to determine your terminal type in order
127 to find out how to clear the screen prior to exiting. If the
131 output is not directed to a terminal
132 (e.g., a pipe or a file), then
134 will send a formfeed prior
137 For example, the command:
140 (scan \-clear \-header; show all \-show pr \-f) | lpr
143 produces a scan listing of the current folder, followed by a formfeed,
144 followed by a formatted listing of all messages in the folder, one
146 .RB \*(lq "\-show\ pr\ \-f" \*(rq
147 will cause the messages to be
148 concatenated, separated by a one\-line header and two blank lines.
150 To override the output format used by
158 switches are used. This permits individual fields of
159 the scan listing to be extracted with ease. The string is simply a format
160 string and the file is simply a format file. See
164 In addition to the standard
168 also recognizes the following additional
174 .ta \w'Dtimenow 'u +\w'Returns 'u
175 .I Escape Returns Description
176 body string the (compressed) first part of the body
177 dtimenow date the current date
178 folder string the name of the current folder
182 If no date header is present in the message, the
187 will return values for the date of last
188 modification of the message file itself. This feature is handy for
189 scanning a draft folder, as message drafts usually aren't allowed
190 to have dates in them.
195 context prior to starting the listing,
196 so interrupting a long
198 listing preserves the new context.
200 purists hate this idea.
205 .ta \w'%etcdir%/ExtraBigFileName 'u
206 ^$HOME/\&.mh\(ruprofile~^The user profile
209 .SH "PROFILE COMPONENTS"
213 .ta \w'ExtraBigProfileName 'u
214 ^Path:~^To determine the user's nmh directory
215 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
216 ^Current\-Folder:~^To find the default current folder
220 inc(1), pick(1), show(1), mh\-format(5)
224 .RB ` +folder "' defaults to the current folder"
225 .RB ` msgs "' defaults to all"
226 .RB ` \-format "' defaulted as described above"
228 .RB ` \-width "' defaulted to the width of the terminal"
232 If a folder is given, it will become the current folder.
235 Prior to using the format string mechanism,
238 a heading saying what each column in the listing was. Format strings
239 prevent this from happening.
244 switch must be interpreted as a single
245 token by the shell that invokes
247 Therefore, one must usually
248 place the argument to this switch inside double\-quotes.
255 contents of the first message header
258 corresponding component name; any following headers with the same
259 component name are ignored.