ncurses 6.4 - patch 20230812

[ncurses.git] / man / curs_scroll.3x

diff --git a/man/curs_scroll.3x b/man/curs_scroll.3x
index f957ac96db7c2fe8a013113ec5dab96fd98ebc7a..ef0f8277df29b18f4e66dce73e16134a8f7a7203 100644 (file)
--- a/man/curs_scroll.3x
+++ b/man/curs_scroll.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998,2000,2001 Free Software Foundation, Inc.              *
+.\" 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  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,48 +27,63 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_scroll.3x,v 1.9 2001/10/14 00:51:56 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
+.el       .ds '' ''
+.na
+.hy 0

 .SH NAME
 .SH NAME

-\fBscroll\fR, \fBscrl\fR, \fBwscrl\fR - scroll a \fBcurses\fR window
+\fBscroll\fP,
+\fBscrl\fP,
+\fBwscrl\fP \- scroll a \fBcurses\fP window
+.ad
+.hy

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <curses.h>\fR
-
-\fBint scroll(WINDOW *win);\fR
-.br
-\fBint scrl(int n);\fR
-.br
-\fBint wscrl(WINDOW *win, int n);\fR
+\fB#include <curses.h>\fP
+.sp
+\fBint scroll(WINDOW *\fIwin\fB);\fR
+.sp
+\fBint scrl(int \fIn\fB);\fR

 .br
 .br

+\fBint wscrl(WINDOW *\fIwin\fB, int \fIn\fB);\fR

 .SH DESCRIPTION
 .SH DESCRIPTION

-The \fBscroll\fR routine scrolls the window up one line.
+The \fBscroll\fP routine scrolls the window up one line.

 This involves moving
 the lines in the window data structure.
 As an optimization, if the scrolling
 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 may be scrolled
-at the same time.
-
-For positive \fIn\fR, the \fBscrl\fR and \fBwscrl\fR routines scroll the
-window up \fIn\fR lines (line \fIi\fR+\fIn\fR becomes \fIi\fR); otherwise
-scroll the window down \fIn\fR lines.
+region of the window is the entire screen,
+the \fIphysical screen\fP may be scrolled at the same time.
+.PP
+For positive \fIn\fP, the \fBscrl\fP and \fBwscrl\fP routines scroll the
+window up \fIn\fP lines (line \fIi\fP+\fIn\fP becomes \fIi\fP); otherwise
+scroll the window down \fIn\fP lines.

 This involves moving the lines in the
 window character image structure.
 The current cursor position is not changed.
 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.
+.PP
+For these functions to work, scrolling must be enabled via \fBscrollok\fP(3X).

 .SH RETURN VALUE
 .SH RETURN VALUE

-These routines return \fBERR\fR upon failure, and \fBOK\fR (SVr4 only specifies
-"an integer value other than \fBERR\fR") upon successful completion.
+These routines return \fBERR\fP upon failure, and \fBOK\fP (SVr4 only specifies
+"an integer value other than \fBERR\fP") upon successful completion.
+.PP
+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(3X).

 .SH NOTES
 .SH NOTES

-Note that \fBscrl\fR and \fBscroll\fR may be macros.
-
-The SVr4 documentation says that the optimization of physically scrolling 
-immediately if the scroll region is the entire screen "is" performed, not
-"may be" performed.
+Note that \fBscrl\fP and \fBscroll\fP may be macros.
+.PP
+The SVr4 documentation says that the optimization of physically scrolling
+immediately if the scroll region is the entire screen \*(``is\*('' performed, not
+\*(``may be\*('' performed.

 This implementation deliberately does not guarantee
 that this will occur, to leave open the possibility of smarter
 This implementation deliberately does not guarantee
 that this will occur, to leave open the possibility of smarter

-optimization of multiple scroll actions on the next update. 
-
+optimization of multiple scroll actions on the next update.
+.PP

 Neither the SVr4 nor the XSI documentation specify whether the current
 attribute or
 current color-pair of blanks generated by the scroll function is zeroed.
 Neither the SVr4 nor the XSI documentation specify whether the current
 attribute or
 current color-pair of blanks generated by the scroll function is zeroed.


@@ -75,10 +91,4 @@ Under this implementation it is.
 .SH PORTABILITY
 The XSI Curses standard, Issue 4 describes these functions.
 .SH SEE ALSO
 .SH PORTABILITY
 The XSI Curses standard, Issue 4 describes these functions.
 .SH SEE ALSO

-\fBcurses\fR(3X), \fBcurs_outopts\fR(3X)
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+\fBcurses\fP(3X), \fBcurs_outopts\fP(3X)