+.TH SCAN %manext1% "November 6, 2012" "%nmhversion%"
.\"
.\" %nmhwarning%
-.\" $Id$
.\"
-.TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
.SH NAME
scan \- produce a one line per message scan listing
.SH SYNOPSIS
.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\0\0<<Last week I asked some of
+16\- 10/\|05 crocker message id format\0\0<<I recommend
18 10/\|06 brien Re: Exit status from mkdir
19 10/\|07*brien \*(lqscan\*(rq listing format in nmh
.fi
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
-.BR mh\-format (5)
+.IR mh\-format (5)
for the details.
.PP
In addition to the standard
-.BR mh\-format (5)
+.IR mh\-format (5)
escapes,
.B scan
also recognizes the following additional
.RS 5
.nf
.ta \w'Dtimenow 'u +\w'Returns 'u
-.I Escape Returns Description
+.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
scanning a draft folder, as message drafts usually aren't allowed
to have dates in them.
.PP
+The
+.B %etcdir%
+directory contains several format files as examples of customized
+.B scan
+output.
+.PP
.B scan
will update the
.B nmh
listing preserves the new context.
.B nmh
purists hate this idea.
-
.SH FILES
.fc ^ ~
.nf
.ta \w'%etcdir%/ExtraBigFileName 'u
^$HOME/\&.mh\(ruprofile~^The user profile
.fi
-
.SH "PROFILE COMPONENTS"
.fc ^ ~
.nf
^Alternate\-Mailboxes:~^To determine the user's mailboxes
^Current\-Folder:~^To find the default current folder
.fi
-
.SH "SEE ALSO"
-inc(1), pick(1), show(1), mh\-format(5)
-
+.IR pick (1),
+.IR show (1),
+.IR mh\-format (5)
.SH DEFAULTS
.nf
.RB ` +folder "' defaults to the current folder"
.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
-switch must be interpreted as a single
-token by the shell that invokes
-.BR scan .
-Therefore, one must usually
-place the argument to this switch inside double\-quotes.
-.PP
The value of each
.I component
escape is set by