expect this commit to be force-replaced periodically

[nmh] / man / scan.man

diff --git a/man/scan.man b/man/scan.man
index 15b9efca7437c971f5b897cfb3d6e2e51bb0695c..7a7396d691367acd98360cc11691d3d9d20b01b4 100644 (file)
--- a/man/scan.man
+++ b/man/scan.man
@@ -1,9 +1,9 @@
-.TH SCAN %manext1% 2014-01-20 "%nmhversion%"
-.\"
+.TH SCAN %manext1% 2020-02-17 "%nmhversion%"
+.
 .\" %nmhwarning%
-.\"
+.
 .SH NAME
-scan \- produce a one line per nmh message scan listing
+scan \- produce a summary listing of nmh messages
 .SH SYNOPSIS
 .HP 5
 .na
@@ -26,7 +26,7 @@ scan \- produce a one line per nmh message scan listing
 .ad
 .SH DESCRIPTION
 .B scan
-produces a one\-line\-per\-message listing of the specified
+produces a one-line-per-message listing of the specified
 folder or messages.  Each
 .B scan
 line contains the message number
@@ -92,13 +92,25 @@ The
 .I filename
 switch allows the user to obtain a
 .B scan
-listing of a mail drop file as produced by
-.BR packf .
+listing of a mail drop.
 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.
+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
@@ -148,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
-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 ,
@@ -182,6 +194,10 @@ folder     string  the name of the current folder
 .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
@@ -211,7 +227,7 @@ purists hate this idea.
 .fc ^ ~
 .nf
 .ta \w'%nmhetcdir%/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+^$HOME/.mh_profile~^The user profile
 .fi
 .SH "PROFILE COMPONENTS"
 .fc ^ ~