]> diplodocus.org Git - nmh/blobdiff - man/scan.man
First basic test of extended parameter output: working!
[nmh] / man / scan.man
index 973003df408d07b483bf472b1ac0c6937d2f4fa6..17a702caee89c1c6cceebe6a38b9a98bebc0f45c 100644 (file)
@@ -1,4 +1,4 @@
-.TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH SCAN %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
 .\"
 .\" %nmhwarning%
 .\"
@@ -68,14 +68,17 @@ produced if there are format errors in any of the messages.
 .PP
 By default,
 .B scan
 .PP
 By default,
 .B scan
-will decode RFC-2047 (MIME) encoding in
+will decode RFC 2047 (MIME) encoding in
 these scan listings.
 .B Scan
 will only decode these fields if your
 terminal can natively display the character set used in the encoding.
 these scan listings.
 .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 ,
 .PP
 The switch
 .BR \-reverse ,
@@ -158,11 +161,11 @@ or
 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
 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
 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
 escapes,
 .B scan
 also recognizes the following additional
@@ -189,6 +192,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 %etcdir%
+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
@@ -216,7 +225,7 @@ purists hate this idea.
 .SH "SEE ALSO"
 .IR pick (1),
 .IR show (1),
 .SH "SEE ALSO"
 .IR pick (1),
 .IR show (1),
-.IR mh\-format(5)
+.IR mh\-format (5)
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
@@ -234,14 +243,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