X-Git-Url: http://git.marmaro.de/?p=mmh;a=blobdiff_plain;f=man%2Fmhl.man1;h=909db5cb020ccdcb46bf15e9c5438cbf5305a1d4;hp=9f84170026ba86791ca3aee7d2eae3bd6b4473f5;hb=32b2354dbaf4bf934936eb5b102a4a3d2fdd209a;hpb=943765e7ac5693ae177fd8d2b5a2440e53ce816e diff --git a/man/mhl.man1 b/man/mhl.man1 index 9f84170..909db5c 100644 --- a/man/mhl.man1 +++ b/man/mhl.man1 @@ -8,19 +8,13 @@ mhl \- produce formatted listings of nmh messages .HP 5 .na .B mhl -.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 @@ -33,33 +27,12 @@ messages. It is the default method of displaying text messages for (it is the default .IR showproc ). .PP -If -.B mhl -is outputting to a terminal, then -.B mhl -will -cause the -.I moreproc -to be placed between the terminal and -.BR mhl . -.PP -To override the default -.I moreproc -and the profile entry, use the -.B \-moreproc -.I program -switch. -.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 @@ -82,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 @@ -139,7 +95,7 @@ Remaining lines define the global environment. For example, the line: .PP .RS 5 -width=80,length=40,overflowtext="***",overflowoffset=5 +width=80,overflowtext="***",overflowoffset=5 .RE .PP defines the screen size to be 80 columns by 40 rows, specifies that the @@ -151,14 +107,14 @@ 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., -width, length). +width). .PP .RS 5 .nf .ta \w'xxxxxxxxxxxxx '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 +length integer component length offset integer positions to indent \*(lqcomponent: \*(rq overflowtext string text to use at the beginning of an overflow line @@ -212,12 +168,9 @@ ignores=component,... 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 +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 message which were not matched by explicit components, or included in @@ -269,20 +222,14 @@ appropriate formatfield variable string. .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 ` \-length 40 ' -.RB ` \-width 80 ' +.RB ` \-width \ 80' .fi .SH CONTEXT