X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=c13c11245af908b81e6f742d4724420b591363d1;hp=84a03a20dd2adea4b2deab262a357fccd06ee999;hb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;hpb=e2d7d0028f4298dca2b0edaf2dc8ce30518d9218 diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html index 84a03a20..c13c1124 100644 --- a/doc/html/man/curs_util.3x.html +++ b/doc/html/man/curs_util.3x.html @@ -1,8 +1,7 @@ - +
+ +- curs_util(3x) curs_util(3x)-
+NAME
delay_output, filter, flushinp, getwin, key_name, keyname, nofilter, putwin, unctrl, use_env, use_tioctl, wunctrl - miscellaneous curses utility routines-SYNOPSIS
+SYNOPSIS
#include <curses.h> char *unctrl(chtype c); @@ -72,7 +73,7 @@-DESCRIPTION
+DESCRIPTION
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- @@ -206,7 +207,7 @@-RETURN VALUE
+RETURN VALUE
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. @@ -229,7 +230,7 @@-PORTABILITY
+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 er- @@ -243,77 +244,81 @@ control code. If use_legacy_coding has been called with a 2 parameter, unctrl returns the parameter, i.e., a one-character string with the parameter as - the first character. Otherwise, it returns ``~@'', - ``~A'', etc., analogous to ``^@'', ``^A'', C0 con- - trols. + the first character. Otherwise, it returns "~@", + "~A", etc., analogous to "^@", "^A", C0 controls. - X/Open Curses does not document whether unctrl can - be called before initializing curses. This imple- - mentation permits that, and returns the ``~@'', - etc., values in that case. + X/Open Curses does not document whether unctrl can + be called before initializing curses. This imple- + mentation permits that, and returns the "~@", etc., + values in that case. - o parameter values outside the 0 to 255 range. unc- + o parameter values outside the 0 to 255 range. unc- trl returns a null pointer. 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-128 codes as print- + 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-128 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. - Likewise, the meta function allows the caller to change - the output of keyname, i.e., it determines whether to use - the `M-' prefix for ``meta'' keys (codes in the range 128 - to 255). Both use_legacy_coding and meta succeed only af- - ter curses is initialized. X/Open Curses does not docu- - ment the treatment of codes 128 to 159. When treating - them as ``meta'' keys (or if keyname is called before ini- - tializing curses), this implementation returns strings - ``M-^@'', ``M-^A'', etc. - - 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 - use_extended_names function controls whether this data is - loaded when the terminal description is read by the li- + Likewise, the meta function allows the caller to change + the output of keyname, i.e., it determines whether to use + the `M-' prefix for "meta" keys (codes in the range 128 to + 255). Both use_legacy_coding and meta succeed only after + curses is initialized. X/Open Curses does not document + the treatment of codes 128 to 159. When treating them as + "meta" keys (or if keyname is called before initializing + curses), this implementation returns strings "M-^@", + "M-^A", etc. + + 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 + use_extended_names function controls whether this data is + loaded when the terminal description is read by the li- brary. - The nofilter and use_tioctl routines are specific to - ncurses. They were not supported on Version 7, BSD or + 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 depending on ncurses extensions be conditioned using NCURSES_VERSION.-SEE ALSO
+SEE ALSO
legacy_coding(3x), curses(3x), curs_initscr(3x), curs_ker- - nel(3x), curs_scr_dump(3x), curs_variables(3x), lega- + nel(3x), curs_scr_dump(3x), curs_variables(3x), lega- cy_coding(3x). curs_util(3x)-
- -Man(1) output converted with -man2html - +