X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=15b6621b21dfba93f50eee3caa3577aeb14e5fe4;hp=981a3725bff512c019053e8ded57c1f8585f3f9c;hb=77afe78361875f531dc2bf8d73f2e781c8e76176;hpb=f6718d80c998008de6cfe8e6296bee3958ff86d7
diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html
index 981a3725..15b6621b 100644
--- a/doc/html/man/curs_util.3x.html
+++ b/doc/html/man/curs_util.3x.html
@@ -27,7 +27,7 @@
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_util.3x,v 1.26 2008/10/11 20:32:56 tom Exp @
+ * @Id: curs_util.3x,v 1.27 2008/10/25 23:45:41 tom Exp @
-->
@@ -88,88 +88,91 @@
- DEL (character 127) is displayed as ^?.
- - Values above 128 are either meta characters (if the
+ - 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-
+ 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.
- - Values above 256 may be the names of the names of
+ - 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
+ - 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-
- tions do not return the same set of strings; the latter
+ responding to the wide-character value w. The two func-
+ tions do not return the same set of strings; the latter
returns null where the former would display a meta charac-
ter.
The filter routine, if used, must be called before initscr
- or newterm are called. The effect is that, during those
- calls, LINES is set to 1; the capabilities clear, cup,
- cud, cud1, cuu1, cuu, vpa are disabled; and the home
+ or newterm are called. The effect is that, during those
+ calls, LINES is set to 1; the capabilities clear, cup,
+ 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
+ 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 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
+ 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 be-
+ havior would be to use the window size if LINES and COL-
+ UMNS 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
+ The putwin routine writes all data associated with window
win into the file to which filep points. This information
can be later retrieved using the getwin function.
The getwin routine reads window related data stored in the
- file by putwin. The routine then creates and initializes
+ file by putwin. The routine then creates and initializes
a new window using that data. It returns a pointer to the
new window.
- 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. If no padding character is specified, this uses
+ 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. 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 re-
- turn ERR upon failure and OK (SVr4 specifies only "an in-
+ 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-
+ 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.