3 ****************************************************************************
4 * Copyright 2018-2020,2021 Thomas E. Dickey *
5 * Copyright 1998-2015,2017 Free Software Foundation, Inc. *
7 * Permission is hereby granted, free of charge, to any person obtaining a *
8 * copy of this software and associated documentation files (the *
9 * "Software"), to deal in the Software without restriction, including *
10 * without limitation the rights to use, copy, modify, merge, publish, *
11 * distribute, distribute with modifications, sublicense, and/or sell *
12 * copies of the Software, and to permit persons to whom the Software is *
13 * furnished to do so, subject to the following conditions: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
21 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
24 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26 * Except as contained in this notice, the name(s) of the above copyright *
27 * holders shall not be used in advertising or otherwise to promote the *
28 * sale, use or other dealings in this Software without prior written *
30 ****************************************************************************
31 * @Id: ncurses.3x,v 1.152 2021/01/09 11:07:55 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>ncurses 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
43 <H1 class="no-header">ncurses 3x</H1>
45 <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG> <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>ncurses</STRONG> - CRT screen handling and optimization package
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
58 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
59 The <STRONG>ncurses</STRONG> library routines give the user a terminal-independent
60 method of updating character screens with reasonable optimization.
61 This implementation is "new curses" (ncurses) and is the approved
62 replacement for 4.4BSD classic curses, which has been discontinued.
63 This describes <STRONG>ncurses</STRONG> version 6.2 (patch 20210522).
65 The <STRONG>ncurses</STRONG> library emulates the curses library of System V Release 4
66 UNIX, and XPG4 (X/Open Portability Guide) curses (also known as XSI
67 curses). XSI stands for X/Open System Interfaces Extension. The
68 <STRONG>ncurses</STRONG> library is freely redistributable in source form. Differences
69 from the SVr4 curses are summarized under the <STRONG>EXTENSIONS</STRONG> and
70 <STRONG>PORTABILITY</STRONG> sections below and described in detail in the respective
71 <STRONG>EXTENSIONS</STRONG>, <STRONG>PORTABILITY</STRONG> and <STRONG>BUGS</STRONG> sections of individual man pages.
73 The <STRONG>ncurses</STRONG> library also provides many useful extensions, i.e.,
74 features which cannot be implemented by a simple add-on library but
75 which require access to the internals of the library.
77 A program using these routines must be linked with the <STRONG>-lncurses</STRONG>
78 option, or (if it has been generated) with the debugging library
79 <STRONG>-lncurses_g</STRONG>. (Your system integrator may also have installed these
80 libraries under the names <STRONG>-lcurses</STRONG> and <STRONG>-lcurses_g</STRONG>.) The ncurses_g
81 library generates trace logs (in a file called 'trace' in the current
82 directory) that describe curses actions. See also the section on
83 <STRONG>ALTERNATE</STRONG> <STRONG>CONFIGURATIONS</STRONG>.
85 The <STRONG>ncurses</STRONG> package supports: overall screen, window and pad
86 manipulation; output to windows and pads; reading terminal input;
87 control over terminal and <STRONG>curses</STRONG> input and output options; environment
88 query routines; color manipulation; use of soft label keys; terminfo
89 capabilities; and access to low-level terminal-manipulation routines.
92 </PRE><H3><a name="h3-Initialization">Initialization</a></H3><PRE>
93 The library uses the locale which the calling program has initialized.
94 That is normally done with <STRONG>setlocale</STRONG>:
96 <STRONG>setlocale(LC_ALL,</STRONG> <STRONG>"");</STRONG>
98 If the locale is not initialized, the library assumes that characters
99 are printable as in ISO-8859-1, to work with certain legacy programs.
100 You should initialize the locale and not rely on specific details of
101 the library when the locale has not been setup.
103 The function <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> must be called to initialize the
104 library before any of the other routines that deal with windows and
105 screens are used. The routine <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG> must be called before
108 To get character-at-a-time input without echoing (most interactive,
109 screen oriented programs want this), the following sequence should be
112 <STRONG>initscr();</STRONG> <STRONG>cbreak();</STRONG> <STRONG>noecho();</STRONG>
114 Most programs would additionally use the sequence:
116 <STRONG>intrflush(stdscr,</STRONG> <STRONG>FALSE);</STRONG>
117 <STRONG>keypad(stdscr,</STRONG> <STRONG>TRUE);</STRONG>
119 Before a <STRONG>curses</STRONG> program is run, the tab stops of the terminal should be
120 set and its initialization strings, if defined, must be output. This
121 can be done by executing the <STRONG>tput</STRONG> <STRONG>init</STRONG> command after the shell
122 environment variable <STRONG>TERM</STRONG> has been exported. <STRONG>tset(1)</STRONG> is usually
123 responsible for doing this. [See <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> for further details.]
126 </PRE><H3><a name="h3-Datatypes">Datatypes</a></H3><PRE>
127 The <STRONG>ncurses</STRONG> library permits manipulation of data structures, called
128 <EM>windows</EM>, which can be thought of as two-dimensional arrays of
129 characters representing all or part of a CRT screen. A default window
130 called <STRONG>stdscr</STRONG>, which is the size of the terminal screen, is supplied.
131 Others may be created with <STRONG>newwin</STRONG>.
133 Note that <STRONG>curses</STRONG> does not handle overlapping windows, that's done by
134 the <STRONG><A HREF="panel.3x.html">panel(3x)</A></STRONG> library. This means that you can either use <STRONG>stdscr</STRONG> or
135 divide the screen into tiled windows and not using <STRONG>stdscr</STRONG> at all.
136 Mixing the two will result in unpredictable, and undesired, effects.
138 Windows are referred to by variables declared as <STRONG>WINDOW</STRONG> <STRONG>*</STRONG>. These data
139 structures are manipulated with routines described here and elsewhere
140 in the <STRONG>ncurses</STRONG> manual pages. Among those, the most basic routines are
141 <STRONG>move</STRONG> and <STRONG>addch</STRONG>. More general versions of these routines are included
142 with names beginning with <STRONG>w</STRONG>, allowing the user to specify a window.
143 The routines not beginning with <STRONG>w</STRONG> affect <STRONG>stdscr</STRONG>.
145 After using routines to manipulate a window, <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG> is called,
146 telling <STRONG>curses</STRONG> to make the user's CRT screen look like <STRONG>stdscr</STRONG>. The
147 characters in a window are actually of type <STRONG>chtype</STRONG>, (character and
148 attribute data) so that other information about the character may also
149 be stored with each character.
151 Special windows called <EM>pads</EM> may also be manipulated. These are windows
152 which are not constrained to the size of the screen and whose contents
153 need not be completely displayed. See <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG> for more
156 In addition to drawing characters on the screen, video attributes and
157 colors may be supported, causing the characters to show up in such
158 modes as underlined, in reverse video, or in color on terminals that
159 support such display enhancements. Line drawing characters may be
160 specified to be output. On input, <STRONG>curses</STRONG> is also able to translate
161 arrow and function keys that transmit escape sequences into single
162 values. The video attributes, line drawing characters, and input
163 values use names, defined in <STRONG><curses.h></STRONG>, such as <STRONG>A_REVERSE</STRONG>, <STRONG>ACS_HLINE</STRONG>,
164 and <STRONG>KEY_LEFT</STRONG>.
167 </PRE><H3><a name="h3-Environment-variables">Environment variables</a></H3><PRE>
168 If the environment variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> are set, or if the
169 program is executing in a window environment, line and column
170 information in the environment will override information read by
171 <EM>terminfo</EM>. This would affect a program running in an AT&T 630 layer,
172 for example, where the size of a screen is changeable (see
173 <STRONG>ENVIRONMENT</STRONG>).
175 If the environment variable <STRONG>TERMINFO</STRONG> is defined, any program using
176 <STRONG>curses</STRONG> checks for a local terminal definition before checking in the
177 standard place. For example, if <STRONG>TERM</STRONG> is set to <STRONG>att4424</STRONG>, then the
178 compiled terminal definition is found in
180 <STRONG>/usr/share/terminfo/a/att4424</STRONG>.
182 (The <STRONG>a</STRONG> is copied from the first letter of <STRONG>att4424</STRONG> to avoid creation of
183 huge directories.) However, if <STRONG>TERMINFO</STRONG> is set to <STRONG>$HOME/myterms</STRONG>,
184 <STRONG>curses</STRONG> first checks
186 <STRONG>$HOME/myterms/a/att4424</STRONG>,
188 and if that fails, it then checks
190 <STRONG>/usr/share/terminfo/a/att4424</STRONG>.
192 This is useful for developing experimental definitions or when write
193 permission in <STRONG>/usr/share/terminfo</STRONG> is not available.
195 The integer variables <STRONG>LINES</STRONG> and <STRONG>COLS</STRONG> are defined in <STRONG><curses.h></STRONG> and will
196 be filled in by <STRONG>initscr</STRONG> with the size of the screen. The constants
197 <STRONG>TRUE</STRONG> and <STRONG>FALSE</STRONG> have the values <STRONG>1</STRONG> and <STRONG>0</STRONG>, respectively.
199 The <STRONG>curses</STRONG> routines also define the <STRONG>WINDOW</STRONG> <STRONG>*</STRONG> variable <STRONG>curscr</STRONG> which is
200 used for certain low-level operations like clearing and redrawing a
201 screen containing garbage. The <STRONG>curscr</STRONG> can be used in only a few
205 </PRE><H3><a name="h3-Routine-and-Argument-Names">Routine and Argument Names</a></H3><PRE>
206 Many <STRONG>curses</STRONG> routines have two or more versions. The routines prefixed
207 with <STRONG>w</STRONG> require a window argument. The routines prefixed with <STRONG>p</STRONG> require
208 a pad argument. Those without a prefix generally use <STRONG>stdscr</STRONG>.
210 The routines prefixed with <STRONG>mv</STRONG> require a <EM>y</EM> and <EM>x</EM> coordinate to move to
211 before performing the appropriate action. The <STRONG>mv</STRONG> routines imply a call
212 to <STRONG>move</STRONG> before the call to the other routine. The coordinate <EM>y</EM> always
213 refers to the row (of the window), and <EM>x</EM> always refers to the column.
214 The upper left-hand corner is always (0,0), not (1,1).
216 The routines prefixed with <STRONG>mvw</STRONG> take both a window argument and <EM>x</EM> and <EM>y</EM>
217 coordinates. The window argument is always specified before the
220 In each case, <EM>win</EM> is the window affected, and <EM>pad</EM> is the pad affected;
221 <EM>win</EM> and <EM>pad</EM> are always pointers to type <STRONG>WINDOW</STRONG>.
223 Option setting routines require a Boolean flag <EM>bf</EM> with the value <STRONG>TRUE</STRONG>
224 or <STRONG>FALSE</STRONG>; <EM>bf</EM> is always of type <STRONG>bool</STRONG>. Most of the data types used in
225 the library routines, such as <STRONG>WINDOW</STRONG>, <STRONG>SCREEN</STRONG>, <STRONG>bool</STRONG>, and <STRONG>chtype</STRONG> are
226 defined in <STRONG><curses.h></STRONG>. Types used for the terminfo routines such as
227 <STRONG>TERMINAL</STRONG> are defined in <STRONG><term.h></STRONG>.
229 This manual page describes functions which may appear in any
230 configuration of the library. There are two common configurations of
234 the "normal" library, which handles 8-bit characters. The
235 normal (8-bit) library stores characters combined with
236 attributes in <STRONG>chtype</STRONG> data.
238 Attributes alone (no corresponding character) may be stored in
239 <STRONG>chtype</STRONG> or the equivalent <STRONG>attr_t</STRONG> data. In either case, the data
240 is stored in something like an integer.
242 Each cell (row and column) in a <STRONG>WINDOW</STRONG> is stored as a <STRONG>chtype</STRONG>.
245 the so-called "wide" library, which handles multibyte
246 characters (see the section on <STRONG>ALTERNATE</STRONG> <STRONG>CONFIGURATIONS</STRONG>). The
247 "wide" library includes all of the calls from the "normal"
248 library. It adds about one third more calls using data types
249 which store multibyte characters:
251 <STRONG>cchar_t</STRONG>
252 corresponds to <STRONG>chtype</STRONG>. However it is a structure, because
253 more data is stored than can fit into an integer. The
254 characters are large enough to require a full integer
255 value - and there may be more than one character per cell.
256 The video attributes and color are stored in separate
257 fields of the structure.
259 Each cell (row and column) in a <STRONG>WINDOW</STRONG> is stored as a
260 <STRONG>cchar_t</STRONG>.
262 The <STRONG><A HREF="curs_getcchar.3x.html">setcchar(3x)</A></STRONG> and <STRONG><A HREF="curs_getcchar.3x.html">getcchar(3x)</A></STRONG> functions store and
263 retrieve the data from a <STRONG>cchar_t</STRONG> structure.
265 <STRONG>wchar_t</STRONG>
266 stores a "wide" character. Like <STRONG>chtype</STRONG>, this may be an
269 <STRONG>wint_t</STRONG>
270 stores a <STRONG>wchar_t</STRONG> or <STRONG>WEOF</STRONG> - not the same, though both may
273 The "wide" library provides new functions which are analogous
274 to functions in the "normal" library. There is a naming
275 convention which relates many of the normal/wide variants: a
276 "_w" is inserted into the name. For example, <STRONG>waddch</STRONG> becomes
277 <STRONG>wadd_wch</STRONG>.
280 </PRE><H3><a name="h3-Routine-Name-Index">Routine Name Index</a></H3><PRE>
281 The following table lists the <STRONG>curses</STRONG> routines provided in the "normal"
282 and "wide" libraries and the names of the manual pages on which they
283 are described. Routines flagged with "*" are ncurses-specific, not
284 described by XPG4 or present in SVr4.
286 <STRONG>curses</STRONG> Routine Name Manual Page Name
287 ---------------------------------------------
288 COLOR_PAIR <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>
289 PAIR_NUMBER <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
290 add_wch <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
291 add_wchnstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>
292 add_wchstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>
293 addch <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>
294 addchnstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
295 addchstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
296 addnstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
297 addnwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>
298 addstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
299 addwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>
300 alloc_pair <STRONG><A HREF="new_pair.3x.html">new_pair(3x)</A></STRONG>*
301 assume_default_colors <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>*
302 attr_get <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
303 attr_off <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
304 attr_on <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
305 attr_set <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
306 attroff <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
307 attron <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
308 attrset <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
309 baudrate <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
310 beep <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>
311 bkgd <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
312 bkgdset <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
313 bkgrnd <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
314 bkgrndset <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
315 border <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
317 border_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG>
318 box <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
319 box_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG>
320 can_change_color <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>
321 cbreak <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
322 chgat <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
323 clear <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
324 clearok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
325 clrtobot <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
326 clrtoeol <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
327 color_content <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>
328 color_set <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
329 copywin <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
330 curs_set <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
331 curses_trace <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>*
332 curses_version <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>*
333 def_prog_mode <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
334 def_shell_mode <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
335 define_key <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG>*
336 del_curterm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
337 delay_output <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
338 delch <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>
339 deleteln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG>
340 delscreen <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
341 delwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
342 derwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
343 doupdate <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
344 dupwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
345 echo <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
346 echo_wchar <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
347 echochar <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>
348 endwin <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
349 erase <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
350 erasechar <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
351 erasewchar <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
352 exit_curses <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>*
353 exit_terminfo <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG>*
354 extended_color_content <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>*
355 extended_pair_content <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>*
356 extended_slk_color <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>*
357 filter <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
358 find_pair <STRONG><A HREF="new_pair.3x.html">new_pair(3x)</A></STRONG>*
359 flash <STRONG><A HREF="curs_beep.3x.html">curs_beep(3x)</A></STRONG>
360 flushinp <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
361 free_pair <STRONG><A HREF="new_pair.3x.html">new_pair(3x)</A></STRONG>*
362 get_wch <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
363 get_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
364 getattrs <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
365 getbegx <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>*
366 getbegy <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>*
367 getbegyx <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>
368 getbkgd <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
369 getbkgrnd <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
370 getcchar <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG>
371 getch <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>
372 getcurx <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>*
373 getcury <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>*
374 getmaxx <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>*
375 getmaxy <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>*
376 getmaxyx <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>
377 getmouse <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>*
378 getn_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
379 getnstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
380 getparx <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>*
381 getpary <STRONG><A HREF="curs_legacy.3x.html">curs_legacy(3x)</A></STRONG>*
383 getparyx <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>
384 getstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
385 getsyx <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
386 getwin <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
387 getyx <STRONG><A HREF="curs_getyx.3x.html">curs_getyx(3x)</A></STRONG>
388 halfdelay <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
389 has_colors <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>
390 has_ic <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
391 has_il <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
392 has_key <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>*
393 has_mouse <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>*
394 hline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
395 hline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG>
396 idcok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
397 idlok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
398 immedok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
399 in_wch <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
400 in_wchnstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
401 in_wchstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
402 inch <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
403 inchnstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
404 inchstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
405 init_color <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>
406 init_extended_color <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>*
407 init_extended_pair <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>*
408 init_pair <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>
409 initscr <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
410 innstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
411 innwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
412 ins_nwstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG>
413 ins_wch <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>
414 ins_wstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG>
415 insch <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>
416 insdelln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG>
417 insertln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG>
418 insnstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
419 insstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
420 instr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
421 intrflush <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
422 inwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
423 is_cleared <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
424 is_idcok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
425 is_idlok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
426 is_immedok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
427 is_keypad <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
428 is_leaveok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
429 is_linetouched <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>
430 is_nodelay <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
431 is_notimeout <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
432 is_pad <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
433 is_scrollok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
434 is_subwin <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
435 is_syncok <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
436 is_term_resized <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>*
437 is_wintouched <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>
438 isendwin <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
439 key_defined <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>*
440 key_name <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
441 keybound <STRONG><A HREF="keybound.3x.html">keybound(3x)</A></STRONG>*
442 keyname <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
443 keyok <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG>*
444 keypad <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
445 killchar <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
446 killwchar <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
447 leaveok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
449 longname <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
450 mcprint <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG>*
451 meta <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
452 mouse_trafo <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>*
453 mouseinterval <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>*
454 mousemask <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>*
455 move <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>
456 mvadd_wch <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
457 mvadd_wchnstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>
458 mvadd_wchstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>
459 mvaddch <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>
460 mvaddchnstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
461 mvaddchstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
462 mvaddnstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
463 mvaddnwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>
464 mvaddstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
465 mvaddwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>
466 mvchgat <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
467 mvcur <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
468 mvdelch <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>
469 mvderwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
470 mvget_wch <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
471 mvget_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
472 mvgetch <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>
473 mvgetn_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
474 mvgetnstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
475 mvgetstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
476 mvhline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
477 mvhline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG>
478 mvin_wch <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
479 mvin_wchnstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
480 mvin_wchstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
481 mvinch <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
482 mvinchnstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
483 mvinchstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
484 mvinnstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
485 mvinnwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
486 mvins_nwstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG>
487 mvins_wch <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>
488 mvins_wstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG>
489 mvinsch <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>
490 mvinsnstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
491 mvinsstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
492 mvinstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
493 mvinwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
494 mvprintw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>
495 mvscanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
496 mvvline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
497 mvvline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG>
498 mvwadd_wch <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
499 mvwadd_wchnstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>
500 mvwadd_wchstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>
501 mvwaddch <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>
502 mvwaddchnstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
503 mvwaddchstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
504 mvwaddnstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
505 mvwaddnwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>
506 mvwaddstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
507 mvwaddwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>
508 mvwchgat <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
509 mvwdelch <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>
510 mvwget_wch <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
511 mvwget_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
512 mvwgetch <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>
513 mvwgetn_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
515 mvwgetnstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
516 mvwgetstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
517 mvwhline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
518 mvwhline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG>
519 mvwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
520 mvwin_wch <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
521 mvwin_wchnstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
522 mvwin_wchstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
523 mvwinch <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
524 mvwinchnstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
525 mvwinchstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
526 mvwinnstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
527 mvwinnwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
528 mvwins_nwstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG>
529 mvwins_wch <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>
530 mvwins_wstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG>
531 mvwinsch <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>
532 mvwinsnstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
533 mvwinsstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
534 mvwinstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
535 mvwinwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
536 mvwprintw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>
537 mvwscanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
538 mvwvline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
539 mvwvline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG>
540 napms <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
541 newpad <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>
542 newterm <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
543 newwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
544 nl <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
545 nocbreak <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
546 nodelay <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
547 noecho <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
548 nofilter <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>*
549 nonl <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
550 noqiflush <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
551 noraw <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
552 notimeout <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
553 overlay <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
554 overwrite <STRONG><A HREF="curs_overlay.3x.html">curs_overlay(3x)</A></STRONG>
555 pair_content <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>
556 pecho_wchar <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>*
557 pechochar <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>
558 pnoutrefresh <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>
559 prefresh <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>
560 printw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>
561 putp <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
562 putwin <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
563 qiflush <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
564 raw <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
565 redrawwin <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
566 refresh <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
567 reset_color_pairs <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>*
568 reset_prog_mode <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
569 reset_shell_mode <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
570 resetty <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
571 resize_term <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>*
572 resizeterm <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG>*
573 restartterm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
574 ripoffline <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
575 savetty <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
576 scanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
577 scr_dump <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
578 scr_init <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
579 scr_restore <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
581 scr_set <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
582 scrl <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>
583 scroll <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>
584 scrollok <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
585 set_curterm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
586 set_term <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
587 setcchar <STRONG><A HREF="curs_getcchar.3x.html">curs_getcchar(3x)</A></STRONG>
588 setscrreg <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
589 setsyx <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
590 setupterm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
591 slk_attr <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>*
592 slk_attr_off <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
593 slk_attr_on <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
594 slk_attr_set <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
595 slk_attroff <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
596 slk_attron <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
597 slk_attrset <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
598 slk_clear <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
599 slk_color <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
600 slk_init <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
601 slk_label <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
602 slk_noutrefresh <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
603 slk_refresh <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
604 slk_restore <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
605 slk_set <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
606 slk_touch <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>
607 slk_wset <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>*
608 standend <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
609 standout <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
610 start_color <STRONG><A HREF="curs_color.3x.html">curs_color(3x)</A></STRONG>
611 subpad <STRONG><A HREF="curs_pad.3x.html">curs_pad(3x)</A></STRONG>
612 subwin <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
613 syncok <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
614 term_attrs <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
615 termattrs <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
616 termname <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
617 tgetent <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
618 tgetflag <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
619 tgetnum <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
620 tgetstr <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
621 tgoto <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
622 tigetflag <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
623 tigetnum <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
624 tigetstr <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
625 timeout <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
626 tiparm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>*
627 touchline <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>
628 touchwin <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>
629 tparm <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
630 tputs <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
631 tputs <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
632 trace <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG>*
633 typeahead <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
634 unctrl <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
635 unget_wch <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
636 ungetch <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>
637 ungetmouse <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>*
638 untouchwin <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>
639 use_default_colors <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>*
640 use_env <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
641 use_extended_names <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG>*
642 use_legacy_coding <STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>*
643 use_tioctl <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>*
644 vid_attr <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
645 vid_puts <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
647 vidattr <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
648 vidputs <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
649 vline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
650 vline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG>
651 vw_printw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>
652 vw_scanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
653 vwprintw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>
654 vwscanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
655 wadd_wch <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
656 wadd_wchnstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>
657 wadd_wchstr <STRONG><A HREF="curs_add_wchstr.3x.html">curs_add_wchstr(3x)</A></STRONG>
658 waddch <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>
659 waddchnstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
660 waddchstr <STRONG><A HREF="curs_addchstr.3x.html">curs_addchstr(3x)</A></STRONG>
661 waddnstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
662 waddnwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>
663 waddstr <STRONG><A HREF="curs_addstr.3x.html">curs_addstr(3x)</A></STRONG>
664 waddwstr <STRONG><A HREF="curs_addwstr.3x.html">curs_addwstr(3x)</A></STRONG>
665 wattr_get <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
666 wattr_off <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
667 wattr_on <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
668 wattr_set <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
669 wattroff <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
670 wattron <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
671 wattrset <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
672 wbkgd <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
673 wbkgdset <STRONG><A HREF="curs_bkgd.3x.html">curs_bkgd(3x)</A></STRONG>
674 wbkgrnd <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
675 wbkgrndset <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
676 wborder <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
677 wborder_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG>
678 wchgat <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
679 wclear <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
680 wclrtobot <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
681 wclrtoeol <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
682 wcolor_set <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
683 wcursyncup <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
684 wdelch <STRONG><A HREF="curs_delch.3x.html">curs_delch(3x)</A></STRONG>
685 wdeleteln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG>
686 wecho_wchar <STRONG><A HREF="curs_add_wch.3x.html">curs_add_wch(3x)</A></STRONG>
687 wechochar <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>
688 wenclose <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>*
689 werase <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>
690 wget_wch <STRONG><A HREF="curs_get_wch.3x.html">curs_get_wch(3x)</A></STRONG>
691 wget_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
692 wgetbkgrnd <STRONG><A HREF="curs_bkgrnd.3x.html">curs_bkgrnd(3x)</A></STRONG>
693 wgetch <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>
694 wgetdelay <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
695 wgetn_wstr <STRONG><A HREF="curs_get_wstr.3x.html">curs_get_wstr(3x)</A></STRONG>
696 wgetnstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
697 wgetparent <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
698 wgetscrreg <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG>*
699 wgetstr <STRONG><A HREF="curs_getstr.3x.html">curs_getstr(3x)</A></STRONG>
700 whline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
701 whline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG>
702 win_wch <STRONG><A HREF="curs_in_wch.3x.html">curs_in_wch(3x)</A></STRONG>
703 win_wchnstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
704 win_wchstr <STRONG><A HREF="curs_in_wchstr.3x.html">curs_in_wchstr(3x)</A></STRONG>
705 winch <STRONG><A HREF="curs_inch.3x.html">curs_inch(3x)</A></STRONG>
706 winchnstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
707 winchstr <STRONG><A HREF="curs_inchstr.3x.html">curs_inchstr(3x)</A></STRONG>
708 winnstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
709 winnwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
710 wins_nwstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG>
711 wins_wch <STRONG><A HREF="curs_ins_wch.3x.html">curs_ins_wch(3x)</A></STRONG>
713 wins_wstr <STRONG><A HREF="curs_ins_wstr.3x.html">curs_ins_wstr(3x)</A></STRONG>
714 winsch <STRONG><A HREF="curs_insch.3x.html">curs_insch(3x)</A></STRONG>
715 winsdelln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG>
716 winsertln <STRONG><A HREF="curs_deleteln.3x.html">curs_deleteln(3x)</A></STRONG>
717 winsnstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
718 winsstr <STRONG><A HREF="curs_insstr.3x.html">curs_insstr(3x)</A></STRONG>
719 winstr <STRONG><A HREF="curs_instr.3x.html">curs_instr(3x)</A></STRONG>
720 winwstr <STRONG><A HREF="curs_inwstr.3x.html">curs_inwstr(3x)</A></STRONG>
721 wmouse_trafo <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG>*
722 wmove <STRONG><A HREF="curs_move.3x.html">curs_move(3x)</A></STRONG>
723 wnoutrefresh <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
724 wprintw <STRONG><A HREF="curs_printw.3x.html">curs_printw(3x)</A></STRONG>
725 wredrawln <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
726 wrefresh <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>
727 wresize <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG>*
728 wscanw <STRONG><A HREF="curs_scanw.3x.html">curs_scanw(3x)</A></STRONG>
729 wscrl <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>
730 wsetscrreg <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
731 wstandend <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
732 wstandout <STRONG><A HREF="curs_attr.3x.html">curs_attr(3x)</A></STRONG>
733 wsyncdown <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
734 wsyncup <STRONG><A HREF="curs_window.3x.html">curs_window(3x)</A></STRONG>
735 wtimeout <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG>
736 wtouchln <STRONG><A HREF="curs_touch.3x.html">curs_touch(3x)</A></STRONG>
737 wunctrl <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
738 wvline <STRONG><A HREF="curs_border.3x.html">curs_border(3x)</A></STRONG>
739 wvline_set <STRONG><A HREF="curs_border_set.3x.html">curs_border_set(3x)</A></STRONG>
741 Depending on the configuration, additional sets of functions may be
744 <STRONG><A HREF="curs_memleaks.3x.html">curs_memleaks(3x)</A></STRONG> - curses memory-leak checking
746 <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG> - curses screen-pointer extension
748 <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG> - curses thread support
750 <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG> - curses debugging routines
753 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
754 Routines that return an integer return <STRONG>ERR</STRONG> upon failure and an integer
755 value other than <STRONG>ERR</STRONG> upon successful completion, unless otherwise noted
756 in the routine descriptions.
758 As a general rule, routines check for null pointers passed as
759 parameters, and handle this as an error.
761 All macros return the value of the <STRONG>w</STRONG> version, except <STRONG>setscrreg</STRONG>,
762 <STRONG>wsetscrreg</STRONG>, <STRONG>getyx</STRONG>, <STRONG>getbegyx</STRONG>, and <STRONG>getmaxyx</STRONG>. The return values of
763 <STRONG>setscrreg</STRONG>, <STRONG>wsetscrreg</STRONG>, <STRONG>getyx</STRONG>, <STRONG>getbegyx</STRONG>, and <STRONG>getmaxyx</STRONG> are undefined
764 (i.e., these should not be used as the right-hand side of assignment
767 Functions with a "mv" prefix first perform a cursor movement using
768 <STRONG>wmove</STRONG>, and return an error if the position is outside the window, or if
769 the window pointer is null. Most "mv"-prefixed functions (except
770 variadic functions such as <STRONG>mvprintw</STRONG>) are provided both as macros and
773 Routines that return pointers return <STRONG>NULL</STRONG> on error.
776 </PRE><H2><a name="h2-ENVIRONMENT">ENVIRONMENT</a></H2><PRE>
777 The following environment symbols are useful for customizing the
778 runtime behavior of the <STRONG>ncurses</STRONG> library. The most important ones have
779 been already discussed in detail.
782 </PRE><H3><a name="h3-CC-command-character">CC command-character</a></H3><PRE>
783 When set, change occurrences of the command_character (i.e., the <STRONG>cmdch</STRONG>
784 capability) of the loaded terminfo entries to the value of this
785 variable. Very few terminfo entries provide this feature.
787 Because this name is also used in development environments to represent
788 the C compiler's name, <STRONG>ncurses</STRONG> ignores it if it does not happen to be a
792 </PRE><H3><a name="h3-BAUDRATE">BAUDRATE</a></H3><PRE>
793 The debugging library checks this environment variable when the
794 application has redirected output to a file. The variable's numeric
795 value is used for the baudrate. If no value is found, <STRONG>ncurses</STRONG> uses
796 9600. This allows testers to construct repeatable test-cases that take
797 into account costs that depend on baudrate.
800 </PRE><H3><a name="h3-COLUMNS">COLUMNS</a></H3><PRE>
801 Specify the width of the screen in characters. Applications running in
802 a windowing environment usually are able to obtain the width of the
803 window in which they are executing. If neither the <STRONG>COLUMNS</STRONG> value nor
804 the terminal's screen size is available, <STRONG>ncurses</STRONG> uses the size which
805 may be specified in the terminfo database (i.e., the <STRONG>cols</STRONG> capability).
807 It is important that your application use a correct size for the
808 screen. This is not always possible because your application may be
809 running on a host which does not honor NAWS (Negotiations About Window
810 Size), or because you are temporarily running as another user.
811 However, setting <STRONG>COLUMNS</STRONG> and/or <STRONG>LINES</STRONG> overrides the library's use of
812 the screen size obtained from the operating system.
814 Either <STRONG>COLUMNS</STRONG> or <STRONG>LINES</STRONG> symbols may be specified independently. This
815 is mainly useful to circumvent legacy misfeatures of terminal
816 descriptions, e.g., xterm which commonly specifies a 65 line screen.
817 For best results, <STRONG>lines</STRONG> and <STRONG>cols</STRONG> should not be specified in a terminal
818 description for terminals which are run as emulations.
820 Use the <STRONG>use_env</STRONG> function to disable all use of external environment
821 (but not including system calls) to determine the screen size. Use the
822 <STRONG>use_tioctl</STRONG> function to update <STRONG>COLUMNS</STRONG> or <STRONG>LINES</STRONG> to match the screen size
823 obtained from system calls or the terminal database.
826 </PRE><H3><a name="h3-ESCDELAY">ESCDELAY</a></H3><PRE>
827 Specifies the total time, in milliseconds, for which ncurses will await
828 a character sequence, e.g., a function key. The default value, 1000
829 milliseconds, is enough for most uses. However, it is made a variable
830 to accommodate unusual applications.
832 The most common instance where you may wish to change this value is to
833 work with slow hosts, e.g., running on a network. If the host cannot
834 read characters rapidly enough, it will have the same effect as if the
835 terminal did not send characters rapidly enough. The library will
838 Note that xterm mouse events are built up from character sequences
839 received from the xterm. If your application makes heavy use of
840 multiple-clicking, you may wish to lengthen this default value because
841 the timeout applies to the composed multi-click event as well as the
844 In addition to the environment variable, this implementation provides a
845 global variable with the same name. Portable applications should not
846 rely upon the presence of ESCDELAY in either form, but setting the
847 environment variable rather than the global variable does not create
848 problems when compiling an application.
851 </PRE><H3><a name="h3-HOME">HOME</a></H3><PRE>
852 Tells <STRONG>ncurses</STRONG> where your home directory is. That is where it may read
853 and write auxiliary terminal descriptions:
859 </PRE><H3><a name="h3-LINES">LINES</a></H3><PRE>
860 Like COLUMNS, specify the height of the screen in characters. See
861 COLUMNS for a detailed description.
864 </PRE><H3><a name="h3-MOUSE_BUTTONS_123">MOUSE_BUTTONS_123</a></H3><PRE>
865 This applies only to the OS/2 EMX port. It specifies the order of
866 buttons on the mouse. OS/2 numbers a 3-button mouse inconsistently
867 from other platforms:
873 This variable lets you customize the mouse. The variable must be three
874 numeric digits 1-3 in any order, e.g., 123 or 321. If it is not
875 specified, <STRONG>ncurses</STRONG> uses 132.
878 </PRE><H3><a name="h3-NCURSES_ASSUMED_COLORS">NCURSES_ASSUMED_COLORS</a></H3><PRE>
879 Override the compiled-in assumption that the terminal's default colors
880 are white-on-black (see <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG>). You may set the
881 foreground and background color values with this environment variable
882 by proving a 2-element list: foreground,background. For example, to
883 tell ncurses to not assume anything about the colors, set this to
884 "-1,-1". To make it green-on-black, set it to "2,0". Any positive
885 value from zero to the terminfo <STRONG>max_colors</STRONG> value is allowed.
888 </PRE><H3><a name="h3-NCURSES_CONSOLE2">NCURSES_CONSOLE2</a></H3><PRE>
889 This applies only to the MinGW port of ncurses.
891 The <STRONG>Console2</STRONG> program's handling of the Microsoft Console API call
892 <STRONG>CreateConsoleScreenBuffer</STRONG> is defective. Applications which use this
893 will hang. However, it is possible to simulate the action of this call
894 by mapping coordinates, explicitly saving and restoring the original
895 screen contents. Setting the environment variable <STRONG>NCGDB</STRONG> has the same
899 </PRE><H3><a name="h3-NCURSES_GPM_TERMS">NCURSES_GPM_TERMS</a></H3><PRE>
900 This applies only to ncurses configured to use the GPM interface.
902 If present, the environment variable is a list of one or more terminal
903 names against which the <STRONG>TERM</STRONG> environment variable is matched. Setting
904 it to an empty value disables the GPM interface; using the built-in
905 support for xterm, etc.
907 If the environment variable is absent, ncurses will attempt to open GPM
908 if <STRONG>TERM</STRONG> contains "linux".
911 </PRE><H3><a name="h3-NCURSES_NO_HARD_TABS">NCURSES_NO_HARD_TABS</a></H3><PRE>
912 <STRONG>Ncurses</STRONG> may use tabs as part of the cursor movement optimization. In
913 some cases, your terminal driver may not handle these properly. Set
914 this environment variable to disable the feature. You can also adjust
915 your <STRONG>stty</STRONG> settings to avoid the problem.
918 </PRE><H3><a name="h3-NCURSES_NO_MAGIC_COOKIE">NCURSES_NO_MAGIC_COOKIE</a></H3><PRE>
919 Some terminals use a magic-cookie feature which requires special
920 handling to make highlighting and other video attributes display
921 properly. You can suppress the highlighting entirely for these
922 terminals by setting this environment variable.
925 </PRE><H3><a name="h3-NCURSES_NO_PADDING">NCURSES_NO_PADDING</a></H3><PRE>
926 Most of the terminal descriptions in the terminfo database are written
927 for real "hardware" terminals. Many people use terminal emulators
928 which run in a windowing environment and use curses-based applications.
929 Terminal emulators can duplicate all of the important aspects of a
930 hardware terminal, but they do not have the same limitations. The
931 chief limitation of a hardware terminal from the standpoint of your
932 application is the management of dataflow, i.e., timing. Unless a
933 hardware terminal is interfaced into a terminal concentrator (which
934 does flow control), it (or your application) must manage dataflow,
935 preventing overruns. The cheapest solution (no hardware cost) is for
936 your program to do this by pausing after operations that the terminal
937 does slowly, such as clearing the display.
939 As a result, many terminal descriptions (including the vt100) have
940 delay times embedded. You may wish to use these descriptions, but not
941 want to pay the performance penalty.
943 Set the NCURSES_NO_PADDING environment variable to disable all but
944 mandatory padding. Mandatory padding is used as a part of special
945 control sequences such as <EM>flash</EM>.
948 </PRE><H3><a name="h3-NCURSES_NO_SETBUF">NCURSES_NO_SETBUF</a></H3><PRE>
949 This setting is obsolete. Before changes
951 <STRONG>o</STRONG> started with 5.9 patch 20120825 and
953 <STRONG>o</STRONG> continued though 5.9 patch 20130126
955 <STRONG>ncurses</STRONG> enabled buffered output during terminal initialization. This
956 was done (as in SVr4 curses) for performance reasons. For testing
957 purposes, both of <STRONG>ncurses</STRONG> and certain applications, this feature was
958 made optional. Setting the NCURSES_NO_SETBUF variable disabled output
959 buffering, leaving the output in the original (usually line buffered)
962 In the current implementation, ncurses performs its own buffering and
963 does not require this workaround. It does not modify the buffering of
966 The reason for the change was to make the behavior for interrupts and
967 other signals more robust. One drawback is that certain
968 nonconventional programs would mix ordinary stdio calls with ncurses
969 calls and (usually) work. This is no longer possible since ncurses is
970 not using the buffered standard output but its own output (to the same
971 file descriptor). As a special case, the low-level calls such as <STRONG>putp</STRONG>
972 still use the standard output. But high-level curses calls do not.
975 </PRE><H3><a name="h3-NCURSES_NO_UTF8_ACS">NCURSES_NO_UTF8_ACS</a></H3><PRE>
976 During initialization, the <STRONG>ncurses</STRONG> library checks for special cases
977 where VT100 line-drawing (and the corresponding alternate character set
978 capabilities) described in the terminfo are known to be missing.
979 Specifically, when running in a UTF-8 locale, the Linux console
980 emulator and the GNU screen program ignore these. Ncurses checks the
981 <STRONG>TERM</STRONG> environment variable for these. For other special cases, you
982 should set this environment variable. Doing this tells ncurses to use
983 Unicode values which correspond to the VT100 line-drawing glyphs. That
984 works for the special cases cited, and is likely to work for terminal
987 When setting this variable, you should set it to a nonzero value.
988 Setting it to zero (or to a nonnumber) disables the special check for
989 "linux" and "screen".
991 As an alternative to the environment variable, ncurses checks for an
992 extended terminfo capability <STRONG>U8</STRONG>. This is a numeric capability which
993 can be compiled using <STRONG>tic</STRONG> <STRONG>-x</STRONG>. For example
995 # linux console, if patched to provide working
996 # VT100 shift-in/shift-out, with corresponding font.
997 linux-vt100|linux console with VT100 line-graphics,
1000 # uxterm with vt100Graphics resource set to false
1001 xterm-utf8|xterm relying on UTF-8 line-graphics,
1004 The name "U8" is chosen to be two characters, to permit it to be used
1005 by applications that use ncurses' termcap interface.
1008 </PRE><H3><a name="h3-NCURSES_TRACE">NCURSES_TRACE</a></H3><PRE>
1009 During initialization, the <STRONG>ncurses</STRONG> debugging library checks the
1010 NCURSES_TRACE environment variable. If it is defined, to a numeric
1011 value, <STRONG>ncurses</STRONG> calls the <STRONG>trace</STRONG> function, using that value as the
1014 The argument values, which are defined in <STRONG>curses.h</STRONG>, provide several
1015 types of information. When running with traces enabled, your
1016 application will write the file <STRONG>trace</STRONG> to the current directory.
1018 See <STRONG><A HREF="curs_trace.3x.html">curs_trace(3x)</A></STRONG> for more information.
1021 </PRE><H3><a name="h3-TERM">TERM</a></H3><PRE>
1022 Denotes your terminal type. Each terminal type is distinct, though
1025 <STRONG>TERM</STRONG> is commonly set by terminal emulators to help applications find a
1026 workable terminal description. Some of those choose a popular
1027 approximation, e.g., "ansi", "vt100", "xterm" rather than an exact fit.
1028 Not infrequently, your application will have problems with that
1029 approach, e.g., incorrect function-key definitions.
1031 If you set <STRONG>TERM</STRONG> in your environment, it has no effect on the operation
1032 of the terminal emulator. It only affects the way applications work
1033 within the terminal. Likewise, as a general rule (<STRONG>xterm</STRONG> being a rare
1034 exception), terminal emulators which allow you to specify <STRONG>TERM</STRONG> as a
1035 parameter or configuration value do not change their behavior to match
1039 </PRE><H3><a name="h3-TERMCAP">TERMCAP</a></H3><PRE>
1040 If the <STRONG>ncurses</STRONG> library has been configured with <EM>termcap</EM> support,
1041 <STRONG>ncurses</STRONG> will check for a terminal's description in termcap form if it
1042 is not available in the terminfo database.
1044 The <STRONG>TERMCAP</STRONG> environment variable contains either a terminal description
1045 (with newlines stripped out), or a file name telling where the
1046 information denoted by the <STRONG>TERM</STRONG> environment variable exists. In either
1047 case, setting it directs <STRONG>ncurses</STRONG> to ignore the usual place for this
1048 information, e.g., /etc/termcap.
1051 </PRE><H3><a name="h3-TERMINFO">TERMINFO</a></H3><PRE>
1052 <STRONG>ncurses</STRONG> can be configured to read from multiple terminal databases.
1053 The <STRONG>TERMINFO</STRONG> variable overrides the location for the default terminal
1054 database. Terminal descriptions (in terminal format) are stored in
1057 <STRONG>o</STRONG> Normally these are stored in a directory tree, using subdirectories
1058 named by the first letter of the terminal names therein.
1060 This is the scheme used in System V, which legacy Unix systems use,
1061 and the <STRONG>TERMINFO</STRONG> variable is used by <EM>curses</EM> applications on those
1062 systems to override the default location of the terminal database.
1064 <STRONG>o</STRONG> If <STRONG>ncurses</STRONG> is built to use hashed databases, then each entry in
1065 this list may be the path of a hashed database file, e.g.,
1067 /usr/share/terminfo.db
1071 /usr/share/terminfo/
1073 The hashed database uses less disk-space and is a little faster
1074 than the directory tree. However, some applications assume the
1075 existence of the directory tree, reading it directly rather than
1076 using the terminfo library calls.
1078 <STRONG>o</STRONG> If <STRONG>ncurses</STRONG> is built with a support for reading termcap files
1079 directly, then an entry in this list may be the path of a termcap
1082 <STRONG>o</STRONG> If the <STRONG>TERMINFO</STRONG> variable begins with "hex:" or "b64:", <STRONG>ncurses</STRONG> uses
1083 the remainder of that variable as a compiled terminal description.
1084 You might produce the base64 format using <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG>:
1086 TERMINFO="$(infocmp -0 -Q2 -q)"
1089 The compiled description is used if it corresponds to the terminal
1090 identified by the <STRONG>TERM</STRONG> variable.
1092 Setting <STRONG>TERMINFO</STRONG> is the simplest, but not the only way to set location
1093 of the default terminal database. The complete list of database
1094 locations in order follows:
1096 <STRONG>o</STRONG> the last terminal database to which <STRONG>ncurses</STRONG> wrote, if any, is
1099 <STRONG>o</STRONG> the location specified by the TERMINFO environment variable
1101 <STRONG>o</STRONG> $HOME/.terminfo
1103 <STRONG>o</STRONG> locations listed in the TERMINFO_DIRS environment variable
1105 <STRONG>o</STRONG> one or more locations whose names are configured and compiled
1106 into the ncurses library, i.e.,
1108 <STRONG>o</STRONG> no default value (corresponding to the TERMINFO_DIRS
1111 <STRONG>o</STRONG> /usr/share/terminfo (corresponding to the TERMINFO variable)
1114 </PRE><H3><a name="h3-TERMINFO_DIRS">TERMINFO_DIRS</a></H3><PRE>
1115 Specifies a list of locations to search for terminal descriptions.
1116 Each location in the list is a terminal database as described in the
1117 section on the <STRONG>TERMINFO</STRONG> variable. The list is separated by colons
1118 (i.e., ":") on Unix, semicolons on OS/2 EMX.
1120 There is no corresponding feature in System V terminfo; it is an
1121 extension developed for <STRONG>ncurses</STRONG>.
1124 </PRE><H3><a name="h3-TERMPATH">TERMPATH</a></H3><PRE>
1125 If <STRONG>TERMCAP</STRONG> does not hold a file name then <STRONG>ncurses</STRONG> checks the <STRONG>TERMPATH</STRONG>
1126 environment variable. This is a list of filenames separated by spaces
1127 or colons (i.e., ":") on Unix, semicolons on OS/2 EMX.
1129 If the <STRONG>TERMPATH</STRONG> environment variable is not set, <STRONG>ncurses</STRONG> looks in the
1132 /etc/termcap, /usr/share/misc/termcap and $HOME/.termcap,
1136 The library may be configured to disregard the following variables when
1137 the current user is the superuser (root), or if the application uses
1138 setuid or setgid permissions:
1140 $TERMINFO, $TERMINFO_DIRS, $TERMPATH, as well as $HOME.
1143 </PRE><H2><a name="h2-ALTERNATE-CONFIGURATIONS">ALTERNATE CONFIGURATIONS</a></H2><PRE>
1144 Several different configurations are possible, depending on the
1145 configure script options used when building <STRONG>ncurses</STRONG>. There are a few
1146 main options whose effects are visible to the applications developer
1147 using <STRONG>ncurses</STRONG>:
1150 The standard include for <STRONG>ncurses</STRONG> is as noted in <STRONG>SYNOPSIS</STRONG>:
1152 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
1154 This option is used to avoid filename conflicts when <STRONG>ncurses</STRONG> is
1155 not the main implementation of curses of the computer. If <STRONG>ncurses</STRONG>
1156 is installed disabling overwrite, it puts its headers in a
1159 <STRONG>#include</STRONG> <STRONG><ncurses/curses.h></STRONG>
1161 It also omits a symbolic link which would allow you to use
1162 <STRONG>-lcurses</STRONG> to build executables.
1165 The configure script renames the library and (if the
1166 <STRONG>--disable-overwrite</STRONG> option is used) puts the header files in a
1167 different subdirectory. All of the library names have a "w"
1168 appended to them, i.e., instead of
1170 <STRONG>-lncurses</STRONG>
1174 <STRONG>-lncursesw</STRONG>
1176 You must also enable the wide-character features in the header
1177 file when compiling for the wide-character library to use the
1178 extended (wide-character) functions. The symbol which enables
1179 these features has changed since XSI Curses, Issue 4:
1181 <STRONG>o</STRONG> Originally, the wide-character feature required the symbol
1182 <STRONG>_XOPEN_SOURCE_EXTENDED</STRONG> but that was only valid for XPG4
1185 <STRONG>o</STRONG> Later, that was deemed conflicting with <STRONG>_XOPEN_SOURCE</STRONG> defined
1188 <STRONG>o</STRONG> As of mid-2018, none of the features in this implementation
1189 require a <STRONG>_XOPEN_SOURCE</STRONG> feature greater than 600. However,
1190 X/Open Curses, Issue 7 (2009) recommends defining it to 700.
1192 <STRONG>o</STRONG> Alternatively, you can enable the feature by defining
1193 <STRONG>NCURSES_WIDECHAR</STRONG> with the caveat that some other header file
1194 than <STRONG>curses.h</STRONG> may require a specific value for <STRONG>_XOPEN_SOURCE</STRONG>
1195 (or a system-specific symbol).
1197 The <STRONG>curses.h</STRONG> file which is installed for the wide-character
1198 library is designed to be compatible with the normal library's
1199 header. Only the size of the <STRONG>WINDOW</STRONG> structure differs, and very
1200 few applications require more than a pointer to <STRONG>WINDOW</STRONG>s.
1202 If the headers are installed allowing overwrite, the wide-
1203 character library's headers should be installed last, to allow
1204 applications to be built using either library from the same set of
1208 The configure script renames the library. All of the library
1209 names have a "t" appended to them (before any "w" added by
1210 <STRONG>--enable-widec</STRONG>).
1212 The global variables such as <STRONG>LINES</STRONG> are replaced by macros to allow
1213 read-only access. At the same time, setter-functions are provided
1214 to set these values. Some applications (very few) may require
1215 changes to work with this convention.
1224 The shared and normal (static) library names differ by their
1225 suffixes, e.g., <STRONG>libncurses.so</STRONG> and <STRONG>libncurses.a</STRONG>. The debug and
1226 profiling libraries add a "_g" and a "_p" to the root names
1227 respectively, e.g., <STRONG>libncurses_g.a</STRONG> and <STRONG>libncurses_p.a</STRONG>.
1230 Low-level functions which do not depend upon whether the library
1231 supports wide-characters, are provided in the tinfo library.
1233 By doing this, it is possible to share the tinfo library between
1234 wide/normal configurations as well as reduce the size of the
1235 library when only low-level functions are needed.
1237 Those functions are described in these pages:
1239 <STRONG>o</STRONG> <STRONG><A HREF="curs_extend.3x.html">curs_extend(3x)</A></STRONG> - miscellaneous curses extensions
1241 <STRONG>o</STRONG> <STRONG><A HREF="curs_inopts.3x.html">curs_inopts(3x)</A></STRONG> - <STRONG>curses</STRONG> input options
1243 <STRONG>o</STRONG> <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG> - low-level <STRONG>curses</STRONG> routines
1245 <STRONG>o</STRONG> <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> - <STRONG>curses</STRONG> environment query routines
1247 <STRONG>o</STRONG> <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> - <STRONG>curses</STRONG> emulation of termcap
1249 <STRONG>o</STRONG> <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> - <STRONG>curses</STRONG> interfaces to terminfo database
1251 <STRONG>o</STRONG> <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG> - miscellaneous <STRONG>curses</STRONG> utility routines
1254 The <STRONG>trace</STRONG> function normally resides in the debug library, but it
1255 is sometimes useful to configure this in the shared library.
1256 Configure scripts should check for the function's existence rather
1257 than assuming it is always in the debug library.
1260 </PRE><H2><a name="h2-FILES">FILES</a></H2><PRE>
1262 directory containing initialization files for the terminal
1263 capability database /usr/share/terminfo terminal capability
1267 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
1268 <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG> and related pages whose names begin "curs_" for detailed
1269 routine descriptions.
1270 <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
1271 <STRONG><A HREF="user_caps.5.html">user_caps(5)</A></STRONG> for user-defined capabilities
1274 </PRE><H2><a name="h2-EXTENSIONS">EXTENSIONS</a></H2><PRE>
1275 The <STRONG>ncurses</STRONG> library can be compiled with an option (<STRONG>-DUSE_GETCAP</STRONG>) that
1276 falls back to the old-style /etc/termcap file if the terminal setup
1277 code cannot find a terminfo entry corresponding to <STRONG>TERM</STRONG>. Use of this
1278 feature is not recommended, as it essentially includes an entire
1279 termcap compiler in the <STRONG>ncurses</STRONG> startup code, at significant cost in
1280 core and startup cycles.
1282 The <STRONG>ncurses</STRONG> library includes facilities for capturing mouse events on
1283 certain terminals (including xterm). See the <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> manual
1286 The <STRONG>ncurses</STRONG> library includes facilities for responding to window
1287 resizing events, e.g., when running in an xterm. See the
1288 <STRONG><A HREF="resizeterm.3x.html">resizeterm(3x)</A></STRONG> and <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG> manual pages for details. In addition,
1289 the library may be configured with a <STRONG>SIGWINCH</STRONG> handler.
1291 The <STRONG>ncurses</STRONG> library extends the fixed set of function key capabilities
1292 of terminals by allowing the application designer to define additional
1293 key sequences at runtime. See the <STRONG><A HREF="define_key.3x.html">define_key(3x)</A></STRONG> <STRONG><A HREF="key_defined.3x.html">key_defined(3x)</A></STRONG>, and
1294 <STRONG><A HREF="keyok.3x.html">keyok(3x)</A></STRONG> manual pages for details.
1296 The <STRONG>ncurses</STRONG> library can exploit the capabilities of terminals which
1297 implement the ISO-6429 SGR 39 and SGR 49 controls, which allow an
1298 application to reset the terminal to its original foreground and
1299 background colors. From the users' perspective, the application is
1300 able to draw colored text on a background whose color is set
1301 independently, providing better control over color contrasts. See the
1302 <STRONG><A HREF="default_colors.3x.html">default_colors(3x)</A></STRONG> manual page for details.
1304 The <STRONG>ncurses</STRONG> library includes a function for directing application
1305 output to a printer attached to the terminal device. See the
1306 <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG> manual page for details.
1309 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
1310 The <STRONG>ncurses</STRONG> library is intended to be BASE-level conformant with XSI
1311 Curses. The EXTENDED XSI Curses functionality (including color
1312 support) is supported.
1314 A small number of local differences (that is, individual differences
1315 between the XSI Curses and <STRONG>ncurses</STRONG> calls) are described in <STRONG>PORTABILITY</STRONG>
1316 sections of the library man pages.
1319 </PRE><H3><a name="h3-Error-checking">Error checking</a></H3><PRE>
1320 In many cases, X/Open Curses is vague about error conditions, omitting
1321 some of the SVr4 documentation.
1323 Unlike other implementations, this one checks parameters such as
1324 pointers to WINDOW structures to ensure they are not null. The main
1325 reason for providing this behavior is to guard against programmer
1326 error. The standard interface does not provide a way for the library
1327 to tell an application which of several possible errors were detected.
1328 Relying on this (or some other) extension will adversely affect the
1329 portability of curses applications.
1332 </PRE><H3><a name="h3-Extensions-versus-portability">Extensions versus portability</a></H3><PRE>
1333 Most of the extensions provided by ncurses have not been standardized.
1334 Some have been incorporated into other implementations, such as
1335 PDCurses or NetBSD curses. Here are a few to consider:
1337 <STRONG>o</STRONG> The routine <STRONG>has_key</STRONG> is not part of XPG4, nor is it present in SVr4.
1338 See the <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG> manual page for details.
1340 <STRONG>o</STRONG> The routine <STRONG>slk_attr</STRONG> is not part of XPG4, nor is it present in
1341 SVr4. See the <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG> manual page for details.
1343 <STRONG>o</STRONG> The routines <STRONG>getmouse</STRONG>, <STRONG>mousemask</STRONG>, <STRONG>ungetmouse</STRONG>, <STRONG>mouseinterval</STRONG>, and
1344 <STRONG>wenclose</STRONG> relating to mouse interfacing are not part of XPG4, nor
1345 are they present in SVr4. See the <STRONG><A HREF="curs_mouse.3x.html">curs_mouse(3x)</A></STRONG> manual page for
1348 <STRONG>o</STRONG> The routine <STRONG>mcprint</STRONG> was not present in any previous curses
1349 implementation. See the <STRONG><A HREF="curs_print.3x.html">curs_print(3x)</A></STRONG> manual page for details.
1351 <STRONG>o</STRONG> The routine <STRONG>wresize</STRONG> is not part of XPG4, nor is it present in SVr4.
1352 See the <STRONG><A HREF="wresize.3x.html">wresize(3x)</A></STRONG> manual page for details.
1354 <STRONG>o</STRONG> The WINDOW structure's internal details can be hidden from
1355 application programs. See <STRONG><A HREF="curs_opaque.3x.html">curs_opaque(3x)</A></STRONG> for the discussion of
1356 <STRONG>is_scrollok</STRONG>, etc.
1358 <STRONG>o</STRONG> This implementation can be configured to provide rudimentary
1359 support for multi-threaded applications. See <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG> for
1362 <STRONG>o</STRONG> This implementation can also be configured to provide a set of
1363 functions which improve the ability to manage multiple screens.
1364 See <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG> for details.
1367 </PRE><H3><a name="h3-Padding-differences">Padding differences</a></H3><PRE>
1368 In historic curses versions, delays embedded in the capabilities <STRONG>cr</STRONG>,
1369 <STRONG>ind</STRONG>, <STRONG>cub1</STRONG>, <STRONG>ff</STRONG> and <STRONG>tab</STRONG> activated corresponding delay bits in the UNIX
1370 tty driver. In this implementation, all padding is done by sending NUL
1371 bytes. This method is slightly more expensive, but narrows the
1372 interface to the UNIX kernel significantly and increases the package's
1373 portability correspondingly.
1376 </PRE><H3><a name="h3-Header-files">Header files</a></H3><PRE>
1377 The header file <STRONG><curses.h></STRONG> automatically includes the header files
1378 <STRONG><stdio.h></STRONG> and <STRONG><unctrl.h></STRONG>.
1380 X/Open Curses has more to say, but does not finish the story:
1382 The inclusion of <curses.h> may make visible all symbols from the
1383 headers <stdio.h>, <term.h>, <termios.h>, and <wchar.h>.
1385 Here is a more complete story:
1387 <STRONG>o</STRONG> Starting with BSD curses, all implementations have included
1390 BSD curses included <curses.h> and <unctrl.h> from an internal
1391 header "curses.ext" ("ext" was a short name for <EM>externs</EM>).
1393 BSD curses used <stdio.h> internally (for <STRONG>printw</STRONG> and <STRONG>scanw</STRONG>), but
1394 nothing in <curses.h> itself relied upon <stdio.h>.
1396 <STRONG>o</STRONG> SVr2 curses added <STRONG><A HREF="curs_initscr.3x.html">newterm(3x)</A></STRONG>, which relies upon <stdio.h>. That
1397 is, the function prototype uses <STRONG>FILE</STRONG>.
1399 SVr4 curses added <STRONG>putwin</STRONG> and <STRONG>getwin</STRONG>, which also use <stdio.h>.
1401 X/Open Curses documents all three of these functions.
1403 SVr4 curses and X/Open Curses do not require the developer to
1404 include <stdio.h> before including <curses.h>. Both document
1405 curses showing <curses.h> as the only required header.
1407 As a result, standard <curses.h> will always include <stdio.h>.
1409 <STRONG>o</STRONG> X/Open Curses is inconsistent with respect to SVr4 regarding
1412 As noted in <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, ncurses includes <unctrl.h> from
1413 <curses.h> (like SVr4).
1415 <STRONG>o</STRONG> X/Open's comments about <term.h> and <termios.h> may refer to HP-UX
1418 HP-UX curses includes <term.h> from <curses.h> to declare <STRONG>setupterm</STRONG>
1419 in curses.h, but ncurses (and Solaris curses) do not.
1421 AIX curses includes <term.h> and <termios.h>. Again, ncurses (and
1422 Solaris curses) do not.
1424 <STRONG>o</STRONG> X/Open says that <curses.h> <EM>may</EM> include <term.h>, but there is no
1425 requirement that it do that.
1427 Some programs use functions declared in both <curses.h> and
1428 <term.h>, and must include both headers in the same module. Very
1429 old versions of AIX curses required including <curses.h> before
1430 including <term.h>.
1432 Because ncurses header files include the headers needed to define
1433 datatypes used in the headers, ncurses header files can be included
1434 in any order. But for portability, you should include <curses.h>
1435 before <term.h>.
1437 <STRONG>o</STRONG> X/Open Curses says <EM>"may</EM> <EM>make</EM> <EM>visible"</EM> because including a header
1438 file does not necessarily make all symbols in it visible (there are
1439 ifdef's to consider).
1441 For instance, in ncurses <wchar.h> <EM>may</EM> be included if the proper
1442 symbol is defined, and if ncurses is configured for wide-character
1443 support. If the header is included, its symbols may be made
1444 visible. That depends on the value used for <STRONG>_XOPEN_SOURCE</STRONG> feature
1447 <STRONG>o</STRONG> X/Open Curses documents one required header, in a special case:
1448 <stdarg.h> before <curses.h> to prototype the <STRONG>vw_printw</STRONG> and
1449 <STRONG>vw_scanw</STRONG> functions (as well as the obsolete the <STRONG>vwprintw</STRONG> and
1450 <STRONG>vwscanw</STRONG> functions). Each of those uses a <STRONG>va_list</STRONG> parameter.
1452 The two obsolete functions were introduced in SVr3. The other
1453 functions were introduced in X/Open Curses. In between, SVr4
1454 curses provided for the possibility that an application might
1455 include either <varargs.h> or <stdarg.h>. Initially, that was done
1456 by using <STRONG>void*</STRONG> for the <STRONG>va_list</STRONG> parameter. Later, a special type
1457 (defined in <stdio.h>) was introduced, to allow for compiler type-
1458 checking. That special type is always available, because <stdio.h>
1459 is always included by <curses.h>.
1461 None of the X/Open Curses implementations require an application to
1462 include <stdarg.h> before <curses.h> because they either have
1463 allowed for a special type, or (like ncurses) include <stdarg.h>
1464 directly to provide a portable interface.
1467 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
1468 If standard output from a <STRONG>ncurses</STRONG> program is re-directed to something
1469 which is not a tty, screen updates will be directed to standard error.
1470 This was an undocumented feature of AT&T System V Release 3 curses.
1473 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
1474 Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on pcurses
1479 <STRONG><A HREF="ncurses.3x.html">ncurses(3x)</A></STRONG>
1483 <li><a href="#h2-NAME">NAME</a></li>
1484 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
1485 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
1487 <li><a href="#h3-Initialization">Initialization</a></li>
1488 <li><a href="#h3-Datatypes">Datatypes</a></li>
1489 <li><a href="#h3-Environment-variables">Environment variables</a></li>
1490 <li><a href="#h3-Routine-and-Argument-Names">Routine and Argument Names</a></li>
1491 <li><a href="#h3-Routine-Name-Index">Routine Name Index</a></li>
1494 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
1495 <li><a href="#h2-ENVIRONMENT">ENVIRONMENT</a>
1497 <li><a href="#h3-CC-command-character">CC command-character</a></li>
1498 <li><a href="#h3-BAUDRATE">BAUDRATE</a></li>
1499 <li><a href="#h3-COLUMNS">COLUMNS</a></li>
1500 <li><a href="#h3-ESCDELAY">ESCDELAY</a></li>
1501 <li><a href="#h3-HOME">HOME</a></li>
1502 <li><a href="#h3-LINES">LINES</a></li>
1503 <li><a href="#h3-MOUSE_BUTTONS_123">MOUSE_BUTTONS_123</a></li>
1504 <li><a href="#h3-NCURSES_ASSUMED_COLORS">NCURSES_ASSUMED_COLORS</a></li>
1505 <li><a href="#h3-NCURSES_CONSOLE2">NCURSES_CONSOLE2</a></li>
1506 <li><a href="#h3-NCURSES_GPM_TERMS">NCURSES_GPM_TERMS</a></li>
1507 <li><a href="#h3-NCURSES_NO_HARD_TABS">NCURSES_NO_HARD_TABS</a></li>
1508 <li><a href="#h3-NCURSES_NO_MAGIC_COOKIE">NCURSES_NO_MAGIC_COOKIE</a></li>
1509 <li><a href="#h3-NCURSES_NO_PADDING">NCURSES_NO_PADDING</a></li>
1510 <li><a href="#h3-NCURSES_NO_SETBUF">NCURSES_NO_SETBUF</a></li>
1511 <li><a href="#h3-NCURSES_NO_UTF8_ACS">NCURSES_NO_UTF8_ACS</a></li>
1512 <li><a href="#h3-NCURSES_TRACE">NCURSES_TRACE</a></li>
1513 <li><a href="#h3-TERM">TERM</a></li>
1514 <li><a href="#h3-TERMCAP">TERMCAP</a></li>
1515 <li><a href="#h3-TERMINFO">TERMINFO</a></li>
1516 <li><a href="#h3-TERMINFO_DIRS">TERMINFO_DIRS</a></li>
1517 <li><a href="#h3-TERMPATH">TERMPATH</a></li>
1520 <li><a href="#h2-ALTERNATE-CONFIGURATIONS">ALTERNATE CONFIGURATIONS</a></li>
1521 <li><a href="#h2-FILES">FILES</a></li>
1522 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
1523 <li><a href="#h2-EXTENSIONS">EXTENSIONS</a></li>
1524 <li><a href="#h2-PORTABILITY">PORTABILITY</a>
1526 <li><a href="#h3-Error-checking">Error checking</a></li>
1527 <li><a href="#h3-Extensions-versus-portability">Extensions versus portability</a></li>
1528 <li><a href="#h3-Padding-differences">Padding differences</a></li>
1529 <li><a href="#h3-Header-files">Header files</a></li>
1532 <li><a href="#h2-NOTES">NOTES</a></li>
1533 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
projects / ncurses.git / blob