bc1f9baba8b48fbda4e8b96be9e9e921801e77c7
[ncurses.git] / doc / html / man / term_variables.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 2010 Free Software Foundation, Inc.                        *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: term_variables.3x,v 1.2 2010/12/04 18:38:55 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>term_variables 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>term_variables 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
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>NAME</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>SYNOPSIS</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        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolcodes;</STRONG>
62        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolfnames;</STRONG>
63        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolnames;</STRONG>
64        <STRONG>TERMINAL</STRONG> <STRONG>*</STRONG> <STRONG>cur_term;</STRONG>
65        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numcodes;</STRONG>
66        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numfnames;</STRONG>
67        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numnames;</STRONG>
68        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strcodes;</STRONG>
69        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strfnames;</STRONG>
70        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strnames;</STRONG>
71        <STRONG>char</STRONG> <STRONG>ttytype[];</STRONG>
72
73
74 </PRE>
75 <H2>DESCRIPTION</H2><PRE>
76        This  page summarizes variables provided by the <STRONG>curses</STRONG> li-
77        brary's low-level terminfo interface.  A more complete de-
78        scription is given in the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> manual page.
79
80        Depending  on the configuration, these may be actual vari-
81        ables, or  macros  (see  <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>)  which  provide
82        read-only  access  to <EM>curses</EM>'s state.  In either case, ap-
83        plications should treat them as read-only to avoid confus-
84        ing the library.
85
86    <STRONG>Alternate</STRONG> <STRONG>Character</STRONG> <STRONG>Set</STRONG> <STRONG>Mapping</STRONG>
87        After  initializing the curses or terminfo interfaces, the
88        <STRONG>acs_map</STRONG> array holds information used  to  translate  cells
89        with  the  <STRONG>A_ALTCHARSET</STRONG>  video attribute into line-drawing
90        characters.
91
92        The encoding of the information in this array has  changed
93        periodically.   Application developers need only know that
94        it is used for the "ACS_" constants in &lt;curses.h&gt;.
95
96        The comparable data for the wide-character  library  is  a
97        private variable.
98
99    <STRONG>Current</STRONG> <STRONG>Terminal</STRONG> <STRONG>Data</STRONG>
100        After  initializing the curses or terminfo interfaces, the
101        <STRONG>cur_term</STRONG> contains data describing  the  current  terminal.
102        This variable is also set as a side-effect of <STRONG><A HREF="set_term.3x.html">set_term(3x)</A></STRONG>
103        and <STRONG><A HREF="delscreen.3x.html">delscreen(3x)</A></STRONG>.
104
105        It is possible to save a value of <STRONG>cur_term</STRONG> for  subsequent
106        use  as  a  parameter  to  <STRONG>set_term</STRONG>, for switching between
107        screens.  Alternatively, one can  save  the  return  value
108        from <STRONG>newterm</STRONG> or <STRONG>setupterm</STRONG> to reuse in <STRONG>set_term</STRONG>.
109
110    <STRONG>Terminfo</STRONG> <STRONG>Names</STRONG>
111        The  <STRONG><A HREF="tic.1.html">tic(1)</A></STRONG>  and <STRONG><A HREF="infocmp.1.html">infocmp(1)</A></STRONG> programs use lookup tables for
112        the long and short names of terminfo capabilities, as well
113        as  the  corresponding  names  for  termcap  capabilities.
114        These are available  to  other  applications,  though  the
115        hash-tables are not available.
116
117        The  long  terminfo  capability  names  use a "l" (ell) in
118        their names: boolfnames numfnames strfnames
119
120        These are the short names for terminfo capabilities: bool-
121        names, numnames, and strnames.
122
123        These  are  the  corresponding  names used for termcap de-
124        scriptions: boolcodes, numcodes, and strcodes.
125
126    <STRONG>Terminal</STRONG> <STRONG>Type</STRONG>
127        On initialization of the curses  or  terminfo  interfaces,
128        <STRONG>setupterm</STRONG> copies the terminal name to the array <STRONG>ttytype</STRONG>.
129
130
131 </PRE>
132 <H2>NOTES</H2><PRE>
133        The  low-level terminfo interface is initialized using <STRONG>se-</STRONG>
134        <STRONG><A HREF="setupterm.3x.html">tupterm(3x)</A></STRONG>.  The upper-level curses  interface  uses  the
135        low-level terminfo interface, internally.
136
137
138 </PRE>
139 <H2>PORTABILITY</H2><PRE>
140        X/Open  Curses  does  not describe any of these except for
141        <STRONG>cur_term</STRONG>.  (The inclusion of <STRONG>cur_term</STRONG>  appears  to  be  an
142        oversight, since other comparable low-level information is
143        omitted by X/Open).
144
145        Other implementations may have comparable variables.  Some
146        implementations  provide the variables in their libraries,
147        but omit them from the header files.
148
149
150 </PRE>
151 <H2>SEE ALSO</H2><PRE>
152        <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>termin-</STRONG>
153        <STRONG><A HREF="terminfo.3x.html">fo(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
154
155
156
157                                                      <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>
158 </PRE>
159 <HR>
160 <ADDRESS>
161 Man(1) output converted with
162 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
163 </ADDRESS>
164 </BODY>
165 </HTML>