]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_outopts.3x.html
projects / ncurses.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
ncurses 6.4 - patch 20240106
[ncurses.git] / doc / html / man / curs_outopts.3x.html
diff --git a/doc/html/man/curs_outopts.3x.html b/doc/html/man/curs_outopts.3x.html
index 0abaa743a0cbccf3b510fc68d5ba26ed0a307fa9..0d9dafe788ec97ca03701d920d7e0983d6077aaa 100644 (file)
--- a/doc/html/man/curs_outopts.3x.html
+++ b/doc/html/man/curs_outopts.3x.html
@@ -1,6 +1,6 @@
 <!--
   ****************************************************************************
 <!--
   ****************************************************************************
-  * Copyright 2018-2022,2023 Thomas E. Dickey                                *
+  * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,19 +27,19 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_outopts.3x,v 1.46 2023/09/30 21:38:11 tom Exp @
+  * @Id: curs_outopts.3x,v 1.56 2024/01/05 21:46:58 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_outopts 3x 2023-09-30 ncurses 6.4 Library calls</TITLE>
+<TITLE>curs_outopts 3x 2024-01-05 ncurses 6.4 Library calls</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 
 </HEAD>
 <BODY>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 
 </HEAD>
 <BODY>
-<H1 class="no-header">curs_outopts 3x 2023-09-30 ncurses 6.4 Library calls</H1>
+<H1 class="no-header">curs_outopts 3x 2024-01-05 ncurses 6.4 Library calls</H1>
 <PRE>
 <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>                 Library calls                <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
 
 <PRE>
 <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>                 Library calls                <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
 
@@ -102,109 +102,110 @@
 
 
 </PRE><H3><a name="h3-immedok">immedok</a></H3><PRE>
 
 
 </PRE><H3><a name="h3-immedok">immedok</a></H3><PRE>
-       If <STRONG>immedok</STRONG> is called with <STRONG>TRUE</STRONG> <STRONG>as</STRONG> <STRONG>argument</STRONG>, any change  in  the  window
-       image,  such  as  the  ones  caused  by <STRONG>waddch,</STRONG> <STRONG>wclrtobot,</STRONG> <STRONG>wscrl</STRONG>, etc.,
-       automatically cause a  call  to  <STRONG>wrefresh</STRONG>.   However,  it  may  degrade
-       performance  considerably,  due  to  repeated calls to <STRONG>wrefresh</STRONG>.  It is
-       disabled by default.
+       If <STRONG>immedok</STRONG> is called with <STRONG>TRUE</STRONG> as second argument, any  change  in  the
+       window  image,  such  as  the  ones caused by <STRONG>waddch,</STRONG> <STRONG>wclrtobot,</STRONG> <STRONG>wscrl</STRONG>,
+       etc., automatically causes a call to <STRONG>wrefresh</STRONG>.  However, it may degrade
+       performance  considerably,  due to repeated calls to <STRONG>wrefresh</STRONG>.  Calling
+       <STRONG>immedok</STRONG> with <STRONG>FALSE</STRONG> as second argument restores  the  default  behavior,
+       i.e., deferring screen updates until a refresh is needed.
 
 
 </PRE><H3><a name="h3-leaveok">leaveok</a></H3><PRE>
 
 
 </PRE><H3><a name="h3-leaveok">leaveok</a></H3><PRE>
-       Normally, the hardware cursor is left at the  location  of  the  window
-       cursor  being  refreshed.   The  <STRONG>leaveok</STRONG> option allows the cursor to be
-       left wherever the update  happens  to  leave  it.   It  is  useful  for
-       applications  where  the  cursor is not used, since it reduces the need
+       Normally,  the  hardware  cursor  is left at the location of the window
+       cursor being refreshed.  The <STRONG>leaveok</STRONG> option allows  the  cursor  to  be
+       left  wherever  the  update  happens  to  leave  it.   It is useful for
+       applications where the cursor is not used, since it  reduces  the  need
        for cursor motions.
 
 
 </PRE><H3><a name="h3-scrollok">scrollok</a></H3><PRE>
        for cursor motions.
 
 
 </PRE><H3><a name="h3-scrollok">scrollok</a></H3><PRE>
-       The <STRONG>scrollok</STRONG> option controls what happens when the cursor of  a  window
-       is  moved  off  the edge of the window or scrolling region, either as a
-       result of a newline action on the  bottom  line,  or  typing  the  last
-       character  of the last line.  If disabled, (<EM>bf</EM> is <STRONG>FALSE</STRONG>), the cursor is
-       left on the bottom line.  If enabled,  (<EM>bf</EM>  is  <STRONG>TRUE</STRONG>),  the  window  is
+       The  <STRONG>scrollok</STRONG>  option controls what happens when the cursor of a window
+       is moved off the edge of the window or scrolling region,  either  as  a
+       result  of  a  newline  action  on  the bottom line, or typing the last
+       character of the last line.  If disabled, (<EM>bf</EM> is <STRONG>FALSE</STRONG>), the cursor  is
+       left  on  the  bottom  line.   If  enabled, (<EM>bf</EM> is <STRONG>TRUE</STRONG>), the window is
        scrolled up one line (Note that to get the physical scrolling effect on
        the terminal, it is also necessary to call <STRONG>idlok</STRONG>).
 
 
        scrolled up one line (Note that to get the physical scrolling effect on
        the terminal, it is also necessary to call <STRONG>idlok</STRONG>).
 
 
