MirBSD manpage: curs_scroll(3), scrl(3), scroll(3), wscrl(3)

curs_scroll(3)      UNIX Programmer's Manual       curs_scroll(3)


     scroll, scrl, wscrl - scroll a curses window


     #include <curses.h>

     int scroll(WINDOW *win);
     int scrl(int n);
     int wscrl(WINDOW *win, int n);


     The scroll routine scrolls the window up one line. This  in-
     volves  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  win-
     dow  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 cursor posi-
     tion is not changed.

     For these functions to work, scrolling must be  enabled  via


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

     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.


     Note that scrl and scroll may be macros.

     The SVr4 documentation says that the optimization of  physi-
     cally  scrolling immediately if the scroll region is the en-
     tire screen "is" performed, not "may be" performed. This im-
     plementation  deliberately does not guarantee that this will
     occur, to leave open the possibility of smarter optimization
     of multiple scroll actions on the next update.

     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  imple-
     mentation it is.

MirBSD #10-current     Printed 2022-12-23                       1

curs_scroll(3)      UNIX Programmer's Manual       curs_scroll(3)


     The XSI Curses standard, Issue 4 describes these functions.


     curses(3), curs_outopts(3)

MirBSD #10-current     Printed 2022-12-23                       2

Generated on 2022-12-24 01:00:14 by $MirOS: src/scripts/roff2htm,v 1.113 2022/12/21 23:14:31 tg Exp $ — This product includes material provided by mirabilos.

These manual pages and other documentation are copyrighted by their respective writers; their sources are available at the project’s CVSweb, AnonCVS and other mirrors. The rest is Copyright © 2002–2022 MirBSD.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.

Kontakt / Impressum & Datenschutzerklärung