mirror of
https://git.FreeBSD.org/src.git
synced 2024-12-18 10:35:55 +00:00
3e6427f35f
old 1M, 3X and 3S section numbers) and make some minor formatting changes to silence manck.
38 lines
1.2 KiB
Groff
38 lines
1.2 KiB
Groff
.TH curs_scroll 3 ""
|
|
.SH NAME
|
|
\fBscroll\fR, \fBscrl\fR, \fBwscrl\fR - scroll a \fBncurses\fR window
|
|
.SH SYNOPSIS
|
|
\fB#include <ncurses.h>\fR
|
|
|
|
\fBint scroll(WINDOW *win);\fR
|
|
.br
|
|
\fBint scrl(int n);\fR
|
|
.br
|
|
\fBint wscrl(WINDOW *win, int n);\fR
|
|
.br
|
|
.SH DESCRIPTION
|
|
The \fBscroll\fR 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 is scrolled at
|
|
the same time.
|
|
|
|
With the \fBscrl\fR and \fBwscrl\fR routines, for positive \fIn\fR scroll the
|
|
window up \fIn\fR lines (line \fIi\fR+\fIn\fR becomes \fIi\fR); otherwise
|
|
scroll the window down \fIn\fR lines. This involves moving the lines in the
|
|
window character image structure. The current cursor position is not changed.
|
|
|
|
For these functions to work, scrolling must be enabled via \fBscrollok\fR.
|
|
.SH RETURN VALUE
|
|
All routines return the integer \fBERR\fR upon failure and an integer value
|
|
other than \fBERR\fR upon successful completion.
|
|
.SH NOTES
|
|
Note that \fBscrl\fR and \fBscroll\fR may be macros.
|
|
.SH SEE ALSO
|
|
\fBncurses\fR(3), \fBcurs_outopts\fR(3)
|
|
.\"#
|
|
.\"# The following sets edit modes for GNU EMACS
|
|
.\"# Local Variables:
|
|
.\"# mode:nroff
|
|
.\"# fill-column:79
|
|
.\"# End:
|