Separate out backquote expression to please Heirloom shell.

[nmh] / man / scan.man

diff --git a/man/scan.man b/man/scan.man
index 0d0b762094e28381e4e5956d1591f4692f8d1c3f..8d53e30ab525d249b79c8e6a8ae078502f3637fc 100644 (file)
--- a/man/scan.man
+++ b/man/scan.man
@@ -1,13 +1,15 @@
+.TH SCAN %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
 .\"
-.TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
 .SH NAME
 scan \- produce a one line per message scan listing
 .SH SYNOPSIS
 .HP 5
 .na
 .B scan
+.RB [ \-help ]
+.RB [ \-version ]
 .RI [ +folder ]
 .RI [ msgs ]
 .RB [ \-clear " | " \-noclear ]
@@ -21,11 +23,9 @@ 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
+.B scan
 produces a one\-line\-per\-message listing of the specified
 folder or messages.  Each
 .B scan
@@ -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 ,
@@ -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
@@ -198,14 +207,12 @@ so interrupting a long
 listing preserves the new context.
 .B nmh
 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"
 .fc ^ ~
 .nf
@@ -215,10 +222,10 @@ purists hate this idea.
 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 ^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"
@@ -227,26 +234,15 @@ inc(1), pick(1), show(1), mh\-format(5)
 .RB ` \-noheader '
 .RB ` \-width "' defaulted to the width of the terminal"
 .fi
-
 .SH CONTEXT
 If a folder is given, it will become the current folder.
-
 .SH HISTORY
 Prior to using the format string mechanism,
 .B \-header
 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