expect this commit to be force-replaced periodically

[nmh] / man / scan.man

diff --git a/man/scan.man b/man/scan.man
index 2d3d43cfacb5158db2341e403a34d70413dce5e7..7a7396d691367acd98360cc11691d3d9d20b01b4 100644 (file)
--- a/man/scan.man
+++ b/man/scan.man
@@ -1,13 +1,15 @@
-.TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
-.\"
+.TH SCAN %manext1% 2020-02-17 "%nmhversion%"
+.

 .\" %nmhwarning%
 .\" %nmhwarning%

-.\"
+.

 .SH NAME
 .SH NAME

-scan \- produce a one line per message scan listing
+scan \- produce a summary listing of nmh messages

 .SH SYNOPSIS
 .HP 5
 .na
 .B scan
 .SH SYNOPSIS
 .HP 5
 .na
 .B scan

+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ +folder ]
 .RI [ msgs ]
 .RB [ \-clear " | " \-noclear ]
 .RI [ +folder ]
 .RI [ msgs ]
 .RB [ \-clear " | " \-noclear ]


@@ -21,12 +23,10 @@ scan \- produce a one line per message scan listing
 .RB [ \-reverse " | " \-noreverse ]
 .RB [ \-file
 .IR filename ]
 .RB [ \-reverse " | " \-noreverse ]
 .RB [ \-file
 .IR filename ]

-.RB [ \-version ]
-.RB [ \-help ]

 .ad
 .SH DESCRIPTION
 .ad
 .SH DESCRIPTION

-.B Scan
-produces a one\-line\-per\-message listing of the specified
+.B scan
+produces a one-line-per-message listing of the specified

 folder or messages.  Each
 .B scan
 line contains the message number
 folder or messages.  Each
 .B scan
 line contains the message number


@@ -61,21 +61,24 @@ If there is sufficient room left on the
 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.
 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
+.B scan

 actually reads each of the specified messages and parses them to extract
 the desired fields.  During parsing, appropriate error messages will be
 produced if there are format errors in any of the messages.
 .PP
 By default,
 .B scan
 actually reads each of the specified messages and parses them to extract
 the desired fields.  During parsing, appropriate error messages will be
 produced if there are format errors in any of the messages.
 .PP
 By default,
 .B scan

-will decode RFC-2047 (MIME) encoding in
+will decode RFC 2047 (MIME) encoding in

 these scan listings.
 these scan listings.

-.B Scan
+.B scan

 will only decode these fields if your
 terminal can natively display the character set used in the encoding.
 will only decode these fields if your
 terminal can natively display the character set used in the encoding.

-You should set the MM_CHARSET environment variable to your native
-character set, if it is not US-ASCII.  See the mh-profile(5) man
-page for details about this environment variable.
+You should set the appropriate
+.IR locale (1)
+environment variables to your native
+character set, if it is not US-ASCII.  See
+.IR locale (1)
+for more details on the appropriate environment variables.

 .PP
 The switch
 .BR \-reverse ,
 .PP
 The switch
 .BR \-reverse ,


@@ -89,13 +92,25 @@ The
 .I filename
 switch allows the user to obtain a
 .B scan
 .I filename
 switch allows the user to obtain a
 .B scan

-listing of a maildrop file as produced by
-.BR packf .
+listing of a mail drop.

 This listing
 This listing

-includes every message in the file (you can't scan individual messages).
+includes every message in the mail drop (you can't scan individual messages).

 The switch
 .B \-reverse
 is ignored with this option.
 The switch
 .B \-reverse
 is ignored with this option.

+If
+.I filename
+is a file, it can be in
+.B mbox
+or
+.B MMDF
+format, as produced by
+.BR packf .
+If
+.I filename
+is a directory, it is considered to be in
+.B Maildir
+format.

 .PP
 The switch
 .B \-width
 .PP
 The switch
 .B \-width


@@ -145,7 +160,7 @@ followed by a formatted listing of all messages in the folder, one
 per page.  Omitting
 .RB \*(lq "\-show\ pr\ \-f" \*(rq
 will cause the messages to be
 per page.  Omitting
 .RB \*(lq "\-show\ pr\ \-f" \*(rq
 will cause the messages to be

-concatenated, separated by a one\-line header and two blank lines.
+concatenated, separated by a one-line header and two blank lines.

 .PP
 To override the output format used by
 .BR scan ,
 .PP
 To override the output format used by
 .BR scan ,


@@ -179,6 +194,10 @@ folder     string  the name of the current folder
 .fi
 .RE
 .PP
 .fi
 .RE
 .PP

+.RB { body }
+returns a string without MIME decoding,
+i.e.\& the MIME boundary seperator may be the first text shown.
+.PP

 If no date header is present in the message, the
 .I function
 escapes
 If no date header is present in the message, the
 .I function
 escapes


@@ -189,6 +208,12 @@ modification of the message file itself.  This feature is handy for
 scanning a draft folder, as message drafts usually aren't allowed
 to have dates in them.
 .PP
 scanning a draft folder, as message drafts usually aren't allowed
 to have dates in them.
 .PP

+The
+.B %nmhetcdir%
+directory contains several format files as examples of customized
+.B scan
+output.
+.PP

 .B scan
 will update the
 .B nmh
 .B scan
 will update the
 .B nmh


@@ -201,8 +226,8 @@ purists hate this idea.
 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'%etcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^$HOME/.mh_profile~^The user profile

 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~


@@ -234,14 +259,6 @@ used to generate
 a heading saying what each column in the listing was.  Format strings
 prevent this from happening.
 .SH BUGS
 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 quotes.
-.PP

 The value of each
 .I component
 escape is set by
 The value of each
 .I component
 escape is set by