xref: /titanic_44/usr/src/man/man3xcurses/scrl.3xcurses (revision a60349c89adffc0902b2353230891d8e7f2b24d9)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
SCRL 3XCURSES "Jun 5, 2002"
NAME
scrl, scroll, wscrl - scroll a window
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -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)