X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scroll.3x.html;h=1d5c8e9d76c7b73a5dca90e8fa46b033d6c690bb;hp=fb2abac9527c2d3ee599df22dca9934210621df7;hb=2a32bee362db64f5a06b2124976b928ac3faa578;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/curs_scroll.3x.html b/doc/html/man/curs_scroll.3x.html index fb2abac9..1d5c8e9d 100644 --- a/doc/html/man/curs_scroll.3x.html +++ b/doc/html/man/curs_scroll.3x.html @@ -1,80 +1,130 @@ + + + + + +curs_scroll 3x + + + +

curs_scroll 3x

-
+curs_scroll(3x)                                         curs_scroll(3x)
 
-
-

NAME

-       scroll, scrl, wscrl - scroll a curses window
 
 
-
-

SYNOPSIS

-       #include <curses.h>
 
-       int scroll(WINDOW *win);
-       int scrl(int n);
-       int wscrl(WINDOW *win, int n);
+

NAME

+       scroll, scrl, wscrl - scroll a curses window
 
 
-
-

DESCRIPTION

-       The  scroll  routine scrolls the window up one line.  This
+

SYNOPSIS

+       #include <curses.h>
+
+       int scroll(WINDOW *win);
+       int scrl(int n);
+       int wscrl(WINDOW *win, int n);
+
+
+

DESCRIPTION

+       The  scroll  routine scrolls the window up one line.  This
        involves moving the lines in the  window  data  structure.
        As  an optimization, if the scrolling region of the window
        is the entire screen, the physical screen may be  scrolled
        at the same time.
 
-       For  positive  n,  the  scrl and wscrl routines scroll the
-       window up n lines (line i+n becomes i);  otherwise  scroll
-       the  window  down n lines.  This involves moving the lines
+       For  positive  n,  the  scrl and wscrl routines scroll the
+       window up n lines (line i+n becomes i);  otherwise  scroll
+       the  window  down n lines.  This involves moving the lines
        in the window character image structure.  The current cur-
        sor position is not changed.
 
        For these functions to work, scrolling must be enabled via
-       scrollok.
+       scrollok.
 
 
-
-

RETURN VALUE

-       These routines return ERR upon failure, and OK (SVr4  only
-       specifies "an integer value other than ERR") upon success-
+

RETURN VALUE

+       These routines return ERR upon failure, and OK (SVr4  only
+       specifies "an integer value other than ERR") upon success-
        ful completion.
 
+       X/Open defines no error conditions.
+
+       This implementation returns an error if the window pointer
+       is  null,  or  if  scrolling is not enabled in the window,
+       e.g., with scrollok.
 
-
-

NOTES

-       Note that scrl and scroll may be macros.
+
+

NOTES

+       Note that scrl and scroll may be macros.
 
        The SVr4 documentation says that the optimization of phys-
        ically  scrolling  immediately if the scroll region is the
        entire screen "is"  performed,  not  "may  be"  performed.
        This  implementation  deliberately does not guarantee that
-       this will occur, in order to leave open the possibility of
-       smarter  optimization  of  multiple  scroll actions on the
-       next update.
+       this will occur, to leave open the possibility of  smarter
+       optimization  of  multiple  scroll actions on the next up-
+       date.
 
        Neither the SVr4 nor the XSI documentation specify whether
        the current attribute or current color-pair of blanks gen-
-       erated by the  scroll  function  is  zeroed.   Under  this
-       implementation it is.
+       erated by the scroll function is zeroed.  Under  this  im-
+       plementation it is.
 
 
-
-

PORTABILITY

+

PORTABILITY

        The  XSI  Curses  standard,  Issue 4 describes these func-
        tions.
 
 
-
-

SEE ALSO

-       curses(3x), curs_outopts(3x)
+

SEE ALSO

+       curses(3x), curs_outopts(3x)
+
+
 
+                                                        curs_scroll(3x)
-
-
-Man(1) output converted with -man2html -
+
+ +