X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/3d7993e40a34f52e2b6394c2f64ef0111ab886f7..8eacff500716cab8256b032c0f4dd29bc2dc16bb:/man/scan.man

diff --git a/man/scan.man b/man/scan.man
index ed782f19..7cf3a353 100644
--- a/man/scan.man
+++ b/man/scan.man
@@ -1,14 +1,15 @@
+.TH SCAN %manext1% "November 6, 2012" "%nmhversion%"
 .\"
 .\" %nmhwarning%
-.\" $Id$
 .\"
-.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 ]
@@ -22,8 +23,6 @@ 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
@@ -37,8 +36,8 @@ and, if room allows, some of the body of the message.  For example:
 .RS 5
 .nf
 .ta \w'15+- 'u +\w'07/\|05x 'u +\w'Dcrocker  'u
-15+	10/\|05 crocker	nned\0\0\*(<<Last week I asked some of
-16\-	10/\|05 crocker	message id format\0\0\*(<<I recommend
+15+	10/\|05 crocker	nned\0\0<<Last week I asked some of
+16\-	10/\|05 crocker	message id format\0\0<<I recommend
 18	10/\|06 brien	Re: Exit status from mkdir
 19	10/\|07*brien	\*(lqscan\*(rq listing format in nmh
 .fi
@@ -69,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 ,
@@ -159,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
@@ -173,7 +175,7 @@ escapes:
 .RS 5
 .nf
 .ta \w'Dtimenow  'u +\w'Returns  'u
-.I Escape	Returns	Description
+.I "Escape	Returns	Description"
 body	string	the (compressed) first part of the body
 dtimenow	date	the current date
 folder	string	the name of the current folder
@@ -190,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
@@ -199,14 +207,12 @@ so interrupting a long
 listing preserves the new context.
 .B nmh
 purists hate this idea.
-
 .SH FILES
 .fc ^ ~
 .nf
-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi
-
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
@@ -216,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"
@@ -228,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 double\-quotes.
-.PP
 The value of each
 .I component
 escape is set by