X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/95e9c4e6befb17ca3e691c26f024fb55eeae5e31..94187a80bd60baab4b9c4b949ad820d730578123:/man/scan.man?ds=sidebyside

diff --git a/man/scan.man b/man/scan.man
index 2d3d43cf..6d41cebb 100644
--- a/man/scan.man
+++ b/man/scan.man
@@ -1,13 +1,15 @@
-.TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
-.\"
+.TH SCAN %manext1% 2014-01-20 "%nmhversion%"
+.
 .\" %nmhwarning%
-.\"
+.
 .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
+.RB [ \-help ]
+.RB [ \-version ]
 .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 [ \-version ]
-.RB [ \-help ]
 .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
@@ -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.
-.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
-will decode RFC-2047 (MIME) encoding in
+will decode RFC 2047 (MIME) encoding in
 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.
-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 ,
@@ -89,7 +92,7 @@ The
 .I filename
 switch allows the user to obtain a
 .B scan
-listing of a maildrop file as produced by
+listing of a mail drop file as produced by
 .BR packf .
 This listing
 includes every message in the file (you can't scan individual messages).
@@ -145,7 +148,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 ,
@@ -179,6 +182,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
@@ -189,6 +196,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
+The
+.B %nmhetcdir%
+directory contains several format files as examples of customized
+.B scan
+output.
+.PP
 .B scan
 will update the
 .B nmh
@@ -201,8 +214,8 @@ purists hate this idea.
 .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 ^ ~
@@ -234,14 +247,6 @@ 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 quotes.
-.PP
 The value of each
 .I component
 escape is set by