X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=898bd9a47928b3a4952204a75ee284f9dd5b184b;hp=00b13c257c8f1e7eaac4fc2f9feb35c66bd6955b;hb=5606eb48618dde18a593793e2e5dafadf18d345b;hpb=db5f7f4f146a91ba8ec7f1df8e9d7f9d2d7c74fd diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html index 00b13c25..898bd9a4 100644 --- a/doc/html/man/curs_util.3x.html +++ b/doc/html/man/curs_util.3x.html @@ -46,15 +46,13 @@ - -
+
delay_output, filter, flushinp, getwin, key_name, keyname, nofilter, putwin, unctrl, use_env, use_tioctl, wunctrl - miscellaneous curses utility routines --
+
#include <curses.h> char *unctrl(chtype c); @@ -71,11 +69,9 @@ int flushinp(void); --
+
--
+
The unctrl routine returns a character string which is a printable representation of the character c, ignoring at- tributes. Control characters are displayed in the ^X no- @@ -84,8 +80,7 @@ of a wide character. --
+
The keyname routine returns a character string correspond- ing to the key c: @@ -118,8 +113,7 @@ ter. --
+
The filter routine, if used, must be called before initscr or newterm are called. The effect is that, during those calls, LINES is set to 1; the capabilities clear, cup, @@ -133,8 +127,7 @@ modifies the in-memory copy of the terminal information. --
+
The use_env routine, if used, should be called before initscr or newterm are called (because those compute the screen size). It modifies the way ncurses treats environ- @@ -162,8 +155,7 @@ environment variables, --
+
The use_tioctl routine, if used, should be called before initscr or newterm are called (because those compute the screen size). After use_tioctl is called with TRUE as an @@ -202,8 +194,7 @@ to determine size. --
+
The putwin routine writes all data associated with window (or pad) win into the file to which filep points. This information can be later retrieved using the getwin func- @@ -230,8 +221,7 @@ will not be colored when the window is refreshed. --
+
The delay_output routine inserts an ms millisecond pause in output. This routine should not be used extensively because padding characters are used rather than a CPU @@ -239,15 +229,13 @@ napms to perform the delay. --
+
The flushinp routine throws away any typeahead that has been typed by the user and has not yet been read by the program. --
+
Except for flushinp, routines that return an integer re- turn ERR upon failure and OK (SVr4 specifies only "an in- teger value other than ERR") upon successful completion. @@ -269,19 +257,16 @@ return an error. --
+
--
+
The SVr4 documentation describes the action of filter only in the vaguest terms. The description here is adapted from the XSI Curses standard (which erroneously fails to describe the disabling of cuu). --
+
The keyname function may return the names of user-defined string capabilities which are defined in the terminfo en- try via the -x option of tic. This implementation auto- @@ -295,8 +280,7 @@ brary. --
+
The nofilter and use_tioctl routines are specific to ncurses. They were not supported on Version 7, BSD or System V implementations. It is recommended that any code @@ -304,8 +288,7 @@ NCURSES_VERSION. --
+
The putwin and getwin functions have several issues with portability: @@ -339,8 +322,7 @@ may not be successful. --
+
The XSI Curses standard, Issue 4 describes these func- tions. It states that unctrl and wunctrl will return a null pointer if unsuccessful, but does not define any er- @@ -387,8 +369,7 @@ "M-^A", etc. --
+
legacy_coding(3x), curses(3x), curs_initscr(3x), curs_ker- nel(3x), curs_scr_dump(3x), curs_variables(3x), lega- cy_coding(3x).