X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/62780d8a7c214bbb3301402fee5a5eb980b3069d..ee9fb87fde55c25f9ab1df2cbcc6e9d21d53b235:/man/scan.man?ds=sidebyside diff --git a/man/scan.man b/man/scan.man index 0d0b7620..b9c94f48 100644 --- a/man/scan.man +++ b/man/scan.man @@ -1,7 +1,7 @@ +.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 @@ -68,7 +68,7 @@ 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 @@ -158,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 -.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 +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 +The +.B %etcdir% +directory contains several format files as examples of customized +.B scan +output. +.PP .B scan will update the .B nmh @@ -198,14 +204,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 ^$HOME/\&.mh\(ruprofile~^The user profile .fi - .SH "PROFILE COMPONENTS" .fc ^ ~ .nf @@ -215,10 +219,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 +231,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