Removed `-format string' switches but made -form accept `=formatstring'.

[mmh] / man / scan.man1

diff --git a/man/scan.man1 b/man/scan.man1
index ba59b45..2b9c0f6 100644 (file)
--- a/man/scan.man1
+++ b/man/scan.man1
@@ -13,8 +13,6 @@ scan \- produce a one line per message scan listing
 .RB [ \-clear " | " \-noclear ]
 .RB [ \-form
 .IR formatfile ]
-.RB [ \-format
-.IR string ]
 .RB [ \-width
 .IR columns ]
 .RB [ \-file
@@ -28,14 +26,14 @@ produces a one\-line\-per\-message listing of the specified
 folder or messages.  Each
 .B scan
 line contains the message number
-(name), the date, the \*(lqFrom:\*(rq field, the \*(lqSubject\*(rq field,
-and, if room allows, some of the body of the message.  For example:
+(name), the date, the \*(lqFrom:\*(rq field and the \*(lqSubject\*(rq field.
+For example:
 .PP
 .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
+16\-   10/\|05 crocker message id format
 18     10/\|06 brien   Re: Exit status from mkdir
 19     10/\|07*brien   \*(lqscan\*(rq listing format in nmh
 .fi
@@ -54,11 +52,6 @@ command).
 The `*' on message 19 indicates that no \*(lqDate:\*(rq header was
 present.  The time of last modification of the message is given instead.
 .PP
-If there is sufficient room left on the
-.B scan
-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
 actually reads each of the specified messages and parses them to extract
 the desired fields.  During parsing, appropriate error messages will be
@@ -129,14 +122,14 @@ concatenated, separated by a one\-line header and two blank lines.
 To override the output format used by
 .BR scan ,
 the
-.B \-format
-.I string
-or
 .B \-form
 .I file
-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
+switch is used.  This permits individual fields of
+the scan listing to be extracted with ease.
+.I file
+is either the name of a format file or a format string directly,
+if prepended with an equal sign `='.
+See
 .BR mh\-format (5)
 for the details.
 .PP
@@ -152,7 +145,6 @@ escapes:
 .nf
 .ta \w'Dtimenow  'u +\w'Returns  'u
 .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
 .fi
@@ -202,7 +194,7 @@ inc(1), pick(1), show(1), mh\-format(5)
 .nf
 .RB ` +folder "' defaults to the current folder"
 .RB ` msgs "' defaults to all"
-.RB ` \-format "' defaulted as described above"
+.RB ` \-form "' defaulted as described above"
 .RB ` \-width "' defaulted to the width of the terminal"
 .fi
 
@@ -211,7 +203,7 @@ If a folder is given, it will become the current folder.
 
 .SH BUGS
 The argument to the
-.B \-format
+.B \-form
 switch must be interpreted as a single
 token by the shell that invokes
 .BR scan .