.RB [ \-clear " | " \-noclear ]
.RB [ \-form
.IR formatfile ]
-.RB [ \-format
-.IR string ]
.RB [ \-width
.IR columns ]
-.RB [ \-reverse " | " \-noreverse ]
.RB [ \-file
.IR filename ]
.RB [ \-version ]
folder or messages. Each
.B scan
line contains the message number
-(name), the date, the \*(lqFrom:\*(rq field, the \*(lqSubject\*(rq field,
-and, if room allows, some of the body of the message. For example:
+(name), the date, the \*(lqFrom:\*(rq field and the \*(lqSubject\*(rq field.
+For example:
.PP
.RS 5
.nf
.ta \w'15+- 'u +\w'07/\|05x 'u +\w'Dcrocker 'u
-15+ 10/\|05 crocker nned\0\0<<Last week I asked some of
-16\- 10/\|05 crocker message id format\0\0\<<I recommend
+15+ 10/\|05 crocker nned
+16\- 10/\|05 crocker message id format
18 10/\|06 brien Re: Exit status from mkdir
19 10/\|07*brien \*(lqscan\*(rq listing format in nmh
.fi
The `*' on message 19 indicates that no \*(lqDate:\*(rq header was
present. The time of last modification of the message is given instead.
.PP
-If there is sufficient room left on the
-.B scan
-line after the
-subject, the line will be filled with text from the body, preceded by
-\*(lq<<\*(rq, and terminated by \*(lq>>\*(rq if the body is sufficiently short.
.B Scan
actually reads each of the specified messages and parses them to extract
the desired fields. During parsing, appropriate error messages will be
character set, if it is not US-ASCII. See the mh-profile(5) man
page for details about this environment variable.
.PP
-The switch
-.BR \-reverse ,
-makes
-.B scan
-list the messages in reverse
-order.
-.PP
The
.B \-file
.I filename
.BR packf .
This listing
includes every message in the file (you can't scan individual messages).
-The switch
-.B \-reverse
-is ignored with this option.
.PP
The switch
.B \-width
To override the output format used by
.BR scan ,
the
-.B \-format
-.I string
-or
.B \-form
.I file
-switches are used. This permits individual fields of
-the scan listing to be extracted with ease. The string is simply a format
-string and the file is simply a format file. See
+switch is used. This permits individual fields of
+the scan listing to be extracted with ease.
+.I file
+is either the name of a format file or a format string directly,
+if prepended with an equal sign `='.
+See
.BR mh\-format (5)
for the details.
.PP
.nf
.ta \w'Dtimenow 'u +\w'Returns 'u
.I Escape Returns Description
-body string the (compressed) first part of the body
dtimenow date the current date
folder string the name of the current folder
.fi
.nf
.RB ` +folder "' defaults to the current folder"
.RB ` msgs "' defaults to all"
-.RB ` \-format "' defaulted as described above"
+.RB ` \-form "' defaulted as described above"
.RB ` \-width "' defaulted to the width of the terminal"
.fi
.SH BUGS
The argument to the
-.B \-format
+.B \-form
switch must be interpreted as a single
token by the shell that invokes
.BR scan .