X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/fbcd71b31868c9969836b00a90a0bf32b13111ef..c525020c77134b8832587755b7c05764a0516d80:/man/fmttest.man diff --git a/man/fmttest.man b/man/fmttest.man index 59626da3..6c375c3a 100644 --- a/man/fmttest.man +++ b/man/fmttest.man @@ -1,4 +1,4 @@ -.TH FMTTEST %manext1% "February 19, 2013" "%nmhversion%" +.TH FMTTEST %manext1% "August 31, 2014" "%nmhversion%" .\" .\" %nmhwarning% .\" @@ -10,20 +10,20 @@ language .HP 5 .na .B fmttest +.RB [ \-help ] +.RB [ \-version ] .RB [ \-form .IR formatfile ] .RB [ \-format .IR formatstring ] .RB [ \-address " | " \-raw " | " \-date " | " \-message ] +.RB [ \-file " | " \-nofile ] .RB [ \-\|\-component .IR component-text ] .RB [ \-dupaddrs " | " \-nodupaddrs ] .RB [ \-ccme " | " \-noccme ] -.RB [ \-normalize " | " \-nonormalize ] .RB [ \-outsize .IR size-in-characters ] -.RB [ \-bufsize -.IR size-in-bytes ] .RB [ \-width .IR column-width ] .RB [ \-msgnum @@ -40,7 +40,7 @@ language .RI [ msgs " | " strings ] .ad .SH DESCRIPTION -.B Fmttest +.B fmttest is used to test programs written for the .B nmh format language as specified by @@ -71,10 +71,10 @@ rules: absolute pathnames are accessed directly, tilde expansion is done on usernames, and files are searched for in the user's .I Mail directory as specified in their profile. If not found there, the directory -.RI \*(lq %etcdir% \*(rq +.RI \*(lq %nmhetcdir% \*(rq is checked. .SS MODE SELECTION AND COMPONENT SPECIFICATION -.B Fmttest +.B fmttest has four operating modes: address mode, raw mode, date mode, and message mode. These modes are selected by the .BR \-address , @@ -131,7 +131,7 @@ Date mode is equivalent to In message mode the arguments to .B fmttest are interpreted as an optional folder and messages. -.B Fmttest +.B fmttest will read each specified message and make all of the components in the message available to the format program. Also, the appropriate information for the @@ -140,7 +140,15 @@ for the .RI %( unseen ), and .RI %( size ) -function escapes will be made available for each message. +function escapes will be made available for each message. If the +.B \-file +switch is given, the arguments are interpreted as filenames instead of +message numbers, but otherwise the behavior is the same (except that the +.RI %( msg ), +.RI %( cur ), +and +.RI %( unseen ) +function escapes will not provide any useful information). .PP The default format used in address mode is the default format used by .BR scan . @@ -198,15 +206,6 @@ and only applies if is in effect. .PP The -.B \-normalize -and -.B \-nonormalize -switches control whether or not email addresses are normalized by the -address parsing routines. This is only functional when in address -mode and is designed to replicate the switch of the same name to -.IR ap (8). -.PP -The .B \-outsize switch controls the maximum number of printable characters that the format engine will produce. Characters marked as non-printing by the format @@ -216,19 +215,14 @@ characters with zero width, and extra bytes that are part of a multibyte character are not counted against this total. Two special values are supported: .RI \*(lq max \*(rq, -which will set the value -to the size of the output buffer, and +which means as many characters as the format engine can produce +(limited by internal buffers), and .RI \*(lq width \*(rq, which will set the -value to the width of the terminal. In message mode it defaults to the -terminal width, otherwise the default is the output buffer size. -.PP -The -.B \-bufsize -switch controls the size of the output buffer. By default it is set -to the size of the -.B BUFSIZ -C preprocessor symbol, which is system-dependent. +value to the width of the terminal. In message mode it defaults to +.RI \*(lq width \*(rq, +otherwise the default is +.RI \*(lq max \*(rq. .PP The .B \-width @@ -367,7 +361,7 @@ V_EQ Set \fInum\fR to 1 if \fInum\fR equals value V_NE Set \fInum\fR to 1 if \fInum\fR does not equal value V_GT Set \fInum\fR to 1 if \fInum\fR is greater than value V_MATCH Set \fInum\fR to 1 if \fIstr\fR contains string -V_AMATCH Set \fInum\fR to 1 if \fIstr\fR starts with string +V_AMATCH Set \fInum\fR to 1 if \fIstr\fR starts with string .fi .PP The @@ -394,6 +388,7 @@ dat[4] %(\fIunseen\fR) .SH DEFAULTS .nf .RB ` \-message ' +.RB ` \-nofile ' .RB ` \-dupaddrs ' .fi .SH BUGS