X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=cc49925196cef0b89017ec0788bdf4d9ebe37f57;hb=82a087c4c47679fcfa59bb6d7bdbe587355ba3f6;hp=0fed7678fc28f6d363f73c3d0c3149d79dd20ae3;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01;p=ncurses.git
diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html
index 0fed7678..cc499251 100644
--- a/doc/html/man/curs_util.3x.html
+++ b/doc/html/man/curs_util.3x.html
@@ -1,7 +1,7 @@
@@ -40,12 +40,16 @@
+curs_util(3x) curs_util(3x)
+
+
+
NAME
delay_output, filter, flushinp, getwin, key_name, keyname,
- putwin, unctrl, use_env, wunctrl - miscellaneous curses
- utility routines
+ nofilter, putwin, unctrl, use_env, wunctrl - miscellaneous
+ curses utility routines
@@ -53,10 +57,11 @@
#include <curses.h>
char *unctrl(chtype c);
- char *wunctrl(wchar_t w);
+ wchar_t *wunctrl(cchar_t *c);
char *keyname(int c);
char *key_name(wchar_t w);
void filter(void);
+ void nofilter(void);
void use_env(bool f);
int putwin(WINDOW *win, FILE *filep);
WINDOW *getwin(FILE *filep);
@@ -67,9 +72,9 @@
DESCRIPTION
The unctrl routine returns a character string which is a
- printable representation of the character c, ignoring
- attributes. Control characters are displayed in the ^X
- notation. Printing characters are displayed as is. The
+ printable representation of the character c, ignoring at-
+ tributes. Control characters are displayed in the ^X no-
+ tation. Printing characters are displayed as is. The
corresponding wunctrl returns a printable representation
of a wide-character.
@@ -89,14 +94,22 @@
cud, cud1, cuu1, cuu, vpa are disabled; and the home
string is set to the value of cr.
+ The nofilter routine cancels the effect of a preceding
+ filter call. That allows the caller to initialize a
+ screen on a different device, using a different value of
+ $TERM. The limitation arises because the filter routine
+ modifies the in-memory copy of the terminal information.
+
The use_env routine, if used, is called before initscr or
newterm are called. When called with FALSE as an argu-
ment, the values of lines and columns specified in the
terminfo database will be used, even if environment vari-
ables LINES and COLUMNS (used by default) are set, or if
- curses is running in a window (in which case default
- behavior would be to use the window size if LINES and
- COLUMNS are not set).
+ curses is running in a window (in which case default be-
+ havior would be to use the window size if LINES and
+ COLUMNS are not set). Note that setting LINES or COLUMNS
+ overrides the corresponding size which may be obtained
+ from the operating system.
The putwin routine writes all data associated with window
win into the file to which filep points. This information
@@ -110,56 +123,80 @@
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
- pause.
+ pause. If no padding character is specified, this uses
+ 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
+ The flushinp routine throws away any typeahead that has
+ been typed by the user and has not yet been read by the
program.
RETURN VALUE
- Except for flushinp, routines that return an integer
- return ERR upon failure and OK (SVr4 specifies only "an
- integer value other than ERR") upon successful completion.
-
- flushinp always returns OK.
+ 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.
Routines that return pointers return NULL on error.
+ X/Open does not define any error conditions. In this im-
+ plementation
+
+ flushinp
+ returns an error if the terminal was not ini-
+ tialized.
+
+ putwin
+ returns an error if the associated fwrite
+ calls return an error.
+
PORTABILITY
- 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
- error conditions.
+ 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-
+ ror conditions.
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
+ in the vaguest terms. The description here is adapted
+ from the XSI Curses standard (which erroneously fails to
describe the disabling of cuu).
+ The strings returned by unctrl in this implementation are
+ determined at compile time, showing C1 controls from the
+ upper-128 codes with a `~' prefix rather than `^'. Other
+ implementations have different conventions. For example,
+ they may show both sets of control characters with `^',
+ and strip the parameter to 7 bits. Or they may ignore C1
+ controls and treat all of the upper-1280 codes as print-
+ able. This implementation uses 8 bits but does not modify
+ the string to reflect locale. The use_legacy_coding func-
+ tion allows the caller to change the output of unctrl.
+
+ 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-
+ matically assigns at run-time keycodes to user-defined
+ strings which begin with "k". The keycodes start at
+ KEY_MAX, but are not guaranteed to be the same value for
+ different runs because user-defined codes are merged from
+ all terminal descriptions which have been loaded.
+
+ The nofilter routine is specific to ncurses. It was not
+ supported on Version 7, BSD or System V implementations.
+ It is recommended that any code depending on ncurses ex-
+ tensions be conditioned using NCURSES_VERSION.
+
SEE ALSO
- curses(3x), curs_initscr(3x), curs_scr_dump(3x).
-
-
-
-
-
-
-
-
-
-
-
-
-
+ legacy_coding(3x), curses(3x), curs_initscr(3x), curs_ker-
+ nel(3x), curs_scr_dump(3x).
+ curs_util(3x)