X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=b8cf550adfba382e58468e11f4f6d09fc1507188;hp=981a3725bff512c019053e8ded57c1f8585f3f9c;hb=f367fa254ce3fe29710c86971f04e03111c2bd2c;hpb=f6718d80c998008de6cfe8e6296bee3958ff86d7
diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html
index 981a3725..b8cf550a 100644
--- a/doc/html/man/curs_util.3x.html
+++ b/doc/html/man/curs_util.3x.html
@@ -1,7 +1,7 @@
@@ -76,32 +76,33 @@
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.
+ of a wide character.
The keyname routine returns a character string correspond-
ing to the key c:
- - Printable characters are displayed as themselves,
- e.g., a one-character string containing the key.
+ o Printable characters are displayed as themselves,
+ e.g., a one-character string containing the key.
- - Control characters are displayed in the ^X notation.
+ o Control characters are displayed in the ^X nota-
+ tion.
- - DEL (character 127) is displayed as ^?.
+ o DEL (character 127) is displayed as ^?.
- - Values above 128 are either meta characters (if the
- screen has not been initialized, or if meta has been
- called with a TRUE parameter), shown in the M-X no-
- tation, or are displayed as themselves. In the lat-
- ter case, the values may not be printable; this fol-
- lows the X/Open specification.
+ o Values above 128 are either meta characters (if the
+ screen has not been initialized, or if meta has
+ been called with a TRUE parameter), shown in the
+ M-X notation, or are displayed as themselves. In
+ the latter case, the values may not be printable;
+ this follows the X/Open specification.
- - Values above 256 may be the names of the names of
- function keys.
+ o Values above 256 may be the names of the names of
+ function keys.
- - Otherwise (if there is no corresponding name) the
- function returns null, to denote an error. X/Open
- also lists an "UNKNOWN KEY" return value, which some
- implementations return rather than null.
+ o Otherwise (if there is no corresponding name) the
+ function returns null, to denote an error. X/Open
+ also lists an "UNKNOWN KEY" return value, which
+ some implementations return rather than null.
The corresponding key_name returns a character string cor-
responding to the wide-character value w. The two func-
@@ -163,90 +164,94 @@
X/Open does not define any error conditions. In this im-
plementation
- flushinp
- returns an error if the terminal was not ini-
- tialized.
+ flushinp
+ returns an error if the terminal was not initial-
+ ized.
- putwin
- returns an error if the associated fwrite
- calls return an error.
+ meta returns an error if the terminal was not initial-
+ ized.
+
+ 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 er-
+ 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. This implementation checks for three cas-
es:
- - the parameter is a 7-bit US-ASCII code. This
- is the case that X/Open Curses documented.
+ o the parameter is a 7-bit US-ASCII code. This is
+ the case that X/Open Curses documented.
- - the parameter is in the range 128-159, i.e., a
- C1 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 controls.
+ o the parameter is in the range 128-159, i.e., a C1
+ 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.
- X/Open Curses does not document whether unctrl
- can be called before initializing curses.
- This implementation 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.
- - parameter values outside the 0 to 255 range.
- unctrl returns a null pointer.
+ 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
+ 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
+ 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
+ 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-
+ 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 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-
+ 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
legacy_coding(3x), curses(3x), curs_initscr(3x), curs_ker-
- nel(3x), curs_scr_dump(3x), legacy_coding(3x).
+ nel(3x), curs_scr_dump(3x), curs_variables(3x), lega-
+ cy_coding(3x).