Debian Codegraph @

upstream/opensuse-tumbleweed/man3/ncurses.3ncurses

raw
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2024,2025 Thomas E. Dickey *
4 .\" Copyright 1998-2015,2017 Free Software Foundation, Inc. *
5 .\" *
6 .\" Permission is hereby granted, free of charge, to any person obtaining a *
7 .\" copy of this software and associated documentation files (the *
8 .\" "Software"), to deal in the Software without restriction, including *
9 .\" without limitation the rights to use, copy, modify, merge, publish, *
10 .\" distribute, distribute with modifications, sublicense, and/or sell *
11 .\" copies of the Software, and to permit persons to whom the Software is *
12 .\" furnished to do so, subject to the following conditions: *
13 .\" *
14 .\" The above copyright notice and this permission notice shall be included *
15 .\" in all copies or substantial portions of the Software. *
16 .\" *
17 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
24 .\" *
25 .\" Except as contained in this notice, the name(s) of the above copyright *
26 .\" holders shall not be used in advertising or otherwise to promote the *
27 .\" sale, use or other dealings in this Software without prior written *
28 .\" authorization. *
29 .\"***************************************************************************
30 .\"
31 .\" $Id: ncurses.3x,v 1.289 2025/11/12 01:01:34 tom Exp $
32 .TH ncurses 3NCURSES 2025-11-11 "ncurses 6.6" "Library calls"
33 .ie \n(.g \{\
34 .ds `` \(lq
35 .ds '' \(rq
36 .\}
37 .el \{\
38 .ie t .ds `` ``
39 .el .ds `` ""
40 .ie t .ds '' ''
41 .el .ds '' ""
42 .\}
43 .
44 .de bP
45 .ie n .IP \(bu 4
46 .el .IP \(bu 2
47 ..
48 .
49 .\" Add supplementary paragraph tag on its own line after TP.
50 .\" Adapted from TQ (which would produce mandoc warnings).
51 .de tQ
52 . br
53 . ns
54 . TP
55 ..
56 .
57 .SH NAME
58 \fB\%ncurses\fP \-
59 character-cell terminal interface with optimized output
60 .SH SYNOPSIS
61 .nf
62 \fB#include <ncursesw/curses.h>
63 .fi
64 .SH DESCRIPTION
65 The \*(``new curses\*('' library offers the programmer a
66 terminal-independent means of reading keyboard and mouse input and
67 writing to character-cell displays with output optimized to minimize
68 screen updates.
69 .I \%ncurses
70 replaces the
71 .I curses
72 libraries from
73 System V Release 4 Unix (\*(``SVr4\*('')
74 and
75 4.4BSD Unix,
76 the development of which ceased in the 1990s.
77 This document describes
78 .I \%ncurses
79 version 6.6
80 (patch 20260516).
81 .PP
82 .I \%ncurses
83 permits control of the terminal screen's contents;
84 abstraction and subdivision thereof with
85 .I windows
86 and
87 .IR pads ;
88 acquisition of keyboard and mouse events;
89 selection of color and rendering attributes
90 (such as bold or underline);
91 the definition and use of
92 .I "soft label"
93 keys;
94 access to the
95 .I \%term\%info
96 terminal capability database;
97 a
98 .I termcap
99 compatibility interface;
100 and an abstraction of the system's API for manipulating the terminal
101 (such as \fI\%termios\fP(3)).
102 .PP
103 .I \%ncurses
104 implements the interface described by X/Open Curses Issue\ 7.
105 In many behavioral details not standardized by X/Open,
106 .I \%ncurses
107 emulates the
108 .I curses
109 library of SVr4 and provides numerous useful extensions.
110 .PP
111 .I \%ncurses
112 man pages employ several sections to clarify matters of usage and
113 interoperability with other
114 .I curses
115 implementations.
116 .bP
117 \*(``NOTES\*('' describes issues and caveats of which any user of the
118 .I \%ncurses
119 API should be aware,
120 such as limitations on the size of an underlying integral type or the
121 availability of a preprocessor macro exclusive of a function definition
122 (which prevents its address from being taken).
123 This section also describes implementation details
124 of significance to the programmer but which are not standardized.
125 .bP
126 \*(``EXTENSIONS\*('' presents
127 .I \%ncurses
128 innovations beyond the X/Open Curses standard and/or the SVr4
129 .I curses
130 implementation.
131 They are termed
132 .I extensions
133 to indicate that they cannot be implemented solely by using the library
134 API,
135 but require access to the library's internal state.
136 .bP
137 \*(``PORTABILITY\*('' discusses matters
138 (beyond the exercise of extensions)
139 that should be considered when writing to a
140 .I curses
141 standard,
142 or for multiple implementations.
143 .bP
144 \*(``HISTORY\*('' examines points of detail in
145 .I \%ncurses
146 and other
147 .I curses
148 implementations over the decades of their development,
149 particularly where precedent or inertia have frustrated better design
150 (and,
151 in a few cases,
152 where such inertia has been overcome).
153 .PP
154 A
155 .I curses
156 application must be linked with the library;
157 use the
158 .B \-lncurses
159 option to your compiler or linker.
160 A debugging version of the library may be available;
161 if so,
162 link with it using
163 .BR \-lncurses_g "."
164 (Your system integrator may have installed these libraries such that you
165 can use the options
166 .B \-lcurses
167 and
168 .BR \-lcurses_g ","
169 respectively.)
170 The
171 .I \%ncurses_g
172 library logs events describing
173 .I \%ncurses
174 actions
175 to a file called
176 .I \%trace
177 in the application's working directory at startup.
178 See section \*(``ALTERNATE CONFIGURATIONS\*('' below.
179 .SS "Application Structure"
180 A
181 .I curses
182 application uses information from the system locale;
183 \fI\%setlocale\fP(3) prepares it for
184 .I curses
185 library calls.
186 .PP
187 .RS 4
188 .EX
189 setlocale(LC_ALL, "");
190 .EE
191 .RE
192 .PP
193 If the locale is not thus initialized,
194 the library assumes that characters are printable as in ISO\ 8859-1,
195 to work with certain legacy programs.
196 You should initialize the locale;
197 do not expect consistent behavior from the library when the locale has
198 not been set up.
199 .PP
200 \fB\%initscr\fP(3NCURSES) or \fB\%newterm\fP(3NCURSES)
201 must be called to initialize
202 .I curses
203 before use of any functions
204 that access or manipulate windows or screens.
205 .PP
206 To get character-at-a-time input without echoing \(em
207 most interactive,
208 screen-oriented programs want this \(em
209 use the following sequence.
210 .PP
211 .RS 4
212 .EX
213 initscr(); cbreak(); noecho();
214 .EE
215 .RE
216 .PP
217 Most applications would perform further setup as follows.
218 .PP
219 .RS 4
220 .EX
221 .nf
222 noqiflush();
223 keypad(stdscr, TRUE);
224 .fi
225 .EE
226 .RE
227 .PP
228 A
229 .I curses
230 program then often enters an event-handling loop.
231 Call \fB\%endwin\fP(3NCURSES) before exiting.
232 .SS Overview
233 A
234 .I curses
235 library abstracts the terminal with a
236 .I \%SCREEN
237 data structure,
238 and represents all or part of its display
239 with
240 .I \%WINDOW
241 structures.
242 Distinct properties apply to each;
243 for example,
244 the
245 .I "line discipline"
246 of a typical Unix terminal driver
247 is in one of three modes:
248 raw,
249 \%cbreak,
250 or canonical (\*(``cooked\*('').
251 In
252 .IR curses ","
253 the line discipline is a property of the screen,
254 applying identically to all windows associated with it.
255 .PP
256 A
257 .I window
258 is a rectangular grid of character cells,
259 addressed by line and column coordinates
260 .RI ( y ","
261 .IR x ),
262 with the upper left corner as (0, 0).
263 A window called
264 .BR \%stdscr ","
265 by default the same size as the terminal screen,
266 is always available.
267 Create others with \fB\%newwin\fP(3NCURSES).
268 .PP
269 A
270 .I curses
271 library does not manage overlapping windows
272 (but see below).
273 You can either use
274 .B \%stdscr
275 to manage one screen-filling window,
276 or tile the screen into non-overlapping windows and not use
277 .B \%stdscr
278 at all.
279 Mixing the two approaches will result in unpredictable and undesired
280 effects.
281 .PP
282 Functions permit manipulation of a window and the
283 .I cursor
284 identifying the cell within it at which the next operation will occur.
285 Among those,
286 the most basic are \fB\%move\fP(3NCURSES) and \fB\%addch\fP(3NCURSES):
287 these place the cursor within and write a character to
288 .BR \%stdscr ","
289 respectively.
290 .PP
291 Frequent changes to the terminal screen can cause unpleasant flicker or
292 inefficient use of the communication channel to the device,
293 so as a rule the library does not update it automatically.
294 Therefore,
295 after using
296 .I curses
297 functions to accumulate a set of desired updates that make sense to
298 present together,
299 call \fB\%refresh\fP(3NCURSES) to tell the library to make the user's screen
300 look like \fBstdscr\fP.
301 The library
302 .\" X/Open Curses Issue 7 assumes some optimization will be done, but
303 .\" does not mandate it in any way.
304 .I optimizes
305 its output by computing a minimal volume of operations to mutate the
306 screen from its state at the previous refresh to the new one.
307 Effective optimization demands accurate information about the terminal
308 device:
309 the management of such information is the province of the
310 \fB\%terminfo\fP(3NCURSES) API,
311 a feature of every standard
312 .I curses
313 implementation.
314 .PP
315 Special windows called
316 .I pads
317 may also be manipulated.
318 These are not constrained to the size of the terminal screen and their
319 contents need not be completely displayed.
320 See \fB\%pad\fP(3NCURSES).
321 .PP
322 Many terminals support configuration of character cell foreground and
323 background colors as well as
324 .IR attributes ","
325 which cause characters to render in such modes as
326 boldfaced,
327 underlined,
328 or in reverse video.
329 See \fB\%color\fP(3NCURSES) and \fB\%attr\fP(3NCURSES).
330 .PP
331 .I curses
332 defines constants to simplify access
333 to a small set of forms-drawing graphics
334 corresponding to the DEC Alternate Character Set (ACS),
335 a feature of VT100 and other terminals.
336 See \fB\%addch\fP(3NCURSES).
337 .PP
338 .I curses
339 is implemented using the operating system's terminal driver;
340 key events are received not as scan codes but as byte sequences.
341 The driver reports graphical keycaps
342 (alphanumeric and punctuation keys,
343 and the space)
344 as-is.
345 Everything else,
346 including the tab,
347 enter/return,
348 keypad,
349 arrow,
350 and function keys,
351 appears to
352 .I curses
353 as a control character or a multibyte
354 .I "escape sequence."
355 .I curses
356 can translate the latter into unique
357 .I "key codes."
358 See \fB\%keypad\fP(3NCURSES) and \fB\%getch\fP(3NCURSES).
359 .PP
360 .I \%ncurses
361 provides reimplementations of the SVr4 \fBpanel\fP(3NCURSES), \fBform\fP(3FORM),
362 and \fBmenu\fP(3MENU) libraries;
363 they permit overlapping windows and ease construction of user interfaces
364 with
365 .IR curses "."
366 .SS "Initialization"
367 Beware: the terminal your program is running may or may not have
368 the features you expect. Ncurses makes no attempt to check available
369 features in advance. This is upon the user.
370 .PP
371 The selection of an appropriate value of
372 .I TERM
373 in the process environment is essential to correct
374 .I curses
375 and
376 .I \%term\%info
377 library operation.
378 A well-configured system selects a correct
379 .I TERM
380 value automatically;
381 \fB\%tset\fP(1) may assist with troubleshooting exotic situations.
382 .PP
383 If you change the terminal type from a shell,
384 export
385 .IR TERM ","
386 then run \fB\%tset\fP(1) or the
387 .RB \*(`` "tput init" \*(''
388 command.
389 See subsection \*(``Tabs and Initialization\*('' of \fB\%terminfo\fP(5).
390 .PP
391 If the environment variables
392 .I \%LINES
393 and
394 .I \%COLUMNS
395 are set,
396 or if the
397 .I curses
398 program is executing in a graphical windowing environment,
399 the information obtained thence overrides that obtained by
400 .IR \%term\%info "."
401 An
402 .I \%ncurses
403 extension supports resizable terminal displays;
404 see \fB\%wresize\fP(3NCURSES).
405 .PP
406 If the environment variable
407 .I \%TERMINFO
408 is defined,
409 a
410 .I curses
411 program checks first for a terminal type description in the location it
412 identifies.
413 .I \%TERMINFO
414 is useful for developing type descriptions or when write permission to
415 .I \%/usr/share/terminfo
416 is not available.
417 .PP
418 See section \*(``ENVIRONMENT\*('' below.
419 .SS "Naming Conventions"
420 .I curses
421 offers many functions in variant forms using a regular set of
422 alternatives to the name of an elemental one.
423 Those prefixed with \*(``w\*('' require a
424 .I \%WINDOW
425 pointer argument;
426 those with a \*(``mv\*('' prefix first perform cursor movement using
427 \fB\%wmove\fP(3NCURSES);
428 a \*(``mvw\*('' prefix indicates both.
429 The \*(``w\*('' function is typically the elemental one;
430 the removal of this prefix usually indicates operation on
431 .BR \%stdscr "."
432 .PP
433 Four functions prefixed with \*(``p\*('' require a
434 .I pad
435 argument;
436 see below.
437 .PP
438 In function synopses,
439 .I \%ncurses
440 man pages apply the following names to parameters.
441 We introduce the character types in the next subsection.
442 .PP
443 .TS
444 center;
445 Li L.
446 bf a \fIbool\fP (\fBTRUE\fP or \fBFALSE\fP)
447 c a \fIchar\fP or \fIint\fP
448 ch a \fIchtype\fP
449 wc a \fIwchar_t\fP or \fIwint_t\fP
450 wch a \fIcchar_t\fP
451 win pointer to a \fIWINDOW\fP
452 pad pointer to a \fIWINDOW\fP that is a pad
453 pair a foreground/background color pair identifier
454 .TE
455 .SS "Wide and Non-wide Character Configurations"
456 This man page primarily surveys functions that appear in any
457 configuration of the library.
458 There are two common configurations;
459 for others,
460 see section \*(``ALTERNATE CONFIGURATIONS\*('' below.
461 .TP 10 \" "ncursesw" + 2n
462 .I \%ncurses
463 is the library in its \*(``non-wide\*('' configuration,
464 handling only eight-bit characters.
465 It stores a character combined with attributes
466 and a color pair identifier
467 in a
468 .I \%chtype
469 datum,
470 which is often an alias of
471 .IR int "."
472 A string of
473 .I curses
474 characters is similar to a C
475 .I char
476 string;
477 a
478 .I chtype
479 string ends with an integral
480 .BR 0 ","
481 the null
482 .I curses
483 character.
484 .IP
485 Attributes and a color pair identifier
486 (with no corresponding character)
487 can be stored in variables of
488 .I \%chtype
489 or
490 .I \%attr_t
491 type.
492 In either case,
493 they are accessed via an integral bit mask.
494 .IP
495 .I \%ncurses
496 stores each cell of a
497 .I \%WINDOW
498 as a
499 .IR \%chtype "."
500 X/Open Curses does not specify the sizes of the character code or
501 color pair identifier,
502 nor the quantity of attribute bits,
503 in
504 .IR chtype ";"
505 these are implementation-dependent.
506 .I \%ncurses
507 uses eight bits for the character code.
508 An application requiring a wider character type,
509 for instance to represent Unicode,
510 should use the wide-character API.
511 .TP 10
512 .I \%ncursesw
513 is the library in its \*(``wide\*('' configuration,
514 which handles character encodings requiring a larger data type than
515 .I \%char
516 (a byte-sized type)
517 can represent.
518 It provides additional functions that complement those in
519 the non-wide library where the size of the underlying character type is
520 significant.
521 A somewhat regular naming convention relates many of the wide variants
522 to their non-wide counterparts;
523 where a non-wide function name contains \*(``ch\*('' or \*(``str\*('',
524 prefix it with \*(``_w\*('' to obtain the wide counterpart.
525 For example,
526 \fB\%waddch\fP becomes \fB\%wadd_wch\fP.
527 An exception is
528 .B \%ins_nwstr
529 (and its variants),
530 spelled thus instead of \*(``insn_wstr\*(''.
531 (Exceptions that add only \*(``w\*('' comprise
532 .BR \%addwstr ","
533 .BR \%inwstr ","
534 and their variants.)
535 .\" This is because they operate on "plain" wide-character strings
536 .\" (`wchar_t*`) and not curses complex character strings (`cchar_t*`).
537 .\" SVID 4 did specify functions like `addwch()` and `inswch()` that
538 .\" operated on `chtype`s assuming that they were wide enough for a
539 .\" `wchar_t` plus attribute and color pair bits; X/Open Curses did not
540 .\" standardize these.
541 .IP
542 This convention is inapplicable to some non-wide function names,
543 so other transformations are used for the wide configuration:
544 the window background management function \*(``bkgd\*('' becomes
545 \*(``bkgrnd\*('';
546 the window border-drawing and -clearing functions are suffixed with
547 \*(``_set\*('';
548 and character attribute manipulation functions like
549 \*(``attron\*('' become \*(``attr_on\*(''.
550 .RS 10 \" same as foregoing tag width
551 .TP 9 \" "cchar_t" + 2n
552 .I \%cchar_t
553 is a
554 .I "curses complex character"
555 and corresponds to the non-wide-character configuration's
556 .IR \%chtype "."
557 It is a structure type
558 because it requires more storage than a standard scalar type offers.
559 A character code may not be representable as a
560 .IR \%char ","
561 and moreover more than one character may occupy a cell
562 (as with accent marks and other diacritics).
563 Each character is of type
564 .IR \%wchar_t ;
565 a complex character contains one spacing character and zero or more
566 non-spacing characters
567 (see below).
568 A string of complex characters ends with a
569 .I \%cchar_t
570 whose
571 .I \%wchar_t
572 member is the null wide character.
573 Attributes and a color pair identifier are stored in separate fields of
574 the structure,
575 not combined into an integer as in
576 .IR \%chtype "."
577 .PP
578 .I \%ncurses
579 stores each cell of a
580 .I \%WINDOW
581 as a
582 .IR \%cchar_t "."
583 \fB\%setcchar\fP(3NCURSES) and \fB\%getcchar\fP(3NCURSES)
584 store and retrieve
585 .I \%cchar_t
586 data.
587 .PP
588 The wide library API of
589 .I \%ncurses
590 depends on two data types standardized by ISO C95.
591 .TP 9
592 .I \%wchar_t
593 stores a wide character.
594 Like
595 .IR \%chtype ","
596 it may be an alias of
597 .IR int "."
598 Depending on the character encoding,
599 a wide character may be
600 .IR spacing ","
601 meaning that it occupies a character cell by itself and typically
602 accompanies cursor advancement,
603 or
604 .IR non-spacing ","
605 meaning that it occupies the same cell as a spacing character,
606 is often regarded as a \*(``modifier\*('' of the base glyph with which
607 it combines,
608 and typically does not advance the cursor.
609 .TP 9
610 .I \%wint_t
611 can store a
612 .I \%wchar_t
613 or the constant
614 .IR \%WEOF ","
615 analogously to the
616 .IR int -sized
617 character manipulation functions of ISO C and its constant
618 .IR \%EOF "."
619 .RE
620 .\"
621 .SS "Function Name Index"
622 The following table lists the
623 .I curses
624 functions provided in the non-wide and wide APIs and the corresponding
625 man pages that describe them.
626 Those flagged with \*(``*\*(''
627 are
628 .IR \%ncurses "-specific,"
629 neither described by X/Open Curses nor present in SVr4.
630 .PP
631 .TS
632 center tab(/);
633 L L.
634 \fIcurses\fP Function Name/Man Page
635 _
636 COLOR_PAIR/\fBcolor\fP(3NCURSES)
637 PAIR_NUMBER/\fBcolor\fP(3NCURSES)
638 add_wch/\fBadd_wch\fP(3NCURSES)
639 add_wchnstr/\fBadd_wchstr\fP(3NCURSES)
640 add_wchstr/\fBadd_wchstr\fP(3NCURSES)
641 addch/\fBaddch\fP(3NCURSES)
642 addchnstr/\fBaddchstr\fP(3NCURSES)
643 addchstr/\fBaddchstr\fP(3NCURSES)
644 addnstr/\fBaddstr\fP(3NCURSES)
645 addnwstr/\fBaddwstr\fP(3NCURSES)
646 addstr/\fBaddstr\fP(3NCURSES)
647 addwstr/\fBaddwstr\fP(3NCURSES)
648 alloc_pair/\fBnew_pair\fP(3NCURSES)*
649 assume_default_colors/\fBdefault_colors\fP(3NCURSES)*
650 attr_get/\fBattr\fP(3NCURSES)
651 attr_off/\fBattr\fP(3NCURSES)
652 attr_on/\fBattr\fP(3NCURSES)
653 attr_set/\fBattr\fP(3NCURSES)
654 attroff/\fBattr\fP(3NCURSES)
655 attron/\fBattr\fP(3NCURSES)
656 attrset/\fBattr\fP(3NCURSES)
657 baudrate/\fBtermattrs\fP(3NCURSES)
658 beep/\fBbeep\fP(3NCURSES)
659 bkgd/\fBbkgd\fP(3NCURSES)
660 bkgdset/\fBbkgd\fP(3NCURSES)
661 bkgrnd/\fBbkgrnd\fP(3NCURSES)
662 bkgrndset/\fBbkgrnd\fP(3NCURSES)
663 border/\fBborder\fP(3NCURSES)
664 border_set/\fBborder_set\fP(3NCURSES)
665 box/\fBborder\fP(3NCURSES)
666 box_set/\fBborder_set\fP(3NCURSES)
667 can_change_color/\fBcolor\fP(3NCURSES)
668 cbreak/\fBinopts\fP(3NCURSES)
669 chgat/\fBattr\fP(3NCURSES)
670 clear/\fBclear\fP(3NCURSES)
671 clearok/\fBoutopts\fP(3NCURSES)
672 clrtobot/\fBclear\fP(3NCURSES)
673 clrtoeol/\fBclear\fP(3NCURSES)
674 color_content/\fBcolor\fP(3NCURSES)
675 color_set/\fBattr\fP(3NCURSES)
676 copywin/\fBoverlay\fP(3NCURSES)
677 curs_set/\fBkernel\fP(3NCURSES)
678 curses_trace/\fBtrace\fP(3NCURSES)*
679 curses_version/\fBextensions\fP(3NCURSES)*
680 def_prog_mode/\fBkernel\fP(3NCURSES)
681 def_shell_mode/\fBkernel\fP(3NCURSES)
682 define_key/\fBdefine_key\fP(3NCURSES)*
683 del_curterm/\fBterminfo\fP(3NCURSES)
684 delay_output/\fButil\fP(3NCURSES)
685 delch/\fBdelch\fP(3NCURSES)
686 deleteln/\fBdeleteln\fP(3NCURSES)
687 delscreen/\fBinitscr\fP(3NCURSES)
688 delwin/\fBwindow\fP(3NCURSES)
689 derwin/\fBwindow\fP(3NCURSES)
690 doupdate/\fBrefresh\fP(3NCURSES)
691 dupwin/\fBwindow\fP(3NCURSES)
692 echo/\fBinopts\fP(3NCURSES)
693 echo_wchar/\fBadd_wch\fP(3NCURSES)
694 echochar/\fBaddch\fP(3NCURSES)
695 endwin/\fBinitscr\fP(3NCURSES)
696 erase/\fBclear\fP(3NCURSES)
697 erasechar/\fBtermattrs\fP(3NCURSES)
698 erasewchar/\fBtermattrs\fP(3NCURSES)
699 exit_curses/\fBmemleaks\fP(3NCURSES)*
700 exit_terminfo/\fBmemleaks\fP(3NCURSES)*
701 extended_color_content/\fBcolor\fP(3NCURSES)*
702 extended_pair_content/\fBcolor\fP(3NCURSES)*
703 extended_slk_color/\fBslk\fP(3NCURSES)*
704 filter/\fButil\fP(3NCURSES)
705 find_pair/\fBnew_pair\fP(3NCURSES)*
706 flash/\fBbeep\fP(3NCURSES)
707 flushinp/\fButil\fP(3NCURSES)
708 free_pair/\fBnew_pair\fP(3NCURSES)*
709 get_escdelay/\fBthreads\fP(3NCURSES)*
710 get_wch/\fBget_wch\fP(3NCURSES)
711 get_wstr/\fBget_wstr\fP(3NCURSES)
712 getattrs/\fBattr\fP(3NCURSES)
713 getbegx/\fBlegacy\fP(3NCURSES)*
714 getbegy/\fBlegacy\fP(3NCURSES)*
715 getbegyx/\fBgetyx\fP(3NCURSES)
716 getbkgd/\fBbkgd\fP(3NCURSES)
717 getbkgrnd/\fBbkgrnd\fP(3NCURSES)
718 getcchar/\fBgetcchar\fP(3NCURSES)
719 getch/\fBgetch\fP(3NCURSES)
720 getcurx/\fBlegacy\fP(3NCURSES)*
721 getcury/\fBlegacy\fP(3NCURSES)*
722 getmaxx/\fBlegacy\fP(3NCURSES)*
723 getmaxy/\fBlegacy\fP(3NCURSES)*
724 getmaxyx/\fBgetyx\fP(3NCURSES)
725 getmouse/\fBmouse\fP(3NCURSES)*
726 getn_wstr/\fBget_wstr\fP(3NCURSES)
727 getnstr/\fBgetstr\fP(3NCURSES)
728 getparx/\fBlegacy\fP(3NCURSES)*
729 getpary/\fBlegacy\fP(3NCURSES)*
730 getparyx/\fBgetyx\fP(3NCURSES)
731 getstr/\fBgetstr\fP(3NCURSES)
732 getsyx/\fBkernel\fP(3NCURSES)
733 getwin/\fButil\fP(3NCURSES)
734 getyx/\fBgetyx\fP(3NCURSES)
735 halfdelay/\fBinopts\fP(3NCURSES)
736 has_colors/\fBcolor\fP(3NCURSES)
737 has_ic/\fBtermattrs\fP(3NCURSES)
738 has_il/\fBtermattrs\fP(3NCURSES)
739 has_key/\fBgetch\fP(3NCURSES)*
740 has_mouse/\fBmouse\fP(3NCURSES)*
741 hline/\fBborder\fP(3NCURSES)
742 hline_set/\fBborder_set\fP(3NCURSES)
743 idcok/\fBoutopts\fP(3NCURSES)
744 idlok/\fBoutopts\fP(3NCURSES)
745 immedok/\fBoutopts\fP(3NCURSES)
746 in_wch/\fBin_wch\fP(3NCURSES)
747 in_wchnstr/\fBin_wchstr\fP(3NCURSES)
748 in_wchstr/\fBin_wchstr\fP(3NCURSES)
749 inch/\fBinch\fP(3NCURSES)
750 inchnstr/\fBinchstr\fP(3NCURSES)
751 inchstr/\fBinchstr\fP(3NCURSES)
752 init_color/\fBcolor\fP(3NCURSES)
753 init_extended_color/\fBcolor\fP(3NCURSES)*
754 init_extended_pair/\fBcolor\fP(3NCURSES)*
755 init_pair/\fBcolor\fP(3NCURSES)
756 initscr/\fBinitscr\fP(3NCURSES)
757 innstr/\fBinstr\fP(3NCURSES)
758 innwstr/\fBinwstr\fP(3NCURSES)
759 ins_nwstr/\fBins_wstr\fP(3NCURSES)
760 ins_wch/\fBins_wch\fP(3NCURSES)
761 ins_wstr/\fBins_wstr\fP(3NCURSES)
762 insch/\fBinsch\fP(3NCURSES)
763 insdelln/\fBdeleteln\fP(3NCURSES)
764 insertln/\fBdeleteln\fP(3NCURSES)
765 insnstr/\fBinsstr\fP(3NCURSES)
766 insstr/\fBinsstr\fP(3NCURSES)
767 instr/\fBinstr\fP(3NCURSES)
768 intrflush/\fBinopts\fP(3NCURSES)
769 inwstr/\fBinwstr\fP(3NCURSES)
770 is_cbreak/\fBinopts\fP(3NCURSES)*
771 is_cleared/\fBopaque\fP(3NCURSES)*
772 is_echo/\fBinopts\fP(3NCURSES)*
773 is_idcok/\fBopaque\fP(3NCURSES)*
774 is_idlok/\fBopaque\fP(3NCURSES)*
775 is_immedok/\fBopaque\fP(3NCURSES)*
776 is_keypad/\fBopaque\fP(3NCURSES)*
777 is_leaveok/\fBopaque\fP(3NCURSES)*
778 is_linetouched/\fBtouch\fP(3NCURSES)
779 is_nl/\fBinopts\fP(3NCURSES)*
780 is_nodelay/\fBopaque\fP(3NCURSES)*
781 is_notimeout/\fBopaque\fP(3NCURSES)*
782 is_pad/\fBopaque\fP(3NCURSES)*
783 is_raw/\fBinopts\fP(3NCURSES)*
784 is_scrollok/\fBopaque\fP(3NCURSES)*
785 is_subwin/\fBopaque\fP(3NCURSES)*
786 is_syncok/\fBopaque\fP(3NCURSES)*
787 is_term_resized/\fBresizeterm\fP(3NCURSES)*
788 is_wintouched/\fBtouch\fP(3NCURSES)
789 isendwin/\fBinitscr\fP(3NCURSES)
790 key_defined/\fBkey_defined\fP(3NCURSES)*
791 key_name/\fButil\fP(3NCURSES)
792 keybound/\fBkeybound\fP(3NCURSES)*
793 keyname/\fButil\fP(3NCURSES)
794 keyok/\fBkeyok\fP(3NCURSES)*
795 keypad/\fBinopts\fP(3NCURSES)
796 killchar/\fBtermattrs\fP(3NCURSES)
797 killwchar/\fBtermattrs\fP(3NCURSES)
798 leaveok/\fBoutopts\fP(3NCURSES)
799 longname/\fBtermattrs\fP(3NCURSES)
800 mcprint/\fBprint\fP(3NCURSES)*
801 meta/\fBinopts\fP(3NCURSES)
802 mouse_trafo/\fBmouse\fP(3NCURSES)*
803 mouseinterval/\fBmouse\fP(3NCURSES)*
804 mousemask/\fBmouse\fP(3NCURSES)*
805 move/\fBmove\fP(3NCURSES)
806 mvadd_wch/\fBadd_wch\fP(3NCURSES)
807 mvadd_wchnstr/\fBadd_wchstr\fP(3NCURSES)
808 mvadd_wchstr/\fBadd_wchstr\fP(3NCURSES)
809 mvaddch/\fBaddch\fP(3NCURSES)
810 mvaddchnstr/\fBaddchstr\fP(3NCURSES)
811 mvaddchstr/\fBaddchstr\fP(3NCURSES)
812 mvaddnstr/\fBaddstr\fP(3NCURSES)
813 mvaddnwstr/\fBaddwstr\fP(3NCURSES)
814 mvaddstr/\fBaddstr\fP(3NCURSES)
815 mvaddwstr/\fBaddwstr\fP(3NCURSES)
816 mvchgat/\fBattr\fP(3NCURSES)
817 mvcur/\fBkernel\fP(3NCURSES)
818 mvdelch/\fBdelch\fP(3NCURSES)
819 mvderwin/\fBwindow\fP(3NCURSES)
820 mvget_wch/\fBget_wch\fP(3NCURSES)
821 mvget_wstr/\fBget_wstr\fP(3NCURSES)
822 mvgetch/\fBgetch\fP(3NCURSES)
823 mvgetn_wstr/\fBget_wstr\fP(3NCURSES)
824 mvgetnstr/\fBgetstr\fP(3NCURSES)
825 mvgetstr/\fBgetstr\fP(3NCURSES)
826 mvhline/\fBborder\fP(3NCURSES)
827 mvhline_set/\fBborder_set\fP(3NCURSES)
828 mvin_wch/\fBin_wch\fP(3NCURSES)
829 mvin_wchnstr/\fBin_wchstr\fP(3NCURSES)
830 mvin_wchstr/\fBin_wchstr\fP(3NCURSES)
831 mvinch/\fBinch\fP(3NCURSES)
832 mvinchnstr/\fBinchstr\fP(3NCURSES)
833 mvinchstr/\fBinchstr\fP(3NCURSES)
834 mvinnstr/\fBinstr\fP(3NCURSES)
835 mvinnwstr/\fBinwstr\fP(3NCURSES)
836 mvins_nwstr/\fBins_wstr\fP(3NCURSES)
837 mvins_wch/\fBins_wch\fP(3NCURSES)
838 mvins_wstr/\fBins_wstr\fP(3NCURSES)
839 mvinsch/\fBinsch\fP(3NCURSES)
840 mvinsnstr/\fBinsstr\fP(3NCURSES)
841 mvinsstr/\fBinsstr\fP(3NCURSES)
842 mvinstr/\fBinstr\fP(3NCURSES)
843 mvinwstr/\fBinwstr\fP(3NCURSES)
844 mvprintw/\fBprintw\fP(3NCURSES)
845 mvscanw/\fBscanw\fP(3NCURSES)
846 mvvline/\fBborder\fP(3NCURSES)
847 mvvline_set/\fBborder_set\fP(3NCURSES)
848 mvwadd_wch/\fBadd_wch\fP(3NCURSES)
849 mvwadd_wchnstr/\fBadd_wchstr\fP(3NCURSES)
850 mvwadd_wchstr/\fBadd_wchstr\fP(3NCURSES)
851 mvwaddch/\fBaddch\fP(3NCURSES)
852 mvwaddchnstr/\fBaddchstr\fP(3NCURSES)
853 mvwaddchstr/\fBaddchstr\fP(3NCURSES)
854 mvwaddnstr/\fBaddstr\fP(3NCURSES)
855 mvwaddnwstr/\fBaddwstr\fP(3NCURSES)
856 mvwaddstr/\fBaddstr\fP(3NCURSES)
857 mvwaddwstr/\fBaddwstr\fP(3NCURSES)
858 mvwchgat/\fBattr\fP(3NCURSES)
859 mvwdelch/\fBdelch\fP(3NCURSES)
860 mvwget_wch/\fBget_wch\fP(3NCURSES)
861 mvwget_wstr/\fBget_wstr\fP(3NCURSES)
862 mvwgetch/\fBgetch\fP(3NCURSES)
863 mvwgetn_wstr/\fBget_wstr\fP(3NCURSES)
864 mvwgetnstr/\fBgetstr\fP(3NCURSES)
865 mvwgetstr/\fBgetstr\fP(3NCURSES)
866 mvwhline/\fBborder\fP(3NCURSES)
867 mvwhline_set/\fBborder_set\fP(3NCURSES)
868 mvwin/\fBwindow\fP(3NCURSES)
869 mvwin_wch/\fBin_wch\fP(3NCURSES)
870 mvwin_wchnstr/\fBin_wchstr\fP(3NCURSES)
871 mvwin_wchstr/\fBin_wchstr\fP(3NCURSES)
872 mvwinch/\fBinch\fP(3NCURSES)
873 mvwinchnstr/\fBinchstr\fP(3NCURSES)
874 mvwinchstr/\fBinchstr\fP(3NCURSES)
875 mvwinnstr/\fBinstr\fP(3NCURSES)
876 mvwinnwstr/\fBinwstr\fP(3NCURSES)
877 mvwins_nwstr/\fBins_wstr\fP(3NCURSES)
878 mvwins_wch/\fBins_wch\fP(3NCURSES)
879 mvwins_wstr/\fBins_wstr\fP(3NCURSES)
880 mvwinsch/\fBinsch\fP(3NCURSES)
881 mvwinsnstr/\fBinsstr\fP(3NCURSES)
882 mvwinsstr/\fBinsstr\fP(3NCURSES)
883 mvwinstr/\fBinstr\fP(3NCURSES)
884 mvwinwstr/\fBinwstr\fP(3NCURSES)
885 mvwprintw/\fBprintw\fP(3NCURSES)
886 mvwscanw/\fBscanw\fP(3NCURSES)
887 mvwvline/\fBborder\fP(3NCURSES)
888 mvwvline_set/\fBborder_set\fP(3NCURSES)
889 napms/\fBkernel\fP(3NCURSES)
890 newpad/\fBpad\fP(3NCURSES)
891 newterm/\fBinitscr\fP(3NCURSES)
892 newwin/\fBwindow\fP(3NCURSES)
893 nl/\fBinopts\fP(3NCURSES)
894 nocbreak/\fBinopts\fP(3NCURSES)
895 nodelay/\fBinopts\fP(3NCURSES)
896 noecho/\fBinopts\fP(3NCURSES)
897 nofilter/\fButil\fP(3NCURSES)*
898 nonl/\fBinopts\fP(3NCURSES)
899 noqiflush/\fBinopts\fP(3NCURSES)
900 noraw/\fBinopts\fP(3NCURSES)
901 notimeout/\fBinopts\fP(3NCURSES)
902 overlay/\fBoverlay\fP(3NCURSES)
903 overwrite/\fBoverlay\fP(3NCURSES)
904 pair_content/\fBcolor\fP(3NCURSES)
905 pecho_wchar/\fBpad\fP(3NCURSES)
906 pechochar/\fBpad\fP(3NCURSES)
907 pnoutrefresh/\fBpad\fP(3NCURSES)
908 prefresh/\fBpad\fP(3NCURSES)
909 printw/\fBprintw\fP(3NCURSES)
910 putp/\fBterminfo\fP(3NCURSES)
911 putwin/\fButil\fP(3NCURSES)
912 qiflush/\fBinopts\fP(3NCURSES)
913 raw/\fBinopts\fP(3NCURSES)
914 redrawwin/\fBrefresh\fP(3NCURSES)
915 refresh/\fBrefresh\fP(3NCURSES)
916 reset_color_pairs/\fBcolor\fP(3NCURSES)*
917 reset_prog_mode/\fBkernel\fP(3NCURSES)
918 reset_shell_mode/\fBkernel\fP(3NCURSES)
919 resetty/\fBkernel\fP(3NCURSES)
920 resize_term/\fBresizeterm\fP(3NCURSES)*
921 resizeterm/\fBresizeterm\fP(3NCURSES)*
922 restartterm/\fBterminfo\fP(3NCURSES)
923 ripoffline/\fBkernel\fP(3NCURSES)
924 savetty/\fBkernel\fP(3NCURSES)
925 scanw/\fBscanw\fP(3NCURSES)
926 scr_dump/\fBscr_dump\fP(3NCURSES)
927 scr_init/\fBscr_dump\fP(3NCURSES)
928 scr_restore/\fBscr_dump\fP(3NCURSES)
929 scr_set/\fBscr_dump\fP(3NCURSES)
930 scrl/\fBscroll\fP(3NCURSES)
931 scroll/\fBscroll\fP(3NCURSES)
932 scrollok/\fBoutopts\fP(3NCURSES)
933 set_curterm/\fBterminfo\fP(3NCURSES)
934 set_escdelay/\fBthreads\fP(3NCURSES)*
935 set_tabsize/\fBthreads\fP(3NCURSES)*
936 set_term/\fBinitscr\fP(3NCURSES)
937 setcchar/\fBgetcchar\fP(3NCURSES)
938 setscrreg/\fBoutopts\fP(3NCURSES)
939 setsyx/\fBkernel\fP(3NCURSES)
940 setupterm/\fBterminfo\fP(3NCURSES)
941 slk_attr/\fBslk\fP(3NCURSES)*
942 slk_attr_off/\fBslk\fP(3NCURSES)
943 slk_attr_on/\fBslk\fP(3NCURSES)
944 slk_attr_set/\fBslk\fP(3NCURSES)
945 slk_attroff/\fBslk\fP(3NCURSES)
946 slk_attron/\fBslk\fP(3NCURSES)
947 slk_attrset/\fBslk\fP(3NCURSES)
948 slk_clear/\fBslk\fP(3NCURSES)
949 slk_color/\fBslk\fP(3NCURSES)
950 slk_init/\fBslk\fP(3NCURSES)
951 slk_label/\fBslk\fP(3NCURSES)
952 slk_noutrefresh/\fBslk\fP(3NCURSES)
953 slk_refresh/\fBslk\fP(3NCURSES)
954 slk_restore/\fBslk\fP(3NCURSES)
955 slk_set/\fBslk\fP(3NCURSES)
956 slk_touch/\fBslk\fP(3NCURSES)
957 slk_wset/\fBslk\fP(3NCURSES)
958 standend/\fBattr\fP(3NCURSES)
959 standout/\fBattr\fP(3NCURSES)
960 start_color/\fBcolor\fP(3NCURSES)
961 subpad/\fBpad\fP(3NCURSES)
962 subwin/\fBwindow\fP(3NCURSES)
963 syncok/\fBwindow\fP(3NCURSES)
964 term_attrs/\fBtermattrs\fP(3NCURSES)
965 termattrs/\fBtermattrs\fP(3NCURSES)
966 termname/\fBtermattrs\fP(3NCURSES)
967 tgetent/\fBtermcap\fP(3NCURSES)
968 tgetflag/\fBtermcap\fP(3NCURSES)
969 tgetnum/\fBtermcap\fP(3NCURSES)
970 tgetstr/\fBtermcap\fP(3NCURSES)
971 tgoto/\fBtermcap\fP(3NCURSES)
972 tigetflag/\fBterminfo\fP(3NCURSES)
973 tigetnum/\fBterminfo\fP(3NCURSES)
974 tigetstr/\fBterminfo\fP(3NCURSES)
975 timeout/\fBinopts\fP(3NCURSES)
976 tiparm/\fBterminfo\fP(3NCURSES)
977 tiparm_s/\fBterminfo\fP(3NCURSES)*
978 tiscan_s/\fBterminfo\fP(3NCURSES)*
979 touchline/\fBtouch\fP(3NCURSES)
980 touchwin/\fBtouch\fP(3NCURSES)
981 tparm/\fBterminfo\fP(3NCURSES)
982 tputs/\fBtermcap\fP(3NCURSES)
983 tputs/\fBterminfo\fP(3NCURSES)
984 trace/\fBtrace\fP(3NCURSES)*
985 typeahead/\fBinopts\fP(3NCURSES)
986 unctrl/\fButil\fP(3NCURSES)
987 unget_wch/\fBget_wch\fP(3NCURSES)
988 ungetch/\fBgetch\fP(3NCURSES)
989 ungetmouse/\fBmouse\fP(3NCURSES)*
990 untouchwin/\fBtouch\fP(3NCURSES)
991 use_default_colors/\fBdefault_colors\fP(3NCURSES)*
992 use_env/\fButil\fP(3NCURSES)
993 use_extended_names/\fBextensions\fP(3NCURSES)*
994 use_legacy_coding/\fBlegacy_coding\fP(3NCURSES)*
995 use_screen/\fBthreads\fP(3NCURSES)*
996 use_tioctl/\fButil\fP(3NCURSES)*
997 use_window/\fBthreads\fP(3NCURSES)*
998 vid_attr/\fBterminfo\fP(3NCURSES)
999 vid_puts/\fBterminfo\fP(3NCURSES)
1000 vidattr/\fBterminfo\fP(3NCURSES)
1001 vidputs/\fBterminfo\fP(3NCURSES)
1002 vline/\fBborder\fP(3NCURSES)
1003 vline_set/\fBborder_set\fP(3NCURSES)
1004 vw_printw/\fBprintw\fP(3NCURSES)
1005 vw_scanw/\fBscanw\fP(3NCURSES)
1006 vwprintw/\fBprintw\fP(3NCURSES)
1007 vwscanw/\fBscanw\fP(3NCURSES)
1008 wadd_wch/\fBadd_wch\fP(3NCURSES)
1009 wadd_wchnstr/\fBadd_wchstr\fP(3NCURSES)
1010 wadd_wchstr/\fBadd_wchstr\fP(3NCURSES)
1011 waddch/\fBaddch\fP(3NCURSES)
1012 waddchnstr/\fBaddchstr\fP(3NCURSES)
1013 waddchstr/\fBaddchstr\fP(3NCURSES)
1014 waddnstr/\fBaddstr\fP(3NCURSES)
1015 waddnwstr/\fBaddwstr\fP(3NCURSES)
1016 waddstr/\fBaddstr\fP(3NCURSES)
1017 waddwstr/\fBaddwstr\fP(3NCURSES)
1018 wattr_get/\fBattr\fP(3NCURSES)
1019 wattr_off/\fBattr\fP(3NCURSES)
1020 wattr_on/\fBattr\fP(3NCURSES)
1021 wattr_set/\fBattr\fP(3NCURSES)
1022 wattroff/\fBattr\fP(3NCURSES)
1023 wattron/\fBattr\fP(3NCURSES)
1024 wattrset/\fBattr\fP(3NCURSES)
1025 wbkgd/\fBbkgd\fP(3NCURSES)
1026 wbkgdset/\fBbkgd\fP(3NCURSES)
1027 wbkgrnd/\fBbkgrnd\fP(3NCURSES)
1028 wbkgrndset/\fBbkgrnd\fP(3NCURSES)
1029 wborder/\fBborder\fP(3NCURSES)
1030 wborder_set/\fBborder_set\fP(3NCURSES)
1031 wchgat/\fBattr\fP(3NCURSES)
1032 wclear/\fBclear\fP(3NCURSES)
1033 wclrtobot/\fBclear\fP(3NCURSES)
1034 wclrtoeol/\fBclear\fP(3NCURSES)
1035 wcolor_set/\fBattr\fP(3NCURSES)
1036 wcursyncup/\fBwindow\fP(3NCURSES)
1037 wdelch/\fBdelch\fP(3NCURSES)
1038 wdeleteln/\fBdeleteln\fP(3NCURSES)
1039 wecho_wchar/\fBadd_wch\fP(3NCURSES)
1040 wechochar/\fBaddch\fP(3NCURSES)
1041 wenclose/\fBmouse\fP(3NCURSES)*
1042 werase/\fBclear\fP(3NCURSES)
1043 wget_wch/\fBget_wch\fP(3NCURSES)
1044 wget_wstr/\fBget_wstr\fP(3NCURSES)
1045 wgetbkgrnd/\fBbkgrnd\fP(3NCURSES)
1046 wgetch/\fBgetch\fP(3NCURSES)
1047 wgetdelay/\fBopaque\fP(3NCURSES)*
1048 wgetn_wstr/\fBget_wstr\fP(3NCURSES)
1049 wgetnstr/\fBgetstr\fP(3NCURSES)
1050 wgetparent/\fBopaque\fP(3NCURSES)*
1051 wgetscrreg/\fBopaque\fP(3NCURSES)*
1052 wgetstr/\fBgetstr\fP(3NCURSES)
1053 whline/\fBborder\fP(3NCURSES)
1054 whline_set/\fBborder_set\fP(3NCURSES)
1055 win_wch/\fBin_wch\fP(3NCURSES)
1056 win_wchnstr/\fBin_wchstr\fP(3NCURSES)
1057 win_wchstr/\fBin_wchstr\fP(3NCURSES)
1058 winch/\fBinch\fP(3NCURSES)
1059 winchnstr/\fBinchstr\fP(3NCURSES)
1060 winchstr/\fBinchstr\fP(3NCURSES)
1061 winnstr/\fBinstr\fP(3NCURSES)
1062 winnwstr/\fBinwstr\fP(3NCURSES)
1063 wins_nwstr/\fBins_wstr\fP(3NCURSES)
1064 wins_wch/\fBins_wch\fP(3NCURSES)
1065 wins_wstr/\fBins_wstr\fP(3NCURSES)
1066 winsch/\fBinsch\fP(3NCURSES)
1067 winsdelln/\fBdeleteln\fP(3NCURSES)
1068 winsertln/\fBdeleteln\fP(3NCURSES)
1069 winsnstr/\fBinsstr\fP(3NCURSES)
1070 winsstr/\fBinsstr\fP(3NCURSES)
1071 winstr/\fBinstr\fP(3NCURSES)
1072 winwstr/\fBinwstr\fP(3NCURSES)
1073 wmouse_trafo/\fBmouse\fP(3NCURSES)*
1074 wmove/\fBmove\fP(3NCURSES)
1075 wnoutrefresh/\fBrefresh\fP(3NCURSES)
1076 wprintw/\fBprintw\fP(3NCURSES)
1077 wredrawln/\fBrefresh\fP(3NCURSES)
1078 wrefresh/\fBrefresh\fP(3NCURSES)
1079 wresize/\fBwresize\fP(3NCURSES)*
1080 wscanw/\fBscanw\fP(3NCURSES)
1081 wscrl/\fBscroll\fP(3NCURSES)
1082 wsetscrreg/\fBoutopts\fP(3NCURSES)
1083 wstandend/\fBattr\fP(3NCURSES)
1084 wstandout/\fBattr\fP(3NCURSES)
1085 wsyncdown/\fBwindow\fP(3NCURSES)
1086 wsyncup/\fBwindow\fP(3NCURSES)
1087 wtimeout/\fBinopts\fP(3NCURSES)
1088 wtouchln/\fBtouch\fP(3NCURSES)
1089 wunctrl/\fButil\fP(3NCURSES)
1090 wvline/\fBborder\fP(3NCURSES)
1091 wvline_set/\fBborder_set\fP(3NCURSES)
1092 .TE
1093 .PP
1094 .IR \%ncurses 's
1095 .I "screen-pointer extension"
1096 adds additional functions corresponding to many of the above,
1097 each with an \*(``_sp\*('' suffix;
1098 see \fBsp_funcs\fP(3NCURSES).
1099 .PP
1100 The availability of some extensions is configurable when
1101 .I \%ncurses
1102 is compiled;
1103 see sections \*(``ALTERNATE CONFIGURATIONS\*('' and \*(``EXTENSIONS\*(''
1104 below.
1105 .SH RETURN VALUE
1106 Unless otherwise noted,
1107 functions that return integers return the constants
1108 .B OK
1109 on success and
1110 .B ERR
1111 on failure;
1112 see \fB\%curses_variables\fP(3NCURSES).
1113 Functions that return pointers return a null pointer on failure.
1114 Typically,
1115 .I \%ncurses
1116 treats a null pointer passed as a function parameter as a failure.
1117 Functions prefixed with \*(``mv\*('' first perform cursor movement and
1118 fail if the position
1119 .RI ( y ","
1120 .IR x )
1121 is outside the window boundaries.
1122 .SH ENVIRONMENT
1123 The following symbols from the process environment customize the
1124 runtime behavior of
1125 .I \%ncurses
1126 applications.
1127 The library may be configured to disregard the variables
1128 .IR \%TERMINFO ","
1129 .IR \%TERMINFO_DIRS ","
1130 .IR \%TERMPATH ","
1131 and
1132 .IR HOME ","
1133 if the user is the superuser (root),
1134 or the application uses \fI\%setuid\fP(2) or \fI\%setgid\fP(2).
1135 .SS "\fIBAUDRATE\fP"
1136 The debugging library checks this variable when the application has
1137 redirected output to a file.
1138 .I \%ncurses
1139 interprets its integral value as the terminal's line speed
1140 in bits per second.
1141 If that value is absent or invalid,
1142 .I \%ncurses
1143 uses 9600.
1144 This feature allows developers to construct repeatable test cases
1145 that take into account optimization decisions that depend
1146 on the terminal's line speed.
1147 .SS "\fICC\fP (command character)"
1148 When set,
1149 the
1150 .B \%command_character
1151 .RB \%( cmdch )
1152 capability value of loaded
1153 .I \%term\%info
1154 entries changes to the value of this variable.
1155 Very few
1156 .I \%term\%info
1157 entries provide this feature.
1158 .PP
1159 Because this name is also used in development environments to store the
1160 C compiler's name,
1161 .I \%ncurses
1162 ignores its value if it is not one character in length.
1163 .SS "\fICOLUMNS\fP"
1164 This variable specifies the width of the screen in character cells.
1165 Applications running in a windowing environment usually are able to
1166 obtain the width of the window in which they are executing.
1167 .I \%ncurses
1168 enforces an upper limit of 512 when reading the value.
1169 If
1170 .I \%COLUMNS
1171 is not defined and the terminal's screen size is not available from the
1172 terminal driver,
1173 .I \%ncurses
1174 uses the size specified by the
1175 .B \%columns
1176 .RB \%( cols )
1177 capability of the terminal type's entry in the
1178 .I \%term\%info
1179 database,
1180 if any.
1181 .PP
1182 It is important that your application use the correct screen size.
1183 Automatic detection thereof is not always possible because an
1184 application may be running on a host that does not honor NAWS
1185 (Negotiations About Window Size)
1186 or as a different user ID than the owner of the terminal device file.
1187 Setting
1188 .I \%COLUMNS
1189 and/or
1190 .I \%LINES
1191 overrides the library's use of the screen size obtained from the
1192 operating system.
1193 .PP
1194 The
1195 .I \%COLUMNS
1196 and
1197 .I \%LINES
1198 variables may be specified independently.
1199 This property is useful to circumvent misfeatures of legacy terminal
1200 type descriptions;
1201 \fI\%xterm\fP(1) descriptions specifying 65 lines were once notorious.
1202 For best results,
1203 avoid specifying
1204 .B cols
1205 and
1206 .B lines
1207 capability codes in
1208 .I \%term\%info
1209 descriptions of terminal emulators.
1210 .PP
1211 \fBuse_env\fP(3NCURSES) can disable use of the process environment
1212 in determining the screen size.
1213 \fBuse_tioctl\fP(3NCURSES) can update
1214 .I \%COLUMNS
1215 and
1216 .I \%LINES
1217 to match the screen size obtained from system calls or the terminal
1218 database.
1219 .SS "\fIESCDELAY\fP"
1220 For
1221 .I curses
1222 to distinguish the ESC character resulting from a user's press of the
1223 \*(``Escape\*('' key on the input device from one beginning an
1224 .I "escape sequence"
1225 (as commonly produced by function keys),
1226 it waits after receiving the escape character to see if further
1227 characters are available on the input stream within a short interval.
1228 A global variable
1229 .B \%ESCDELAY
1230 stores this interval in milliseconds.
1231 The default value of 1000
1232 (one second)
1233 is adequate for most uses.
1234 This environment variable overrides it;
1235 .I \%ncurses
1236 enforces an upper limit of 30,000
1237 (30 seconds)
1238 when reading the value.
1239 .PP
1240 The most common instance where you may wish to change this value
1241 is to work with a remote host over a slow communication channel.
1242 If the host running a
1243 .I curses
1244 application does not receive the characters of an escape sequence in a
1245 timely manner,
1246 the library can interpret them as multiple key stroke events.
1247 Conversely,
1248 a fast typist on a low-latency connection who happens to input an ESC
1249 followed by characters that match an escape sequence may experience
1250 confusing application behavior.
1251 .PP
1252 \fI\%xterm\fP(1) mouse events are a form of escape sequence;
1253 therefore,
1254 if your application makes heavy use of multiple-clicking,
1255 you may wish to lengthen the default value because the delay applies
1256 to the composite multi-click event as well as the individual clicks.
1257 .PP
1258 Portable applications should not rely upon the presence of
1259 .B \%ESCDELAY
1260 in either form,
1261 but setting the environment variable rather than the global variable
1262 does not create problems when compiling an application.
1263 .PP
1264 If \fB\%keypad\fP(3NCURSES) is disabled for the
1265 .I curses
1266 window receiving input,
1267 .B \%ESCDELAY
1268 is irrelevant
1269 and a program must disambiguate escape sequences itself.
1270 .SS "\fIHOME\fP"
1271 .I \%ncurses
1272 may read and write auxiliary terminal descriptions in
1273 .I \%.termcap
1274 and
1275 .I \%.terminfo
1276 files in the user's home directory.
1277 .SS "\fILINES\fP"
1278 This counterpart to
1279 .I \%COLUMNS
1280 specifies the height of the screen in characters.
1281 The corresponding
1282 .I \%term\%info
1283 capability and code is
1284 .BR \%lines "."
1285 See the description of the
1286 .I \%COLUMNS
1287 variable above.
1288 .SS "\fIMOUSE_BUTTONS_123\fP"
1289 (OS/2 EMX port only)
1290 OS/2 numbers a three-button mouse inconsistently with other platforms,
1291 such that 1 is the left button,
1292 2 the right,
1293 and 3 the middle.
1294 This variable customizes the mouse button numbering.
1295 Its value must be three digits 1\-3 in any order.
1296 By default,
1297 .I \%ncurses
1298 assumes a numbering of \*(``132\*(''.
1299 .SS "\fINCURSES_ASSUMED_COLORS\fP"
1300 If set,
1301 this variable overrides the
1302 .I \%ncurses
1303 library's compiled-in assumption that the terminal's default colors are
1304 white on black;
1305 see \fB\%default_colors\fP(3NCURSES).
1306 Set the foreground and background color values with this environment
1307 variable by assigning it two integer values separated by a comma,
1308 indicating foregound and background color numbers,
1309 respectively.
1310 .PP
1311 For example,
1312 to tell
1313 .I \%ncurses
1314 not to assume anything about the colors,
1315 use a value of \*(``\-1,\-1\*(''.
1316 To make the default color scheme green on black on a terminal
1317 that uses ANSI\ X3.64/ECMA-48/ISO\ 6429 color assignments,
1318 use \*(``2,0\*(''.
1319 .I \%ncurses
1320 accepts integral values from \-1 up to the value of the
1321 .I \%term\%info
1322 .B \%max_colors
1323 .RB ( colors )
1324 capability for the selected terminal type.
1325 .SS "\fINCURSES_CONSOLE2\fP"
1326 (MinGW port only)
1327 The
1328 .I \%Console2
1329 .\" https://www.hanselman.com/blog/console2-a-better-windows-command-prompt
1330 program defectively handles the Microsoft Console API call
1331 .IR \%Create\%Console\%Screen\%Buffer "."
1332 Applications that use it will hang.
1333 However,
1334 it is possible to simulate the action of this call by mapping
1335 coordinates,
1336 explicitly saving and restoring the original screen contents.
1337 Setting the environment variable
1338 .I \%NCGDB
1339 has the same effect.
1340 .SS "\fINCURSES_GPM_TERMS\fP"
1341 (Linux only)
1342 When
1343 .I \%ncurses
1344 is configured to use the GPM interface,
1345 this variable may list one or more terminal type names,
1346 delimited by vertical bars
1347 .RB ( | )
1348 or colons
1349 .RB ( : ),
1350 against which the
1351 .I TERM
1352 variable
1353 (see below)
1354 is matched.
1355 An empty value disables the GPM interface,
1356 using
1357 .IR \%ncurses 's
1358 built-in support for \fI\%xterm\fP(1) mouse protocols instead.
1359 If the variable is absent,
1360 .I \%ncurses
1361 attempts to open GPM if
1362 .I TERM
1363 contains \*(``linux\*(''.
1364 .SS "\fINCURSES_NO_HARD_TABS\fP"
1365 .I \%ncurses
1366 may use tab characters in cursor movement optimization.
1367 In some cases,
1368 your terminal driver may not handle them properly.
1369 Set this environment variable to any value to disable the feature.
1370 You can also adjust your \fI\%stty\fP(1) settings to avoid the problem.
1371 .SS "\fINCURSES_NO_MAGIC_COOKIE\fP"
1372 Many terminals store video attributes as properties of a character cell,
1373 as
1374 .I curses
1375 does.
1376 Historically,
1377 some recorded changes in video attributes as data
1378 that logically
1379 (but invisibly)
1380 .I occupied
1381 character cells on the display,
1382 switching attributes on or off,
1383 similarly to tags in a markup language,
1384 which then had to be overprinted to depict the cells' desired contents;
1385 these are termed \*(``magic cookies\*(''.
1386 If the
1387 .I \%term\%info
1388 entry for your terminal type does not adequately describe its handling
1389 of magic cookies,
1390 set this variable to any value to instruct
1391 .I \%ncurses
1392 to disable attributes entirely.
1393 .SS "\fINCURSES_NO_PADDING\fP"
1394 Most terminal type descriptions in the
1395 .I \%term\%info
1396 database detail hardware devices.
1397 Many people use
1398 .IR curses -based
1399 applications in terminal emulator programs that run in a windowing
1400 environment.
1401 These programs can duplicate all of the important features of a hardware
1402 terminal,
1403 but often lack their limitations.
1404 Chief among these absent drawbacks is the problem of data flow
1405 management;
1406 that is,
1407 limiting the speed of communication to what the hardware could handle.
1408 Unless a hardware terminal is interfaced into a terminal concentrator
1409 (which does flow control),
1410 an application must manage flow itself to prevent overruns and data
1411 loss.
1412 .PP
1413 A solution that comes at no hardware cost
1414 is for an application to pause transmission
1415 after directing a terminal to execute an operation
1416 that it performs slowly,
1417 such as clearing the display.
1418 Many terminal type descriptions,
1419 including that for the VT100,
1420 embed delay specifications in capabilities.
1421 You may wish to use these terminal descriptions without paying the
1422 performance penalty.
1423 Set
1424 .I \%NCURSES_NO_PADDING
1425 to any value to disable all but mandatory padding.
1426 Mandatory padding is used by such terminal capabilities as
1427 .B \%flash_screen
1428 .RB ( flash ).
1429 .SS "\fINCURSES_NO_SETBUF\fP"
1430 (Obsolete)
1431 Prior to internal changes developed in
1432 .I \%ncurses
1433 5.9
1434 (patches 20120825 through 20130126),
1435 the library used \fI\%setbuf\fP(3) to enable fully buffered output when
1436 initializing the terminal.
1437 This was done,
1438 as in SVr4
1439 .IR curses ","
1440 to increase performance.
1441 For testing purposes,
1442 both of
1443 .I \%ncurses
1444 and of certain applications,
1445 this feature was made optional.
1446 Setting this variable disabled output buffering,
1447 leaving the output stream in the original
1448 (usually line-buffered)
1449 mode.
1450 .PP
1451 Nowadays,
1452 .I \%ncurses
1453 performs its own buffering and does not require this workaround;
1454 it does not modify the buffering of the standard output stream.
1455 This approach makes the library's handling of keyboard-initiated signals
1456 more robust.
1457 A drawback is that certain unconventional programs mixed
1458 \fI\%stdio\fP(3) calls with
1459 .I \%ncurses
1460 calls and (usually)
1461 got the behavior they expected.
1462 This is no longer the case;
1463 .I \%ncurses
1464 does not write to the standard output file descriptor through a
1465 .IR stdio -buffered
1466 stream.
1467 .PP
1468 As a special case,
1469 low-level API calls such as \fB\%putp\fP(3NCURSES) still use the
1470 standard output stream.
1471 High-level
1472 .I curses
1473 calls such as \fB\%printw\fP(3NCURSES) do not.
1474 .SS "\fINCURSES_NO_UTF8_ACS\fP"
1475 At initialization,
1476 .I \%ncurses
1477 inspects the
1478 .I TERM
1479 environment variable for special cases where VT100 forms-drawing
1480 characters
1481 (and the corresponding alternate character set
1482 .I \%term\%info
1483 capabilities)
1484 are known to be unsupported by terminal types that otherwise claim VT100
1485 compatibility.
1486 Specifically,
1487 when running in a UTF-8 locale,
1488 the Linux virtual console device and the GNU \fI\%screen\fP(1)
1489 program ignore them.
1490 Set this variable to a nonzero value to instruct
1491 .I \%ncurses
1492 that the terminal's ACS support is broken;
1493 the library then outputs Unicode code points that correspond to the
1494 forms-drawing
1495 characters.
1496 Set it to zero
1497 (or a non-integer)
1498 to disable the special check for terminal type names matching
1499 \*(``linux\*('' or \*(``screen\*('',
1500 directing
1501 .I \%ncurses
1502 to assume that the ACS feature works if the terminal type description
1503 advertises it.
1504 .PP
1505 As an alternative to use of this variable,
1506 .I \%ncurses
1507 checks for an extended
1508 .I \%term\%info
1509 numeric capability \fBU8\fP
1510 that can be compiled using
1511 .RB \*(`` "tic \-x" \*(''.
1512 Examples follow.
1513 .PP
1514 .RS 3
1515 .EX
1516 .nf
1517 # linux console, if patched to provide working
1518 # VT100 shift\-in/shift\-out, with corresponding font.
1519 linux\-vt100|linux console with VT100 line\-graphics,
1520 U8#0, use=linux,
1521 \&
1522 # uxterm with vt100Graphics resource set to false
1523 xterm\-utf8|xterm relying on UTF\-8 line\-graphics,
1524 U8#1, use=xterm,
1525 .fi
1526 .EE
1527 .RE
1528 .PP
1529 The two-character name \*(``U8\*('' was chosen to permit its use via
1530 .IR \%ncurses 's
1531 .I termcap
1532 interface.
1533 .SS "\fINCURSES_TRACE\fP"
1534 At initialization,
1535 .I \%ncurses
1536 (in its debugging configuration)
1537 checks for this variable's presence.
1538 If defined with an integral value,
1539 the library calls \fB\%curses_trace\fP(3NCURSES) with that value as the
1540 argument.
1541 .SS "\fITERM\fP"
1542 The
1543 .I TERM
1544 variable denotes the terminal type.
1545 Each is distinct,
1546 though many are similar.
1547 It is commonly set by terminal emulators to help applications find a
1548 workable terminal description.
1549 Some choose a popular approximation such as \*(``ansi\*('',
1550 \*(``vt100\*('', or \*(``xterm\*('' rather than an exact fit to their
1551 capabilities.
1552 Not infrequently,
1553 an application will have problems with that approach;
1554 for example,
1555 a key stroke may not operate correctly,
1556 or produce no effect but seeming garbage characters on the screen.
1557 .PP
1558 Setting
1559 .I TERM
1560 has no effect on hardware operation;
1561 it affects the way applications communicate with the terminal.
1562 Likewise,
1563 as a general rule
1564 (\fIxterm\fP(1) being a rare exception),
1565 terminal emulators that allow you to specify
1566 .I TERM
1567 as a parameter or configuration value do not change their behavior to
1568 match that setting.
1569 .SS "\fITERMCAP\fP"
1570 If
1571 .I \%ncurses
1572 is configured with
1573 .I termcap
1574 support,
1575 it checks for a terminal type description in
1576 .I termcap
1577 format if one in
1578 .I \%term\%info
1579 format is not available.
1580 Setting this variable directs
1581 .I \%ncurses
1582 to ignore the usual
1583 .I termcap
1584 database location,
1585 .IR \%/etc/termcap ;
1586 see
1587 .I \%TERMPATH
1588 below.
1589 .I \%TERMCAP
1590 should contain either a terminal description
1591 (with newlines stripped out),
1592 or a file name indicating where the information required by the
1593 .I TERM
1594 environment variable is stored.
1595 .SS "\fITERMINFO\fP"
1596 .I \%ncurses
1597 can be configured to read terminal type description databases in various
1598 locations using different formats.
1599 This variable overrides the default location.
1600 .bP
1601 Descriptions in
1602 .I \%term\%info
1603 format are normally stored in a directory tree using subdirectories
1604 named for the common first letters of the terminal types named therein.
1605 System\ V used this scheme.
1606 .bP
1607 If
1608 .I \%ncurses
1609 is configured to use hashed databases,
1610 then
1611 .I \%TERM\%INFO
1612 may name its location,
1613 such as
1614 .IR \%/usr/share/terminfo.db ","
1615 rather than
1616 .IR \%/usr/share/terminfo/ "."
1617 .PP
1618 The hashed database uses less disk space and is a little faster than the
1619 directory tree.
1620 However,
1621 some applications assume the existence of the directory tree
1622 and read it directly,
1623 ignoring the
1624 .I \%term\%info
1625 API.
1626 .bP
1627 If
1628 .I \%ncurses
1629 is configured with
1630 .I termcap
1631 support,
1632 this variable may contain the location of a
1633 .I \%termcap
1634 file.
1635 .bP
1636 If the value of
1637 .I \%TERM\%INFO
1638 begins with \*(``hex:\*('' or \*(``b64:\*('',
1639 .I \%ncurses
1640 uses the remainder of the value as a compiled
1641 .I \%term\%info
1642 description.
1643 You might produce the base64 format using \fB\%infocmp\fP(1).
1644 .RS 4
1645 .IP
1646 .EX
1647 .nf
1648 TERMINFO=$(infocmp \-0 \-Q2 \-q)
1649 export TERMINFO
1650 .fi
1651 .EE
1652 .RE
1653 .IP
1654 .I \%ncurses
1655 uses the compiled description only if it corresponds
1656 to the terminal type identified by
1657 .IR TERM "."
1658 .PP
1659 Setting
1660 .I \%TERM\%INFO
1661 is the simplest,
1662 but not the only,
1663 way to direct
1664 .I \%ncurses
1665 to a terminal database.
1666 The search path is as follows.
1667 .bP
1668 the last terminal database to which the running
1669 .I \%ncurses
1670 application wrote,
1671 if any
1672 .bP
1673 the location specified by the
1674 .I \%TERM\%INFO
1675 environment variable
1676 .bP
1677 .I $HOME/.terminfo
1678 .bP
1679 locations listed in the
1680 .I \%TERMINFO_DIRS
1681 environment variable
1682 .ds td \" empty
1683 .if !'/etc/terminfo:/usr/share/terminfo'no default value' .as td /etc/terminfo:/usr/share/terminfo
1684 .if !'/usr/share/terminfo\*(td'' \{\
1685 .bP
1686 location(s) configured and compiled into
1687 .I \%ncurses
1688 .RS
1689 .if !'\*(td'' \{\
1690 .bP
1691 .I \%/etc/terminfo:/usr/share/terminfo
1692 .\}
1693 .if !'@TERMINFO'' .if !'\*(td'/usr/share/terminfo' \{\
1694 .bP
1695 .I \%/usr/share/terminfo
1696 .\}
1697 .\}
1698 .RE
1699 .SS "\fITERMINFO_DIRS\fP"
1700 This variable specifies a list of locations,
1701 akin to
1702 .IR PATH ","
1703 in which
1704 .I \%ncurses
1705 searches for the terminal type descriptions described by
1706 .I \%TERMINFO
1707 above.
1708 The list items are separated by colons on Unix
1709 and semicolons on OS/2 EMX.
1710 System\ V
1711 .I \%term\%info
1712 lacks a corresponding feature;
1713 .I \%TERMINFO_DIRS
1714 is an
1715 .I \%ncurses
1716 extension.
1717 .SS "\fITERMPATH\fP"
1718 If
1719 .I \%TERMCAP
1720 does not hold a terminal type description or file name,
1721 then
1722 .I \%ncurses
1723 checks the contents of
1724 .IR \%TERMPATH ","
1725 a list of locations,
1726 akin to
1727 .IR PATH ","
1728 in which it searches for
1729 .I termcap
1730 terminal type descriptions.
1731 The list items are separated by colons on Unix
1732 and semicolons on OS/2 EMX.
1733 .PP
1734 If both
1735 .I \%TERMCAP
1736 and
1737 .I \%TERMPATH
1738 are unset or invalid,
1739 .I \%ncurses
1740 searches for the files
1741 .IR \%/etc/termcap ","
1742 .IR \%/usr/share/misc/termcap ","
1743 and
1744 .IR \%$HOME/.termcap ","
1745 in that order.
1746 .SH "ALTERNATE CONFIGURATIONS"
1747 Many different
1748 .I \%ncurses
1749 configurations are possible,
1750 determined by the options given to the
1751 .I \%configure
1752 script when building the library.
1753 Run the script with the
1754 .B \%\-\-help
1755 option to peruse them all.
1756 A few are of particular significance to the application developer
1757 employing
1758 .IR \%ncurses "."
1759 .TP 5
1760 .B \-\-disable\-overwrite
1761 Avoid file name conflicts between
1762 .I \%ncurses
1763 and an existing
1764 .I curses
1765 installation on the system.
1766 The standard C preprocessor inclusion for the
1767 .I curses
1768 library is as follows.
1769 .RS 5
1770 .PP
1771 .RS 4
1772 .EX
1773 .nf
1774 .\" The dummy character prevents undesired rewriting of the next line on
1775 .\" installation of the man page.
1776 \fB#\&include <curses.h>\fP
1777 .fi
1778 .EE
1779 .RE
1780 .PP
1781 If
1782 .I \%ncurses
1783 is installed disabling overwrite,
1784 it puts its header files in a subdirectory.
1785 Here is an example.
1786 .PP
1787 .RS 4
1788 .EX
1789 .\" The dummy character prevents undesired rewriting of the next line on
1790 .\" installation of the man page.
1791 \fB#\&include <ncurses/curses.h>\fP
1792 .EE
1793 .RE
1794 .PP
1795 With
1796 .BR \%\-\-disable\-overwrite ","
1797 installation also omits a symbolic link that would cause the compiler's
1798 .B \%\-lcurses
1799 option to link object files with
1800 .I \%ncurses
1801 instead of the system
1802 .I curses
1803 library.
1804 .PP
1805 The directory used by this configuration of
1806 .I \%ncurses
1807 is shown in section \*(``SYNOPSIS\*('' above.
1808 .RE
1809 .TP 5
1810 .B \-\-enable\-widec
1811 (default for ABI\ 6+ since 2023-10-21)
1812 Enable support for wide characters.
1813 The
1814 .I \%configure
1815 script renames the
1816 .I \%ncurses
1817 library
1818 (and the
1819 .I tinfo
1820 library,
1821 if
1822 .B \%\-\-with\-termlib
1823 is also specified),
1824 appending \*(``w\*(''.
1825 An application desirous of wide-character support then uses
1826 .B \%\-lncursesw
1827 (or
1828 .BR \%\-ltinfow )
1829 instead of
1830 .B \%\-lncurses
1831 (or
1832 .BR \%\-ltinfo )
1833 as its linker option.
1834 The
1835 .IR ncurses++ ","
1836 .IR panel ","
1837 .IR form ","
1838 and
1839 .I menu
1840 libraries are renamed similarly.
1841 .IP
1842 An application must also
1843 define certain C preprocessor symbols
1844 to enable wide-character features
1845 in
1846 .I curses
1847 header files
1848 to use the extended (wide-character) functions.
1849 The symbol that enables these features has changed
1850 since X/Open Curses Issue\ 4.
1851 .RS 5
1852 .bP
1853 Originally,
1854 the wide-character feature required the symbol
1855 .IR \%_XOPEN_SOURCE_EXTENDED ","
1856 but that was valid only for XPG4 (1996).
1857 .bP
1858 Later,
1859 that was deemed conflicting with an
1860 .I \%_XOPEN_SOURCE
1861 value of 500.
1862 .bP
1863 As of mid-2018,
1864 no
1865 .I \%ncurses
1866 feature requires a
1867 .I \%_XOPEN_SOURCE
1868 value greater than 600.
1869 However,
1870 X/Open Curses Issue\ 7 (2009) recommends defining it to 700.
1871 .bP
1872 Alternatively,
1873 you can enable the feature by defining
1874 .B \%NCURSES_WIDECHAR
1875 with the caveat that some header file other than
1876 .I \%curses.h
1877 may require a specific value for
1878 .I \%_XOPEN_SOURCE
1879 (or a system-specific symbol).
1880 .RE
1881 .IP
1882 The
1883 .I \%curses.h
1884 header file installed
1885 for the wide-character library
1886 is designed to be compatible with the non-wide library's header.
1887 Only the size of the
1888 .I \%WINDOW
1889 structure differs;
1890 few applications require more than pointers to
1891 .IR \%WINDOW "."
1892 .\" XXX: What's different in term.h?
1893 .IP
1894 If
1895 .IR \%ncurses 's
1896 header files are installed allowing overwrite
1897 (the default,
1898 but see
1899 .B \%\-\-disable\-overwrite
1900 above),
1901 the wide-character library's headers should be installed last
1902 by packaging systems and similar,
1903 to allow applications to be built using either library
1904 from the same set of headers.
1905 .TP 5
1906 .B \-\-with\-pthread
1907 Enable support for multi-threaded applications.
1908 The
1909 .I \%configure
1910 script renames the
1911 .I \%ncurses
1912 library
1913 (and the
1914 .I tinfo
1915 library,
1916 if
1917 .B \%\-\-with\-termlib
1918 is also specified),
1919 appending \*(``t\*(''
1920 (before any \*(``w\*('' added by
1921 .BR \%\-\-enable\-widec ).
1922 An application desirous of support for multiple threads of execution
1923 then uses,
1924 for example,
1925 .B \%\-lncursest
1926 (or
1927 .BR \%\-ltinfot )
1928 instead of
1929 .B \%\-lncurses
1930 (or
1931 .BR \%\-ltinfo )
1932 as its linker option.
1933 The
1934 .IR ncurses++ ","
1935 .IR panel ","
1936 .IR form ","
1937 and
1938 .I menu
1939 libraries are renamed similarly.
1940 .IP
1941 .I \%ncursest
1942 and
1943 .I \%ncursestw
1944 replace global variables such as
1945 .B \%LINES
1946 with macros allowing read-only access.
1947 At the same time,
1948 they provide functions to set these values.
1949 Very few applications require changes
1950 to work with this convention.
1951 .\" see definition of NCURSES_WRAPPED_VAR
1952 .TP 5
1953 .B \-\-with\-shared
1954 .tQ
1955 .B \-\-with\-normal
1956 .tQ
1957 .B \-\-with\-debug
1958 .tQ
1959 .B \-\-with\-profile
1960 Mandate compilation of the
1961 .I \%ncurses
1962 library
1963 (and the
1964 .I tinfo
1965 library,
1966 if
1967 .B \%\-\-with\-termlib
1968 is also specified)
1969 in the specified forms.
1970 The shared and normal (static) library names differ by their suffixes,
1971 as with
1972 .I \%libncurses.so
1973 and
1974 .IR \%libncurses.a "."
1975 The debugging and profiling libraries add a \*(``_g\*(''
1976 and a \*(``_p\*('' to the roots of these respective names,
1977 forming
1978 .I \%libncurses_g.so
1979 and
1980 .IR \%libncurses_p.a ","
1981 for example.
1982 The
1983 .IR ncurses++ ","
1984 .IR panel ","
1985 .IR form ","
1986 and
1987 .I menu
1988 libraries are made available similarly.
1989 .TP 5
1990 .B \-\-with\-termlib
1991 Provide
1992 .IR \%ncurses 's
1993 lower-level terminal interface functions
1994 (those that do not depend
1995 on the
1996 .I \%SCREEN
1997 and
1998 .I \%WINDOW
1999 abstractions)
2000 in a library named
2001 .IR \%tinfo "."
2002 This arrangement reduces an application's linking and/or loading times
2003 when it does not require
2004 .IR curses 's
2005 higher-level features.
2006 .IP
2007 The following pages document
2008 .I curses
2009 functions provided by
2010 .IR \%tinfo "."
2011 .RS
2012 .bP
2013 \fB\%extensions\fP(3NCURSES) \- miscellaneous \fIncurses\fP extensions
2014 .bP
2015 \fB\%inopts\fP(3NCURSES) \- \fIcurses\fP input options
2016 .bP
2017 \fB\%kernel\fP(3NCURSES) \- low-level \fIcurses\fP routines
2018 .bP
2019 \fB\%termattrs\fP(3NCURSES) \- \fIcurses\fP environment query routines
2020 .bP
2021 \fB\%termcap\fP(3NCURSES) \- \fIcurses\fP emulation of \fItermcap\fP
2022 .bP
2023 \fB\%terminfo\fP(3NCURSES) \- \fIcurses\fP interface to \fIterminfo\fP
2024 database
2025 .bP
2026 \fB\%util\fP(3NCURSES) \- miscellaneous \fIcurses\fP utility routines
2027 .RE
2028 .TP 5
2029 .B \-\-with\-trace
2030 Expose the \fBcurses_trace\fP(3NCURSES) function
2031 in the
2032 .I ncurses(w)
2033 shared and static libraries.
2034 Normally,
2035 it is available only in the debugging library.
2036 (If
2037 .B \-\-with\-termlib
2038 is also specified,
2039 .I tinfo(w)
2040 rather than
2041 .I ncurses(w)
2042 supplies the deprecated \fBtrace\fP(3NCURSES) function.)
2043 An application's configuration script should check
2044 for the function's existence
2045 rather than assuming its confinement to the debugging library.
2046 .SH FILES
2047 .TP
2048 .I /usr/share/tabset
2049 tab stop initialization database
2050 .TP
2051 .I /usr/share/terminfo
2052 compiled terminal capability database
2053 .SH NOTES
2054 X/Open Curses permits most functions it specifies to be made available
2055 as macros as well.
2056 .\" See X/Open Curses Issue 4, Version 2, pp. 227-234.
2057 .\" See X/Open Curses Issue 7, pp. 311-318.
2058 \fI\%ncurses\fP does so
2059 .bP
2060 for functions that return values via their parameters,
2061 .bP
2062 to support obsolete features,
2063 .bP
2064 to reuse functions
2065 (for example,
2066 those that move the cursor before another operation),
2067 and
2068 .bP
2069 in a few special cases.
2070 .PP
2071 If the standard output file descriptor of an
2072 .I \%ncurses
2073 program is redirected to something that is not a terminal device,
2074 the library writes screen updates to the standard error file descriptor.
2075 This was an undocumented feature of SVr3
2076 .IR curses "."
2077 .PP
2078 See subsection \*(``Header Files\*('' below regarding symbols exposed by
2079 inclusion of \fI\%curses.h\fP.
2080 .SH EXTENSIONS
2081 .I \%ncurses
2082 enables an application to capture mouse events from certain terminals,
2083 including \fI\%xterm\fP(1);
2084 see \fB\%mouse\fP(3NCURSES).
2085 .PP
2086 .I \%ncurses
2087 provides a means of responding to window resizing events,
2088 as when running in a GUI terminal emulator application such as
2089 .IR \%xterm ;
2090 see \fB\%resizeterm\fP(3NCURSES) and \fB\%wresize\fP(3NCURSES).
2091 .PP
2092 .I \%ncurses
2093 allows an application to query the terminal for the presence of a wide
2094 variety of special keys;
2095 see \fB\%has_key\fP(3NCURSES).
2096 .PP
2097 .I \%ncurses
2098 extends the fixed set of function key capabilities specified by X/Open
2099 Curses by allowing the application programmer to define additional key
2100 events at runtime;
2101 see
2102 \fB\%define_key\fP(3NCURSES),
2103 \fB\%key_defined\fP(3NCURSES),
2104 \fB\%keybound\fP(3NCURSES),
2105 and
2106 \fB\%keyok\fP(3NCURSES).
2107 .PP
2108 .I \%ncurses
2109 can exploit the capabilities of terminals implementing ISO\ 6429/ECMA-48
2110 SGR\ 39 and SGR\ 49 sequences,
2111 which allow an application to reset the terminal to its original
2112 foreground and background colors.
2113 From a user's perspective,
2114 the application is able to draw colored text on a background whose color
2115 is set independently,
2116 providing better control over color contrasts.
2117 See \fB\%default_colors\fP(3NCURSES).
2118 .PP
2119 An
2120 .I \%ncurses
2121 application can eschew knowledge of
2122 .I \%SCREEN
2123 and
2124 .I \%WINDOW
2125 structure internals,
2126 instead using accessor functions such as
2127 \fB\%is_cbreak\fP(3NCURSES) and
2128 \fB\%is_scrollok\fP(3NCURSES).
2129 .PP
2130 .I \%ncurses
2131 enables an application to direct its output to a printer attached to the
2132 terminal device;
2133 see \fB\%print\fP(3NCURSES).
2134 .PP
2135 .I \%ncurses
2136 offers \fB\%slk_attr\fP(3NCURSES) as a counterpart of \fB\%attr_get\fP(3NCURSES) for
2137 soft-label key lines,
2138 and \fB\%extended_slk_color\fP(3NCURSES) as a form of \fB\%slk_color\fP(3NCURSES)
2139 that can gather color information from them when many colors are
2140 supported.
2141 .PP
2142 .I \%ncurses
2143 permits modification of \fB\%unctrl\fP(3NCURSES)'s behavior;
2144 see \fB\%use_legacy_coding\fP(3NCURSES).
2145 .PP
2146 Rudimentary support for multi-threaded applications may be available;
2147 see \fBthreads\fP(3NCURSES).
2148 .PP
2149 Functions that ease the management of multiple screens can be exposed;
2150 see \fBsp_funcs\fP(3NCURSES).
2151 .PP
2152 To aid applications to debug their memory usage,
2153 .I \%ncurses
2154 optionally offers functions to more aggressively free memory it
2155 dynamically allocates itself;
2156 see \fBmemleaks\fP(3NCURSES).
2157 .PP
2158 The library facilitates auditing and troubleshooting of its behavior;
2159 see \fBtrace\fP(3NCURSES).
2160 .PP
2161 Compiling
2162 .I \%ncurses
2163 with the option
2164 .B \%\-DUSE_GETCAP
2165 causes it to fall back to reading
2166 .I \%/etc/termcap
2167 if the terminal setup code cannot find a
2168 .I \%term\%info
2169 entry corresponding to
2170 .IR TERM "."
2171 Use of this feature is not recommended,
2172 as it essentially includes an entire
2173 .I termcap
2174 compiler in the
2175 .I \%ncurses
2176 startup code,
2177 at a cost in memory usage and application launch latency.
2178 .PP
2179 .I \%PDCurses
2180 and NetBSD
2181 .I curses
2182 incorporate some
2183 .I \%ncurses
2184 extensions.
2185 Individual man pages indicate where this is the case.
2186 .SH PORTABILITY
2187 X/Open Curses defines two levels of conformance,
2188 \*(``base\*('' and \*(``enhanced\*(''.
2189 The latter includes several additional features,
2190 such as wide-character and color support.
2191 .I \%ncurses
2192 intends base-level conformance with X/Open Curses,
2193 and supports all features of its enhanced level
2194 except the
2195 .I \%untic
2196 utility.
2197 .PP
2198 Differences between X/Open Curses and
2199 .I \%ncurses
2200 are documented in the \*(``PORTABILITY\*('' sections of applicable man
2201 pages.
2202 .SS "Error Checking"
2203 In many cases, X/Open Curses is vague about error conditions,
2204 omitting some of the SVr4 documentation.
2205 .PP
2206 Unlike other implementations,
2207 .I \%ncurses
2208 checks pointer parameters,
2209 such as those to
2210 .I \%WINDOW
2211 structures,
2212 to ensure that they are not null.
2213 This is done primarily to guard against programmer error.
2214 The standard interface does not provide a way for the library
2215 to tell an application which of several possible errors occurred.
2216 An application that relies on
2217 .I \%ncurses
2218 to check its function parameters for validity limits its portability and
2219 robustness.
2220 .SS "Padding Differences"
2221 In historical
2222 .I curses
2223 implementations,
2224 delays embedded in the
2225 .I \%term\%info
2226 capabilities
2227 .B \%carriage_return
2228 .RB ( cr ),
2229 .B \%scroll_forward
2230 .RB ( ind ),
2231 .B \%cursor_left
2232 .RB ( cub1 ),
2233 .B \%form_feed
2234 .RB ( ff ),
2235 and
2236 .B \%tab
2237 .RB ( ht )
2238 activated corresponding delay bits in the Unix terminal driver.
2239 .I \%ncurses
2240 performs all padding by sending NUL bytes to the device.
2241 This method is slightly more expensive,
2242 but narrows the interface to the Unix kernel significantly and
2243 correspondingly increases the package's portability.
2244 .SS "Header Files"
2245 The header file
2246 .I \%curses.h
2247 itself includes the header files
2248 .I \%stdio.h
2249 and
2250 .IR \%unctrl.h "."
2251 .PP
2252 X/Open Curses has more to say,
2253 .RS 4
2254 .PP
2255 The inclusion of
2256 .I \%curses.h
2257 may make visible all symbols from the headers
2258 .IR \%stdio.h ","
2259 .IR \%term.h ","
2260 .IR \%termios.h ","
2261 and
2262 .IR \%wchar.h "."
2263 .RE
2264 .PP
2265 but does not finish the story.
2266 A more complete account follows.
2267 .bP
2268 The first
2269 .IR curses ","
2270 in 4BSD,
2271 provided a
2272 .I \%curses.h
2273 file.
2274 .IP
2275 BSD
2276 .I curses
2277 code included
2278 .I \%curses.h
2279 and
2280 .I \%unctrl.h
2281 from an internal header file
2282 .IR \%curses.ext ","
2283 where
2284 \*(``ext\*('' abbreviated \*(``externs\*(''.
2285 .IP
2286 The implementations of
2287 .I \%printw
2288 and
2289 .I \%scanw
2290 used undocumented internal functions of the standard I/O library
2291 .RI ( _doprnt
2292 and
2293 .IR _doscan ),
2294 but nothing in
2295 .I \%curses.h
2296 itself relied upon
2297 .IR \%stdio.h "."
2298 .bP
2299 SVr2
2300 .I curses
2301 added
2302 .IR \%newterm ","
2303 which relies upon
2304 .I \%stdio.h
2305 because its function prototype employs the
2306 .I FILE
2307 type.
2308 .IP
2309 SVr4
2310 .I curses
2311 added
2312 .I \%putwin
2313 and
2314 .IR \%getwin ","
2315 which also use
2316 .IR \%stdio.h "."
2317 .IP
2318 X/Open Curses specifies all three of these functions.
2319 .IP
2320 SVr4
2321 .I curses
2322 and X/Open Curses do not require the developer to include
2323 .I \%stdio.h
2324 before
2325 .IR \%curses.h "."
2326 Both document use of
2327 .I curses
2328 as requiring only
2329 .IR \%curses.h "."
2330 .IP
2331 As a result,
2332 standard
2333 .I \%curses.h
2334 always includes
2335 .IR \%stdio.h "."
2336 .bP
2337 X/Open Curses and SVr4
2338 .I curses
2339 are inconsistent with respect to
2340 .IR \%unctrl.h "."
2341 .IP
2342 As noted in \fButil\fP(3NCURSES),
2343 .I \%ncurses
2344 includes
2345 .I \%unctrl.h
2346 from
2347 .I \%curses.h
2348 (as SVr4 does).
2349 .bP
2350 X/Open Curses's comments about
2351 .I \%term.h
2352 and
2353 .I \%termios.h
2354 may refer to HP-UX and AIX.
2355 .IP
2356 HP-UX
2357 .I curses
2358 includes
2359 .I \%term.h
2360 from
2361 .I \%curses.h
2362 to declare
2363 .I \%setupterm
2364 in
2365 .IR \%curses.h ","
2366 but
2367 .I \%ncurses
2368 and Solaris
2369 .I curses
2370 do not.
2371 .IP
2372 AIX
2373 .I curses
2374 includes
2375 .I \%term.h
2376 and
2377 .IR \%termios.h "."
2378 Again,
2379 .I \%ncurses
2380 and Solaris
2381 .I curses
2382 do not.
2383 .bP
2384 X/Open Curses says that
2385 .I \%curses.h
2386 .B may
2387 include
2388 .IR \%term.h ","
2389 but does not require it to do so.
2390 .IP
2391 Some programs use functions declared in both
2392 .I \%curses.h
2393 and
2394 .IR \%term.h ","
2395 and must include both header files in the same translation unit.
2396 .\" Is that true in ncurses? Can we supply an example? --GBR
2397 .IP
2398 The header files supplied by
2399 .I \%ncurses
2400 include the standard library headers required for its declarations,
2401 so
2402 .IR \%ncurses 's
2403 own header files can be included in any order.
2404 For portability even to old AIX systems,
2405 include
2406 .I \%curses.h
2407 before
2408 .IR \%term.h "."
2409 .bP
2410 X/Open Curses says \*(``may make visible\*('' because including a header
2411 file does not necessarily make visible all of the symbols in it
2412 (consider
2413 .B \%#ifdef
2414 and similar).
2415 .IP
2416 For instance,
2417 .IR \%ncurses 's
2418 .I \%curses.h
2419 .B may \" bold to contrast with preceding italic
2420 include
2421 .I \%wchar.h
2422 if the proper symbol is defined,
2423 and if
2424 .I \%ncurses
2425 is configured for wide-character support.
2426 If
2427 .I \%wchar.h
2428 is included,
2429 its symbols
2430 .B may \" bold for consistency in this paragraph
2431 be made visible depending on the value of the
2432 .I \%_XOPEN_SOURCE
2433 feature test macro.
2434 .bP
2435 X/Open Curses mandates an application's inclusion of one standard C
2436 library header in a special case:
2437 .I \%stdarg.h
2438 before
2439 .I \%curses.h
2440 to prototype the functions
2441 .I \%vw_printw
2442 and
2443 .I \%vw_scanw
2444 (as well as the obsolete
2445 .I \%vwprintw
2446 and
2447 .IR \%vwscanw ).
2448 Each of these takes a variadic argument list,
2449 a
2450 .I \%va_list
2451 parameter,
2452 like that of \fI\%printf\fP(3).
2453 .IP
2454 SVr3
2455 .I curses
2456 introduced
2457 the two obsolete functions,
2458 and X/Open Curses the others.
2459 In between,
2460 SVr4
2461 .I curses
2462 provided for the possibility that an application might include either
2463 .I \%varargs.h
2464 or
2465 .IR \%stdarg.h "."
2466 These represented contrasting approaches to handling variadic
2467 argument lists.
2468 The older interface,
2469 .IR \%varargs.h ","
2470 used a pointer to
2471 .I char \" V7, 32V, System III, 3BSD
2472 for variadic functions'
2473 .I \%va_list
2474 parameter.
2475 Later,
2476 the list acquired its own standard data type,
2477 .IR \%va_list ","
2478 defined in
2479 .IR \%stdarg.h ","
2480 empowering the compiler to check the types of a function call's actual
2481 parameters against the formal ones declared in its prototype.
2482 .IP
2483 No conforming implementations of X/Open Curses require an application
2484 to include
2485 .I \%stdarg.h
2486 before
2487 .I \%curses.h
2488 because they either have allowed for a special type,
2489 or,
2490 like
2491 .IR \%ncurses ","
2492 they include
2493 .I \%stdarg.h
2494 themselves to provide a portable interface.
2495 .SH AUTHORS
2496 Zeyd M. Ben-Halim,
2497 Eric S. Raymond,
2498 Thomas E. Dickey.
2499 Based on
2500 .I \%pcurses
2501 by Pavel Curtis.
2502 .SH SEE ALSO
2503 \fB\%curses_variables\fP(3NCURSES),
2504 \fB\%terminfo\fP(5),
2505 \fB\%user_caps\fP(5)