man/*.man: Fix some multi-word .B invocations.

[nmh] / man / scan.man

diff --git a/man/scan.man b/man/scan.man
index ed782f1911d5a4f6d917520abb2355940fec1a44..f3a2c83ea68b34e30facce6aa776b88a431ce765 100644 (file)
--- a/man/scan.man
+++ b/man/scan.man
@@ -1,14 +1,15 @@
-.\"
+.TH SCAN %manext1% 2014-01-20 "%nmhversion%"
+.

 .\" %nmhwarning%
 .\" %nmhwarning%

-.\" $Id$
-.\"
-.TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]
+.

 .SH NAME
 .SH NAME

-scan \- produce a one line per message scan listing
+scan \- produce a one line per nmh message scan listing

 .SH SYNOPSIS
 .HP 5
 .na
 .B scan
 .SH SYNOPSIS
 .HP 5
 .na
 .B scan

+.RB [ \-help ]
+.RB [ \-version ]

 .RI [ +folder ]
 .RI [ msgs ]
 .RB [ \-clear " | " \-noclear ]
 .RI [ +folder ]
 .RI [ msgs ]
 .RB [ \-clear " | " \-noclear ]


@@ -22,12 +23,10 @@ scan \- produce a one line per message scan listing
 .RB [ \-reverse " | " \-noreverse ]
 .RB [ \-file
 .IR filename ]
 .RB [ \-reverse " | " \-noreverse ]
 .RB [ \-file
 .IR filename ]

-.RB [ \-version ]
-.RB [ \-help ]

 .ad
 .SH DESCRIPTION
 .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
 folder or messages.  Each
 .B scan
 line contains the message number


@@ -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
 .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
 18     10/\|06 brien   Re: Exit status from mkdir
 19     10/\|07*brien   \*(lqscan\*(rq listing format in nmh
 .fi


@@ -62,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.
 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
 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.
 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.
 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 ,


@@ -90,7 +92,7 @@ The
 .I filename
 switch allows the user to obtain a
 .B scan
 .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).
 .BR packf .
 This listing
 includes every message in the file (you can't scan individual messages).


@@ -146,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
 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 ,
 .PP
 To override the output format used by
 .BR scan ,


@@ -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
 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


@@ -173,7 +175,7 @@ escapes:
 .RS 5
 .nf
 .ta \w'Dtimenow  'u +\w'Returns  'u
 .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
 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
 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
 .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.
 listing preserves the new context.
 .B nmh
 purists hate this idea.

-

 .SH FILES
 .fc ^ ~
 .nf
 .SH FILES
 .fc ^ ~
 .nf

-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
-^$HOME/\&.mh\(ruprofile~^The user profile
+.ta \w'%nmhetcdir%/ExtraBigFileName  'u
+^$HOME/.mh_profile~^The user profile

 .fi
 .fi

-

 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .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
 ^Alternate\-Mailboxes:~^To determine the user's mailboxes
 ^Current\-Folder:~^To find the default current folder
 .fi

-

 .SH "SEE ALSO"
 .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"
 .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
 .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 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 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
 .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
 The value of each
 .I component
 escape is set by