X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/fc25a4f840747685117a482f9a0cf6296224ea1a..a0250745de00aacfe03f82bdcc7e5e86f0768dd7:/man/mhl.man diff --git a/man/mhl.man b/man/mhl.man index 48488d4b..01a1e641 100644 --- a/man/mhl.man +++ b/man/mhl.man @@ -1,4 +1,4 @@ -.TH MHL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] +.TH MHL %manext1% "September 14, 2014" "%nmhversion%" .\" .\" %nmhwarning% .\" @@ -7,7 +7,9 @@ mhl \- produce formatted listings of nmh messages .SH SYNOPSIS .HP 5 .na -.B %libdir%/mhl +.B %nmhlibexecdir%/mhl +.RB [ \-help ] +.RB [ \-version ] .RB [ \-bell " | " \-nobell ] .RB [ \-clear " | " \-noclear ] .RB [ \-folder @@ -26,11 +28,9 @@ mhl \- produce formatted listings of nmh messages .RB [ \-nofmtproc ] .RI [ files .IR \&... ] -.RB [ \-version ] -.RB [ \-help ] .ad .SH DESCRIPTION -.B Mhl +.B mhl is an .B nmh command for filtering and/or displaying text @@ -129,7 +129,7 @@ is called will first search for this file in the user's .B nmh directory, and will then search in the directory -.IR %etcdir% . +.IR %nmhetcdir% . This default can be changed by using the .B \-form @@ -153,7 +153,7 @@ and .B prev initialize appropriately. .PP -.B Mhl +.B mhl operates in two phases: 1) read and parse the format file, and 2) process each message (file). During phase 1, an internal description of the format is produced as a structured list. In phase 2, this list @@ -236,6 +236,9 @@ nocenter flag don't center leftadjust flag strip off leading whitespace on each line of text noleftadjust flag don't leftadjust +rtrim flag trim whitespace at end of text lines +nortrim flag retain whitespace at end of text + lines (default) compress flag change newlines in text to spaces nocompress flag don't compress wrap flag Wrap lines that exceed width (default) @@ -249,7 +252,7 @@ newline flag print newline at end of components nonewline flag don't print newline at end of components formatfield string format string for this component (see below) -decode flag decode text as RFC-2047 encoded +decode flag decode text as RFC 2047 encoded header field addrfield flag field contains addresses datefield flag field contains dates @@ -301,7 +304,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 @@ -312,7 +315,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 @@ -335,7 +338,7 @@ name will be prefixed to the output 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 @@ -354,19 +357,18 @@ 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) +.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 -.ta \w'%etcdir%/ExtraBigFileName 'u -^%etcdir%/mhl.format~^The message template +.ta \w'%nmhetcdir%/ExtraBigFileName 'u +^%nmhetcdir%/mhl.format~^The message template ^or /mhl.format~^Rather than the standard template ^$HOME/\&.mh\(ruprofile~^The user profile .fi - .SH "PROFILE COMPONENTS" .fc ^ ~ .nf @@ -376,10 +378,10 @@ options can be used to build up multiple arguments to the format filter. ^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 ' @@ -387,10 +389,8 @@ 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.