]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_scroll.3x.html
ncurses 6.4 - patch 20230311
[ncurses.git] / doc / html / man / curs_scroll.3x.html
index 4d885e512b1635e8936986aa79e8e15b213e70c3..3079d60d792c5841a97ea95dc25b1eb4479bcd02 100644 (file)
@@ -1,6 +1,7 @@
-<!-- 
+<!--
   ****************************************************************************
   ****************************************************************************
-  * Copyright (c) 1998-2018,2019 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,7 +27,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_scroll.3x,v 1.17 2019/11/30 21:06:30 tom Exp @
+  * @Id: curs_scroll.3x,v 1.23 2023/03/11 20:41:05 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
@@ -35,7 +36,7 @@
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
 <TITLE>curs_scroll 3x</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
 <TITLE>curs_scroll 3x</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+
 </HEAD>
 <BODY>
 <H1 class="no-header">curs_scroll 3x</H1>
 </HEAD>
 <BODY>
 <H1 class="no-header">curs_scroll 3x</H1>
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
-       <STRONG>int</STRONG> <STRONG>scroll(WINDOW</STRONG> <STRONG>*win);</STRONG>
-       <STRONG>int</STRONG> <STRONG>scrl(int</STRONG> <STRONG>n);</STRONG>
-       <STRONG>int</STRONG> <STRONG>wscrl(WINDOW</STRONG> <STRONG>*win,</STRONG> <STRONG>int</STRONG> <STRONG>n);</STRONG>
+       <STRONG>int</STRONG> <STRONG>scroll(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
+
+       <STRONG>int</STRONG> <STRONG>scrl(int</STRONG> <EM>n</EM><STRONG>);</STRONG>
+       <STRONG>int</STRONG> <STRONG>wscrl(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
@@ -68,7 +70,8 @@
        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 <STRONG>scrollok</STRONG>.
+       For  these  functions  to  work,  scrolling  must be enabled via <STRONG>scrol-</STRONG>
+       <STRONG><A HREF="scrollok.3x.html">lok(3x)</A></STRONG>.
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 
        X/Open defines no error conditions.
 
 
        X/Open defines no error conditions.
 
-       This implementation returns an error if the window pointer is null,  or
-       if scrolling is not enabled in the window, e.g., with <STRONG>scrollok</STRONG>.
+       This  implementation returns an error if the window pointer is null, or
+       if scrolling is not enabled in the window, e.g., with <STRONG><A HREF="scrollok.3x.html">scrollok(3x)</A></STRONG>.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
        Note that <STRONG>scrl</STRONG> and <STRONG>scroll</STRONG> may be macros.
 
        The  SVr4  documentation  says  that  the  optimization  of  physically
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
        Note that <STRONG>scrl</STRONG> and <STRONG>scroll</STRONG> 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.  This implementation deliberately
-       does not guarantee that this will occur, to leave open the  possibility
+       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.
 
        of smarter optimization of multiple scroll actions on the next update.
 
-       Neither  the SVr4 nor the XSI documentation specify whether the current
+       Neither the SVr4 nor the XSI documentation specify whether the  current
        attribute or current color-pair of blanks generated by the scroll func-
        tion is zeroed.  Under this implementation it is.
 
        attribute or current color-pair of blanks generated by the scroll func-
        tion is zeroed.  Under this implementation it is.