X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fresizeterm.3x.html;h=5f2defe2ab726506747821221f2e705bcfcf549e;hp=23b0845735c0db518f217cec7ef03036e7b58bff;hb=acc28c6418f43cbf15187f2f1fd9a562d5d96535;hpb=55ccd2b959766810cf7db8d1c4462f338ce0afc8 diff --git a/doc/html/man/resizeterm.3x.html b/doc/html/man/resizeterm.3x.html index 23b08457..5f2defe2 100644 --- a/doc/html/man/resizeterm.3x.html +++ b/doc/html/man/resizeterm.3x.html @@ -1,7 +1,7 @@ - + @@ -69,30 +69,31 @@ terminal (e.g., xterm). The function resizeterm resizes the standard and current windows to the specified dimen- sions, and adjusts other bookkeeping data used by the - ncurses library that record the window dimensions. + ncurses library that record the window dimensions such as + the LINES and COLS variables. - Most of the work is done by the inner function + Most of the work is done by the inner function resize_term. The outer function resizeterm adds bookkeep- - ing for the SIGWINCH handler. When resizing the windows, - resize_term blank-fills the areas that are extended. The + ing for the SIGWINCH handler. When resizing the windows, + resize_term blank-fills the areas that are extended. The calling application should fill in these areas with appro- - priate data. The resize_term function attempts to resize - all windows. However, due to the calling convention of - pads, it is not possible to resize these without addi- + priate data. The resize_term function attempts to resize + all windows. However, due to the calling convention of + pads, it is not possible to resize these without addi- tional interaction with the application. - A support function is_term_resized is provided so that - applications can check if the resize_term function would + A support function is_term_resized is provided so that + applications can check if the resize_term function would modify the window structures. It returns TRUE if the win- dows would be modified, and FALSE otherwise.

RETURN VALUE

-       Except  as  notes,  these  function return the integer ERR
-       upon failure and OK on success.  They will fail if  either
+       Except as noted, these functions return  the  integer  ERR
+       upon  failure and OK on success.  They will fail if either
        of the dimensions are less than or equal to zero, or if an
-       error occurs while (re)allocating memory for the  windows.
+       error occurs while (re)allocating memory for the windows.
@@ -104,7 +105,7 @@ tions. If ncurses is configured to supply its own SIGWINCH han- - dler, the resizeterm function ungetch's a KEY_RESIZE which + dler, the resizeterm function ungetch's a KEY_RESIZE which will be read on the next call to getch. This is used to alert an application that the screen size has changed, and that it should repaint special features such as pads that @@ -113,14 +114,12 @@ If the environment variables LINES or COLUMNS are set, this overrides the library's use of the window size obtained from the operating system. Thus, even if a SIG- - WINCH is received, no screen size change may be recorded. - In that case, no KEY_RESIZE is queued for the next call to - getch; an ERR will be returned instead. + WINCH is received, no screen size change may be recorded.

SEE ALSO

-       wresize(3x).
+       curs_getch(3x), curs_variables(3x), wresize(3x).