.IR formatfile ]
.RB [ \-format
.IR string ]
-.RB [ \-header " | " \-noheader ]
.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
may be used to specify the width of
the scan line. The default is to use the width of the terminal.
.PP
-The
-.B \-header
-switch produces a header line prior to the
-.B scan
-listing. Currently, the name of the folder and the current date and
-time are output (see the
-.B HISTORY
-section for more information).
-.PP
If the
.B \-clear
switch is used and
For example, the command:
.PP
.RS 5
-(scan \-clear \-header; show all \-show pr \-f) | lpr
+(scan \-clear ; show all \-show pr \-f) | lpr
.RE
.PP
produces a scan listing of the current folder, followed by a formfeed,
.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
.RB ` +folder "' defaults to the current folder"
.RB ` msgs "' defaults to all"
.RB ` \-format "' defaulted as described above"
-.RB ` \-noheader '
.RB ` \-width "' defaulted to the width of the terminal"
.fi
.SH CONTEXT
If a folder is given, it will become the current folder.
-.SH HISTORY
-Prior to using the format string mechanism,
-.B \-header
-used to generate
-a heading saying what each column in the listing was. Format strings
-prevent this from happening.
-
.SH BUGS
The argument to the
.B \-format