X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fmhl.man1;h=a80d6bf02afa12cd72ea8e076b3788d723949d9f;hp=de444489e9e96d95c0fc71b00de0c7398e4f9114;hb=18591f8e001ecedbee48a51c1d1f08ebaa1c15c8;hpb=e11983f44e59d8de236affa5b0d0d3067c192e24 diff --git a/man/mhl.man1 b/man/mhl.man1 index de44448..a80d6bf 100644 --- a/man/mhl.man1 +++ b/man/mhl.man1 @@ -3,118 +3,41 @@ .\" .TH MHL %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME -mhl \- produce formatted listings of nmh messages +mhl \- produce formatted listings of mh messages .SH SYNOPSIS .HP 5 .na .B mhl -.RB [ \-clear " | " \-noclear ] -.RB [ \-folder -.IR +folder ] .RB [ \-form .IR formfile ] -.RB [ \-length -.IR lines ] .RB [ \-width .IR columns ] -.RB [ \-moreproc -.IR program ] .RI [ files .IR \&... ] -.RB [ \-version ] +.RB [ \-Version ] .RB [ \-help ] .ad .SH DESCRIPTION .B Mhl is an -.B nmh +.B mmh command for filtering and/or displaying text messages. It is the default method of displaying text messages for -.B nmh +.B mmh (it is the default .IR showproc ). .PP -As with -.BR more , -each of the messages specified as arguments (or -the standard input) will be output. If more than one message file is -specified, the user will be prompted prior to each one, and a -or will begin the output, with clearing the screen (if -appropriate), and (usually CTRL\-D) suppressing the screen clear. -An (usually CTRL\-C) will abort the current message output, -prompting for the next message (if there is one), and a (usually -CTRL-\\) will terminate the program (without core dump). -.PP The -.B \-clear -option tells -.B mhl -to clear the -screen at the end of each page (or output a formfeed after each message). -This switches (and its inverse counterpart) take effect only -if the profile entry -.I moreproc -is defined but empty, and -.B mhl -is outputting to a terminal. If the -.I moreproc -entry is defined and -non-empty, and -.B mhl -is outputting to a terminal, then -.B mhl -will -cause the -.I moreproc -to be placed between the terminal and -.B mhl -and the switches are ignored. Furthermore, if the -.B \-clear -switch is -used and \fImhl's\fR output is directed to a terminal, then -.B mhl -will consult the -.B $TERM -and -.B $TERMCAP -environment variables -to determine the user's terminal type in order to find out how to clear -the screen. If the -.B \-clear -switch is used and -.BR mhl 's -output is -not directed to a terminal (e.g., a pipe or a file), then -.B mhl -will -send a formfeed after each message. -.PP -To override the default -.I moreproc -and the profile entry, use the -.B \-moreproc -.I program -switch. Note that -.B mhl -will never start a -.I moreproc -if invoked on a hardcopy terminal. -.PP -The -.B \-length -.I length -and .B \-width .I width -switches set the screen -length and width, respectively. These default to the values indicated by +switch sets the screen width. This defaults to the value indicated by .BR $TERMCAP , -if appropriate, otherwise they default to 40 and 80, respectively. +if appropriate, otherwise it defaults to 80. .PP The default format file used by .B mhl is called -.RI \*(lq mhl.format \*(rq. +.RI ` mhl.format '. .B mhl will first search for this file in the user's .B mmh @@ -132,23 +55,6 @@ tool, the switch does only take file names, but no format strings with a prepended equal sign `='. .PP -Finally, the -.B \-folder -.I +folder -switch sets the -.B nmh -folder name, -which is used for the \*(lqmessagename:\*(rq field described below. The -environment variable -.B $mhfolder -is consulted for the default value, -which -.BR show , -.BR next , -and -.B prev -initialize appropriately. -.PP .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 @@ -156,10 +62,10 @@ of the format is produced as a structured list. In phase 2, this list is walked for each message, outputting message information under the format constraints from the format file. .PP -The format file can contain information controlling screen clearing, +The format file can contain information controlling screen size, wrap\-around control, transparent text, component ordering, and component formatting. Also, a list of components to ignore may be -specified, and a couple of \*(lqspecial\*(rq components are defined +specified, and a couple of `special' components are defined to provide added functionality. Message output will be in the order specified by the order in the format file. .PP @@ -181,7 +87,7 @@ A line beginning with a `:' is clear text, and is output exactly as is. .IP \(bu 4 A line containing only a `:' produces a blank line in the output. .IP \(bu 4 -A line beginning with \*(lqcomponent:\*(rq defines the format for the specified +A line beginning with `component:' defines the format for the specified component, .IP \(bu 4 Remaining lines define the global environment. @@ -189,27 +95,27 @@ Remaining lines define the global environment. For example, the line: .PP .RS 5 -width=80,length=40,clearscreen,overflowtext="***",overflowoffset=5 +width=80,overflowtext="***",overflowoffset=5 .RE .PP defines the screen size to be 80 columns by 40 rows, specifies that the -screen should be cleared prior to each page, that the overflow indentation -is 5, and that overflow text should be flagged with \*(lq***\*(rq. +overflow indentation +is 5, and that overflow text should be flagged with `***'. .PP Following are all of the current variables and their arguments. If they follow a component, they apply only to that component, otherwise, their affect is global. Since the whole format is parsed before any output processing, the last global switch setting for a variable applies to the whole message if that variable is used in a global context (i.e., -clearscreen, width, length). +width). .PP .RS 5 .nf -.ta \w'noclearscreen 'u +\w'integer/G 'u -.I variable type semantics +.ta \w'xxxxxxxxxxxxx 'u +\w'integer/G 'u +.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 +length integer component length +offset integer positions to indent `component: ' overflowtext string text to use at the beginning of an overflow line overflowoffset integer positions to indent overflow lines @@ -218,11 +124,9 @@ compwidth integer positions to indent component text uppercase flag output text of this component in all upper case nouppercase flag don't uppercase -clearscreen flag/G clear the screen prior to each page -noclearscreen flag/G don't clearscreen -component string/L name to use instead of \*(lqcomponent\*(rq for +component string/L name to use instead of `component' for this component -nocomponent flag don't output \*(lqcomponent: \*(rq for this +nocomponent flag don't output `component: ' for this component center flag center component on line (works for one\-line components only) @@ -252,7 +156,7 @@ To specify the value of integer\-valued and string\-valued variables, follow their name with an equals\-sign and the value. Integer\-valued variables are given decimal values, while string\-valued variables are given arbitrary text bracketed by double\-quotes. If a value is -suffixed by \*(lq/G\*(rq or \*(lq/L\*(rq, then its value is useful in +suffixed by `/G' or `/L', then its value is useful in a global\-only or local\-only context (respectively). .PP A line of the form: @@ -263,20 +167,17 @@ ignores=component,... .PP specifies a list of components which are never output. .PP -The component \*(lqMessageName\*(rq (case\-insensitive) will output the -actual message name (file name) preceded by the folder name if one is -specified or found in the environment. The format is identical to that -produced by the -.B \-header -option to +The component `MessageName' (case\-insensitive) will output the +message file name as a one-line header, similar to .BR show . +E.g. ``(Message 42)'' .PP -The component \*(lqExtras\*(rq will output all of the components of the +The component `Extras' will output all of the components of the message which were not matched by explicit components, or included in the ignore list. If this component is not specified, an ignore list is not needed since all non\-specified components will be ignored. .PP -If \*(lqnocomponent\*(rq is NOT specified, then the component name will +If `nocomponent' is NOT specified, then the component name will be output as it appears in the format file. .PP The default format file is: @@ -287,10 +188,10 @@ The default format file is: .fi .RE .PP -The variable \*(lqformatfield\*(rq specifies a format string (see +The variable `formatfield' specifies a format string (see .BR mh\-format (5)). -The flag variables \*(lqaddrfield\*(rq and -\*(lqdatefield\*(rq (which are mutually exclusive), tell +The flag variables `addrfield' and +`datefield' (which are mutually exclusive), tell .B mhl to interpret the escapes in the format string as either addresses or dates, respectively. @@ -317,25 +218,18 @@ appropriate formatfield variable string. .ta \w'%etcdir%/ExtraBigFileName 'u ^%etcdir%/mhl.format~^The message template ^or $HOME/.mmh/mhl.format~^Rather than the standard template -^$HOME/.mh/profile~^The user profile +^$HOME/.mmh/profile~^The user profile .fi .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^moreproc:~^Program to use as interactive front\-end -.fi +none .SH "SEE ALSO" show(1), ap(8), dp(8) .SH DEFAULTS .nf -.RB ` \-noclear ' -.RB ` \-length 40 ' -.RB ` \-width 80 ' +.RB ` \-width \ 80' .fi .SH CONTEXT @@ -349,8 +243,5 @@ tool, the switch does only take file names, but no format strings with a prepended equal sign `='. .PP -There should be some way to pass `clear' information to the -front\-end. -.PP -The \*(lqnonewline\*(rq option interacts badly with \*(lqcompress\*(rq -and \*(lqsplit\*(rq. +The `nonewline' option interacts badly with `compress' +and `split'.