]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/curs_scroll.3x
ncurses 6.4 - patch 20230812
[ncurses.git] / man / curs_scroll.3x
index 4e01b55d1d2dafc2153f04c4ef1db825e83f6fa4..ef0f8277df29b18f4e66dce73e16134a8f7a7203 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
 .\" Copyright 1998-2006,2010 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_scroll.3x,v 1.21 2021/12/25 21:49:32 tom Exp $
-.TH curs_scroll 3X ""
+.\" $Id: curs_scroll.3x,v 1.27 2023/07/01 14:31:54 tom Exp $
+.TH curs_scroll 3X 2023-07-01 "ncurses 6.4" "Library calls"
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .sp
-\fBint scroll(WINDOW *\fP\fIwin\fP\fB);\fP
+\fBint scroll(WINDOW *\fIwin\fB);\fR
 .sp
-\fBint scrl(int \fP\fIn\fP\fB);\fP
-.br
-\fBint wscrl(WINDOW *\fP\fIwin\fP\fB, int \fP\fIn\fP\fB);\fP
+\fBint scrl(int \fIn\fB);\fR
 .br
+\fBint wscrl(WINDOW *\fIwin\fB, int \fIn\fB);\fR
 .SH DESCRIPTION
 The \fBscroll\fP routine scrolls the window up one line.
 This involves moving
@@ -65,7 +64,7 @@ This involves moving the lines in the
 window character image structure.
 The current cursor position is not changed.
 .PP
-For these functions to work, scrolling must be enabled via \fBscrollok\fP.
+For these functions to work, scrolling must be enabled via \fBscrollok\fP(3X).
 .SH RETURN VALUE
 These routines return \fBERR\fP upon failure, and \fBOK\fP (SVr4 only specifies
 "an integer value other than \fBERR\fP") upon successful completion.
@@ -74,7 +73,7 @@ X/Open defines no error conditions.
 .PP
 This implementation returns an error
 if the window pointer is null, or
-if scrolling is not enabled in the window, e.g., with \fBscrollok\fP.
+if scrolling is not enabled in the window, e.g., with \fBscrollok\fP(3X).
 .SH NOTES
 Note that \fBscrl\fP and \fBscroll\fP may be macros.
 .PP