X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fncurses.3x.html;h=ff2399006f0e697bc7ad5168bca7006cadb6daa4;hp=0c562ca19d298894c86ee072a07ab289496d97aa;hb=dc690a36a0e53e2c2ecd99c971cd749f78275fdc;hpb=02f02dcd4464143580e783ae32c822d8eb8cdcbf diff --git a/doc/html/man/ncurses.3x.html b/doc/html/man/ncurses.3x.html index 0c562ca1..ff239900 100644 --- a/doc/html/man/ncurses.3x.html +++ b/doc/html/man/ncurses.3x.html @@ -1,7 +1,7 @@ @@ -46,24 +46,21 @@ - -
+
ncurses - CRT screen handling and optimization package --
+
#include <curses.h> --
+
The ncurses library routines give the user a terminal- independent method of updating character screens with rea- sonable optimization. This implementation is "new curses" (ncurses) and is the approved replacement for 4.4BSD clas- sic curses, which has been discontinued. This describes - ncurses version 6.0 (patch 20150808). + ncurses version 6.0 (patch 20170121). The ncurses library emulates the curses library of System V Release 4 UNIX, and XPG4 (X/Open Portability Guide) @@ -97,8 +94,7 @@ access to low-level terminal-manipulation routines. --
+
The library uses the locale which the calling program has initialized. That is normally done with setlocale: @@ -112,7 +108,7 @@ The function initscr or newterm must be called to initial- ize the library before any of the other routines that deal - with windows and screens are used. The routine endwin + with windows and screens are used. The routine endwin(3x) must be called before exiting. To get character-at-a-time input without echoing (most @@ -135,8 +131,7 @@ for doing this. [See terminfo(5) for further details.] --
+
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 @@ -158,12 +153,12 @@ 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 - each character. + After using routines to manipulate a window, refresh(3x) + 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. These are windows which are not constrained to the size of @@ -182,8 +177,7 @@ <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 @@ -224,8 +218,7 @@ curscr can be used in only a few routines. --
+
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- @@ -306,8 +299,7 @@ becomes wadd_wch. --
+
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 @@ -766,8 +758,7 @@ wvline_set curs_border_set(3x) --
+
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- @@ -785,8 +776,7 @@ Routines that return pointers return NULL on error. --
+
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. @@ -802,8 +792,7 @@ it does not happen to be a single character. --
+
The debugging library checks this environment variable when the application has redirected output to a file. The variable's numeric value is used for the baudrate. If no @@ -812,8 +801,7 @@ costs that depend on baudrate. --
+
Specify the width of the screen in characters. Applica- tions running in a windowing environment usually are able to obtain the width of the window in which they are exe- @@ -844,8 +832,7 @@ system calls or the terminal database. --
+
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 @@ -874,8 +861,7 @@ lems when compiling an application. --
+
Tells ncurses where your home directory is. That is where it may read and write auxiliary terminal descriptions: @@ -883,14 +869,12 @@ $HOME/.terminfo --
+
Like COLUMNS, specify the height of the screen in charac- ters. See COLUMNS for a detailed description. --
+
This applies only to the OS/2 EMX port. It specifies the order of buttons on the mouse. OS/2 numbers a 3-button mouse inconsistently from other platforms: @@ -904,8 +888,7 @@ or 321. If it is not specified, ncurses uses 132. --
+
Override the compiled-in assumption that the terminal's default colors are white-on-black (see default_col- ors(3x)). You may set the foreground and background color @@ -917,8 +900,7 @@ value is allowed. --
+
This applies only to the MinGW port of ncurses. The Console2 program's handling of the Microsoft Console @@ -930,8 +912,7 @@ same effect. --
+
This applies only to ncurses configured to use the GPM interface. @@ -945,8 +926,7 @@ attempt to open GPM if TERM contains "linux". --
+
Ncurses may use tabs as part of the cursor movement opti- mization. In some cases, your terminal driver may not handle these properly. Set this environment variable to @@ -959,8 +939,7 @@ environment variable. --
+
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 environ- @@ -987,8 +966,7 @@ part of special control sequences such as flash. --
+
This setting is obsolete. Before changes o started with 5.9 patch 20120825 and @@ -1018,8 +996,7 @@ level curses calls do not. --
+
During initialization, the ncurses library checks for spe- cial cases where VT100 line-drawing (and the corresponding alternate character set capabilities) described in the @@ -1055,8 +1032,7 @@ interface. --
+
During initialization, the ncurses debugging library checks the NCURSES_TRACE environment variable. If it is defined, to a numeric value, ncurses calls the trace func- @@ -1070,8 +1046,7 @@ See curs_trace(3x) for more information. --
+
Denotes your terminal type. Each terminal type is dis- tinct, though many are similar. @@ -1091,8 +1066,7 @@ match that setting. --
+
If the ncurses library has been configured with termcap support, ncurses will check for a terminal's description in termcap form if it is not available in the terminfo @@ -1106,8 +1080,7 @@ mation, e.g., /etc/termcap. --
+
Overrides the directory in which ncurses searches for your terminal description. This is the simplest, but not the only way to change the list of directories. The complete @@ -1135,8 +1108,7 @@ MINFO variable) --
+
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. @@ -1155,8 +1127,7 @@ of a termcap file. --
+
If TERMCAP does not hold a file name then ncurses checks the TERMPATH environment variable. This is a list of filenames separated by spaces or colons (i.e., ":") on @@ -1173,8 +1144,7 @@ $TERMINFO, $TERMINFO_DIRS, $TERMPATH, as well as $HOME. --
+
Several different configurations are possible, depending on the configure script options used when building ncurses. There are a few main options whose effects are @@ -1255,23 +1225,20 @@ ing it is always in the debug library. --
+
/usr/share/tabset directory containing initialization files for the terminal capability database /usr/share/terminfo ter- minal capability database --
+
terminfo(5) and related pages whose names begin "curs_" for detailed routine descriptions. curs_variables(3x) --
+
The ncurses library can be compiled with an option (-DUSE_GETCAP) that falls back to the old-style /etc/term- cap file if the terminal setup code cannot find a terminfo @@ -1310,8 +1277,7 @@ device. See the curs_print(3x) manual page for details. --
+
The ncurses library is intended to be BASE-level confor- mant with XSI Curses. The EXTENDED XSI Curses functional- ity (including color support) is supported. @@ -1374,8 +1340,7 @@ package's portability correspondingly. --
+
The header file <curses.h> automatically includes the header files <stdio.h> and <unctrl.h>. @@ -1385,8 +1350,7 @@ ture of AT&T System V Release 3 curses. --
+
Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Based on pcurses by Pavel Curtis.