opensolaris man page for scrl

scrl(3XCURSES)						  X/Open Curses Library Functions					    scrl(3XCURSES)

NAME
       scrl, scroll, wscrl - scroll a window

SYNOPSIS
       cc [ flag... ] file... -I /usr/xpg4/include  -L	/usr/xpg4/lib 
	-R  /usr/xpg4/lib  -lcurses  [ library... ]

       c89 [ flag... ] file... -lcurses [ library... ]

       #include <curses.h>

       int scrl(int n);

       int scroll(WINDOW *win);

       int wscrl(WINDOW *win, int n);

PARAMETERS
       n      number and direction of lines to scroll

       win    pointer to the window in which to scroll

DESCRIPTION
       The scroll() function scrolls the window win up one line.  The current cursor position is not changed.

       The  scrl() and wscrl() functions scroll the window stdscr or win up or down n lines, where n is a positive (scroll up) or negative (scroll
       down) integer.

       The scrollok(3XCURSES) function must be enabled for these functions to work.

RETURN VALUES
       On success, these functions return OK. Otherwise, they return ERR.

ERRORS
       None.

ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |Unsafe			   |
       +-----------------------------+-----------------------------+

SEE ALSO
       clearok(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)

SunOS 5.11							    5 Jun 2002							    scrl(3XCURSES)