X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_outopts.3x.html;h=d61be749383c975ed6d88722119464296c102e04;hb=fc11bff62abb32a3e7724180a94c1068c148ea6c;hp=f4ab7c98516f0456b2ce7b92bba95ffd151b1ed7;hpb=122d3739b3c11c83decc625d53f26fff6e825710;p=ncurses.git diff --git a/doc/html/man/curs_outopts.3x.html b/doc/html/man/curs_outopts.3x.html index f4ab7c98..d61be749 100644 --- a/doc/html/man/curs_outopts.3x.html +++ b/doc/html/man/curs_outopts.3x.html @@ -1,6 +1,6 @@ -curs_outopts 3x 2023-11-11 ncurses 6.4 Library calls +curs_outopts 3x 2024-05-11 ncurses 6.5 Library calls -

curs_outopts 3x 2023-11-11 ncurses 6.4 Library calls

curs_outopts 3x 2024-05-11 ncurses 6.5 Library calls

 curs_outopts(3x)                 Library calls                curs_outopts(3x)
 
@@ -47,16 +47,16 @@

NAME

-       clearok,   idlok,   idcok,  immedok,  leaveok,  setscrreg,  wsetscrreg,
-       scrollok - set curses output options
+       clearok,   idcok,   idlok,   immedok,   leaveok,  scrollok,  setscrreg,
+       wsetscrreg - set curses output options

SYNOPSIS

        #include <curses.h>
 
        int clearok(WINDOW *win, bool bf);
-       int idlok(WINDOW *win, bool bf);
        void idcok(WINDOW *win, bool bf);
+       int idlok(WINDOW *win, bool bf);
        void immedok(WINDOW *win, bool bf);
        int leaveok(WINDOW *win, bool bf);
        int scrollok(WINDOW *win, bool bf);
@@ -81,6 +81,14 @@
        repainted from scratch.
 
 
+

idcok

+       If idcok is called with FALSE as  second  argument,  curses  no  longer
+       considers   using  the  hardware  insert/delete  character  feature  of
+       terminals so equipped.  Use of character insert/delete  is  enabled  by
+       default.   Calling idcok with TRUE as second argument re-enables use of
+       character insertion and deletion.
+
+

idlok

        If idlok is called with TRUE as second argument, curses considers using
        the  hardware  insert/delete  line  feature  of  terminals so equipped.
@@ -93,14 +101,6 @@
        changed portions of all lines.
 
 
-

idcok

-       If idcok is called with FALSE as  second  argument,  curses  no  longer
-       considers   using  the  hardware  insert/delete  character  feature  of
-       terminals so equipped.  Use of character insert/delete  is  enabled  by
-       default.   Calling idcok with TRUE as second argument re-enables use of
-       character insertion and deletion.
-
-

immedok

        If immedok is called with TRUE as second argument, any  change  in  the
        window  image,  such  as  the  ones caused by waddch, wclrtobot, wscrl,
@@ -128,7 +128,7 @@
        the terminal, it is also necessary to call idlok).
 
 
-

setscrreg/wsetscrreg

setscrreg, wsetscrreg

        The  setscrreg and wsetscrreg routines allow the application programmer
        to set a software scrolling region  in  a  window.   The  top  and  bot
        parameters  are  the  line  numbers of the top and bottom margin of the
@@ -148,7 +148,7 @@
        upon  failure.  All other routines that return an integer always return
        OK.
 
-       X/Open Curses does not define any error conditions.
+       X/Open Curses does not specify any error conditions.
 
        In this implementation,
 
@@ -156,56 +156,47 @@
            the window pointer is null
 
        o   wsetscrreg  returns  an error if the scrolling region limits extend
-           outside the window.
+           outside the window boundaries.
 
-       X/Open does not  define  any  error  conditions.   This  implementation
-       returns an error if the window pointer is null.
+
+

NOTES

+       Note that clearok, leaveok,  scrollok,  idcok,  and  setscrreg  may  be
+       macros.
+
+       The  immedok  routine  is  useful for windows that are used as terminal
+       emulators.

PORTABILITY

-       These functions are described in the XSI Curses standard, Issue 4.
-
-       From  the  outset,  ncurses  used  nl/nonl 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 pcurses source (which  used  ioctl
-       calls  with  the sgttyb structure) to termios (i.e., the POSIX terminal
-       interface).  In the former, both input and output were controlled via a
-       single  option  CRMOD,  while  the  latter  separates  these  features.
-       Because that conversion interferes with  output  optimization,  nl/nonl
-       were amended after ncurses 6.2 to eliminate their effect on output.
-
-       Some  historic  curses implementations had, as an undocumented feature,
-       the  ability  to  do  the  equivalent  of  clearok(...,  1)  by  saying
-       touchwin(stdscr) or clear(stdscr).  This will not work under ncurses.
+       These functions are described in X/Open Curses, Issue 4.
 
-       Earlier  System  V  curses implementations specified that with scrollok
-       enabled, any window modification triggering  a  scroll  also  forced  a
-       physical refresh.  XSI Curses does not require this, and ncurses avoids
-       doing it to perform better  vertical-motion  optimization  at  wrefresh
-       time.
+       Some historic curses implementations had, as an  undocumented  feature,
+       the  ability  to  do  the  equivalent  of  clearok(...,  1)  by  saying
+       touchwin(stdscr) or clear(stdscr).  This will not work under ncurses.
 
-       The XSI Curses standard does not mention that the cursor should be made
-       invisible as a side-effect of leaveok.  SVr4 curses documentation  does
-       this,  but  the  code  does  not.   Use  curs_set  to  make  the cursor
-       invisible.
+       Earlier System V curses implementations specified  that  with  scrollok
+       enabled,  any  window  modification  triggering  a scroll also forced a
+       physical refresh.  X/Open Curses does not  require  this,  and  ncurses
+       avoids  doing  it  to  perform  better  vertical-motion optimization at
+       wrefresh time.
 
+       X/Open Curses does not mention that the cursor should be made invisible
+       as  a side-effect of leaveok.  SVr4 curses documentation does this, but
+       the code does not.  Use curs_set to make the cursor invisible.
 
-

NOTES

-       Note that clearok, leaveok,  scrollok,  idcok,  and  setscrreg  may  be
-       macros.
 
-       The  immedok  routine  is  useful for windows that are used as terminal
-       emulators.
+

HISTORY

+       ncurses formerly treated nl(3x) and nonl(3x) as both input  and  output
+       options, but no longer; see curs_inopts(3x).