<!--
****************************************************************************
- * Copyright 2019,2020 Thomas E. Dickey *
+ * Copyright 2019-2022,2023 Thomas E. Dickey *
* Copyright 2010-2015,2017 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: term_variables.3x,v 1.12 2020/02/02 23:34:34 tom Exp @
+ * @Id: term_variables.3x,v 1.23 2023/09/09 17:06:25 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>term_variables 3X</TITLE>
+<TITLE>term_variables 3x 2023-09-09 ncurses 6.4 Library calls</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+
</HEAD>
<BODY>
-<H1 class="no-header">term_variables 3X</H1>
+<H1 class="no-header">term_variables 3x 2023-09-09 ncurses 6.4 Library calls</H1>
<PRE>
-<B><A HREF="term_variables.3X.html">term_variables(3X)</A></B> <B><A HREF="term_variables.3X.html">term_variables(3X)</A></B>
+<STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG> Library calls <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <B>SP</B>, <B>acs_map</B>, <B>boolcodes</B>, <B>boolfnames</B>, <B>boolnames</B>, <B>cur_term</B>, <B>numcodes</B>,
- <B>numfnames</B>, <B>numnames</B>, <B>strcodes</B>, <B>strfnames</B>, <B>strnames</B>, <B>ttytype</B> - <B>curses</B>
+ <STRONG>SP</STRONG>, <STRONG>acs_map</STRONG>, <STRONG>boolcodes</STRONG>, <STRONG>boolfnames</STRONG>, <STRONG>boolnames</STRONG>, <STRONG>cur_term</STRONG>, <STRONG>numcodes</STRONG>,
+ <STRONG>numfnames</STRONG>, <STRONG>numnames</STRONG>, <STRONG>strcodes</STRONG>, <STRONG>strfnames</STRONG>, <STRONG>strnames</STRONG>, <STRONG>ttytype</STRONG> - <STRONG>curses</STRONG>
terminfo global variables
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <B>#include</B> <B><curses.h></B>
- <B>#include</B> <B><term.h></B>
+ <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
+ <STRONG>#include</STRONG> <STRONG><term.h></STRONG>
- <B>chtype</B> <B>acs_map[];</B>
+ <STRONG>chtype</STRONG> <STRONG>acs_map[];</STRONG>
- <B>SCREEN</B> <B>*</B> <B>SP;</B>
+ <STRONG>SCREEN</STRONG> <STRONG>*</STRONG> <STRONG>SP;</STRONG>
- <B>TERMINAL</B> <B>*</B> <B>cur_term;</B>
+ <STRONG>TERMINAL</STRONG> <STRONG>*</STRONG> <STRONG>cur_term;</STRONG>
- <B>char</B> <B>ttytype[];</B>
+ <STRONG>char</STRONG> <STRONG>ttytype[];</STRONG>
- <B>NCURSES_CONST</B> <B>char</B> <B>*</B> <B>const</B> <B>boolcodes[];</B>
- <B>NCURSES_CONST</B> <B>char</B> <B>*</B> <B>const</B> <B>boolfnames[];</B>
- <B>NCURSES_CONST</B> <B>char</B> <B>*</B> <B>const</B> <B>boolnames[];</B>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>boolcodes[];</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>boolfnames[];</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>boolnames[];</STRONG>
- <B>NCURSES_CONST</B> <B>char</B> <B>*</B> <B>const</B> <B>numcodes[];</B>
- <B>NCURSES_CONST</B> <B>char</B> <B>*</B> <B>const</B> <B>numfnames[];</B>
- <B>NCURSES_CONST</B> <B>char</B> <B>*</B> <B>const</B> <B>numnames[];</B>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>numcodes[];</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>numfnames[];</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>numnames[];</STRONG>
- <B>NCURSES_CONST</B> <B>char</B> <B>*</B> <B>const</B> <B>strcodes[];</B>
- <B>NCURSES_CONST</B> <B>char</B> <B>*</B> <B>const</B> <B>strfnames[];</B>
- <B>NCURSES_CONST</B> <B>char</B> <B>*</B> <B>const</B> <B>strnames[];</B>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>strcodes[];</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>strfnames[];</STRONG>
+ <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>strnames[];</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- This page summarizes variables provided by the <B>curses</B> library's low-
+ This page summarizes variables provided by the <STRONG>curses</STRONG> library's low-
level terminfo interface. A more complete description is given in the
- <B><A HREF="curs_terminfo.3X.html">curs_terminfo(3X)</A></B> manual page.
+ <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> manual page.
Depending on the configuration, these may be actual variables, or
- macros (see <B><A HREF="curs_threads.3X.html">curs_threads(3X)</A></B>) which provide read-only access to <I>curs-</I>
- <I>es</I>'s state. In either case, applications should treat them as read-on-
+ macros (see <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>) which provide read-only access to <EM>curs-</EM>
+ <EM>es</EM>'s state. In either case, applications should treat them as read-on-
ly to avoid confusing the library.
</PRE><H3><a name="h3-Alternate-Character-Set-Mapping">Alternate Character Set Mapping</a></H3><PRE>
- After initializing the curses or terminfo interfaces, the <B>acs_map</B> array
- holds information used to translate cells with the <B>A_ALTCHARSET</B> video
+ After initializing the curses or terminfo interfaces, the <STRONG>acs_map</STRONG> array
+ holds information used to translate cells with the <STRONG>A_ALTCHARSET</STRONG> video
attribute into line-drawing characters.
The encoding of the information in this array has changed periodically.
</PRE><H3><a name="h3-Current-Terminal-Data">Current Terminal Data</a></H3><PRE>
- After initializing the curses or terminfo interfaces, the <B>cur_term</B> con-
+ After initializing the curses or terminfo interfaces, the <STRONG>cur_term</STRONG> con-
tains data describing the current terminal. This variable is also set
- as a side-effect of <B><A HREF="curs_initscr.3X.html">set_term(3X)</A></B> and <B><A HREF="curs_initscr.3X.html">delscreen(3X)</A></B>.
+ as a side-effect of <STRONG><A HREF="curs_initscr.3x.html">set_term(3x)</A></STRONG> and <STRONG><A HREF="curs_initscr.3x.html">delscreen(3x)</A></STRONG>.
- It is possible to save a value of <B>cur_term</B> for subsequent use as a pa-
- rameter to <B>set_term</B>, for switching between screens. Alternatively, one
- can save the return value from <B>newterm</B> or <B><A HREF="curs_terminfo.3X.html">setupterm(3X)</A></B> to reuse in
- <B>set_term</B>.
+ It is possible to save a value of <STRONG>cur_term</STRONG> for subsequent use as a pa-
+ rameter to <STRONG>set_term</STRONG>, for switching between screens. Alternatively, one
+ can save the return value from <STRONG>newterm</STRONG> or <STRONG><A HREF="curs_terminfo.3x.html">setupterm(3x)</A></STRONG> to reuse in
+ <STRONG>set_term</STRONG>.
-</PRE><H3><a name="h3-Terminfo-Names">Terminfo Names</a></H3><PRE>
- The <B><A HREF="tic.1M.html">tic(1)</A></B> and <B><A HREF="infocmp.1M.html">infocmp(1)</A></B> programs use lookup tables for the long and
+</PRE><H3><a name="h3-Terminfo-Lookup-Tables">Terminfo Lookup Tables</a></H3><PRE>
+ The <STRONG><A HREF="tic.1m.html">tic(1)</A></STRONG> and <STRONG><A HREF="infocmp.1m.html">infocmp(1)</A></STRONG> programs use lookup tables for the long and
short names of terminfo capabilities, as well as the corresponding
names for termcap capabilities. These are available to other applica-
tions, although the hash-tables used by the terminfo and termcap func-
tions are not available.
- The long terminfo capability names use a "l" (ell) in their names:
- <B>boolfnames</B>, <B>numfnames</B>, and <B>strfnames</B>.
+ The long terminfo capability names use a "f" (eff) in their names:
+ <STRONG>boolfnames</STRONG>, <STRONG>numfnames</STRONG>, and <STRONG>strfnames</STRONG>.
- These are the short names for terminfo capabilities: <B>boolnames</B>, <B>num-</B>
- <B>names</B>, and <B>strnames</B>.
+ These are the short names for terminfo capabilities: <STRONG>boolnames</STRONG>, <STRONG>num-</STRONG>
+ <STRONG>names</STRONG>, and <STRONG>strnames</STRONG>.
- These are the corresponding names used for termcap descriptions: <B>bool-</B>
- <B>codes</B>, <B>numcodes</B>, and <B>strcodes</B>.
+ These are the corresponding names used for termcap descriptions: <STRONG>bool-</STRONG>
+ <STRONG>codes</STRONG>, <STRONG>numcodes</STRONG>, and <STRONG>strcodes</STRONG>.
</PRE><H3><a name="h3-Terminal-Type">Terminal Type</a></H3><PRE>
A terminal description begins with one or more terminal names separated
by "|" (vertical bars). On initialization of the curses or terminfo
- interfaces, <B><A HREF="curs_terminfo.3X.html">setupterm(3X)</A></B> copies the terminal names to the array <B>tty-</B>
- <B>type</B>.
+ interfaces, <STRONG><A HREF="curs_terminfo.3x.html">setupterm(3x)</A></STRONG> copies the terminal names to the array <STRONG>tty-</STRONG>
+ <STRONG>type</STRONG>.
</PRE><H3><a name="h3-Terminfo-Names">Terminfo Names</a></H3><PRE>
- In addition to the variables, <B><term.h></B> also defines a symbol for each
- terminfo capability <I>long</I> <I>name</I>. These are in terms of the symbol <B>CUR</B>,
+ In addition to the variables, <STRONG><term.h></STRONG> also defines a symbol for each
+ terminfo capability <EM>long</EM> <EM>name</EM>. These are in terms of the symbol <STRONG>CUR</STRONG>,
which is defined
#define CUR ((TERMTYPE *)(cur_term))->
These symbols provide a faster method of accessing terminfo capabili-
- ties than using <B><A HREF="curs_terminfo.3X.html">tigetstr(3X)</A></B>, etc.
+ ties than using <STRONG><A HREF="curs_terminfo.3x.html">tigetstr(3x)</A></STRONG>, etc.
- The actual definition of <B>CUR</B> depends upon the implementation, but each
+ The actual definition of <STRONG>CUR</STRONG> depends upon the implementation, but each
terminfo library provides these long names defined to point into the
current terminal description loaded into memory.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- The low-level terminfo interface is initialized using <B><A HREF="curs_terminfo.3X.html">setupterm(3X)</A></B>.
+ The low-level terminfo interface is initialized using <STRONG><A HREF="curs_terminfo.3x.html">setupterm(3x)</A></STRONG>.
The upper-level curses interface uses the low-level terminfo interface,
internally.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- X/Open Curses does not describe any of these except for <B>cur_term</B>. (The
- inclusion of <B>cur_term</B> appears to be an oversight, since other compara-
+ X/Open Curses does not describe any of these except for <STRONG>cur_term</STRONG>. (The
+ inclusion of <STRONG>cur_term</STRONG> appears to be an oversight, since other compara-
ble low-level information is omitted by X/Open).
Other implementations may have comparable variables. Some implementa-
header files.
All implementations which provide terminfo interfaces add definitions
- as described in the <B>Terminfo</B> <B>Names</B> section. Most, but not all, base
- the definition upon the <B>cur_term</B> variable.
+ as described in the <STRONG>Terminfo</STRONG> <STRONG>Names</STRONG> section. Most, but not all, base
+ the definition upon the <STRONG>cur_term</STRONG> variable.
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_terminfo.3X.html">curs_terminfo(3X)</A></B>, <B><A HREF="curs_threads.3X.html">curs_threads(3X)</A></B>, <B><A HREF="terminfo.5.html">terminfo(5)</A></B>.
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>, <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
- <B><A HREF="term_variables.3X.html">term_variables(3X)</A></B>
+ncurses 6.4 2023-09-09 <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
<ul>
<li><a href="#h3-Alternate-Character-Set-Mapping">Alternate Character Set Mapping</a></li>
<li><a href="#h3-Current-Terminal-Data">Current Terminal Data</a></li>
-<li><a href="#h3-Terminfo-Names">Terminfo Names</a></li>
+<li><a href="#h3-Terminfo-Lookup-Tables">Terminfo Lookup Tables</a></li>
<li><a href="#h3-Terminal-Type">Terminal Type</a></li>
<li><a href="#h3-Terminfo-Names">Terminfo Names</a></li>
</ul>