ncurses 5.5
[ncurses.git] / man / curs_scroll.3x
index 4e694c33b1f932e3b00594f02d925f71c092a3b2..0ba48f6256cdadcf7579c96ac0083e8735a9f749 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998-2001,2003 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2003,2005 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_scroll.3x,v 1.10 2003/05/10 20:33:49 jmc Exp $
+.\" $Id: curs_scroll.3x,v 1.12 2005/05/15 16:19:01 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
 
@@ -58,6 +64,12 @@ 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.