X-Git-Url: http://git.marmaro.de/?a=blobdiff_plain;f=man%2Fmhl.man;h=cc5254dd216f0cd8433e65027143caa666e87863;hb=307383ed8da4c05a4e5cb98bab9bf6161dd51bf3;hp=6158564873320ed25fe50e48fd25cf6894593b0b;hpb=278a48ef53b5dde10d7c88f67f51ce15ad11c0c0;p=mmh

diff --git a/man/mhl.man b/man/mhl.man
index 6158564..cc5254d 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 ]
@@ -25,6 +25,7 @@ mhl \- produce formatted listings of nmh messages
 .IR \&... ]
 .RB [ \-version ]
 .RB [ \-help ]
+.ad
 .SH DESCRIPTION
 .B Mhl
 is an
@@ -206,7 +207,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 +235,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 +250,10 @@ 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)
 .fi
 .RE
 .PP
@@ -312,11 +319,28 @@ 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
 .SH FILES
 .fc ^ ~
 .nf
-.ta \w'/usr/local/nmh/etc/ExtraBigFileName  'u
+.ta \w'%etcdir%/ExtraBigFileName  'u
 ^%etcdir%/mhl.format~^The message template
 ^or <mh\-dir>/mhl.format~^Rather than the standard template
 ^$HOME/\&.mh\(ruprofile~^The user profile
@@ -328,6 +352,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 +363,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