-</PRE><H3><a name="h3-setscrreg_wsetscrreg">setscrreg/wsetscrreg</a></H3><PRE>
-       The <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> routines allow the application  programmer
-       to  set  a  software  scrolling  region  in  a window.  The <EM>top</EM> and <EM>bot</EM>
-       parameters are the line numbers of the top and  bottom  margin  of  the
-       scrolling  region.   (Line  0  is the top line of the window.)  If this
-       option and <STRONG>scrollok</STRONG> are enabled, an attempt  to  move  off  the  bottom
+</PRE><H3><a name="h3-setscrreg_wsetscrreg">setscrreg, wsetscrreg</a></H3><PRE>
+       The  <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> routines allow the application programmer
+       to set a software scrolling region  in  a  window.   The  <EM>top</EM>  and  <EM>bot</EM>
+       parameters  are  the  line  numbers of the top and bottom margin of the
+       scrolling region.  (Line 0 is the top line of  the  window.)   If  this
+       option  and  <STRONG>scrollok</STRONG>  are  enabled,  an attempt to move off the bottom
        margin line causes all lines in the scrolling region to scroll one line
        margin line causes all lines in the scrolling region to scroll one line
-       in the direction of the first line.  Only the text  of  the  window  is
+       in  the  direction  of  the first line.  Only the text of the window is
        scrolled.  (Note that this has nothing to do with the use of a physical
        scrolled.  (Note that this has nothing to do with the use of a physical
-       scrolling region capability in the terminal, like that  in  the  VT100.
-       If  <STRONG>idlok</STRONG>  is enabled and the terminal has either a scrolling region or
+       scrolling  region  capability  in the terminal, like that in the VT100.
+       If <STRONG>idlok</STRONG> is enabled and the terminal has either a scrolling  region  or
        insert/delete line capability, they will probably be used by the output
        routines.)
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
        insert/delete line capability, they will probably be used by the output
        routines.)
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       The  functions  <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> return <STRONG>OK</STRONG> upon success and <STRONG>ERR</STRONG>
-       upon failure.  All other routines that return an integer always  return
+       The functions <STRONG>setscrreg</STRONG> and <STRONG>wsetscrreg</STRONG> return <STRONG>OK</STRONG> upon success  and  <STRONG>ERR</STRONG>
+       upon  failure.  All other routines that return an integer always return
        <STRONG>OK</STRONG>.
 
        X/Open Curses does not define any error conditions.
 
        In this implementation,
 
        <STRONG>OK</STRONG>.
 
        X/Open Curses does not define any error conditions.
 
        In this implementation,
 
-       <STRONG>o</STRONG>   those  functions that have a window pointer will return an error if
+       <STRONG>o</STRONG>   those functions that have a window pointer will return an error  if
            the window pointer is null
 
            the window pointer is null
 
-       <STRONG>o</STRONG>   <STRONG>wsetscrreg</STRONG> returns an error if the scrolling region  limits  extend
+       <STRONG>o</STRONG>   <STRONG>wsetscrreg</STRONG>  returns  an error if the scrolling region limits extend
            outside the window.
 
            outside the window.
 
-       X/Open  does  not  define  any  error  conditions.  This implementation
+       X/Open does not  define  any  error  conditions.   This  implementation
        returns an error if the window pointer is null.
 
 
        returns an error if the window pointer is null.
 
 
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+       Note  that  <STRONG>clearok</STRONG>,  <STRONG>leaveok</STRONG>,  <STRONG>scrollok</STRONG>,  <STRONG>idcok</STRONG>,  and <STRONG>setscrreg</STRONG> may be
+       macros.
+
+       The <STRONG>immedok</STRONG> routine is useful for windows that  are  used  as  terminal
+       emulators.
+
+
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
        These functions are described in the XSI Curses standard, Issue 4.
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
        These functions are described in the XSI Curses standard, Issue 4.
 
-       From the outset, ncurses used <STRONG>nl</STRONG>/<STRONG>nonl</STRONG>  to  control  the  conversion  of
-       newlines  to carriage return/line-feed on output as well as input.  XSI
-       Curses documents only the use  of  these  functions  for  input.   This
-       difference  arose  from converting the <EM>pcurses</EM> source (which used <STRONG>ioctl</STRONG>
-       calls with the <STRONG>sgttyb</STRONG> structure) to termios (i.e., the  POSIX  terminal
+       From  the  outset,  <EM>ncurses</EM>  used  <STRONG>nl</STRONG>/<STRONG>nonl</STRONG> to control the conversion of
+       newlines to carriage return/line-feed on output as well as input.   XSI
+       Curses  documents  only  the  use  of  these functions for input.  This
+       difference arose from converting the <EM>pcurses</EM> source (which  used  <STRONG>ioctl</STRONG>
+       calls  with  the <STRONG>sgttyb</STRONG> structure) to termios (i.e., the POSIX terminal
        interface).  In the former, both input and output were controlled via a
        single  option  <STRONG>CRMOD</STRONG>,  while  the  latter  separates  these  features.
        interface).  In the former, both input and output were controlled via a
        single  option  <STRONG>CRMOD</STRONG>,  while  the  latter  separates  these  features.
