X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=ad619492b2b6d0bb28c41936a492180f01e4f6f0;hb=refs%2Ftags%2Fv5.6;hp=2557f86df3cdd074a8ab6052e0adce7e146aed84;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;p=ncurses.git
diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html
index 2557f86d..ad619492 100644
--- a/doc/html/man/curs_util.3x.html
+++ b/doc/html/man/curs_util.3x.html
@@ -1,7 +1,7 @@
@@ -40,7 +40,7 @@
-curs_util(3x) curs_util(3x)
+curs_util(3x) curs_util(3x)
@@ -48,8 +48,8 @@
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
@@ -61,6 +61,7 @@
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);
@@ -71,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.
@@ -93,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
@@ -124,36 +133,70 @@
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.
+ 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
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_kernel(3x),
- curs_scr_dump(3x).
+ use_legacy_coding(3), curses(3x), curs_initscr(3x),
+ curs_kernel(3x), curs_scr_dump(3x).
- curs_util(3x)
+ curs_util(3x)