ncurses 6.0 - patch 20151205
[ncurses.git] / doc / html / man / term_variables.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 2011-2013,2015 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: term_variables.3x,v 1.7 2015/12/05 18:43:25 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>term_variables 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">term_variables 3x</H1>
42 <PRE>
43 <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>                                   <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>
44
45
46
47
48 </PRE>
49 <H2><a name="h2-NAME">NAME</a></H2><PRE>
50        <STRONG>SP</STRONG>, <STRONG>acs_map</STRONG>, <STRONG>boolcodes</STRONG>, <STRONG>boolfnames</STRONG>, <STRONG>boolnames</STRONG>, <STRONG>cur_term</STRONG>,
51        <STRONG>numcodes</STRONG>, <STRONG>numfnames</STRONG>, <STRONG>numnames</STRONG>, <STRONG>strcodes</STRONG>, <STRONG>strfnames</STRONG>,
52        <STRONG>strnames</STRONG>, <STRONG>ttytype</STRONG> - <STRONG>curses</STRONG> terminfo global variables
53
54
55 </PRE>
56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
57        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58        <STRONG>#include</STRONG> <STRONG>&lt;term.h&gt;</STRONG>
59
60        <STRONG>chtype</STRONG> <STRONG>acs_map[];</STRONG>
61
62        <STRONG>SCREEN</STRONG> <STRONG>*</STRONG> <STRONG>SP;</STRONG>
63
64        <STRONG>TERMINAL</STRONG> <STRONG>*</STRONG> <STRONG>cur_term;</STRONG>
65
66        <STRONG>char</STRONG> <STRONG>ttytype[];</STRONG>
67
68        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolcodes;</STRONG>
69        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolfnames;</STRONG>
70        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolnames;</STRONG>
71
72        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numcodes;</STRONG>
73        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numfnames;</STRONG>
74        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numnames;</STRONG>
75
76        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strcodes;</STRONG>
77        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strfnames;</STRONG>
78        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strnames;</STRONG>
79
80
81 </PRE>
82 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
83        This  page summarizes variables provided by the <STRONG>curses</STRONG> li-
84        brary's low-level terminfo interface.  A more complete de-
85        scription is given in the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> manual page.
86
87        Depending  on the configuration, these may be actual vari-
88        ables, or  macros  (see  <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>)  which  provide
89        read-only  access  to <EM>curses</EM>'s state.  In either case, ap-
90        plications should treat them as read-only to avoid confus-
91        ing the library.
92
93
94 </PRE>
95 <H3><a name="h3-Alternate-Character-Set-Mapping">Alternate Character Set Mapping</a></H3><PRE>
96        After  initializing the curses or terminfo interfaces, the
97        <STRONG>acs_map</STRONG> array holds information used  to  translate  cells
98        with  the  <STRONG>A_ALTCHARSET</STRONG>  video attribute into line-drawing
99        characters.
100
101        The encoding of the information in this array has  changed
102        periodically.   Application developers need only know that
103        it is used for the "ACS_" constants in &lt;curses.h&gt;.
104
105        The comparable data for the wide-character  library  is  a
106        private variable.
107
108
109 </PRE>
110 <H3><a name="h3-Current-Terminal-Data">Current Terminal Data</a></H3><PRE>
111        After  initializing the curses or terminfo interfaces, the
112        <STRONG>cur_term</STRONG> contains data describing  the  current  terminal.
113        This variable is also set as a side-effect of <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
114        and <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>.
115
116        It is possible to save a value of <STRONG>cur_term</STRONG> for  subsequent
117        use  as  a  parameter  to  <STRONG>set_term</STRONG>, for switching between
118        screens.  Alternatively, one can  save  the  return  value
119        from <STRONG>newterm</STRONG> or <STRONG>setupterm</STRONG> to reuse in <STRONG>set_term</STRONG>.
120
121
122 </PRE>
123 <H3><a name="h3-Terminfo-Names">Terminfo Names</a></H3><PRE>
124        The  <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>  and <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG> programs use lookup tables for
125        the long and short names of terminfo capabilities, as well
126        as  the  corresponding  names  for  termcap  capabilities.
127        These are available to other  applications,  although  the
128        hash-tables used by the terminfo and termcap functions are
129        not available.
130
131        The long terminfo capability names  use  a  "l"  (ell)  in
132        their names: <STRONG>boolfnames</STRONG>, <STRONG>numfnames</STRONG>, and <STRONG>strfnames</STRONG>.
133
134        These are the short names for terminfo capabilities: <STRONG>bool-</STRONG>
135        <STRONG>names</STRONG>, <STRONG>numnames</STRONG>, and <STRONG>strnames</STRONG>.
136
137        These are the corresponding names  used  for  termcap  de-
138        scriptions: <STRONG>boolcodes</STRONG>, <STRONG>numcodes</STRONG>, and <STRONG>strcodes</STRONG>.
139
140
141 </PRE>
142 <H3><a name="h3-Terminal-Type">Terminal Type</a></H3><PRE>
143        On  initialization  of  the curses or terminfo interfaces,
144        <STRONG>setupterm</STRONG> copies the terminal name to the array <STRONG>ttytype</STRONG>.
145
146
147 </PRE>
148 <H3><a name="h3-Terminfo-Names">Terminfo Names</a></H3><PRE>
149        In addition to the variables, <STRONG>&lt;term.h&gt;</STRONG> also defines a sym-
150        bol  for each terminfo capability <EM>long</EM> <EM>name</EM>.  These are in
151        terms of the symbol <STRONG>CUR</STRONG>, which is defined
152
153        #define CUR cur_term-&gt;type.
154
155        These symbols provide a faster method of accessing termin-
156        fo capabilities than using <STRONG><A HREF="tigetstr.3x.html">tigetstr(3x)</A></STRONG>, etc.
157
158
159 </PRE>
160 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
161        The  low-level  terminfo  interface  is  initialized using
162        <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>.  The upper-level curses interface uses  the
163        low-level terminfo interface, internally.
164
165
166 </PRE>
167 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
168        X/Open  Curses  does  not describe any of these except for
169        <STRONG>cur_term</STRONG>.  (The inclusion of <STRONG>cur_term</STRONG>  appears  to  be  an
170        oversight, since other comparable low-level information is
171        omitted by X/Open).
172
173        Other implementations may have comparable variables.  Some
174        implementations  provide the variables in their libraries,
175        but omit them from the header files.
176
177        All implementations which provide terminfo interfaces  add
178        definitions  as  described  in the <STRONG>Terminfo</STRONG> <STRONG>Names</STRONG> section.
179        Most, but not all, base the definition upon  the  <STRONG>cur_term</STRONG>
180        variable.
181
182
183 </PRE>
184 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
185        <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>,
186        <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
187
188
189
190                                                      <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>
191 </PRE>
192 <div class="nav">
193 <ul>
194 <li><a href="#h2-NAME">NAME</a></li>
195 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
196 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
197 <ul>
198 <li><a href="#h3-Alternate-Character-Set-Mapping">Alternate Character Set Mapping</a></li>
199 <li><a href="#h3-Current-Terminal-Data">Current Terminal Data</a></li>
200 <li><a href="#h3-Terminfo-Names">Terminfo Names</a></li>
201 <li><a href="#h3-Terminal-Type">Terminal Type</a></li>
202 <li><a href="#h3-Terminfo-Names">Terminfo Names</a></li>
203 </ul>
204 </li>
205 <li><a href="#h2-NOTES">NOTES</a></li>
206 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
207 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
208 </ul>
209 </div>
210 </BODY>
211 </HTML>