X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fncurses.3x.html;h=0490529778fa0486c0d9d32a0fef90d2a9e39a38;hp=83995f9e1407afe0068f2bec6000c2e003870510;hb=refs%2Ftags%2Fv5.4;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01
diff --git a/doc/html/man/ncurses.3x.html b/doc/html/man/ncurses.3x.html
index 83995f9e..04905297 100644
--- a/doc/html/man/ncurses.3x.html
+++ b/doc/html/man/ncurses.3x.html
@@ -2,7 +2,7 @@
@@ -41,6 +41,10 @@
+ncurses(3x) ncurses(3x)
+
+
+
NAME
@@ -55,41 +59,40 @@
DESCRIPTION
The ncurses library routines give the user a terminal-
- independent method of updating character screens with
- reasonable optimization. This implementation is ``new
+ independent method of updating character screens with rea-
+ sonable optimization. This implementation is ``new
curses'' (ncurses) and is the approved replacement for
4.4BSD classic curses, which has been discontinued.
The ncurses routines emulate the curses(3x) library of
System V Release 4 UNIX, and the XPG4 curses standard (XSI
curses) but the ncurses library is freely redistributable
- in source form. Differences from the SVr4 curses are
- summarized under the EXTENSIONS and BUGS sections below
- and described in detail in the EXTENSIONS and BUGS
- sections of individual man pages.
+ in source form. Differences from the SVr4 curses are sum-
+ marized under the EXTENSIONS and BUGS sections below and
+ described in detail in the EXTENSIONS and BUGS sections of
+ individual man pages.
A program using these routines must be linked with the
-lncurses option, or (if it has been generated) with the
debugging library -lncurses_g. (Your system integrator
may also have installed these libraries under the names
-lcurses and -lcurses_g.) The ncurses_g library generates
- trace logs (in a file called 'trace' in the current
- directory) that describe curses actions.
+ trace logs (in a file called 'trace' in the current direc-
+ tory) that describe curses actions.
The ncurses package supports: overall screen, window and
- pad manipulation; output to windows and pads; reading
- terminal input; control over terminal and curses input and
- output options; environment query routines; color
- manipulation; use of soft label keys; terminfo
- capabilities; and access to low-level terminal-
- manipulation routines.
+ pad manipulation; output to windows and pads; reading ter-
+ minal input; control over terminal and curses input and
+ output options; environment query routines; color manipu-
+ lation; use of soft label keys; terminfo capabilities; and
+ access to low-level terminal-manipulation routines.
To initialize the routines, the routine initscr or newterm
- must be called before any of the other routines that deal
- with windows and screens are used. The routine endwin
+ must be called before any of the other routines that deal
+ with windows and screens are used. The routine endwin
must be called before exiting. To get character-at-a-time
- input without echoing (most interactive, screen oriented
- programs want this), the following sequence should be
+ input without echoing (most interactive, screen oriented
+ programs want this), the following sequence should be
used:
initscr(); cbreak(); noecho();
@@ -100,74 +103,74 @@
intrflush(stdscr, FALSE);
keypad(stdscr, TRUE);
- Before a curses program is run, the tab stops of the
- terminal should be set and its initialization strings, if
- defined, must be output. This can be done by executing
+ Before a curses program is run, the tab stops of the ter-
+ minal should be set and its initialization strings, if
+ defined, must be output. This can be done by executing
the tput init command after the shell environment variable
- TERM has been exported. tset(1) is usually responsible
+ TERM has been exported. tset(1) is usually responsible
for doing this. [See terminfo(5) for further details.]
- The ncurses library permits manipulation of data
- structures, called windows, which can be thought of as
- two-dimensional arrays of characters representing all or
- part of a CRT screen. A default window called stdscr,
- which is the size of the terminal screen, is supplied.
- Others may be created with newwin.
-
- Note that curses does not handle overlapping windows,
- that's done by the panel(3x) library. This means that you
- can either use stdscr or divide the screen into tiled
- windows and not using stdscr at all. Mixing the two will
+ The ncurses library permits manipulation of data struc-
+ tures, called windows, which can be thought of as two-
+ dimensional arrays of characters representing all or part
+ of a CRT screen. A default window called stdscr, which is
+ the size of the terminal screen, is supplied. Others may
+ be created with newwin.
+
+ Note that curses does not handle overlapping windows,
+ that's done by the panel(3x) library. This means that you
+ can either use stdscr or divide the screen into tiled win-
+ dows and not using stdscr at all. Mixing the two will
result in unpredictable, and undesired, effects.
Windows are referred to by variables declared as WINDOW *.
- These data structures are manipulated with routines
- described here and elsewhere in the ncurses manual pages.
- Among which the most basic routines are move and addch.
- More general versions of these routines are included with
- names beginning with w, allowing the user to specify a
+ These data structures are manipulated with routines
+ described here and elsewhere in the ncurses manual pages.
+ Among which the most basic routines are move and addch.
+ More general versions of these routines are included with
+ names beginning with w, allowing the user to specify a
window. The routines not beginning with w affect stdscr.)
- After using routines to manipulate a window, refresh is
- called, telling curses to make the user's CRT screen look
- like stdscr. The characters in a window are actually of
- type chtype, (character and attribute data) so that other
- information about the character may also be stored with
+ After using routines to manipulate a window, refresh is
+ called, telling curses to make the user's CRT screen look
+ like stdscr. The characters in a window are actually of
+ type chtype, (character and attribute data) so that other
+ information about the character may also be stored with
each character.
- Special windows called pads may also be manipulated.
+ Special windows called pads may also be manipulated.
These are windows which are not constrained to the size of
- the screen and whose contents need not be completely
- displayed. See curs_pad(3x) for more information.
-
- In addition to drawing characters on the screen, video
- attributes and colors may be supported, causing the
- characters to show up in such modes as underlined, in
- reverse video, or in color on terminals that support such
- display enhancements. Line drawing characters may be
- specified to be output. On input, curses is also able to
- translate arrow and function keys that transmit escape
- sequences into single values. The video attributes, line
- drawing characters, and input values use names, defined in
+ the screen and whose contents need not be completely dis-
+ played. See curs_pad(3x) for more information.
+
+ In addition to drawing characters on the screen, video
+ attributes and colors may be supported, causing the char-
+ acters to show up in such modes as underlined, in reverse
+ video, or in color on terminals that support such display
+ enhancements. Line drawing characters may be specified to
+ be output. On input, curses is also able to translate
+ arrow and function keys that transmit escape sequences
+ into single values. The video attributes, line drawing
+ characters, and input values use names, defined in
<curses.h>, such as A_REVERSE, ACS_HLINE, and KEY_LEFT.
If the environment variables LINES and COLUMNS are set, or
- if the program is executing in a window environment, line
- and column information in the environment will override
+ if the program is executing in a window environment, line
+ and column information in the environment will override
information read by terminfo. This would effect a program
- running in an AT&T 630 layer, for example, where the size
+ running in an AT&T 630 layer, for example, where the size
of a screen is changeable (see ENVIRONMENT).
- If the environment variable TERMINFO is defined, any
- program using curses checks for a local terminal
- definition before checking in the standard place. For
- example, if TERM is set to att4424, then the compiled
- terminal definition is found in
+ If the environment variable TERMINFO is defined, any pro-
+ gram using curses checks for a local terminal definition
+ before checking in the standard place. For example, if
+ TERM is set to att4424, then the compiled terminal defini-
+ tion is found in
/usr/share/terminfo/a/att4424.
(The a is copied from the first letter of att4424 to avoid
- creation of huge directories.) However, if TERMINFO is
+ creation of huge directories.) However, if TERMINFO is
set to $HOME/myterms, curses first checks
$HOME/myterms/a/att4424,
@@ -176,54 +179,52 @@
/usr/share/terminfo/a/att4424.
- This is useful for developing experimental definitions or
- when write permission in /usr/share/terminfo is not
- available.
+ This is useful for developing experimental definitions or
+ when write permission in /usr/share/terminfo is not avail-
+ able.
- The integer variables LINES and COLS are defined in
- <curses.h> and will be filled in by initscr with the size
- of the screen. The constants TRUE and FALSE have the
- values 1 and 0, respectively.
+ The integer variables LINES and COLS are defined in
+ <curses.h> and will be filled in by initscr with the size
+ of the screen. The constants TRUE and FALSE have the val-
+ ues 1 and 0, respectively.
- The curses routines also define the WINDOW * variable
+ The curses routines also define the WINDOW * variable
curscr which is used for certain low-level operations like
- clearing and redrawing a screen containing garbage. The
+ clearing and redrawing a screen containing garbage. The
curscr can be used in only a few routines.
-
Routine and Argument Names
- Many curses routines have two or more versions. The
- routines prefixed with w require a window argument. The
- routines prefixed with p require a pad argument. Those
- without a prefix generally use stdscr.
+ Many curses routines have two or more versions. The rou-
+ tines prefixed with w require a window argument. The rou-
+ tines prefixed with p require a pad argument. Those with-
+ out a prefix generally use stdscr.
The routines prefixed with mv require a y and x coordinate
- to move to before performing the appropriate action. The
- mv routines imply a call to move before the call to the
- other routine. The coordinate y always refers to the row
- (of the window), and x always refers to the column. The
+ to move to before performing the appropriate action. The
+ mv routines imply a call to move before the call to the
+ other routine. The coordinate y always refers to the row
+ (of the window), and x always refers to the column. The
upper left-hand corner is always (0,0), not (1,1).
The routines prefixed with mvw take both a window argument
- and x and y coordinates. The window argument is always
+ and x and y coordinates. The window argument is always
specified before the coordinates.
- In each case, win is the window affected, and pad is the
- pad affected; win and pad are always pointers to type
- WINDOW.
+ In each case, win is the window affected, and pad is the
+ pad affected; win and pad are always pointers to type WIN-
+ DOW.
Option setting routines require a Boolean flag bf with the
- value TRUE or FALSE; bf is always of type bool. The
- variables ch and attrs below are always of type chtype.
- The types WINDOW, SCREEN, bool, and chtype are defined in
- <curses.h>. The type TERMINAL is defined in <term.h>.
+ value TRUE or FALSE; bf is always of type bool. The vari-
+ ables ch and attrs below are always of type chtype. The
+ types WINDOW, SCREEN, bool, and chtype are defined in
+ <curses.h>. The type TERMINAL is defined in <term.h>.
All other arguments are integers.
-
Routine Name Index
The following table lists each curses routine and the name
- of the manual page on which it is described. Routines
- flagged with `*' are ncurses-specific, not described by
+ of the manual page on which it is described. Routines
+ flagged with `*' are ncurses-specific, not described by
XPG4 or present in SVr4.
curses Routine Name Manual Page Name
@@ -243,6 +244,7 @@
add_wchnstr curs_add_wchstr(3x)
add_wchstr curs_add_wchstr(3x)
addch curs_addch(3x)
+
addchnstr curs_addchstr(3x)
addchstr curs_addchstr(3x)
addnstr curs_addstr(3x)
@@ -262,7 +264,6 @@
bkgd curs_bkgd(3x)
bkgdset curs_bkgd(3x)
bkgrnd curs_bkgrnd(3x)
-
bkgrndset curs_bkgrnd(3x)
border curs_border(3x)
border_set curs_border_set(3x)
@@ -309,6 +310,7 @@
getbkgrnd curs_bkgrnd(3x)
getcchar curs_getcchar(3x)
getch curs_getch(3x)
+
getmaxyx curs_getyx(3x)
getmouse curs_mouse(3x)*
getn_wstr curs_get_wstr(3x)
@@ -316,7 +318,6 @@
getparyx curs_getyx(3x)
getstr curs_getstr(3x)
getsyx curs_kernel(3x)
-
getwin curs_util(3x)
getyx curs_getyx(3x)
halfdelay curs_inopts(3x)
@@ -354,6 +355,7 @@
is_linetouched curs_touch(3x)
is_wintouched curs_touch(3x)
isendwin curs_initscr(3x)
+ key_defined key_defined(3x)*
key_name curs_util(3x)
keybound keybound(3x)*
keyname curs_util(3x)
@@ -370,11 +372,11 @@
mousemask curs_mouse(3x)*
move curs_move(3x)
mvadd_wch curs_add_wch(3x)
-
mvadd_wchnstr curs_add_wchstr(3x)
mvadd_wchstr curs_add_wchstr(3x)
mvaddch curs_addch(3x)
mvaddchnstr curs_addchstr(3x)
+
mvaddchstr curs_addchstr(3x)
mvaddnstr curs_addstr(3x)
mvaddnwstr curs_addwstr(3x)
@@ -424,7 +426,6 @@
mvwaddwstr curs_addwstr(3x)
mvwchgat curs_attr(3x)
mvwdelch curs_delch(3x)
-
mvwget_wch curs_get_wch(3x)
mvwget_wstr curs_get_wstr(3x)
mvwgetch curs_getch(3x)
@@ -441,6 +442,7 @@
mvwinchnstr curs_inchstr(3x)
mvwinchstr curs_inchstr(3x)
mvwinnstr curs_instr(3x)
+
mvwinnwstr curs_inwstr(3x)
mvwins_nwstr curs_ins_wstr(3x)
mvwins_wch curs_ins_wch(3x)
@@ -478,7 +480,6 @@
qiflush curs_inopts(3x)
raw curs_inopts(3x)
redrawwin curs_refresh(3x)
-
refresh curs_refresh(3x)
reset_prog_mode curs_kernel(3x)
reset_shell_mode curs_kernel(3x)
@@ -507,6 +508,7 @@
slk_attr_on curs_slk(3x)
slk_attr_set curs_slk(3x)
slk_attroff curs_slk(3x)
+
slk_attron curs_slk(3x)
slk_attrset curs_slk(3x)
slk_clear curs_slk(3x)
@@ -532,7 +534,6 @@
tgetnum curs_termcap(3x)
tgetstr curs_termcap(3x)
tgoto curs_termcap(3x)
-
tigetflag curs_terminfo(3x)
tigetnum curs_terminfo(3x)
tigetstr curs_terminfo(3x)
@@ -573,6 +574,7 @@
waddstr curs_addstr(3x)
waddwstr curs_addwstr(3x)
wattr_get curs_attr(3x)
+
wattr_off curs_attr(3x)
wattr_on curs_attr(3x)
wattr_set curs_attr(3x)
@@ -586,7 +588,6 @@
wborder curs_border(3x)
wborder_set curs_border_set(3x)
wchgat curs_attr(3x)
-
wclear curs_clear(3x)
wclrtobot curs_clear(3x)
wclrtoeol curs_clear(3x)
@@ -639,8 +640,8 @@
wstandout curs_attr(3x)
wsyncdown curs_window(3x)
wsyncup curs_window(3x)
- wtimeout curs_inopts(3x)
+ wtimeout curs_inopts(3x)
wtouchln curs_touch(3x)
wunctrl curs_util(3x)
wvline curs_border(3x)
@@ -649,15 +650,15 @@
RETURN VALUE
- Routines that return an integer return ERR upon failure
- and an integer value other than ERR upon successful
- completion, unless otherwise noted in the routine
- descriptions.
-
- All macros return the value of the w version, except
- setscrreg, wsetscrreg, getyx, getbegyx, getmaxyx. The
- return values of setscrreg, wsetscrreg, getyx, getbegyx,
- and getmaxyx are undefined (i.e., these should not be used
+ Routines that return an integer return ERR upon failure
+ and an integer value other than ERR upon successful com-
+ pletion, unless otherwise noted in the routine descrip-
+ tions.
+
+ All macros return the value of the w version, except
+ setscrreg, wsetscrreg, getyx, getbegyx, and getmaxyx. The
+ return values of setscrreg, wsetscrreg, getyx, getbegyx,
+ and getmaxyx are undefined (i.e., these should not be used
as the right-hand side of assignment statements).
Routines that return pointers return NULL on error.
@@ -665,28 +666,27 @@
ENVIRONMENT
- The following environment symbols are useful for
- customizing the runtime behavior of the ncurses library.
- The most important ones have been already discussed in
- detail.
+ The following environment symbols are useful for customiz-
+ ing the runtime behavior of the ncurses library. The most
+ important ones have been already discussed in detail.
BAUDRATE
The debugging library checks this environment symbol
when the application has redirected output to a file.
The symbol's numeric value is used for the baudrate.
- If no value is found ncurses uses 9600. This allows
+ If no value is found, ncurses uses 9600. This allows
testers to construct repeatable test-cases that take
into account costs that depend on baudrate.
CC When set, change occurrences of the command_character
(i.e., the cmdch capability) of the loaded terminfo
- entries to the value of this symbol. Very few
- terminfo entries provide this feature.
+ entries to the value of this symbol. Very few ter-
+ minfo entries provide this feature.
COLUMNS
Specify the width of the screen in characters.
- Applications running in a windowing environment
- usually are able to obtain the width of the window in
+ Applications running in a windowing environment usu-
+ ally are able to obtain the width of the window in
which they are executing. If neither the $COLUMNS
value nor the terminal's screen size is available,
ncurses uses the size which may be specified in the
@@ -713,8 +713,8 @@
Specifies the total time, in milliseconds, for which
ncurses will await a character sequence, e.g., a
function key. The default value, 1000 milliseconds,
- is enough for most uses. However, it is made a
- variable to accommodate unusual applications.
+ is enough for most uses. However, it is made a vari-
+ able to accommodate unusual applications.
The most common instance where you may wish to change
this value is to work with slow hosts, e.g., running
@@ -723,8 +723,8 @@
the terminal did not send characters rapidly enough.
The library will still see a timeout.
- Note that xterm mouse events are built up from
- character sequences received from the xterm. If your
+ Note that xterm mouse events are built up from char-
+ acter sequences received from the xterm. If your
application makes heavy use of multiple-clicking, you
may wish to lengthen this default value because the
timeout applies to the composed multi-click event as
@@ -756,34 +756,34 @@
132.
NCURSES_ASSUMED_COLORS
- Override the compiled-in assumption that the
- terminal's default colors are white-on-black (see
- assume_default_colors(3x)). You may set the
- foreground and background color values with this
- environment variable by proving a 2-element list:
- foreground,background. For example, to tell ncurses
- to not assume anything about the colors, set this to
+ Override the compiled-in assumption that the termi-
+ nal's default colors are white-on-black (see
+ assume_default_colors(3x)). You may set the fore-
+ ground and background color values with this environ-
+ ment variable by proving a 2-element list: fore-
+ ground,background. For example, to tell ncurses to
+ not assume anything about the colors, set this to
"-1,-1". To make it green-on-black, set it to "2,0".
- Any positive value from zero to the terminfo
- max_colors value is allowed.
+ Any positive value from zero to the terminfo max_col-
+ ors value is allowed.
NCURSES_NO_PADDING
Most of the terminal descriptions in the terminfo
database are written for real "hardware" terminals.
Many people use terminal emulators which run in a
- windowing environment and use curses-based
- applications. Terminal emulators can duplicate all
- of the important aspects of a hardware terminal, but
- they do not have the same limitations. The chief
- limitation of a hardware terminal from the standpoint
- of your application is the management of dataflow,
- i.e., timing. Unless a hardware terminal is
- interfaced into a terminal concentrator (which does
- flow control), it (or your application) must manage
- dataflow, preventing overruns. The cheapest solution
- (no hardware cost) is for your program to do this by
- pausing after operations that the terminal does
- slowly, such as clearing the display.
+ windowing environment and use curses-based applica-
+ tions. Terminal emulators can duplicate all of the
+ important aspects of a hardware terminal, but they do
+ not have the same limitations. The chief limitation
+ of a hardware terminal from the standpoint of your
+ application is the management of dataflow, i.e.,
+ timing. Unless a hardware terminal is interfaced
+ into a terminal concentrator (which does flow con-
+ trol), it (or your application) must manage dataflow,
+ preventing overruns. The cheapest solution (no hard-
+ ware cost) is for your program to do this by pausing
+ after operations that the terminal does slowly, such
+ as clearing the display.
As a result, many terminal descriptions (including
the vt100) have delay times embedded. You may wish
@@ -795,11 +795,11 @@
part of special control sequences such as flash.
NCURSES_NO_SETBUF
- Normally ncurses enables buffered output during
- terminal initialization. This is done (as in SVr4
- curses) for performance reasons. For testing
- purposes, both of ncurses and certain applications,
- this feature is made optional. Setting the
+ Normally ncurses enables buffered output during ter-
+ minal initialization. This is done (as in SVr4
+ curses) for performance reasons. For testing pur-
+ poses, both of ncurses and certain applications, this
+ feature is made optional. Setting the
NCURSES_NO_SETBUF variable disables output buffering,
leaving the output in the original (usually line
buffered) mode.
@@ -819,8 +819,8 @@
distinct, though many are similar.
TERMCAP
- If the ncurses library has been configured with
- termcap support, ncurses will check for a terminal's
+ If the ncurses library has been configured with term-
+ cap support, ncurses will check for a terminal's
description in termcap form if it is not available in
the terminfo database.
@@ -838,7 +838,7 @@
The complete list of directories in order follows:
- the last directory to which ncurses wrote, if any,
- is searched first.
+ is searched first
- the directory specified by the TERMINFO symbol
@@ -851,21 +851,21 @@
/usr/share/terminfo
TERMINFO_DIRS
- Specifies a list of directories to search for
- terminal descriptions. The list is separated by
- colons (i.e., ":") on Unix, semicolons on OS/2 EMX.
- All of the terminal descriptions are in terminfo
- form, which makes a subdirectory named for the first
- letter of the terminal names therein.
+ Specifies a list of directories to search for termi-
+ nal descriptions. The list is separated by colons
+ (i.e., ":") on Unix, semicolons on OS/2 EMX. All of
+ the terminal descriptions are in terminfo form, which
+ makes a subdirectory named for the first letter of
+ the terminal names therein.
TERMPATH
If TERMCAP does not hold a file name then ncurses
- checks the TERMPATH symbol. This is a list of
- filenames separated by spaces or colons (i.e., ":")
- on Unix, semicolons on OS/2 EMX. If the TERMPATH
- symbol is not set, ncurses looks in the files
- /etc/termcap, /usr/share/misc/termcap and
- $HOME/.termcap, in that order.
+ checks the TERMPATH symbol. This is a list of file-
+ names separated by spaces or colons (i.e., ":") on
+ Unix, semicolons on OS/2 EMX. If the TERMPATH symbol
+ is not set, ncurses looks in the files /etc/termcap,
+ /usr/share/misc/termcap and $HOME/.termcap, in that
+ order.
The library may be configured to disregard the following
variables when the current user is the superuser (root),
@@ -877,8 +877,8 @@
FILES
/usr/share/tabset
directory containing initialization files for the
- terminal capability database /usr/share/terminfo
- terminal capability database
+ terminal capability database /usr/share/terminfo ter-
+ minal capability database
@@ -890,12 +890,12 @@
EXTENSIONS
The ncurses library can be compiled with an option
- (-DUSE_GETCAP) that falls back to the old-style
- /etc/termcap file if the terminal setup code cannot find a
- terminfo entry corresponding to TERM. Use of this feature
- is not recommended, as it essentially includes an entire
- termcap compiler in the ncurses startup code, at
- significant cost in core and startup cycles.
+ (-DUSE_GETCAP) that falls back to the old-style /etc/term-
+ cap file if the terminal setup code cannot find a terminfo
+ entry corresponding to TERM. Use of this feature is not
+ recommended, as it essentially includes an entire termcap
+ compiler in the ncurses startup code, at significant cost
+ in core and startup cycles.
The ncurses library includes facilities for capturing
mouse events on certain terminals (including xterm). See
@@ -910,132 +910,82 @@
The ncurses library extends the fixed set of function key
capabilities of terminals by allowing the application
designer to define additional key sequences at runtime.
- See the define_key(3x) and keyok(3x) manual pages for
- details.
+ See the define_key(3x) key_defined(3x), and keyok(3x) man-
+ ual pages for details.
- The ncurses library can exploit the capabilities of
- terminals which implement the ISO-6429 SGR 39 and SGR 49
+ The ncurses library can exploit the capabilities of termi-
+ nals which implement the ISO-6429 SGR 39 and SGR 49
controls, which allow an application to reset the terminal
to its original foreground and background colors. From
the users' perspective, the application is able to draw
- colored text on a background whose color is set
- independently, providing better control over color
- contrasts. See the default_colors(3x) manual page for
- details.
+ colored text on a background whose color is set indepen-
+ dently, providing better control over color contrasts.
+ See the default_colors(3x) manual page for details.
- The ncurses library includes a function for directing
- application output to a printer attached to the terminal
+ The ncurses library includes a function for directing
+ application output to a printer attached to the terminal
device. See the curs_print(3x) manual page for details.
PORTABILITY
- The ncurses library is intended to be BASE-level
- conformant with the XSI Curses standard. Certain portions
- of the EXTENDED XSI Curses functionality (including color
- support) are supported. The following EXTENDED XSI Curses
- calls in support of wide (multibyte) characters are not
- yet implemented: pecho_wchar, slk_wset.
-
- A small number of local differences (that is, individual
- differences between the XSI Curses and ncurses calls) are
- described in PORTABILITY sections of the library man
+ The ncurses library is intended to be BASE-level confor-
+ mant with the XSI Curses standard. The EXTENDED XSI
+ Curses functionality (including color support) is sup-
+ ported.
+
+ A small number of local differences (that is, individual
+ differences between the XSI Curses and ncurses calls) are
+ described in PORTABILITY sections of the library man
pages.
The routine has_key is not part of XPG4, nor is it present
- in SVr4. See the curs_getch(3x) manual page for details.
+ in SVr4. See the curs_getch(3x) manual page for details.
- The routine slk_attr is not part of XPG4, nor is it
- present in SVr4. See the curs_slk(3x) manual page for
+ The routine slk_attr is not part of XPG4, nor is it pre-
+ sent in SVr4. See the curs_slk(3x) manual page for
details.
- The routines getmouse, mousemask, ungetmouse,
- mouseinterval, and wenclose relating to mouse interfacing
- are not part of XPG4, nor are they present in SVr4. See
- the curs_mouse(3x) manual page for details.
+ The routines getmouse, mousemask, ungetmouse, mouseinter-
+ val, and wenclose relating to mouse interfacing are not
+ part of XPG4, nor are they present in SVr4. See the
+ curs_mouse(3x) manual page for details.
The routine mcprint was not present in any previous curses
- implementation. See the curs_print(3x) manual page for
+ implementation. See the curs_print(3x) manual page for
details.
The routine wresize is not part of XPG4, nor is it present
in SVr4. See the wresize(3x) manual page for details.
- In historic curses versions, delays embedded in the
- capabilities cr, ind, cub1, ff and tab activated
- corresponding delay bits in the UNIX tty driver. In this
- implementation, all padding is done by NUL sends. This
- method is slightly more expensive, but narrows the
- interface to the UNIX kernel significantly and increases
- the package's portability correspondingly.
+ In historic curses versions, delays embedded in the capa-
+ bilities cr, ind, cub1, ff and tab activated corresponding
+ delay bits in the UNIX tty driver. In this implementa-
+ tion, all padding is done by NUL sends. This method is
+ slightly more expensive, but narrows the interface to the
+ UNIX kernel significantly and increases the package's
+ portability correspondingly.
NOTES
- The header file <curses.h> automatically includes the
+ The header file <curses.h> automatically includes the
header files <stdio.h> and <unctrl.h>.
- If standard output from a ncurses program is re-directed
- to something which is not a tty, screen updates will be
- directed to standard error. This was an undocumented
- feature of AT&T System V Release 3 curses.
+ If standard output from a ncurses program is re-directed
+ to something which is not a tty, screen updates will be
+ directed to standard error. This was an undocumented fea-
+ ture of AT&T System V Release 3 curses.
AUTHORS
- Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey.
+ Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey.
Based on pcurses by Pavel Curtis.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ ncurses(3x)