Factor trim format function out
[mmh] / man / mhl.man1
index a04464d..a80d6bf 100644 (file)
@@ -3,39 +3,30 @@
 .\"
 .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 [ \-folder
-.IR +folder ]
 .RB [ \-form
 .IR formfile ]
 .RB [ \-width
 .IR columns ]
 .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
-If
-.B mhl
-is outputting to a terminal, then
-.B mhl
-will cause a pager to be placed between the terminal and
-.BR mhl .
-.PP
 The
 .B \-width
 .I width
@@ -46,7 +37,7 @@ if appropriate, otherwise it defaults to 80.
 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
@@ -64,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
@@ -91,7 +65,7 @@ format constraints from the format file.
 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
@@ -113,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.
@@ -126,7 +100,7 @@ width=80,overflowtext="***",overflowoffset=5
 .PP
 defines the screen size to be 80 columns by 40 rows, specifies that the
 overflow indentation
-is 5, and that overflow text should be flagged with \*(lq***\*(rq.
+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
@@ -138,10 +112,10 @@ width).
 .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 component length
-offset integer positions to indent \*(lqcomponent: \*(rq
+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
@@ -150,9 +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
-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)
@@ -182,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:
@@ -193,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:
@@ -217,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.
@@ -247,16 +218,11 @@ 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
-^Pager:~^Program to use as interactive front\-end
-.fi
+none
 
 .SH "SEE ALSO"
 show(1), ap(8), dp(8)
@@ -277,5 +243,5 @@ tool, the
 switch does only take file names, but no format strings with a prepended
 equal sign `='.
 .PP
-The \*(lqnonewline\*(rq option interacts badly with \*(lqcompress\*(rq
-and \*(lqsplit\*(rq.
+The `nonewline' option interacts badly with `compress'
+and `split'.