X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_outopts.3x.html;h=c8d4a06c094cecb1b3504003801ef2f9e82fbe02;hp=9d2d1735b8dcf4adeaa0ccacd654aa81801b0387;hb=ca276baf720e3a44721b9e18955d3f546955c6c8;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/doc/html/man/curs_outopts.3x.html b/doc/html/man/curs_outopts.3x.html index 9d2d1735..c8d4a06c 100644 --- a/doc/html/man/curs_outopts.3x.html +++ b/doc/html/man/curs_outopts.3x.html @@ -1,7 +1,7 @@ @@ -40,10 +40,14 @@
 
+curs_outopts(3x)                                       curs_outopts(3x)
+
+
+
 
 

NAME

-       clearok,   idlok,   idcok,  immedok,  leaveok,  setscrreg,
+       clearok, idlok, idcok, immedok, leaveok, setscrreg,
        wsetscrreg, scrollok, nl, nonl - curses output options
 
 
@@ -67,8 +71,8 @@
 

DESCRIPTION

        These routines set options that change the style of output
        within  curses.   All  options are initially FALSE, unless
-       otherwise stated.  It  is  not  necessary  to  turn  these
-       options off before calling endwin.
+       otherwise stated.  It is not necessary to turn  these  op-
+       tions off before calling endwin.
 
        If  clearok is called with TRUE as argument, the next call
        to wrefresh with this window will clear  the  screen  com-
@@ -87,7 +91,7 @@
        needs  insert/delete  line, for example, for a screen edi-
        tor.  It is disabled by default because insert/delete line
        tends  to  be  visually annoying when used in applications
-       where it isn't really needed.  If insert/delete line  can-
+       where it is not really needed.  If insert/delete line can-
        not  be  used,  curses redraws the changed portions of all
        lines.
 
@@ -99,33 +103,32 @@
        tion and deletion.
 
        If  immedok is called with TRUE as argument, any change in
-       the window image, such  as  the  ones  caused  by  waddch,
-       wclrtobot, wscrl, etc., automatically cause a call to wre-
+       the window image, such as the ones caused by waddch, wclr-
+       tobot,  wscrl,  etc.,  automatically  cause a call to wre-
        fresh.  However, it may degrade performance  considerably,
-       due  to  repeated  calls  to  wrefresh.  It is disabled by
-       default.
+       due  to repeated calls to wrefresh.  It is disabled by de-
+       fault.
 
        Normally, the hardware cursor is left at the  location  of
-       the  window  cursor  being  refreshed.  The leaveok option
-       allows the cursor to be left wherever the  update  happens
-       to leave it.  It is useful for applications where the cur-
-       sor is not used, since it  reduces  the  need  for  cursor
-       motions.
+       the window cursor being refreshed.  The leaveok option al-
+       lows 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.
 
        The  setscrreg  and wsetscrreg routines allow the applica-
        tion programmer to set a software scrolling  region  in  a
        window.   top  and bot 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 scrollok are
-       enabled, an attempt to move off  the  bottom  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 scrolled.  (Note that this has nothing to do
+       line  of the window.)  If this option and scrollok are en-
+       abled, an attempt to move off the bottom margin line caus-
+       es all lines in the scrolling region to scroll one line 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 scrolling region capability  in
        the terminal, like that in the VT100.  If idlok is enabled
-       and  the  terminal  has  either  a  scrolling  region   or
-       insert/delete  line capability, they will probably be used
-       by the output routines.)
+       and the terminal has either  a  scrolling  region  or  in-
+       sert/delete line capability, they will probably be used by
+       the output routines.)
 
        The scrollok option controls what happens when the  cursor
        of  a  window  is  moved  off  the  edge  of the window or
@@ -155,6 +158,22 @@
        cess and ERR upon failure.  All other routines that return
        an integer always return OK.
 
+       X/Open does not define any error conditions.
+
+       In this implementation, those functions that have a window
+       pointer will return an error  if  the  window  pointer  is
+       null.
+
+              wclrtoeol
+                   returns  an  error  if  the cursor position is
+                   about to wrap.
+
+              wsetscrreg
+                   returns an error if the scrolling region  lim-
+                   its extend outside the window.
+
+       X/Open  does not define any error conditions.  This imple-
+       mentation returns an error if the window pointer is  null.
 
 
 
@@ -168,7 +187,7 @@ translations; AT&T curses (at least as late as SVr1) did not. We choose to do so, on the theory that a programmer requesting raw input wants a clean (ideally 8-bit clean) - connection that the operating system does not mess with. + connection that the operating system will not alter. Some historic curses implementations had, as an undocu- mented feature, the ability to do the equivalent of @@ -203,19 +222,7 @@ - - - - - - - - - - - - - + curs_outopts(3x)