X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fscan.man1;h=73032794a9f853ecb19ced96121b51342f953625;hp=173289591e94970470cee36f0d1f93abbcc3809e;hb=32b2354dbaf4bf934936eb5b102a4a3d2fdd209a;hpb=70b2643e0da8485174480c644ad9785c84f5bff4 diff --git a/man/scan.man1 b/man/scan.man1 index 1732895..7303279 100644 --- a/man/scan.man1 +++ b/man/scan.man1 @@ -10,16 +10,13 @@ scan \- produce a one line per message scan listing .B scan .RI [ +folder ] .RI [ msgs ] -.RB [ \-clear " | " \-noclear ] .RB [ \-form .IR formatfile ] -.RB [ \-format -.IR string ] .RB [ \-width .IR columns ] .RB [ \-file .IR filename ] -.RB [ \-version ] +.RB [ \-Version ] .RB [ \-help ] .ad .SH DESCRIPTION @@ -86,52 +83,30 @@ The switch may be used to specify the width of the scan line. The default is to use the width of the terminal. .PP -If the -.B \-clear -switch is used and -.BR scan 's -output is directed -to a terminal, then -.B scan -will consult the environment variables -.B $TERM -and -.B $TERMCAP -to determine your terminal type in order -to find out how to clear the screen prior to exiting. If the -.B \-clear -switch is used and -.BR scan 's -output is not directed to a terminal -(e.g., a pipe or a file), then -.B scan -will send a formfeed prior -to exiting. -.PP -For example, the command: +The command: .PP .RS 5 -(scan \-clear ; show all \-show pr \-f) | lpr +(scan | pr ; show a \-showproc pr) | lpr .RE .PP -produces a scan listing of the current folder, followed by a formfeed, +produces a scan listing of the current folder, followed by a formatted listing of all messages in the folder, one per page. Omitting -.RB \*(lq "\-show\ pr\ \-f" \*(rq +.RB \*(lq "\-showproc\ pr" \*(rq will cause the messages to be concatenated, separated by a one\-line header and two blank lines. .PP 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 @@ -146,7 +121,7 @@ escapes: .RS 5 .nf .ta \w'Dtimenow 'u +\w'Returns 'u -.I Escape Returns Description +.I "Escape Returns Description dtimenow date the current date folder string the name of the current folder .fi @@ -196,7 +171,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 @@ -204,14 +179,6 @@ inc(1), pick(1), show(1), mh\-format(5) If a folder is given, it will become the current folder. .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