ncurses 6.0 - patch 20170826

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

diff --git a/man/curs_scroll.3x b/man/curs_scroll.3x
index f957ac96db7c2fe8a013113ec5dab96fd98ebc7a..2cb152d865c7c86ab00908ec81678c1143db5e96 100644 (file)
--- a/man/curs_scroll.3x
+++ b/man/curs_scroll.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998,2000,2001 Free Software Foundation, Inc.              *
+.\" Copyright (c) 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            *
@@ -26,13 +26,19 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_scroll.3x,v 1.9 2001/10/14 00:51:56 tom Exp $
+.\" $Id: curs_scroll.3x,v 1.15 2010/12/04 18:40:45 tom Exp $
 .TH curs_scroll 3X ""
+.na
+.hy 0
 .SH NAME
-\fBscroll\fR, \fBscrl\fR, \fBwscrl\fR - scroll a \fBcurses\fR window
+\fBscroll\fR,
+\fBscrl\fR,
+\fBwscrl\fR \- scroll a \fBcurses\fR window
+.ad
+.hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
-
+.sp
 \fBint scroll(WINDOW *win);\fR
 .br
 \fBint scrl(int n);\fR
@@ -46,28 +52,34 @@ 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.
-
+.PP
 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.
 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\fR.
 .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.
+.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.
 .SH NOTES
 Note that \fBscrl\fR and \fBscroll\fR may be macros.
-
-The SVr4 documentation says that the optimization of physically scrolling 
+.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
-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.
@@ -76,9 +88,3 @@ Under this implementation it is.
 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: