]> diplodocus.org Git - nmh/blobdiff - man/scan.man
Added multiply format function, requested by Norm.
[nmh] / man / scan.man
index 931cd7f3c054a3d672833cfc8ccd91429d9f82a8..d63e280ec64aec09a53d5e5dfb67cddf6b83bfce 100644 (file)
@@ -1,4 +1,4 @@
-.TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.TH SCAN %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
@@ -68,14 +68,17 @@ 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
 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 ,
@@ -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
-.BR mh\-format (5)
+.IR mh\-format (5)
 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
@@ -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
+The
+.B %nmhetcdir%
+directory contains several format files as examples of customized
+.B scan
+output.
+.PP
 .B scan
 will update the
 .B nmh
@@ -201,7 +210,7 @@ purists hate this idea.
 .SH FILES
 .fc ^ ~
 .nf
-.ta \w'%etcdir%/ExtraBigFileName  'u
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi
 .SH "PROFILE COMPONENTS"
@@ -214,7 +223,9 @@ purists hate this idea.
 ^Current\-Folder:~^To find the default current folder
 .fi
 .SH "SEE ALSO"
-inc(1), pick(1), show(1), mh\-format(5)
+.IR pick (1),
+.IR show (1),
+.IR mh\-format (5)
 .SH DEFAULTS
 .nf
 .RB ` +folder "' defaults to the current folder"
@@ -232,14 +243,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