.B scan
.RI [ +folder ]
.RI [ msgs ]
-.RB [ \-clear " | " \-noclear ]
.RB [ \-form
.IR formatfile ]
-.RB [ \-format
-.IR string ]
.RB [ \-width
.IR columns ]
-.RB [ \-reverse " | " \-noreverse ]
.RB [ \-file
.IR filename ]
-.RB [ \-version ]
+.RB [ \-Version ]
.RB [ \-help ]
.ad
.SH DESCRIPTION
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 `From:' field and the `Subject' 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
+19 10/\|07*brien `scan' listing format in mmh
.fi
.RE
.PP
The `+' on message 15 indicates that it is the current message.
.PP
The `\-' on message 16 indicates that it has been replied to, as indicated
-by a \*(lqReplied:\*(rq component (produced by the
+by a `Replied:' component (produced by the
.B \-annotate
switch
to the
.B repl
command).
.PP
-The `*' on message 19 indicates that no \*(lqDate:\*(rq header was
+The `*' on message 19 indicates that no `Date:' 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
-If the
-.B \-clear
-switch is used and
-.BR scan 's
-output is directed
-to a terminal, then
-.B scan
-will consult the environment variables
-.B $TERM
-and
-.B $TERMCAP
-to determine your terminal type in order
-to find out how to clear the screen prior to exiting. If the
-.B \-clear
-switch is used and
-.BR scan 's
-output is not directed to a terminal
-(e.g., a pipe or a file), then
-.B scan
-will send a formfeed prior
-to exiting.
-.PP
-For example, the command:
+The command:
.PP
.RS 5
-(scan \-clear ; show all \-show pr \-f) | lpr
+(scan | pr ; show a \-showproc pr) | lpr
.RE
.PP
-produces a scan listing of the current folder, followed by a formfeed,
+produces a scan listing of the current folder,
followed by a formatted listing of all messages in the folder, one
per page. Omitting
-.RB \*(lq "\-show\ pr\ \-f" \*(rq
+.RB ` "\-showproc\ pr" '
will cause the messages to be
concatenated, separated by a one\-line header and two blank lines.
.PP
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
.RS 5
.nf
.ta \w'Dtimenow 'u +\w'Returns 'u
-.I Escape Returns Description
-body string the (compressed) first part of the body
+.I "Escape Returns Description
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
If a folder is given, it will become the current folder.
.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
projects / mmh / blobdiff