X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/95e9c4e6befb17ca3e691c26f024fb55eeae5e31..939dea68806ab22c29755091b16236b48876442f:/man/scan.man diff --git a/man/scan.man b/man/scan.man index 2d3d43cf..8d53e30a 100644 --- a/man/scan.man +++ b/man/scan.man @@ -1,4 +1,4 @@ -.TH SCAN %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] +.TH SCAN %manext1% "November 6, 2012" "%nmhversion%" .\" .\" %nmhwarning% .\" @@ -8,6 +8,8 @@ scan \- produce a one line per message scan listing .HP 5 .na .B scan +.RB [ \-help ] +.RB [ \-version ] .RI [ +folder ] .RI [ msgs ] .RB [ \-clear " | " \-noclear ] @@ -21,11 +23,9 @@ 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 +.B scan produces a one\-line\-per\-message listing of the specified folder or messages. Each .B scan @@ -61,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. -.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 -will decode RFC-2047 (MIME) encoding in +will decode RFC 2047 (MIME) encoding in 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. -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 , @@ -189,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 @@ -201,7 +210,7 @@ purists hate this idea. .SH FILES .fc ^ ~ .nf -.ta \w'%etcdir%/ExtraBigFileName 'u +.ta \w'%nmhetcdir%/ExtraBigFileName 'u ^$HOME/\&.mh\(ruprofile~^The user profile .fi .SH "PROFILE COMPONENTS" @@ -234,14 +243,6 @@ 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