X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fmhl.man;h=0f2c670b5972376dfd2c6f7d089c68c377090782;hb=8139180649a758e0766757952e87b20e88fdd3ed;hp=6158564873320ed25fe50e48fd25cf6894593b0b;hpb=278a48ef53b5dde10d7c88f67f51ce15ad11c0c0;p=mmh diff --git a/man/mhl.man b/man/mhl.man index 6158564..0f2c670 100644 --- a/man/mhl.man +++ b/man/mhl.man @@ -1,12 +1,12 @@ .\" .\" %nmhwarning% -.\" $Id$ .\" .TH MHL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME mhl \- produce formatted listings of nmh messages .SH SYNOPSIS .HP 5 +.na .B %libdir%/mhl .RB [ \-bell " | " \-nobell ] .RB [ \-clear " | " \-noclear ] @@ -21,10 +21,14 @@ mhl \- produce formatted listings of nmh messages .RB [ \-moreproc .IR program ] .RB [ \-nomoreproc ] +.RB [ \-fmtproc +.IR program ] +.RB [ \-nofmtproc ] .RI [ files .IR \&... ] .RB [ \-version ] .RB [ \-help ] +.ad .SH DESCRIPTION .B Mhl is an @@ -206,7 +210,7 @@ bell, clearscreen, width, length). .RS 5 .nf .ta \w'noclearscreen 'u +\w'integer/G 'u -.I variable type semantics +.I "variable type semantics" width integer screen width or component width length integer screen length or component length offset integer positions to indent \*(lqcomponent: \*(rq @@ -234,6 +238,8 @@ leftadjust flag strip off leading whitespace on each noleftadjust flag don't leftadjust compress flag change newlines in text to spaces nocompress flag don't compress +wrap flag Wrap lines that exceed width (default) +nowrap flag Do not perform line wrapping split flag don't combine multiple fields into a single field nosplit flag combine multiple fields into @@ -247,6 +253,11 @@ decode flag decode text as RFC-2047 encoded header field addrfield flag field contains addresses datefield flag field contains dates +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 @@ -312,11 +323,45 @@ can be given a default format string for either address or date fields (but not both). To do this, on a global line specify: either the flag addrfield or datefield, along with the appropriate formatfield variable string. - +.PP +The \*(lqformat\*(rq flag specifies that this component will be run through +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 +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) +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 +.BR 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 -.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u +.ta \w'%etcdir%/ExtraBigFileName 'u ^%etcdir%/mhl.format~^The message template ^or /mhl.format~^Rather than the standard template ^$HOME/\&.mh\(ruprofile~^The user profile @@ -328,6 +373,8 @@ appropriate formatfield variable string. .ta 2.4i .ta \w'ExtraBigProfileName 'u ^moreproc:~^Program to use as interactive front\-end +^formatproc:~^Program to use as a filter for components that +^^have the \*(lqformat\*(rq flag set. .fi .SH "SEE ALSO" @@ -337,8 +384,8 @@ show(1), ap(8), dp(8) .nf .RB ` \-bell ' .RB ` \-noclear ' -.RB ` \-length 40 ' -.RB ` \-width 80 ' +.RB ` \-length\ 40 ' +.RB ` \-width\ 80 ' .fi .SH CONTEXT @@ -350,3 +397,6 @@ 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.