Added format support for zputlit function escape. It requires

[mmh] / man / scan.man

diff --git a/man/scan.man b/man/scan.man
index 3655a10..95cf428 100644 (file)
--- a/man/scan.man
+++ b/man/scan.man
@@ -1,8 +1,7 @@
+.TH SCAN %manext1% "November 4, 2012" "%nmhversion%"

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

-.\" $Id$

 .\"
 .\"

-.TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%]

 .SH NAME
 scan \- produce a one line per message scan listing
 .SH SYNOPSIS
 .SH NAME
 scan \- produce a one line per message scan listing
 .SH SYNOPSIS

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

@@ -159,11 +158,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 +172,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 +189,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

@@ -199,14 +204,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
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi
 .SH FILES
 .fc ^ ~
 .nf
 .ta \w'%etcdir%/ExtraBigFileName  'u
 ^$HOME/\&.mh\(ruprofile~^The user profile
 .fi

-

 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf
 .SH "PROFILE COMPONENTS"
 .fc ^ ~
 .nf

@@ -216,10 +219,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,17 +231,14 @@ 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
 The argument to the
 .B \-format
 .SH BUGS
 The argument to the
 .B \-format

@@ -246,7 +246,7 @@ switch must be interpreted as a single
 token by the shell that invokes
 .BR scan .
 Therefore, one must usually
 token by the shell that invokes
 .BR scan .
 Therefore, one must usually

-place the argument to this switch inside double\-quotes.
+place the argument to this switch inside quotes.

 .PP
 The value of each
 .I component
 .PP
 The value of each
 .I component