X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_util.3x.html;h=9ae2f4195439220585b578e0585e81cf9311abc6;hp=8181efa432f386223c3e02ac29ab60a833f53ba9;hb=e6f4ffe150c7d919792f29a70b4f031cfab5ef06;hpb=f86cbeb5f9bd96ab041d34039c35749a14965039
diff --git a/doc/html/man/curs_util.3x.html b/doc/html/man/curs_util.3x.html
index 8181efa4..9ae2f419 100644
--- a/doc/html/man/curs_util.3x.html
+++ b/doc/html/man/curs_util.3x.html
@@ -1,7 +1,8 @@
-
+
@@ -48,8 +49,8 @@
NAME
delay_output, filter, flushinp, getwin, key_name, keyname,
- nofilter, putwin, unctrl, use_env, wunctrl - miscellaneous
- curses utility routines
+ nofilter, putwin, unctrl, use_env, use_tioctl, wunctrl -
+ miscellaneous curses utility routines
@@ -63,6 +64,7 @@
void filter(void);
void nofilter(void);
void use_env(bool f);
+ void use_tioctl(bool f);
int putwin(WINDOW *win, FILE *filep);
WINDOW *getwin(FILE *filep);
int delay_output(int ms);
@@ -122,16 +124,66 @@
$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
- from the operating system.
+ The use_env routine, if used, should be called before
+ initscr or newterm are called (because those compute the
+ screen size). It modifies the way ncurses treats environ-
+ ment variables when determining the screen size.
+
+ o Normally ncurses looks first at the terminal database
+ for the screen size.
+
+ If use_env was called with FALSE for parameter, it
+ stops here unless If use_tioctl was also called with
+ TRUE for parameter.
+
+ o Then it asks for the screen size via operating system
+ calls. If successful, it overrides the values from
+ the terminal database.
+
+ o Finally (unless use_env was called with FALSE parame-
+ ter), ncurses examines the LINES or COLUMNS environ-
+ ment variables, using a value in those to override the
+ results from the operating system or terminal data-
+ base.
+
+ Ncurses also updates the screen size in response to
+ SIGWINCH, unless overridden by the LINES or COLUMNS
+ environment variables,
+
+ The use_tioctl routine, if used, should be called before
+ initscr or newterm are called (because those compute the
+ screen size). After use_tioctl is called with TRUE as an
+ argument, ncurses modifies the last step in its computa-
+ tion of screen size as follows:
+
+ o checks if the LINES and COLUMNS environment variables
+ are set to a number greater than zero.
+
+ o for each, ncurses updates the corresponding environ-
+ ment variable with the value that it has obtained via
+ operating system call or from the terminal database.
+
+ o ncurses re-fetches the value of the environment vari-
+ ables so that it is still the environment variables
+ which set the screen size.
+
+ The use_env and use_tioctl routines combine as summarized
+ here:
+
+ use_env use_tioctl Summary
+ ----------------------------------------------------------------
+ TRUE FALSE This is the default behavior. ncurses
+ uses operating system calls unless over-
+ ridden by $LINES or $COLUMNS environment
+ variables.
+ TRUE TRUE ncurses updates $LINES and $COLUMNS
+ based on operating system calls.
+
+ FALSE TRUE ncurses ignores $LINES and $COLUMNS, us-
+ es operating system calls to obtain
+ size.
+ FALSE FALSE ncurses relies on the terminal database
+ to determine size.
The putwin routine writes all data associated with window
win into the file to which filep points. This information
@@ -241,16 +293,17 @@
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-
- tensions be conditioned using NCURSES_VERSION.
+ 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
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).