Renamed -version switch to -Version to remove the conflict with -verbose.
[mmh] / man / mhl.man1
index d687eef..909db5c 100644 (file)
@@ -8,22 +8,13 @@ mhl \- produce formatted listings of nmh messages
 .HP 5
 .na
 .B mhl
-.RB [ \-bell " | " \-nobell ]
-.RB [ \-clear " | " \-noclear ]
-.RB [ \-folder
-.IR +folder ]
 .RB [ \-form
 .IR formfile ]
-.RB [ \-length
-.IR lines ]
 .RB [ \-width
 .IR columns ]
-.RB [ \-moreproc
-.IR program ]
-.RB [ \-nomoreproc ]
 .RI [ files
 .IR \&... ]
-.RB [ \-version ]
+.RB [ \-Version ]
 .RB [ \-help ]
 .ad
 .SH DESCRIPTION
@@ -36,87 +27,12 @@ messages.  It is the default method of displaying text messages for
 (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 <RETURN>
-or <EOT> will begin the output, with <RETURN> clearing the screen (if
-appropriate), and <EOT> (usually CTRL\-D) suppressing the screen clear.
-An <INTERRUPT> (usually CTRL\-C) will abort the current message output,
-prompting for the next message (if there is one), and a <QUIT> (usually
-CTRL-\\) will terminate the program (without core dump).
-.PP
-The
-.B \-bell
-option tells
-.B mhl
-to ring the terminal's bell at the
-end of each page, while the
-.B \-clear
-option tells
-.B mhl
-to clear the
-screen at the end of each page (or output a formfeed after each message).
-Both of these switches (and their inverse counterparts) 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
@@ -132,23 +48,12 @@ can be changed by using the
 .B \-form
 .I formatfile
 switch.
-.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.
+Note: In contrast to any other
+.B mmh
+tool, the
+.B \-form
+switch does only take file names, but no format strings with a prepended
+equal sign `='.
 .PP
 .B Mhl
 operates in two phases: 1) read and parse the format file, and
@@ -157,7 +62,7 @@ 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
@@ -190,11 +95,11 @@ 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
+overflow indentation
 is 5, and that overflow text should be flagged with \*(lq***\*(rq.
 .PP
 Following are all of the current variables and their arguments.  If they
@@ -202,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.,
-bell, 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
+length integer component length
 offset integer positions to indent \*(lqcomponent: \*(rq
 overflowtext   string  text to use at the beginning of an
                overflow line
@@ -219,10 +124,6 @@ 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
-bell   flag/G  ring the bell at the end of each page
-nobell flag/G  don't bell
 component      string/L        name to use instead of \*(lqcomponent\*(rq for
                this component
 nocomponent    flag    don't output \*(lqcomponent: \*(rq for this
@@ -267,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
@@ -324,30 +222,26 @@ 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 ` \-bell '
-.RB ` \-noclear '
-.RB ` \-length 40 '
-.RB ` \-width 80 '
+.RB ` \-width \ 80'
 .fi
 
 .SH CONTEXT
 None
 
 .SH BUGS
-There should be some way to pass `bell' and `clear' information to the
-front\-end.
+In contrast to any other
+.B mmh
+tool, the
+.B \-form
+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.