ncurses 5.4

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

diff --git a/man/curs_kernel.3x b/man/curs_kernel.3x
index ffba687f89c1ac42c8279db2d2f01677bec3fc3e..caeb5bba0cd882f433acfe203148d226995d4446 100644 (file)
--- a/man/curs_kernel.3x
+++ b/man/curs_kernel.3x
@@ -1,9 +1,38 @@
+.\"***************************************************************************
+.\" Copyright (c) 1998 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            *
+.\" "Software"), to deal in the Software without restriction, including      *
+.\" without limitation the rights to use, copy, modify, merge, publish,      *
+.\" distribute, distribute with modifications, sublicense, and/or sell       *
+.\" copies of the Software, and to permit persons to whom the Software is    *
+.\" furnished to do so, subject to the following conditions:                 *
+.\"                                                                          *
+.\" The above copyright notice and this permission notice shall be included  *
+.\" in all copies or substantial portions of the Software.                   *
+.\"                                                                          *
+.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+.\"                                                                          *
+.\" Except as contained in this notice, the name(s) of the above copyright   *
+.\" holders shall not be used in advertising or otherwise to promote the     *
+.\" sale, use or other dealings in this Software without prior written       *
+.\" authorization.                                                           *
+.\"***************************************************************************
+.\"
+.\" $Id: curs_kernel.3x,v 1.13 2001/12/08 18:01:25 tom Exp $

 .TH curs_kernel 3X ""
 .SH NAME
 \fBdef_prog_mode\fR, \fBdef_shell_mode\fR,
 \fBreset_prog_mode\fR, \fBreset_shell_mode\fR, \fBresetty\fR,
 \fBsavetty\fR, \fBgetsyx\fR, \fBsetsyx\fR, \fBripoffline\fR,
 .TH curs_kernel 3X ""
 .SH NAME
 \fBdef_prog_mode\fR, \fBdef_shell_mode\fR,
 \fBreset_prog_mode\fR, \fBreset_shell_mode\fR, \fBresetty\fR,
 \fBsavetty\fR, \fBgetsyx\fR, \fBsetsyx\fR, \fBripoffline\fR,

-\fBcurs_set\fR, \fBnapms\fR - low-level \fBxscurses\fR routines
+\fBcurs_set\fR, \fBnapms\fR - low-level \fBcurses\fR routines

 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 


@@ -70,7 +99,7 @@ at the beginning, do its manipulation of its own windows, do a
 \fBdoupdate\fR.
 
 The \fBripoffline\fR routine provides access to the same facility that
 \fBdoupdate\fR.
 
 The \fBripoffline\fR routine provides access to the same facility that

-\fBslk_init\fR [see curs_slk(3X)] uses to reduce the size of the
+\fBslk_init\fR [see \fBcurs_slk\fR(3X)] uses to reduce the size of the

 screen.  \fBripoffline\fR must be called before \fBinitscr\fR or
 \fBnewterm\fR is called.  If \fIline\fR is positive, a line is removed
 from the top of \fBstdscr\fR; if \fIline\fR is negative, a line is
 screen.  \fBripoffline\fR must be called before \fBinitscr\fR or
 \fBnewterm\fR is called.  If \fIline\fR is positive, a line is removed
 from the top of \fBstdscr\fR; if \fIline\fR is negative, a line is


@@ -102,9 +131,16 @@ requested \fIvisibility\fR is not supported.
 Note that \fBgetsyx\fR is a macro, so \fB&\fR is not necessary before
 the variables \fIy\fR and \fIx\fR.
 
 Note that \fBgetsyx\fR is a macro, so \fB&\fR is not necessary before
 the variables \fIy\fR and \fIx\fR.
 

-The SVr4 man pages warn that the return value of \fBcurs_set\fR "is currently
+Older SVr4 man pages warn that the return value of \fBcurs_set\fR "is currently

 incorrect".  This implementation gets it right, but it may be unwise to count
 on the correctness of the return value anywhere else.
 incorrect".  This implementation gets it right, but it may be unwise to count
 on the correctness of the return value anywhere else.

+
+Both ncurses and SVr4 will call \fBcurs_set\fR in \fBendwin\fR
+if \fBcurs_set\fR
+has been called to make the cursor other than normal, i.e., either
+invisible or very visible.
+There is no way for ncurses to determine the initial cursor state to
+restore that.

 .SH PORTABILITY
 The functions \fBsetsyx\fR and \fBgetsyx\fR are not described in the XSI
 Curses standard, Issue 4.  All other functions are as described in XSI Curses.
 .SH PORTABILITY
 The functions \fBsetsyx\fR and \fBgetsyx\fR are not described in the XSI
 Curses standard, Issue 4.  All other functions are as described in XSI Curses.