[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Nmh-workers] Changes to mhl.man
[Nmh-workers] Changes to mhl.man
Thu, 23 Mar 2017 17:31:12 +0000
- Refer to environment variables (in text) without preceding $
- Don't put environment variables in bold (as per most other pages)
- Some better formatting
diff --git a/man/mhl.man b/man/mhl.man
index 01a1e641..00ee73b2 100644
@@ -33,71 +33,63 @@ mhl \- produce formatted listings of nmh messages
-command for filtering and/or displaying text
-messages. It is the default method of displaying text messages for
+command for filtering and/or displaying text messages.
+It is the default method of displaying text messages for
(it is the default
.IR showproc ).
.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).
+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
-to ring the terminal's bell at the
-end of each page, while the
+to ring the terminal's bell at the end of each page, while the
-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
+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
is defined but empty, and
is outputting to a terminal. If the
-entry is defined and
+entry is defined and non-empty, and
is outputting to a terminal, then
+will cause the
to be placed between the terminal and
and the switches are ignored. Furthermore, if the
-used and \fImhl's\fR output is directed to a terminal, then
+.IR mhl 's
+output is directed to a terminal, then
-will consult the
-to determine the user's terminal type in order to find out how to clear
-the screen. If the
+will consult the TERM and TERMCAP environment variables to determine
+the user's terminal type in order to find out how to clear the screen.
-switch is used and
+switch is given and
.BR mhl 's
-not directed to a terminal (e.g., a pipe or a file), then
+output is not directed to a terminal (e.g., a pipe or a file), then
-send a formfeed after each message.
+will send a formfeed after each message.
To override the default
@@ -116,10 +108,9 @@ The
-switches set the screen
-length and width, respectively. These default to the values indicated by
-.BR $TERMCAP ,
-if appropriate, otherwise they default to 40 and 80, respectively.
+switches set the screen length and width, respectively.
+These default to the values indicated by TERMCAP, if appropriate, otherwise
+they default to 40 and 80, respectively.
The default format file used by
@@ -130,8 +121,7 @@ will first search for this file in the user's
directory, and will then search in the directory
.IR %nmhetcdir% .
-can be changed by using the
+This default can be changed by using the
@@ -141,14 +131,12 @@ Finally, the
switch sets the
-which is used for the \*(lqmessagename:\*(rq field described below. The
+folder name, which is used for the \*(lqmessagename:\*(rq field described
+The environment variable
-is consulted for the default value,
-.BR show ,
+is consulted for the default value, which
.BR next ,
+.BR show ,
@@ -161,7 +149,7 @@ is walked for each message, outputting message information
format constraints from the format file.
The format file can contain information controlling screen clearing,
-screen size, wrap\-around control, transparent text, component ordering,
+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
to provide added functionality. Message output will be in the order
@@ -177,7 +165,6 @@ variable[,variable...]
.IP \(bu 4
A line beginning with a `;' is a comment, and is ignored.
.IP \(bu 4
@@ -264,12 +251,12 @@ formatarg string Argument to format filter
-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
+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
-a global\-only or local\-only context (respectively).
+a global-only or local-only context (respectively).
A line of the form:
@@ -290,7 +277,7 @@ option to
The component \*(lqExtras\*(rq 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.
+not needed since all non-specified components will be ignored.
If \*(lqnocomponent\*(rq is NOT specified, then the component name will
be output as it appears in the format file.
@@ -305,16 +292,16 @@ The default format file is:
The variable \*(lqformatfield\*(rq specifies a format string (see
.IR mh\-format (5)).
-The flag variables \*(lqaddrfield\*(rq and
-\*(lqdatefield\*(rq (which are mutually exclusive), tell
+The flag variables \*(lqaddrfield\*(rq and \*(lqdatefield\*(rq
+(which are mutually exclusive), tell
to interpret the escapes in the format string as either addresses or
-does not apply any formatting string to fields
-containing address or dates (see
+does not apply any formatting string to fields containing address or dates
.IR mh\-mail (5)
for a list of these
fields). Note that this results in faster operation since
@@ -322,13 +309,12 @@ fields). Note that this results in faster operation since
must parse both addresses and dates in order to apply a format string
to them. If desired,
-can be given a default format string for
-either address or date fields (but not both). To do this, on a global
-line specify: either the flag addrfield or datefield, along with the
-appropriate formatfield variable string.
+can be given a default format string for either address or date fields
+(but not both). To do this, on a global line specify: either the flag
+addrfield or datefield, along with the appropriate formatfield variable string.
The \*(lqformat\*(rq flag specifies that this component will be run through
-the filter program specified by the
+the filter program specified by the
profile entry. This filter program is expected to read data on standard
input and output data on standard output. Currently the \*(lqformat\*(rq
@@ -356,7 +342,7 @@ profile entry.
option specifies a string that is used as an argument to the format filter.
-This string is processed by
+This string is processed by
.IR mh\-format (5)
and all of the message components are available for use. Multiple
@@ -392,7 +378,7 @@ options can be used to build up multiple arguments to the
-There should be some way to pass `bell' and `clear' information to the
+There should be some way to pass `bell' and `clear' information to the
The \*(lqnonewline\*(rq option interacts badly with \*(lqcompress\*(rq
|[Prev in Thread]
||[Next in Thread]|
- [Nmh-workers] Changes to mhl.man,
Larry Hynes <=