2 ****************************************************************************
3 * Copyright (c) 2010-2015,2017 Free Software Foundation, Inc. *
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: *
13 * The above copyright notice and this permission notice shall be included *
14 * in all copies or substantial portions of the Software. *
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. *
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 *
28 ****************************************************************************
29 * @Id: curs_variables.3x,v 1.9 2017/11/18 23:56:00 tom Exp @
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_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">
41 <H1 class="no-header">curs_variables 3x</H1>
43 <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG> <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49 <STRONG>COLORS</STRONG>, <STRONG>COLOR_PAIRS</STRONG>, <STRONG>COLS</STRONG>, <STRONG>ESCDELAY</STRONG>, <STRONG>LINES</STRONG>, <STRONG>TABSIZE</STRONG>, <STRONG>curscr</STRONG>, <STRONG>newscr</STRONG>,
50 <STRONG>stdscr</STRONG> - <STRONG>curses</STRONG> global variables
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
56 <STRONG>int</STRONG> <STRONG>COLOR_PAIRS;</STRONG>
57 <STRONG>int</STRONG> <STRONG>COLORS;</STRONG>
58 <STRONG>int</STRONG> <STRONG>COLS;</STRONG>
59 <STRONG>int</STRONG> <STRONG>ESCDELAY;</STRONG>
60 <STRONG>int</STRONG> <STRONG>LINES;</STRONG>
61 <STRONG>int</STRONG> <STRONG>TABSIZE;</STRONG>
62 <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>curscr;</STRONG>
63 <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>newscr;</STRONG>
64 <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> <STRONG>stdscr;</STRONG>
67 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
68 This page summarizes variables provided by the <STRONG>curses</STRONG> library. A more
69 complete description is given in the <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> manual page.
71 Depending on the configuration, these may be actual variables, or
72 macros (see <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG> and <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>) which provide read-
73 only access to <EM>curses</EM>'s state. In either case, applications should
74 treat them as read-only to avoid confusing the library.
77 </PRE><H3><a name="h3-COLOR_PAIRS">COLOR_PAIRS</a></H3><PRE>
78 After initializing curses, this variable contains the number of color
79 pairs which the terminal can support. Usually the number of color
80 pairs will be the product <STRONG>COLORS</STRONG>*<STRONG>COLORS</STRONG>, however this is not always
83 <STRONG>o</STRONG> a few terminals use HLS colors, which do not follow this rule
85 <STRONG>o</STRONG> terminals supporting a large number of colors are limited by the
86 number of color pairs that can be represented in a <EM>signed</EM> <EM>short</EM>
90 </PRE><H3><a name="h3-COLORS">COLORS</a></H3><PRE>
91 After initializing curses, this variable contains the number of colors
92 which the terminal can support.
95 </PRE><H3><a name="h3-COLS">COLS</a></H3><PRE>
96 After initializing curses, this variable contains the width of the
97 screen, i.e., the number of columns.
100 </PRE><H3><a name="h3-ESCDELAY">ESCDELAY</a></H3><PRE>
101 This variable holds the number of milliseconds to wait after reading an
102 escape character, to distinguish between an individual escape character
103 entered on the keyboard from escape sequences sent by cursor- and func-
104 tion-keys (see <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>.
107 </PRE><H3><a name="h3-LINES">LINES</a></H3><PRE>
108 After initializing curses, this variable contains the height of the
109 screen, i.e., the number of lines.
112 </PRE><H3><a name="h3-TABSIZE">TABSIZE</a></H3><PRE>
113 This variable holds the number of columns used by the <EM>curses</EM> library
114 when converting a tab character to spaces as it adds the tab to a win-
115 dow (see <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>.
118 </PRE><H3><a name="h3-The-Current-Screen">The Current Screen</a></H3><PRE>
119 This implementation of curses uses a special window <STRONG>curscr</STRONG> to record
120 its updates to the terminal screen.
123 </PRE><H3><a name="h3-The-New-Screen">The New Screen</a></H3><PRE>
124 This implementation of curses uses a special window <STRONG>newscr</STRONG> to hold up-
125 dates to the terminal screen before applying them to <STRONG>curscr</STRONG>.
128 </PRE><H3><a name="h3-The-Standard-Screen">The Standard Screen</a></H3><PRE>
129 Upon initializing curses, a default window called <STRONG>stdscr</STRONG>, which is the
130 size of the terminal screen, is created. Many curses functions use
134 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
135 The curses library is initialized using either <STRONG><A HREF="curs_initscr.3x.html">initscr(3x)</A></STRONG>, or
136 <STRONG><A HREF="curs_initscr.3x.html">newterm(3x)</A></STRONG>.
138 If <STRONG>curses</STRONG> is configured to use separate curses/terminfo libraries, most
139 of these variables reside in the curses library.
142 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
143 ESCDELAY and TABSIZE are extensions, not provided in most other imple-
144 mentations of curses.
146 ESCDELAY is an extension in AIX curses:
148 <STRONG>o</STRONG> In AIX, the units for ESCDELAY are <EM>fifths</EM> of a millisecond.
150 <STRONG>o</STRONG> The default value for AIX's ESCDELAY is 0.1 seconds.
152 <STRONG>o</STRONG> AIX also enforces a limit of 10,000 seconds for ESCDELAY; this im-
153 plementation currently has no upper limit.
155 This implementation has long used ESCDELAY with units of milliseconds,
156 making it impossible to be completely compatible with AIX. Likewise,
157 most users have either decided to override the value, or rely upon its
161 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
162 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(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>,
163 <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
167 <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
171 <li><a href="#h2-NAME">NAME</a></li>
172 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
173 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
175 <li><a href="#h3-COLOR_PAIRS">COLOR_PAIRS</a></li>
176 <li><a href="#h3-COLORS">COLORS</a></li>
177 <li><a href="#h3-COLS">COLS</a></li>
178 <li><a href="#h3-ESCDELAY">ESCDELAY</a></li>
179 <li><a href="#h3-LINES">LINES</a></li>
180 <li><a href="#h3-TABSIZE">TABSIZE</a></li>
181 <li><a href="#h3-The-Current-Screen">The Current Screen</a></li>
182 <li><a href="#h3-The-New-Screen">The New Screen</a></li>
183 <li><a href="#h3-The-Standard-Screen">The Standard Screen</a></li>
186 <li><a href="#h2-NOTES">NOTES</a></li>
187 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
188 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>