-       Because  that  conversion  interferes with output optimization, <STRONG>nl</STRONG>/<STRONG>nonl</STRONG>
-       were amended after ncurses 6.2 to eliminate their effect on output.
+       Because that conversion interferes with  output  optimization,  <STRONG>nl</STRONG>/<STRONG>nonl</STRONG>
+       were amended after <EM>ncurses</EM> 6.2 to eliminate their effect on output.
 
 
-       Some historic curses implementations had, as an  undocumented  feature,
+       Some  historic  curses implementations had, as an undocumented feature,
        the  ability  to  do  the  equivalent  of  <STRONG>clearok(...,</STRONG>  <STRONG>1)</STRONG>  by  saying
        the  ability  to  do  the  equivalent  of  <STRONG>clearok(...,</STRONG>  <STRONG>1)</STRONG>  by  saying
-       <STRONG>touchwin(stdscr)</STRONG> or <STRONG>clear(stdscr)</STRONG>.  This will not work under ncurses.
+       <STRONG>touchwin(stdscr)</STRONG> or <STRONG>clear(stdscr)</STRONG>.  This will not work under <EM>ncurses</EM>.
 
 
-       Earlier System V curses implementations specified  that  with  <STRONG>scrollok</STRONG>
-       enabled,  any  window  modification  triggering  a scroll also forced a
-       physical refresh.  XSI Curses does not require this, and <STRONG>ncurses</STRONG> avoids
-       doing  it  to  perform  better vertical-motion optimization at <STRONG>wrefresh</STRONG>
+       Earlier  System  V  curses implementations specified that with <STRONG>scrollok</STRONG>
+       enabled, any window modification triggering  a  scroll  also  forced  a
+       physical refresh.  XSI Curses does not require this, and <EM>ncurses</EM> avoids
+       doing it to perform better  vertical-motion  optimization  at  <STRONG>wrefresh</STRONG>
        time.
 
        The XSI Curses standard does not mention that the cursor should be made
        time.
 
        The XSI Curses standard does not mention that the cursor should be made
-       invisible  as a side-effect of <STRONG>leaveok</STRONG>.  SVr4 curses documentation does
-       this, but  the  code  does  not.   Use  <STRONG>curs_set</STRONG>  to  make  the  cursor
+       invisible as a side-effect of <STRONG>leaveok</STRONG>.  SVr4 curses documentation  does
+       this,  but  the  code  does  not.   Use  <STRONG>curs_set</STRONG>  to  make  the cursor
        invisible.
 
 
        invisible.
 
 
-</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
-       Note  that  <STRONG>clearok</STRONG>,  <STRONG>leaveok</STRONG>,  <STRONG>scrollok</STRONG>,  <STRONG>idcok</STRONG>,  and <STRONG>setscrreg</STRONG> may be
-       macros.
-
-       The <STRONG>immedok</STRONG> routine is useful for windows that  are  used  as  terminal
-       emulators.
-
-
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,     <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>,    <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>,    <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>,
-       <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,    <STRONG><A HREF="curs_addch.3x.html">curs_addch(3x)</A></STRONG>,    <STRONG><A HREF="curs_clear.3x.html">curs_clear(3x)</A></STRONG>,     <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>,
+       <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>, <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>
 
 
 
 
 
 
-ncurses 6.4                       2023-09-30                  <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
+ncurses 6.4                       2024-01-05                  <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>
 </PRE>
 <div class="nav">
 <ul>
@@ -218,12 +219,12 @@ ncurses 6.4                       2023-09-30                  <STRONG><A HREF="c
 <li><a href="#h3-immedok">immedok</a></li>
 <li><a href="#h3-leaveok">leaveok</a></li>
 <li><a href="#h3-scrollok">scrollok</a></li>
 <li><a href="#h3-immedok">immedok</a></li>
 <li><a href="#h3-leaveok">leaveok</a></li>
 <li><a href="#h3-scrollok">scrollok</a></li>
-<li><a href="#h3-setscrreg_wsetscrreg">setscrreg/wsetscrreg</a></li>
+<li><a href="#h3-setscrreg_wsetscrreg">setscrreg, wsetscrreg</a></li>
 </ul>
 </li>
 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 </ul>
 </li>
 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
-<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 <li><a href="#h2-NOTES">NOTES</a></li>
 <li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 </ul>
 </div>
 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 </ul>
 </div>
ncurses, with patches starting at ncurses-5.6; new users should use https://github.com/ThomasDickey/ncurses-snapshots/