X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;fp=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=a923c7654fc9ccbdbd50cb710f5ea6aa17e4418a;hb=725169bda4d3b4c3fde0d4a94f76d017812c7ea6;hp=e6d8fe14d6998e0868d1f685fe4dd682580c49a6;hpb=d8d029ed8d2793e679c2b247620ea5e2e9d6144b;p=ncurses.git
diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html
index e6d8fe14..a923c765 100644
--- a/doc/html/man/curs_util.3x.html
+++ b/doc/html/man/curs_util.3x.html
@@ -28,19 +28,19 @@
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_util.3x,v 1.96 2024/02/24 19:22:01 tom Exp @
+ * @Id: curs_util.3x,v 1.98 2024/03/16 15:50:09 tom Exp @
-->
-curs_util 3x 2024-02-24 ncurses 6.4 Library calls
+curs_util 3x 2024-03-16 ncurses 6.4 Library calls
-
curs_util 3x 2024-02-24 ncurses 6.4 Library calls
+
curs_util 3x 2024-03-16 ncurses 6.4 Library calls
curs_util(3x) Library calls curs_util(3x)
@@ -254,96 +254,97 @@
Routines that return pointers return NULL on error.
- X/Open does not define any error conditions. In this implementation
+ X/Open Curses does not specify any error conditions. In this
+ implementation
flushinp
returns an error if the terminal was not initialized.
putwin
- returns an error if the associated fwrite calls return an
+ returns an error if the associated fwrite calls 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
+ 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 limitation to 30 seconds and the use of napms differ from other
+ The limitation to 30 seconds and the use of napms differ from other
implementations.
o SVr4 curses does not delay if no padding character is available.
- o NetBSD curses uses napms when no padding character is available,
- but does not take timing into account when using the padding
+ o NetBSD curses uses napms when no padding character is available,
+ but does not take timing into account when using the padding
character.
Neither limits the delay.
- The keyname function may return the names of user-defined string
- capabilities which are defined in the terminfo entry via the -x option
+ The keyname function may return the names of user-defined string
+ capabilities which are defined in the terminfo entry via the -x option
of tic. This implementation automatically assigns at run-time keycodes
- to user-defined strings which begin with "k". The keycodes start at
+ 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(3x) function controls
- whether this data is loaded when the terminal description is read by
+ because user-defined codes are merged from all terminal descriptions
+ which have been loaded. The use_extended_names(3x) function controls
+ whether this data is loaded when the terminal description is read by
the library.
- 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
+ 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.
The putwin and getwin functions have several issues with portability:
- o The files written and read by these functions use an
- implementation-specific format. Although the format is an obvious
+ o The files written and read by these functions use an
+ implementation-specific format. Although the format is an obvious
target for standardization, it has been overlooked.
- Interestingly enough, according to the copyright dates in Solaris
- source, the functions (along with scr_init, etc.) originated with
+ Interestingly enough, according to the copyright dates in Solaris
+ source, the functions (along with scr_init, etc.) originated with
the University of California, Berkeley (in 1982) and were later (in
- 1988) incorporated into SVr4. Oddly, there are no such functions
+ 1988) incorporated into SVr4. Oddly, there are no such functions
in the 4.3BSD curses sources.
o Most implementations simply dump the binary WINDOW structure to the
- file. These include SVr4 curses, NetBSD and PDCurses, as well as
+ file. These include SVr4 curses, NetBSD and PDCurses, as well as
older ncurses versions. This implementation (as well as the X/Open
variant of Solaris curses, dated 1995) uses textual dumps.
- The implementations which use binary dumps use block-I/O (the
- fwrite and fread functions). Those that use textual dumps use
+ The implementations which use binary dumps use block-I/O (the
+ fwrite and fread functions). Those that use textual dumps use
buffered-I/O. A few applications may happen to write extra data in
- the file using these functions. Doing that can run into problems
- mixing block- and buffered-I/O. This implementation reduces the
- problem on writes by flushing the output. However, reading from a
+ the file using these functions. Doing that can run into problems
+ mixing block- and buffered-I/O. This implementation reduces the
+ problem on writes by flushing the output. However, reading from a
file written using mixed schemes may not be successful.
- The XSI Curses standard, Issue 4 describes these functions. It states
+ The XSI Curses standard, Issue 4 describes these functions. It states
that unctrl and wunctrl will return a null pointer if unsuccessful, but
- does not define any error conditions. This implementation checks for
+ does not define any error conditions. This implementation checks for
three cases:
- o the parameter is a 7-bit US-ASCII code. This is the case that
+ o the parameter is a 7-bit US-ASCII code. This is the case that
X/Open Curses documented.
o the parameter is in the range 128-159, i.e., a C1 control code. If
- use_legacy_coding(3x) 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 "~@",
+ use_legacy_coding(3x) 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.
X/Open Curses does not document whether unctrl can be called before
@@ -354,44 +355,44 @@
pointer.
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 printable.
- This implementation uses 8 bits but does not modify the string to
- reflect locale. The use_legacy_coding(3x) function allows the caller
+ 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 printable.
+ This implementation uses 8 bits but does not modify the string to
+ reflect locale. The use_legacy_coding(3x) function allows the caller
to change the output of unctrl.
- Likewise, the meta(3x) 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(3x) and meta(3x) succeed only after curses is
- initialized. X/Open Curses does not document the treatment of codes
+ Likewise, the meta(3x) 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(3x) and meta(3x) 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
+ before initializing curses), this implementation returns strings
"M-^@", "M-^A", etc.
X/Open Curses documents unctrl as declared in <unctrl.h>, which ncurses
- does. However, ncurses' <curses.h> includes <unctrl.h>, matching the
+ does. However, ncurses' <curses.h> includes <unctrl.h>, matching the
behavior of SVr4 curses. Other implementations may not do that.
- If ncurses is configured to provide the sp-functions extension, the
- state of use_env and use_tioctl may be updated before creating each
- screen rather than once only (curs_sp_funcs(3x)). This feature of
+ If ncurses is configured to provide the sp-functions extension, the
+ state of use_env and use_tioctl may be updated before creating each
+ screen rather than once only (curs_sp_funcs(3x)). This feature of
use_env is not provided by other implementations of curses.