[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 03/14] Set environment variable names in italics, not bold.
|
From: |
G. Branden Robinson |
|
Subject: |
[PATCH 03/14] Set environment variable names in italics, not bold. |
|
Date: |
Fri, 1 Dec 2023 17:31:46 -0600 |
* man/MKncu_config.in:
* man/clear.1:
* man/curs_termcap.3x:
* man/curs_terminfo.3x:
* man/curs_util.3x:
* man/infocmp.1m:
* man/ncurses.3x:
* man/resizeterm.3x:
* man/term.5:
* man/term.7:
* man/terminfo.tail:
* man/tic.1m:
* man/toe.1m:
* man/tput.1:
* man/tset.1: Do it.
Also protect them from hyphenation where needed ("LINES" doesn't).
Care is required with "LINES", because it is also the name of a library
symbol (a global variable) that should be set in bold.
Also break input lines where excessively long, and after commas and
around multi-word parentheticals.
---
man/MKncu_config.in | 6 +--
man/clear.1 | 8 +--
man/curs_termcap.3x | 2 +-
man/curs_terminfo.3x | 8 +--
man/curs_util.3x | 14 +++---
man/infocmp.1m | 10 ++--
man/ncurses.3x | 114 +++++++++++++++++++++++--------------------
man/resizeterm.3x | 2 +-
man/term.5 | 6 +--
man/term.7 | 29 ++++++-----
man/terminfo.tail | 11 +++--
man/tic.1m | 20 +++++---
man/toe.1m | 4 +-
man/tput.1 | 26 +++++-----
man/tset.1 | 40 ++++++++-------
15 files changed, 165 insertions(+), 135 deletions(-)
diff --git a/man/MKncu_config.in b/man/MKncu_config.in
index 26ec4067..44adb622 100644
--- a/man/MKncu_config.in
+++ b/man/MKncu_config.in
@@ -83,16 +83,16 @@ reports the directory containing \fIncurses\fP libraries.
reports the directory containing \fIncurses\fP man pages.
.TP
\fB\-\-terminfo\fP
-reports the \fBTERMINFO\fP \fIterminfo\fP database path,
+reports the \fI\%TERMINFO\fP \fIterminfo\fP database path,
for example \fI\%@TERMINFO@\fP.
.TP
\fB\-\-terminfo\-dirs\fP
-reports the \fBTERMINFO_DIRS\fP supplemental search path for the
+reports the \fI\%TERMINFO_DIRS\fP supplemental search path for the
\fIterminfo\fP database,
for example \fI\%@TERMINFO_DIRS@\fP.
.TP
\fB\-\-termpath\fP
-reports the \fBTERMPATH\fP supplemental search path for the
+reports the \fI\%TERMPATH\fP supplemental search path for the
\fItermcap\fP database,
if support for \fItermcap\fP is configured.
.TP
diff --git a/man/clear.1 b/man/clear.1
index 9cd80e11..9b1433a0 100644
--- a/man/clear.1
+++ b/man/clear.1
@@ -62,7 +62,7 @@ .SH DESCRIPTION
\fB\%@CLEAR@\fP clears your terminal's screen and its scrollback buffer,
if any.
\fB\%@CLEAR@\fP retrieves the terminal type from the environment
-variable \fBTERM\fP,
+variable \fITERM\fP,
then consults the \fIterminfo\fP terminal capability database entry for
that type to determine how to perform these actions.
.PP
@@ -78,10 +78,10 @@ .SH OPTIONS
Normally,
this option is unnecessary,
because the terminal type is inferred from the environment variable
-\fBTERM\fP.
+\fITERM\fP.
If this option is specified,
-\fB\%@CLEAR@\fP ignores the environment variables \fBLINES\fP and
-\fB\%COLUMNS\fP as well.
+\fB\%@CLEAR@\fP ignores the environment variables \fILINES\fP and
+\fI\%COLUMNS\fP as well.
.TP
.B \-V
reports the version of \fIncurses\fP associated with this program and
diff --git a/man/curs_termcap.3x b/man/curs_termcap.3x
index e0497b29..ba4dbd15 100644
--- a/man/curs_termcap.3x
+++ b/man/curs_termcap.3x
@@ -211,7 +211,7 @@ .SS Releasing Memory
.PP
to free this memory, but there is an additional complication with ncurses.
It uses a fixed-size \fIpool\fP of storage locations,
-one per setting of the \fBTERM\fP variable when \fBtgetent\fP is called.
+one per setting of the \fITERM\fP variable when \fBtgetent\fP is called.
The \fBscreen\fP(1) program relies upon this arrangement,
to improve its performance.
.PP
diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x
index f8d2e68a..0185facb 100644
--- a/man/curs_terminfo.3x
+++ b/man/curs_terminfo.3x
@@ -147,8 +147,9 @@ .SS Initialization
If \fBuse_env(FALSE)\fP has been called, values for
\fBlines\fP and \fBcolumns\fP specified in \fBterminfo\fP are used.
.bP
-Otherwise, if the environment variables \fBLINES\fP and \fBCOLUMNS\fP
-exist, their values are used.
+Otherwise,
+if the environment variables \fILINES\fP and \fI\%COLUMNS\fP exist,
+their values are used.
If these environment variables do not
exist and the program is running in a window, the current window size
is used.
@@ -188,7 +189,8 @@ .SS Initialization
.TP 5
\fIterm\fP
is the terminal type, a character string.
-If \fIterm\fP is null, the environment variable \fBTERM\fP is used.
+If \fIterm\fP is null,
+the environment variable \fITERM\fP is used.
.TP 5
\fIfiledes\fP
is the file descriptor used for getting and setting terminal I/O modes.
diff --git a/man/curs_util.3x b/man/curs_util.3x
index 90ffab5b..0a9ac01b 100644
--- a/man/curs_util.3x
+++ b/man/curs_util.3x
@@ -181,12 +181,14 @@ .SS use_env
it overrides the values from the terminal database.
.bP
Finally (unless \fBuse_env\fP was called with \fBFALSE\fP parameter),
-\fBncurses\fP examines the \fBLINES\fP or \fBCOLUMNS\fP environment variables,
+\fBncurses\fP examines the \fILINES\fP or \fI\%COLUMNS\fP environment
+variables,
using a value in those to override the results
from the operating system or terminal database.
.IP
\fBNcurses\fP also updates the screen size in response to \fBSIGWINCH\fP,
-unless overridden by the \fBLINES\fP or \fBCOLUMNS\fP environment variables,
+unless overridden by the \fILINES\fP or \fI\%COLUMNS\fP environment
+variables,
.SS use_tioctl
The \fBuse_tioctl\fP routine, if used,
should be called before \fBinitscr\fP or \fBnewterm\fP are called
@@ -195,7 +197,7 @@ .SS use_tioctl
\fBncurses\fP modifies the last step in its computation
of screen size as follows:
.bP
-checks if the \fBLINES\fP and \fBCOLUMNS\fP environment variables
+checks if the \fILINES\fP and \fI\%COLUMNS\fP environment variables
are set to a number greater than zero.
.bP
for each, \fBncurses\fP updates the corresponding environment variable
@@ -215,16 +217,16 @@ .SS use_tioctl
TRUE FALSE T{
This is the default behavior.
\fIncurses\fP uses operating system calls
-unless overridden by \fBLINES\fP or \fB\%COLUMNS\fP environment
+unless overridden by \fILINES\fP or \fB\%COLUMNS\fP environment
variables;
default.
T}
TRUE TRUE T{
-\fIncurses\fP updates \fBLINES\fP and \fB\%COLUMNS\fP based on operating
+\fIncurses\fP updates \fILINES\fP and \fB\%COLUMNS\fP based on operating
system calls.
T}
FALSE TRUE T{
-\fIncurses\fP ignores \fBLINES\fP and \fB\%COLUMNS\fP,
+\fIncurses\fP ignores \fILINES\fP and \fB\%COLUMNS\fP,
using operating system calls to obtain size.
T}
.TE
diff --git a/man/infocmp.1m b/man/infocmp.1m
index 8b6f8c15..2a7bca0f 100644
--- a/man/infocmp.1m
+++ b/man/infocmp.1m
@@ -140,7 +140,7 @@ .SS Comparison Options [\-d] [\-c] [\-n]
capabilities (names prefixed with \*(``OT\*('').
.IP
If no \fIterminal-types\fP are given,
-\fB@INFOCMP@\fP uses the environment variable \fBTERM\fP
+\fB@INFOCMP@\fP uses the environment variable \fITERM\fP
for each of the \fIterminal-types\fP.
.SS Source Listing Options [\-I] [\-L] [\-C] [\-r]
The \fB\-I\fP, \fB\-L\fP, and \fB\-C\fP options will produce
@@ -157,7 +157,7 @@ .SS Source Listing Options [\-I] [\-L] [\-C] [\-r]
.TE
.PP
If no \fIterminal-types\fP are given,
-the environment variable \fBTERM\fP will be used for the terminal name.
+the environment variable \fITERM\fP will be used for the terminal name.
.PP
The source produced by the \fB\-C\fP option may be used directly as a
\fBtermcap\fP entry, but not all parameterized strings can be changed to
@@ -272,8 +272,8 @@ .SS Use= Option [\-u]
.SS Changing Databases [\-A \fIdirectory\fR] [\-B \fIdirectory\fR]
Like other \fBncurses\fP utilities,
\fB@INFOCMP@\fP looks for the terminal descriptions in several places.
-You can use the \fBTERMINFO\fP and \fBTERMINFO_DIRS\fP environment variables
-to override the compiled-in default list of places to search.
+You can use the \fI\%TERMINFO\fP and \fI\%TERMINFO_DIRS\fP environment
+variables to override the compiled-in default list of places to search.
See \fBcurses\fP(3X), as well as
the \fIFetching Compiled Descriptions\fP section in \fBterminfo\fR(5).
.PP
@@ -454,7 +454,7 @@ .SS Other Options
.RE
.IP
For example, this prints the compiled terminfo value as a string
-which could be assigned to the \fBTERMINFO\fP environment variable:
+which could be assigned to the \fI\%TERMINFO\fP environment variable:
.PP
.RS 9
.EX
diff --git a/man/ncurses.3x b/man/ncurses.3x
index fc0e549a..f0344265 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -155,7 +155,7 @@ .SS Initialization
Before a \fBcurses\fP program is run, the tab stops of the terminal
should be set and its initialization strings, if defined, must be output.
This can be done by executing the \fB@TPUT@ init\fP command
-after the shell environment variable \fBTERM\fP has been exported.
+after the shell environment variable \fITERM\fP has been exported.
(The BSD-style \fB\%@TSET@\fP(1) utility also performs this function.)
See subsection \*(``Tabs and Initialization\*('' of \fBterminfo\fP(5).
.SS Datatypes
@@ -208,17 +208,19 @@ .SS Datatypes
drawing characters, and input values use names, defined in \fB<curses.h>\fP,
such as \fBA_REVERSE\fP, \fBACS_HLINE\fP, and \fBKEY_LEFT\fP.
.SS Environment variables
-If the environment variables \fBLINES\fP and \fBCOLUMNS\fP are set, or if the
+If the environment variables \fILINES\fP and \fI\%COLUMNS\fP are set,
+or if the
program is executing in a window environment, line and column information in
the environment will override information read by \fIterminfo\fP.
This would affect a program running in an AT&T 630 layer,
for example, where the size of a
screen is changeable (see \fBENVIRONMENT\fP).
.PP
-If the environment variable \fBTERMINFO\fP is defined, any program using
+If the environment variable \fI\%TERMINFO\fP is defined,
+any program using
\fBcurses\fP checks for a local terminal definition before checking in the
standard place.
-For example, if \fBTERM\fP is set to \fBatt4424\fP, then the
+For example, if \fITERM\fP is set to \fBatt4424\fP, then the
compiled terminal definition is found in
.PP
.RS 4
@@ -228,7 +230,9 @@ .SS Environment variables
.RE
.PP
(The \fBa\fP is copied from the first letter of \fBatt4424\fP to avoid
-creation of huge directories.) However, if \fBTERMINFO\fP is set to
+creation of huge directories.)
+However,
+if \fI\%TERMINFO\fP is set to
\fB$HOME/myterms\fP, \fBcurses\fP first checks
.PP
.RS 4
@@ -852,7 +856,7 @@ .SH ENVIRONMENT
The following environment symbols are useful for customizing the
runtime behavior of the \fBncurses\fP library.
The most important ones have been already discussed in detail.
-.SS CC command-character
+.SS \fICC\fP command-character
When set, change occurrences of the command_character
(i.e., the \fBcmdch\fP capability)
of the loaded terminfo entries to the value of this variable.
@@ -861,14 +865,14 @@ .SS CC command-character
Because this name is also used in development environments to represent
the C compiler's name, \fBncurses\fP ignores it if it does not happen to
be a single character.
-.SS BAUDRATE
+.SS \fIBAUDRATE\fP
The debugging library checks this environment variable when the application
has redirected output to a file.
The variable's numeric value is used for the baudrate.
If no value is found, \fBncurses\fP uses 9600.
This allows testers to construct repeatable test-cases
that take into account costs that depend on baudrate.
-.SS COLUMNS
+.SS \fICOLUMNS\fP
Specify the width of the screen in characters.
Applications running in a windowing environment usually are able to
obtain the width of the window in which they are executing.
@@ -880,10 +884,12 @@ .SS COLUMNS
This is not always possible because your application may be
running on a host which does not honor NAWS (Negotiations About Window
Size), or because you are temporarily running as another user.
-However, setting \fBCOLUMNS\fP and/or \fBLINES\fP overrides the library's
-use of the screen size obtained from the operating system.
+However,
+setting \fI\%COLUMNS\fP and/or \fILINES\fP overrides the library's use
+of the screen size obtained from the operating system.
.PP
-Either \fBCOLUMNS\fP or \fBLINES\fP symbols may be specified independently.
+Either \fI\%COLUMNS\fP or \fILINES\fP symbols may be specified
+independently.
This is mainly useful to circumvent legacy misfeatures of terminal
descriptions,
e.g., xterm which commonly specifies a 65 line screen.
For best results, \fBlines\fP and \fBcols\fP should not be specified in
@@ -891,9 +897,10 @@ .SS COLUMNS
.PP
Use the \fBuse_env\fP function to disable all use of external environment
(but not including system calls) to determine the screen size.
-Use the \fBuse_tioctl\fP function to update \fBCOLUMNS\fP or \fBLINES\fP
-to match the screen size obtained from system calls or the terminal database.
-.SS ESCDELAY
+Use the \fBuse_tioctl\fP function to update \fI\%COLUMNS\fP or
+\fILINES\fP to match the screen size obtained from system calls or the
+terminal database.
+.SS \fIESCDELAY\fP
Specifies the total time, in milliseconds, for which ncurses will
await a character sequence, e.g., a function key.
The default value, 1000 milliseconds, is enough for most uses.
@@ -917,7 +924,7 @@ .SS ESCDELAY
in either form,
but setting the environment variable rather than the global variable
does not create problems when compiling an application.
-.SS HOME
+.SS \fIHOME\fP
Tells \fBncurses\fP where your home directory is.
That is where it may read and write auxiliary terminal descriptions:
.PP
@@ -927,10 +934,10 @@ .SS HOME
$HOME/.terminfo
.EE
.RE
-.SS LINES
+.SS \fILINES\fP
Like COLUMNS, specify the height of the screen in characters.
See COLUMNS for a detailed description.
-.SS MOUSE_BUTTONS_123
+.SS \fIMOUSE_BUTTONS_123\fP
This applies only to the OS/2 EMX port.
It specifies the order of buttons on the mouse.
OS/2 numbers a 3-button mouse inconsistently from other
@@ -947,7 +954,7 @@ .SS MOUSE_BUTTONS_123
This variable lets you customize the mouse.
The variable must be three numeric digits 1\-3 in any order, e.g., 123 or 321.
If it is not specified, \fBncurses\fP uses 132.
-.SS NCURSES_ASSUMED_COLORS
+.SS \fINCURSES_ASSUMED_COLORS\fP
Override the compiled-in assumption that the
terminal's default colors are white-on-black
(see \fBdefault_colors\fP(3X)).
@@ -957,7 +964,7 @@ .SS NCURSES_ASSUMED_COLORS
about the colors, set this to "\-1,\-1".
To make it green-on-black, set it to "2,0".
Any positive value from zero to the terminfo \fBmax_colors\fP value is allowed.
-.SS NCURSES_CONSOLE2
+.SS \fINCURSES_CONSOLE2\fP
This applies only to the MinGW port of ncurses.
.PP
The \fBConsole2\fP program's handling of the Microsoft Console API call
@@ -967,29 +974,29 @@ .SS NCURSES_CONSOLE2
mapping coordinates,
explicitly saving and restoring the original screen contents.
Setting the environment variable \fBNCGDB\fP has the same effect.
-.SS NCURSES_GPM_TERMS
+.SS \fINCURSES_GPM_TERMS\fP
This applies only to ncurses configured to use the GPM interface.
.PP
If present,
the environment variable is a list of one or more terminal names
-against which the \fBTERM\fP environment variable is matched.
+against which the \fITERM\fP environment variable is matched.
Setting it to an empty value disables the GPM interface;
using the built-in support for xterm, etc.
.PP
If the environment variable is absent,
-ncurses will attempt to open GPM if \fBTERM\fP contains \*(``linux\*(''.
-.SS NCURSES_NO_HARD_TABS
+ncurses will attempt to open GPM if \fITERM\fP contains \*(``linux\*(''.
+.SS \fINCURSES_NO_HARD_TABS\fP
\fBNcurses\fP may use tabs as part of the cursor movement optimization.
In some cases,
your terminal driver may not handle these properly.
Set this environment variable to disable the feature.
You can also adjust your \fBstty\fP(1) settings to avoid the problem.
-.SS NCURSES_NO_MAGIC_COOKIE
+.SS \fINCURSES_NO_MAGIC_COOKIE\fP
Some terminals use a magic-cookie feature which requires special handling
to make highlighting and other video attributes display properly.
You can suppress the highlighting entirely for these terminals by
setting this environment variable.
-.SS NCURSES_NO_PADDING
+.SS \fINCURSES_NO_PADDING\fP
Most of the terminal descriptions in the terminfo database are written
for real \*(``hardware\*('' terminals.
Many people use terminal emulators
@@ -1015,7 +1022,7 @@ .SS NCURSES_NO_PADDING
padding.
Mandatory padding is used as a part of special control
sequences such as \fBflash\fP.
-.SS NCURSES_NO_SETBUF
+.SS \fINCURSES_NO_SETBUF\fP
This setting is obsolete.
Before changes
.RS 3
@@ -1048,14 +1055,14 @@ .SS NCURSES_NO_SETBUF
As a special case, the low-level calls such as \fBputp\fP still use the
standard output.
But high-level curses calls do not.
-.SS NCURSES_NO_UTF8_ACS
+.SS \fINCURSES_NO_UTF8_ACS\fP
During initialization, the \fBncurses\fP library
checks for special cases where VT100 line-drawing (and the corresponding
alternate character set capabilities) described in the terminfo are known
to be missing.
Specifically, when running in a UTF\-8 locale,
the Linux console emulator and the GNU screen program ignore these.
-Ncurses checks the \fBTERM\fP environment variable for these.
+Ncurses checks the \fITERM\fP environment variable for these.
For other special cases, you should set this environment variable.
Doing this tells ncurses to use Unicode values which correspond to
the VT100 line-drawing glyphs.
@@ -1087,7 +1094,7 @@ .SS NCURSES_NO_UTF8_ACS
The name \*(``U8\*('' is chosen to be two characters,
to permit it to be used by applications that use ncurses'
termcap interface.
-.SS NCURSES_TRACE
+.SS \fINCURSES_TRACE\fP
During initialization, the \fBncurses\fP debugging library
checks the NCURSES_TRACE environment variable.
If it is defined, to a numeric value, \fBncurses\fP calls the \fBtrace\fP
@@ -1099,38 +1106,38 @@ .SS NCURSES_TRACE
file \fBtrace\fP to the current directory.
.PP
See \fBcurs_trace\fP(3X) for more information.
-.SS TERM
+.SS \fITERM\fP
Denotes your terminal type.
Each terminal type is distinct, though many are similar.
.PP
-\fBTERM\fP is commonly set by terminal emulators to help
+\fITERM\fP is commonly set by terminal emulators to help
applications find a workable terminal description.
Some of those choose a popular approximation, e.g.,
\*(``ansi\*('', \*(``vt100\*('', \*(``xterm\*('' rather than an exact fit.
Not infrequently, your application will have problems with that approach,
e.g., incorrect function-key definitions.
.PP
-If you set \fBTERM\fP in your environment,
+If you set \fITERM\fP in your environment,
it has no effect on the operation of the terminal emulator.
It only affects the way applications work within the terminal.
Likewise, as a general rule (\fBxterm\fP(1) being a rare exception),
terminal emulators which allow you to
-specify \fBTERM\fP as a parameter or configuration value do
+specify \fITERM\fP as a parameter or configuration value do
not change their behavior to match that setting.
-.SS TERMCAP
+.SS \fITERMCAP\fP
If the \fBncurses\fP library has been configured with \fItermcap\fP
support, \fBncurses\fP will check for a terminal's description in
termcap form if it is not available in the terminfo database.
.PP
-The \fBTERMCAP\fP environment variable contains
+The \fI\%TERMCAP\fP environment variable contains
either a terminal description (with newlines stripped out),
or a file name telling where the information denoted by
-the \fBTERM\fP environment variable exists.
+the \fITERM\fP environment variable exists.
In either case, setting it directs \fBncurses\fP to ignore
the usual place for this information, e.g., /etc/termcap.
-.SS TERMINFO
+.SS \fITERMINFO\fP
\fBncurses\fP can be configured to read from multiple terminal databases.
-The \fBTERMINFO\fP variable overrides the location for
+The \fI\%TERMINFO\fP variable overrides the location for
the default terminal database.
Terminal descriptions (in terminal format) are stored in terminal databases:
.bP
@@ -1138,7 +1145,8 @@ .SS TERMINFO
using subdirectories named by the first letter of the terminal names therein.
.IP
This is the scheme used in System V, which legacy Unix systems use,
-and the \fBTERMINFO\fP variable is used by \fIcurses\fP applications on those
+and the \fI\%TERMINFO\fP variable is used by \fIcurses\fP applications
+on those
systems to override the default location of the terminal database.
.IP \(bu 4
If \fBncurses\fP is built to use hashed databases,
@@ -1170,7 +1178,7 @@ .SS TERMINFO
If \fBncurses\fP is built with a support for reading termcap files
directly, then an entry in this list may be the path of a termcap file.
.IP \(bu 4
-If the \fBTERMINFO\fP variable begins with
+If the \fI\%TERMINFO\fP variable begins with
\*(``hex:\*('' or \*(``b64:\*('',
\fBncurses\fP uses the remainder of that variable as a compiled terminal
description.
@@ -1185,10 +1193,10 @@ .SS TERMINFO
.RE
.PP
The compiled description is used if it corresponds to the terminal identified
-by the \fBTERM\fP variable.
+by the \fITERM\fP variable.
.RE
.PP
-Setting \fBTERMINFO\fP is the simplest,
+Setting \fI\%TERMINFO\fP is the simplest,
but not the only way to set location of the default terminal database.
The complete list of database locations in order follows:
.RS 3
@@ -1196,36 +1204,36 @@ .SS TERMINFO
the last terminal database to which \fBncurses\fP wrote,
if any, is searched first
.bP
-the location specified by the TERMINFO environment variable
+the location specified by the \fI\%TERMINFO\fP environment variable
.bP
$HOME/.terminfo
.bP
-locations listed in the TERMINFO_DIRS environment variable
+locations listed in the \fI\%TERMINFO_DIRS\fP environment variable
.bP
one or more locations whose names are configured and compiled into the
ncurses library, i.e.,
.RS 3
.bP
-@TERMINFO_DIRS@ (corresponding to the TERMINFO_DIRS variable)
+@TERMINFO_DIRS@ (corresponding to the \fI\%TERMINFO_DIRS\fP variable)
.bP
-@TERMINFO@ (corresponding to the TERMINFO variable)
+@TERMINFO@ (corresponding to the \fITERMINFO\fP variable)
.RE
.RE
-.SS TERMINFO_DIRS
+.SS \fITERMINFO_DIRS\fP
Specifies a list of locations to search for terminal descriptions.
Each location in the list is a terminal database as described in
-the section on the \fBTERMINFO\fP variable.
+the section on the \fI\%TERMINFO\fP variable.
The list is separated by colons (i.e., ":") on Unix, semicolons on OS/2 EMX.
.PP
There is no corresponding feature in System V terminfo;
it is an extension developed for \fBncurses\fP.
-.SS TERMPATH
-If \fBTERMCAP\fP does not hold a file name then \fBncurses\fP checks
-the \fBTERMPATH\fP environment variable.
+.SS \fITERMPATH\fP
+If \fI\%TERMCAP\fP does not hold a file name then \fBncurses\fP checks
+the \fI\%TERMPATH\fP environment variable.
This is a list of filenames separated by spaces or colons (i.e., ":") on Unix,
semicolons on OS/2 EMX.
.PP
-If the \fBTERMPATH\fP environment variable is not set,
+If the \fI\%TERMPATH\fP environment variable is not set,
\fBncurses\fP looks in the files
.PP
.RS 4
@@ -1401,7 +1409,7 @@ .SH NOTES
.SH EXTENSIONS
The \fBncurses\fP library can be compiled with an option (\fB\-DUSE_GETCAP\fP)
that falls back to the old-style /etc/termcap file if the terminal setup code
-cannot find a terminfo entry corresponding to \fBTERM\fP.
+cannot find a terminfo entry corresponding to \fITERM\fP.
Use of this feature
is not recommended, as it essentially includes an entire termcap compiler in
the \fBncurses\fP startup code, at significant cost in core and startup cycles.
diff --git a/man/resizeterm.3x b/man/resizeterm.3x
index f07a63dc..36a7806a 100644
--- a/man/resizeterm.3x
+++ b/man/resizeterm.3x
@@ -153,7 +153,7 @@ .SH NOTES
This indirect method is used to provide a safe way to resize the \fIncurses\fP
data structures.
.PP
-If the environment variables \fB\%LINES\fP or \fB\%COLUMNS\fP are set,
+If the environment variables \fILINES\fP or \fI\%COLUMNS\fP are set,
this overrides the library's use of the window size obtained from
the operating system.
Thus, even if a \fB\%SIGWINCH\fP is received,
diff --git a/man/term.5 b/man/term.5
index 9c885204..f014abc7 100644
--- a/man/term.5
+++ b/man/term.5
@@ -91,9 +91,9 @@ .SS STORAGE LOCATION
but cannot write entries into the directory tree.
It can write (or rewrite) entries in the hashed database.
.IP
-\fBncurses\fP distinguishes the two cases in the TERMINFO and TERMINFO_DIRS
-environment variable by assuming a directory tree for entries that
-correspond to an existing directory,
+\fBncurses\fP distinguishes the two cases in the \fI\%TERMINFO\fP and
+\fI\%TERMINFO_DIRS\fP environment variable by assuming a directory tree
+for entries that correspond to an existing directory,
and hashed database otherwise.
.SS LEGACY STORAGE FORMAT
The format has been chosen so that it will be the same on all hardware.
diff --git a/man/term.7 b/man/term.7
index 03fadc60..dbbc0292 100644
--- a/man/term.7
+++ b/man/term.7
@@ -46,12 +46,13 @@ .SH NAME
conventions for naming terminal types
.\"SH SYNOPSIS
.SH DESCRIPTION
-The environment variable \fBTERM\fP should normally contain the type name of
-the terminal, console or display-device type you are using.
+The environment variable \fITERM\fP should normally contain the type
+name of the terminal,
+console or display-device type you are using.
This information
is critical for all screen-oriented programs, including your editor and mailer.
.PP
-A default \fBTERM\fP value will be set on a per-line basis by either
+A default \fITERM\fP value will be set on a per-line basis by either
\fB/etc/inittab\fP (e.g., System\-V-like Unices)
or \fB/etc/ttys\fP (BSD Unices).
This will nearly always suffice for workstation and microcomputer consoles.
@@ -62,22 +63,23 @@ .SH DESCRIPTION
Newer ones may pre-set \*(``vt100\*('', reflecting the prevalence of DEC
VT100-compatible terminals and personal-computer emulators.
.PP
-Modern telnets pass your \fBTERM\fP environment variable from the local side to
-the remote one.
+Modern telnets pass your \fITERM\fP environment variable from the local
+side to the remote one.
There can be problems if the remote terminfo or termcap entry
for your type is not compatible with yours, but this situation is rare and
can almost always be avoided by explicitly exporting \*(``vt100\*(''
(assuming you are in fact using a VT100-superset console,
terminal, or terminal emulator).
.PP
-In any case, you are free to override the system \fBTERM\fP setting to your
-taste in your shell profile.
+In any case, you are free to override the system \fITERM\fP setting to
+your taste in your shell profile.
The \fB@TSET@\fP(1) utility may be of assistance;
you can give it a set of rules for deducing or requesting a terminal type based
on the tty device and baud rate.
.PP
-Setting your own \fBTERM\fP value may also be useful if you have created a
-custom entry incorporating options (such as visual bell or reverse-video)
+Setting your own \fITERM\fP value may also be useful if you have created
+a custom entry incorporating options
+(such as visual bell or reverse-video)
which you wish to override the system default type for your line.
.PP
Terminal type descriptions are stored as files of capability data underneath
@@ -105,8 +107,11 @@ .SH DESCRIPTION
separated by \*(``|\*('' (pipe-bar) characters with the last
name field terminated by a comma.
The first name field is the type's
-\fIprimary name\fP, and is the one to use when setting \fBTERM\fP. The last
-name field (if distinct from the first) is actually a description of the
+\fIprimary name\fP,
+and is the one to use when setting \fITERM\fP.
+The last name field
+(if distinct from the first)
+is actually a description of the
terminal type (it may contain blanks; the others must be single words).
Name
fields between the first and last (if present) are aliases for the terminal,
@@ -213,7 +218,7 @@ .SH DESCRIPTION
Commands which use a terminal type to control display often accept a \-T
option that accepts a terminal name argument.
Such programs should fall back
-on the \fBTERM\fP environment variable when no \-T option is specified.
+on the \fITERM\fP environment variable when no \-T option is specified.
.SH FILES
.TP 5
.I \*d
diff --git a/man/terminfo.tail b/man/terminfo.tail
index 267a104d..4f06b987 100644
--- a/man/terminfo.tail
+++ b/man/terminfo.tail
@@ -267,7 +267,8 @@ for a compiled description.
This is an optional feature which may be omitted entirely from
the library, or limited to prevent accidental use by privileged applications.
.bP
-Next, if the environment variable \fBTERMINFO_DIRS\fR is set,
+Next,
+if the environment variable \fI\%TERMINFO_DIRS\fP is set,
\fBncurses\fP interprets the contents of that variable
as a list of colon-separated pathnames of terminal databases to be searched.
.IP
@@ -296,8 +297,10 @@ The preceding addresses the usual configuration of
\fBncurses\fP,
which uses terminal descriptions prepared in \fIterminfo\fP format.
While \fItermcap\fP is less expressive,
\fBncurses\fP can also be configured to read \fItermcap\fP descriptions.
-In that configuration, it checks the \fBTERMCAP\fP and \fBTERMPATH\fP
-variables (for content and search path, respectively)
+In that configuration,
+it checks the \fI\%TERMCAP\fP and \fI\%TERMPATH\fP variables
+(for content and search path,
+respectively)
after the system terminal database.
.SS Preparing Descriptions
We now outline how to prepare descriptions of terminals.
@@ -2012,7 +2015,7 @@ adding extension capabilities to the string table that
collide with subsequent System V and XSI Curses extensions.
.SH EXTENSIONS
Searching for terminal descriptions in
-\fB$HOME/.terminfo\fP and TERMINFO_DIRS
+\fB$HOME/.terminfo\fP and \fI\%TERMINFO_DIRS\fP
is not supported by older implementations.
.PP
Some SVr4 \fBcurses\fP implementations, and all previous to SVr4, do not
diff --git a/man/tic.1m b/man/tic.1m
index 4f582738..401e2a97 100644
--- a/man/tic.1m
+++ b/man/tic.1m
@@ -116,22 +116,22 @@ .SH DESCRIPTION
.bP
First, you may override the system default either by
using the \fB\-o\fP option,
-or by setting the variable \fBTERMINFO\fP
+or by setting the variable \fI\%TERMINFO\fP
in your shell environment to a valid database location.
.bP
Secondly, if \fB@TIC@\fP cannot write in \fI\*d\fP
-or the location specified using your TERMINFO variable,
+or the location specified using your \fI\%TERMINFO\fP variable,
it looks for the directory \fI$HOME/.terminfo\fP
(or hashed database \fI$HOME/.terminfo.db)\fP;
if that location exists, the entry is placed there.
.PP
Libraries that read terminfo entries are expected to check in succession
.bP
-a location specified with the TERMINFO environment variable,
+a location specified with the \fI\%TERMINFO\fP environment variable,
.bP
\fI$HOME/.terminfo\fP,
.bP
-directories listed in the TERMINFO_DIRS environment variable,
+directories listed in the \fI\%TERMINFO_DIRS\fP environment variable,
.bP
a compiled-in list of directories (@TERMINFO_DIRS@), and
.bP
@@ -264,7 +264,7 @@ .SH OPTIONS
.TP
\fB\-o\fIdir\fR
Write compiled entries to given database location.
-Overrides the TERMINFO environment variable.
+Overrides the \fI\%TERMINFO\fP environment variable.
.TP
\fB\-Q\fIn\fR
Rather than show source in terminfo (text) format,
@@ -461,8 +461,11 @@ .SH EXTENSIONS
The SVr4 manual pages are not clear on the resolution rules for \fBuse\fP
capabilities.
This implementation of \fB@TIC@\fP will find \fBuse\fP targets anywhere
-in the source file, or anywhere in the file tree rooted at \fBTERMINFO\fP (if
-\fBTERMINFO\fP is defined),
+in the source file,
+or anywhere in the file tree rooted at
+\fI\%TERMINFO\fP
+(if
+\fI\%TERMINFO\fP is defined),
or in the user's \fI$HOME/.terminfo\fP database
(if it exists),
or (finally) anywhere in the system's file tree of
@@ -512,7 +515,8 @@ .SH EXTENSIONS
The SVr4 \fB\-c\fP mode does not report bad \*(``use=\*('' links.
.PP
System V does not compile entries to or read entries from your
-\fI$HOME/.terminfo\fP database unless TERMINFO is explicitly set to it.
+\fI$HOME/.terminfo\fP database unless \fI\%TERMINFO\fP is explicitly set
+to it.
.SH PORTABILITY
X/Open Curses, Issue 7 (2009) provides a brief description of \fBtic\fP.
It lists one option: \fB\-c\fP.
diff --git a/man/toe.1m b/man/toe.1m
index 14b09a05..c6929663 100644
--- a/man/toe.1m
+++ b/man/toe.1m
@@ -162,8 +162,8 @@ .SH HISTORY
.SH EXAMPLES
When not sorting with the \fB\-s\fP option,
the \fB\-a\fP option reports all of the names found in all of the
-terminal database directories named in the \fB\%TERMINFO\fP and
-\fB\%TERMINFO_DIRS\fP environment variables.
+terminal database directories named in the \fI\%TERMINFO\fP and
+\fI\%TERMINFO_DIRS\fP environment variables.
.RS 4
.PP
.\" toe -a | grep -E '^(xterm|vt)'
diff --git a/man/tput.1 b/man/tput.1
index 40dfadc1..1be0aa60 100644
--- a/man/tput.1
+++ b/man/tput.1
@@ -114,9 +114,9 @@ .SS Options
indicates the \fItype\fP of terminal.
Normally this option is
unnecessary, because the default is taken from the environment
-variable \fBTERM\fP.
+variable \fITERM\fP.
If \fB\-T\fP is specified, then the shell
-variables \fBLINES\fP and \fBCOLUMNS\fP will also be ignored.
+variables \fILINES\fP and \fI\%COLUMNS\fP will also be ignored.
.TP
\fB\-V\fP
reports the version of ncurses which was used in this program, and exits.
@@ -171,8 +171,10 @@ .SS Commands
.TP
(2)
if the window size cannot be obtained from the operating system,
-but the terminal description (or environment, e.g., \fBLINES\fP
-and \fBCOLUMNS\fP variables specify this),
+but the terminal description
+(or environment,
+e.g.,
+\fILINES\fP and \fI\%COLUMNS\fP variables specify this),
update the operating system's notion of the window size.
.TP
(3)
@@ -292,8 +294,8 @@ .SS Terminal Size
(which generally works, unless connecting via a serial line which
does not support \fINAWS\fP: negotiations about window size).
.bP
-finally, it inspects the environment variables \fBLINES\fP and \fBCOLUMNS\fP
-which may override the terminal size.
+finally, it inspects the environment variables \fILINES\fP and
+\fI\%COLUMNS\fP which may override the terminal size.
.PP
If the \fB\-T\fP option is given
@TPUT@ ignores the environment variables by calling \fBuse_tioctl(TRUE)\fP,
@@ -544,14 +546,14 @@ .SH EXAMPLES
.TP 5
\fB@TPUT@ init\fP
Initialize the terminal according to the type of
-terminal in the environmental variable \fBTERM\fP. This
-command should be included in everyone's .profile after
-the environmental variable \fBTERM\fP has been exported, as
-illustrated on the \fBprofile\fP(5) manual page.
+terminal in the environmental variable \fITERM\fP.
+This command should be included in everyone's .profile after
+the environmental variable \fITERM\fP has been exported,
+as illustrated on the \fBprofile\fP(5) manual page.
.TP 5
\fB@TPUT@ \-T5620 reset\fP
Reset an AT&T 5620 terminal, overriding the type of
-terminal in the environmental variable \fBTERM\fP.
+terminal in the environmental variable \fITERM\fP.
.TP 5
\fB@TPUT@ cup 0 0\fP
Send the sequence to move the cursor to row \fB0\fP, column \fB0\fP
@@ -586,7 +588,7 @@ .SH EXAMPLES
\fB@TPUT@ longname\fP
Print the long name from the \fBterminfo\fP database for the
type of terminal specified in the environmental
-variable \fBTERM\fP.
+variable \fITERM\fP.
.PP
.RS 5
\fB@TPUT@ \-S <<!\fP
diff --git a/man/tset.1 b/man/tset.1
index 5f845787..0cb449f0 100644
--- a/man/tset.1
+++ b/man/tset.1
@@ -81,13 +81,13 @@ .SS tset - initialization
.PP
1. The \fBterminal\fP argument specified on the command line.
.PP
-2. The value of the \fBTERM\fP environmental variable.
+2. The value of the \fITERM\fP environmental variable.
.PP
3. (BSD systems only.) The terminal type associated with the standard
error output device in the \fI/etc/ttys\fP file.
(On System\-V-like Unices and systems using that convention,
\fBgetty\fP(1) does this job by setting
-\fBTERM\fP according to the type passed to it by \fI/etc/inittab\fP.)
+\fITERM\fP according to the type passed to it by \fI/etc/inittab\fP.)
.PP
4. The default terminal type, \*(``unknown\*('',
is not suitable for curses applications.
@@ -111,8 +111,10 @@ .SS tset - initialization
the terminal's window size.
.IP
If the window size cannot be obtained from the operating system,
-but the terminal description (or environment, e.g., \fBLINES\fP
-and \fBCOLUMNS\fP variables specify this),
+but the terminal description
+(or environment,
+e.g.,
+\fILINES\fP and \fI\%COLUMNS\fP variables specify this),
use this to set the operating system's notion of the window size.
.bP
if the \*(``\fB\-c\fP\*('' option is enabled,
@@ -162,8 +164,8 @@ .SS "Setting the Environment"
.PP
When the \fB\-s\fP option is specified, the commands to enter the information
into the shell's environment are written to the standard output.
-If
-the \fBSHELL\fP environmental variable ends in \*(``csh\*('', the commands
+If the \fISHELL\fP environmental variable ends in \*(``csh\*('',
+the commands
are for \fBcsh\fP, otherwise, they are for \fBsh\fP(1).
Note, the \fBcsh\fP commands set and unset the shell variable
\fBnoglob\fP, leaving it unset.
@@ -175,7 +177,7 @@ .SS "Setting the Environment"
.SS "Terminal Type Mapping"
When the terminal is not hardwired into the system (or the current
system information is incorrect) the terminal type derived from the
-\fI/etc/ttys\fP file or the \fBTERM\fP environmental variable is often
+\fI/etc/ttys\fP file or the \fITERM\fP environmental variable is often
something generic like \fBnetwork\fP, \fBdialup\fP, or \fBunknown\fP.
When \fB@TSET@\fP is used in a startup script it is often desirable to
provide information about the type of terminal used on such ports.
@@ -271,7 +273,7 @@ .SH OPTIONS
.TP
.B \-s
Print the sequence of shell commands to initialize the environment variable
-\fBTERM\fP to the standard output;
+\fITERM\fP to the standard output;
see subsection \*(``Setting the Environment\*(''.
.TP
.B \-V
@@ -291,15 +293,15 @@ .SH OPTIONS
.SH ENVIRONMENT
The \fB@TSET@\fP command uses these environment variables:
.TP 5
-SHELL
-tells \fB@TSET@\fP whether to initialize \fBTERM\fP using \fBsh\fP(1) or
+.I SHELL
+tells \fB@TSET@\fP whether to initialize \fITERM\fP using \fBsh\fP(1) or
\fBcsh\fP(1) syntax.
.TP 5
-TERM
+.I TERM
Denotes your terminal type.
Each terminal type is distinct, though many are similar.
.TP 5
-TERMCAP
+.I TERMCAP
may denote the location of a termcap database.
If it is not an absolute pathname, e.g., begins with a \*(``/\*('',
\fB@TSET@\fP removes the variable from the environment before looking
@@ -326,19 +328,20 @@ .SH PORTABILITY
.PP
The \fB@TSET@\fP utility provides for backward-compatibility with BSD
environments (under most modern Unices, \fB/etc/inittab\fP and \fBgetty\fP(1)
-can set \fBTERM\fP appropriately for each dial-up line; this obviates what was
-\fB@TSET@\fP's most important use).
+can set \fITERM\fP appropriately for each dial-up line;
+this obviates what was \fB@TSET@\fP's most important use).
This implementation behaves like 4.4BSD
\fBtset\fP, with a few exceptions specified here.
.PP
A few options are different
-because the \fBTERMCAP\fP variable
+because the \fI\%TERMCAP\fP variable
is no longer supported under terminfo-based \fBncurses\fP:
.bP
The \fB\-S\fP option of BSD \fBtset\fP no longer works;
it prints an error message to the standard error and dies.
.bP
-The \fB\-s\fP option only sets \fBTERM\fP, not \fBTERMCAP\fP.
+The \fB\-s\fP option only sets \fITERM\fP,
+not \fI\%TERMCAP\fP.
.PP
There was an undocumented 4.4BSD feature
that invoking \fBtset\fP via a link named
@@ -385,7 +388,7 @@ .SH PORTABILITY
In ncurses, \fB@TSET@\fP obtains the window size using
\fBsetupterm\fP, which may be from
the operating system,
-the \fBLINES\fP and \fBCOLUMNS\fP environment variables or
+the \fILINES\fP and \fICOLUMNS\fP environment variables or
the terminal description.
.PP
Obtaining the window size from the terminal description is common to
@@ -394,7 +397,8 @@ .SH PORTABILITY
Generally speaking, a window size would be unset only if there were
some problem obtaining the value from the operating system
(and \fBsetupterm\fP would still fail).
-For that reason, the \fBLINES\fP and \fBCOLUMNS\fP environment variables
+For that reason,
+the \fILINES\fP and \fI\%COLUMNS\fP environment variables
may be useful for working around window-size problems.
Those have the drawback that if the window is resized,
those variables must be recomputed and reassigned.
--
2.30.2
signature.asc
Description: PGP signature
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 03/14] Set environment variable names in italics, not bold.,
G. Branden Robinson <=