X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fmhl.man;h=065a455cd103df6a18b17cc0e31d26363826ffac;hb=0f0af4e32a4d734209c16282b63f7cb1094e2699;hp=cc5254dd216f0cd8433e65027143caa666e87863;hpb=62780d8a7c214bbb3301402fee5a5eb980b3069d;p=mmh diff --git a/man/mhl.man b/man/mhl.man index cc5254d..065a455 100644 --- a/man/mhl.man +++ b/man/mhl.man @@ -1,7 +1,7 @@ +.TH MHL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .\" .\" %nmhwarning% .\" -.TH MHL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mhl \- produce formatted listings of nmh messages .SH SYNOPSIS @@ -21,6 +21,9 @@ mhl \- produce formatted listings of nmh messages .RB [ \-moreproc .IR program ] .RB [ \-nomoreproc ] +.RB [ \-fmtproc +.IR program ] +.RB [ \-nofmtproc ] .RI [ files .IR \&... ] .RB [ \-version ] @@ -254,6 +257,7 @@ format flag Run component through formatproc filter (body only) noformat flag Do not run component through formatproc filter (default) +formatarg string Argument to format filter .fi .RE .PP @@ -297,7 +301,7 @@ The default format file is: .RE .PP The variable \*(lqformatfield\*(rq specifies a format string (see -.BR mh\-format (5)). +.IR mh\-format (5)). The flag variables \*(lqaddrfield\*(rq and \*(lqdatefield\*(rq (which are mutually exclusive), tell .B mhl @@ -308,7 +312,7 @@ By default, .B mhl does not apply any formatting string to fields containing address or dates (see -.BR mh\-mail (5) +.IR mh\-mail (5) for a list of these fields). Note that this results in faster operation since .B mhl @@ -325,18 +329,35 @@ the filter program specified by the .IR formatproc profile entry. This filter program is expected to read data on standard input and output data on standard output. Currently the \*(lqformat\*(rq -flag is only supported for the \(*lqbody\*(rq component. The component +flag is only supported for the \*(lqbody\*(rq component. The component name will be prefixed to the output .IR after the filter has been run. The expected use of this is to filter a message body to create more pleasing text to use in a reply message. A suggested filter to use for -.BR repl(1) +.IR repl(1) is as follows: .PP .RS 5 body:component=">",overflowtext=">",overflowoffset=0,format,nowrap .RE +.PP +The +.B \-fmtproc +and +.B \-nofmtproc +switches can be used to override the +.I formatproc +profile entry. +.PP +The +.I formatarg +option specifies a string that is used as an argument to the format filter. +This string is processed by +.IR mh\-format (5) +and all of the message components are available for use. Multiple +.I formatarg +options can be used to build up multiple arguments to the format filter. .SH FILES .fc ^ ~ .nf @@ -345,7 +366,6 @@ body:component=">",overflowtext=">",overflowoffset=0,format,nowrap ^or /mhl.format~^Rather than the standard template ^$HOME/\&.mh\(ruprofile~^The user profile .fi - .SH "PROFILE COMPONENTS" .fc ^ ~ .nf @@ -355,10 +375,10 @@ body:component=">",overflowtext=">",overflowoffset=0,format,nowrap ^formatproc:~^Program to use as a filter for components that ^^have the \*(lqformat\*(rq flag set. .fi - .SH "SEE ALSO" -show(1), ap(8), dp(8) - +.IR show (1), +.IR ap (8), +.IR dp (8) .SH DEFAULTS .nf .RB ` \-bell ' @@ -366,13 +386,14 @@ show(1), ap(8), dp(8) .RB ` \-length\ 40 ' .RB ` \-width\ 80 ' .fi - .SH CONTEXT None - .SH BUGS There should be some way to pass `bell' and `clear' information to the front\-end. .PP The \*(lqnonewline\*(rq option interacts badly with \*(lqcompress\*(rq and \*(lqsplit\*(rq. +.PP +The \*(lqformat\*(rq option really should work on something other than the body +component.