X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fncurses.3x.html;h=8b1dee843247a8907e220114fabf8401d17d93d8;hb=f6718d80c998008de6cfe8e6296bee3958ff86d7;hp=a825da78b50cb364a6413361a9bdc4b6e855cd4e;hpb=ca276baf720e3a44721b9e18955d3f546955c6c8;p=ncurses.git
diff --git a/doc/html/man/ncurses.3x.html b/doc/html/man/ncurses.3x.html
index a825da78..8b1dee84 100644
--- a/doc/html/man/ncurses.3x.html
+++ b/doc/html/man/ncurses.3x.html
@@ -2,7 +2,7 @@
@@ -63,7 +63,7 @@
sonable optimization. This implementation is ``new
curses'' (ncurses) and is the approved replacement for
4.4BSD classic curses, which has been discontinued. This
- describes ncurses version 5.6 (patch 20080621).
+ describes ncurses version 5.6 (patch 20081011).
The ncurses library emulates the curses(3x) library of
System V Release 4 UNIX, and XPG4 (X/Open Portability
@@ -96,13 +96,25 @@
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 exiting. To get character-at-a-time
- input without echoing (most interactive, screen oriented
- programs want this), the following sequence should be
- used:
+ The library uses the locale which the calling program has
+ initialized. That is normally done with setlocale:
+
+ setlocale(LC_ALL, "");
+
+ If the locale is not initialized, the library assumes that
+ characters are printable as in ISO-8859-1, to work with
+ certain legacy programs. You should initialize the locale
+ and not rely on specific details of the library when the
+ locale has not been setup.
+
+ 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
+ must be called before exiting.
+
+ To get character-at-a-time input without echoing (most
+ interactive, screen oriented programs want this), the fol-
+ lowing sequence should be used:
initscr(); cbreak(); noecho();
@@ -112,8 +124,8 @@
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
+ 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
@@ -298,6 +310,7 @@
COLOR_PAIR curs_color(3x)
PAIR_NUMBER curs_attr(3x)
_nc_tracebits curs_trace(3x)*
+
_traceattr curs_trace(3x)*
_traceattr2 curs_trace(3x)*
_tracechar curs_trace(3x)*
@@ -310,7 +323,6 @@
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)
@@ -364,6 +376,7 @@
echochar curs_addch(3x)
endwin curs_initscr(3x)
erase curs_clear(3x)
+
erasechar curs_termattrs(3x)
erasewchar curs_termattrs(3x)
filter curs_util(3x)
@@ -376,7 +389,6 @@
getbegy curs_legacy(3x)*
getbegyx curs_getyx(3x)
getbkgd curs_bkgd(3x)
-
getbkgrnd curs_bkgrnd(3x)
getcchar curs_getcchar(3x)
getch curs_getch(3x)
@@ -430,6 +442,7 @@
is_cleared curs_opaque(3x)*
is_idcok curs_opaque(3x)*
is_idlok curs_opaque(3x)*
+
is_immedok curs_opaque(3x)*
is_keypad curs_opaque(3x)*
is_leaveok curs_opaque(3x)*
@@ -442,7 +455,6 @@
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)
@@ -496,6 +508,7 @@
mvinsstr curs_insstr(3x)
mvinstr curs_instr(3x)
mvinwstr curs_inwstr(3x)
+
mvprintw curs_printw(3x)
mvscanw curs_scanw(3x)
mvvline curs_border(3x)
@@ -508,7 +521,6 @@
mvwaddchstr curs_addchstr(3x)
mvwaddnstr curs_addstr(3x)
mvwaddnwstr curs_addwstr(3x)
-
mvwaddstr curs_addstr(3x)
mvwaddwstr curs_addwstr(3x)
mvwchgat curs_attr(3x)
@@ -562,6 +574,7 @@
pnoutrefresh curs_pad(3x)
prefresh curs_pad(3x)
printw curs_printw(3x)
+
putp curs_terminfo(3x)
putwin curs_util(3x)
qiflush curs_inopts(3x)
@@ -574,7 +587,6 @@
resizeterm resizeterm(3x)*
restartterm curs_terminfo(3x)
ripoffline curs_kernel(3x)
-
savetty curs_kernel(3x)
scanw curs_scanw(3x)
scr_dump curs_scr_dump(3x)
@@ -628,6 +640,7 @@
touchline curs_touch(3x)
touchwin curs_touch(3x)
tparm curs_terminfo(3x)
+
tputs curs_termcap(3x)
tputs curs_terminfo(3x)
trace curs_trace(3x)*
@@ -640,7 +653,6 @@
use_default_colors default_colors(3x)*
use_env curs_util(3x)
use_extended_names curs_extend(3x)*
-
use_legacy_coding legacy_coding(3x)*
vid_attr curs_terminfo(3x)
vid_puts curs_terminfo(3x)
@@ -694,6 +706,7 @@
wgetn_wstr curs_get_wstr(3x)
wgetnstr curs_getstr(3x)
wgetstr curs_getstr(3x)
+
whline curs_border(3x)
whline_set curs_border_set(3x)
win_wch curs_in_wch(3x)
@@ -706,7 +719,6 @@
winnwstr curs_inwstr(3x)
wins_nwstr curs_ins_wstr(3x)
wins_wch curs_ins_wch(3x)
-
wins_wstr curs_ins_wstr(3x)
winsch curs_insch(3x)
winsdelln curs_deleteln(3x)
@@ -867,6 +879,19 @@
tive value from zero to the terminfo max_colors value
is allowed.
+ NCURSES_GPM_TERMS
+ This applies only to ncurses configured to use the
+ GPM interface.
+
+ If present, the environment variable is a list of one
+ or more terminal names against which the TERM envi-
+ ronment variable is matched. Setting it to an empty
+ value disables the GPM interface; using the built-in
+ support for xterm, etc.
+
+ If the environment variable is absent, ncurses will
+ attempt to open GPM if TERM contains "linux".
+
NCURSES_NO_HARD_TABS
Ncurses may use tabs as part of the cursor movement
optimization. In some cases, your terminal driver
@@ -885,19 +910,19 @@
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 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., tim-
- ing. Unless a hardware terminal is interfaced into a
- terminal concentrator (which does flow control), it
- (or your application) must manage dataflow, prevent-
- ing 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
+ 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 inter-
+ faced 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.
As a result, many terminal descriptions (including
the vt100) have delay times embedded. You may wish
@@ -1048,9 +1073,9 @@
extended (wide-character) functions. The curses.h
file which is installed for the wide-character
library is designed to be compatible with the normal
- library's header. Only the size of the WINDOW
- structure differs, and very few applications require
- more than a pointer to WINDOWs. If the headers are
+ library's header. Only the size of the WINDOW struc-
+ ture differs, and very few applications require more
+ than a pointer to WINDOWs. If the headers are
installed allowing overwrite, the wide-character
library's headers should be installed last, to allow
applications to be built using either library from
@@ -1122,78 +1147,77 @@
trols, 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 col-
- ored text on a background whose color is set
- independently, providing better control over color con-
- trasts. See the default_colors(3x) manual page for
- details.
+ ored 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 confor-
+ 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.
- 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
+ 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.
This implementation also contains several extensions:
- The routine has_key is not part of XPG4, nor is it
- present in SVr4. See the curs_getch(3x) manual page
+ The routine has_key is not part of XPG4, nor is it
+ present 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
+ The routine slk_attr is not part of XPG4, nor is it
+ present in SVr4. See the curs_slk(3x) manual page
for details.
- The routines getmouse, mousemask, ungetmouse, mou-
- seinterval, and wenclose relating to mouse interfac-
- ing are not part of XPG4, nor are they present in
- SVr4. See the curs_mouse(3x) manual page for
+ The routines getmouse, mousemask, ungetmouse, mou-
+ seinterval, and wenclose relating to mouse interfac-
+ ing 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
+ The routine mcprint was not present in any previous
curses implementation. See the curs_print(3x) manual
page for details.
- The routine wresize is not part of XPG4, nor is it
+ The routine wresize is not part of XPG4, nor is it
present in SVr4. See the wresize(3x) manual page for
details.
The WINDOW structure's internal details can be hidden
- from application programs. See curs_opaque(3x) for
+ from application programs. See curs_opaque(3x) for
the discussion of is_scrollok, etc.
- In historic curses versions, delays embedded in the capa-
+ 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 sending NUL bytes. This
- method is slightly more expensive, but narrows the inter-
- face to the UNIX kernel significantly and increases the
+ delay bits in the UNIX tty driver. In this implementa-
+ tion, all padding is done by sending NUL bytes. This
+ method is slightly more expensive, but narrows the inter-
+ face 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
+ 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.