ncurses 6.3 - patch 20220122
[ncurses.git] / doc / html / man / curs_scroll.3x.html
index f6fbcbb0762684d1057895cb7e8c91b40307785f..4c24b6fdfb19b24329ef366137743e2ca906c3ef 100644 (file)
@@ -1,6 +1,6 @@
 <!--
   ****************************************************************************
 <!--
   ****************************************************************************
-  * Copyright 2018-2019,2020 Thomas E. Dickey                                *
+  * Copyright 2018-2020,2021 Thomas E. Dickey                                *
   * Copyright 1998-2006,2010 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * Copyright 1998-2006,2010 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * 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.19 2020/10/24 09:45:48 tom Exp @
+  * @Id: curs_scroll.3x,v 1.21 2021/12/25 21:49:32 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>curs_scroll 3X</TITLE>
+<TITLE>curs_scroll 3x</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+
 </HEAD>
 <BODY>
 </HEAD>
 <BODY>
-<H1 class="no-header">curs_scroll 3X</H1>
+<H1 class="no-header">curs_scroll 3x</H1>
 <PRE>
 <PRE>
-<B><A HREF="curs_scroll.3X.html">curs_scroll(3X)</A></B>                                                <B><A HREF="curs_scroll.3X.html">curs_scroll(3X)</A></B>
+<STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>                                                <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <B>scroll</B>, <B>scrl</B>, <B>wscrl</B> - scroll a <B>curses</B> window
+       <STRONG>scroll</STRONG>, <STRONG>scrl</STRONG>, <STRONG>wscrl</STRONG> - scroll a <STRONG>curses</STRONG> window
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
-       <B>#include</B> <B>&lt;curses.h&gt;</B>
+       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
 
-       <B>int</B> <B>scroll(WINDOW</B> <B>*</B><I>win</I><B>);</B>
+       <STRONG>int</STRONG> <STRONG>scroll(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
 
 
-       <B>int</B> <B>scrl(int</B> <I>n</I><B>);</B>
-       <B>int</B> <B>wscrl(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
+       <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>
-       The  <B>scroll</B> routine scrolls the window up one line.  This involves mov-
+       The  <STRONG>scroll</STRONG> routine scrolls the window up one line.  This involves mov-
        ing the lines in the window data structure.  As an optimization, if the
        ing the lines in the window data structure.  As an optimization, if the
-       scrolling  region  of  the  window  is  the entire screen, the <I>physical</I>
-       <I>screen</I> may be scrolled at the same time.
+       scrolling  region  of  the  window  is  the entire screen, the <EM>physical</EM>
+       <EM>screen</EM> may be scrolled at the same time.
 
 
-       For positive <I>n</I>, the <B>scrl</B> and <B>wscrl</B> routines  scroll  the  window  up  <I>n</I>
-       lines  (line  <I>i</I>+<I>n</I> becomes <I>i</I>); otherwise scroll the window down <I>n</I> lines.
+       For positive <EM>n</EM>, the <STRONG>scrl</STRONG> and <STRONG>wscrl</STRONG> routines  scroll  the  window  up  <EM>n</EM>
+       lines  (line  <EM>i</EM>+<EM>n</EM> becomes <EM>i</EM>); otherwise scroll the window down <EM>n</EM> 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 <B>scrollok</B>.
+       For these functions to work, scrolling must be enabled via <STRONG>scrollok</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>
-       These routines return <B>ERR</B> upon failure, and <B>OK</B> (SVr4 only specifies "an
-       integer value other than <B>ERR</B>") upon successful completion.
+       These routines return <STRONG>ERR</STRONG> upon failure, and <STRONG>OK</STRONG> (SVr4 only specifies "an
+       integer value other than <STRONG>ERR</STRONG>") upon successful completion.
 
        X/Open defines no error conditions.
 
        This implementation returns an error if the window pointer is null,  or
 
        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 <B>scrollok</B>.
+       if scrolling is not enabled in the window, e.g., with <STRONG>scrollok</STRONG>.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
-       Note that <B>scrl</B> and <B>scroll</B> may be macros.
+       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"
 
        The  SVr4  documentation  says  that  the  optimization  of  physically
        scrolling immediately if the scroll region is the  entire  screen  "is"
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_outopts.3X.html">curs_outopts(3X)</A></B>
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>
 
 
 
 
 
 
-                                                               <B><A HREF="curs_scroll.3X.html">curs_scroll(3X)</A></B>
+                                                               <STRONG><A HREF="curs_scroll.3x.html">curs_scroll(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>
 </PRE>
 <div class="nav">
 <ul>