ncurses 6.0 - patch 20150606
[ncurses.git] / doc / html / man / curs_kernel.3x.html
index 094f396ea793a31c9aa17a9411610fef479d29c8..7a8c618933ae1c7523e8d6ff3b80ac9e99c900e0 100644 (file)
+<!-- 
+  ****************************************************************************
+  * Copyright (c) 1998-2005,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            *
+  * "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.19 2010/12/04 18:38:55 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 http://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>curs_kernel 3x</TITLE>
+<link rev=made 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_kernel 3x</H1>
 <PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>                                         <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
+
+
+
 
 </PRE>
-<H2>NAME</H2><PRE>
-       <B>def_prog_mode</B>,       <B>def_shell_mode</B>,      <B>reset_prog_mode</B>,
-       <B>reset_shell_mode</B>, <B>resetty</B>, <B>savetty</B>, <B>getsyx</B>, <B>setsyx</B>, <B>ripof-</B>
-       <B>fline</B>, <B>curs_set</B>, <B>napms</B> - low-level <B>curses</B> routines
+<H2><a name="h2-NAME">NAME</a></H2><PRE>
+       <STRONG>def_prog_mode</STRONG>, <STRONG>def_shell_mode</STRONG>, <STRONG>reset_prog_mode</STRONG>,
+       <STRONG>reset_shell_mode</STRONG>, <STRONG>resetty</STRONG>, <STRONG>savetty</STRONG>, <STRONG>getsyx</STRONG>, <STRONG>setsyx</STRONG>,
+       <STRONG>ripoffline</STRONG>, <STRONG>curs_set</STRONG>, <STRONG>napms</STRONG> - low-level <STRONG>curses</STRONG> routines
 
 
 </PRE>
-<H2>SYNOPSIS</H2><PRE>
-       <B>#include</B> <B>&lt;curses.h&gt;</B>
-
-       <B>int</B> <B>def_prog_mode(void);</B>
-       <B>int</B> <B>def_shell_mode(void);</B>
-       <B>int</B> <B>reset_prog_mode(void);</B>
-       <B>int</B> <B>reset_shell_mode(void);</B>
-       <B>int</B> <B>resetty(void);</B>
-       <B>int</B> <B>savetty(void);</B>
-       <B>void</B> <B>getsyx(int</B> <B>y,</B> <B>int</B> <B>x);</B>
-       <B>void</B> <B>setsyx(int</B> <B>y,</B> <B>int</B> <B>x);</B>
-       <B>int</B> <B>ripoffline(int</B> <B>line,</B> <B>int</B> <B>(*init)(WINDOW</B> <B>*,</B> <B>int));</B>
-       <B>int</B> <B>curs_set(int</B> <B>visibility);</B>
-       <B>int</B> <B>napms(int</B> <B>ms);</B>
+<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
+
+       <STRONG>int</STRONG> <STRONG>def_prog_mode(void);</STRONG>
+       <STRONG>int</STRONG> <STRONG>def_shell_mode(void);</STRONG>
+       <STRONG>int</STRONG> <STRONG>reset_prog_mode(void);</STRONG>
+       <STRONG>int</STRONG> <STRONG>reset_shell_mode(void);</STRONG>
+       <STRONG>int</STRONG> <STRONG>resetty(void);</STRONG>
+       <STRONG>int</STRONG> <STRONG>savetty(void);</STRONG>
+       <STRONG>void</STRONG> <STRONG>getsyx(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
+       <STRONG>void</STRONG> <STRONG>setsyx(int</STRONG> <STRONG>y,</STRONG> <STRONG>int</STRONG> <STRONG>x);</STRONG>
+       <STRONG>int</STRONG> <STRONG>ripoffline(int</STRONG> <STRONG>line,</STRONG> <STRONG>int</STRONG> <STRONG>(*init)(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int));</STRONG>
+       <STRONG>int</STRONG> <STRONG>curs_set(int</STRONG> <STRONG>visibility);</STRONG>
+       <STRONG>int</STRONG> <STRONG>napms(int</STRONG> <STRONG>ms);</STRONG>
 
 
 </PRE>
-<H2>DESCRIPTION</H2><PRE>
+<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
        The  following  routines  give low-level access to various
-       <B>curses</B> capabilities.  Theses routines typically  are  used
+       <STRONG>curses</STRONG> capabilities.  These routines  typically  are  used
        inside library routines.
 
-       The  <B>def_prog_mode</B>  and  <B>def_shell_mode</B>  routines save the
-       current terminal modes as the  "program"  (in  <B>curses</B>)  or
-       "shell"   (not   in   <B>curses</B>)   state   for   use  by  the
-       <B>reset_prog_mode</B> and <B>reset_shell_mode</B>  routines.   This  is
-       done  automatically  by  <B>initscr</B>.   There is one such save
-       area for each screen context allocated by <B>newterm()</B>.
-
-       The <B>reset_prog_mode</B> and <B>reset_shell_mode</B> routines  restore
-       the  terminal  to "program" (in <B>curses</B>) or "shell" (out of
-       <B>curses</B>) state.  These are  done  automatically  by  <B>endwin</B>
-       and,  after  an  <B>endwin</B>, by <B>doupdate</B>, so they normally are
+       The  <STRONG>def_prog_mode</STRONG>  and  <STRONG>def_shell_mode</STRONG>  routines save the
+       current terminal modes as the  "program"  (in  <STRONG>curses</STRONG>)  or
+       "shell"   (not  in  <STRONG>curses</STRONG>)  state  for  use  by  the  <STRONG>re-</STRONG>
+       <STRONG>set_prog_mode</STRONG> and <STRONG>reset_shell_mode</STRONG> routines.  This is done
+       automatically by <STRONG>initscr</STRONG>.  There is one such save area for
+       each screen context allocated by <STRONG>newterm()</STRONG>.
+
+       The <STRONG>reset_prog_mode</STRONG> and <STRONG>reset_shell_mode</STRONG> routines  restore
+       the  terminal  to "program" (in <STRONG>curses</STRONG>) or "shell" (out of
+       <STRONG>curses</STRONG>) state.  These are  done  automatically  by  <STRONG>endwin</STRONG>
+       and,  after  an  <STRONG>endwin</STRONG>, by <STRONG>doupdate</STRONG>, so they normally are
        not called.
 
-       The <B>resetty</B> and <B>savetty</B>  routines  save  and  restore  the
-       state  of  the  terminal modes.  <B>savetty</B> saves the current
-       state in a buffer and <B>resetty</B> restores the state  to  what
-       it was at the last call to <B>savetty</B>.
-
-       The  <B>getsyx</B> routine returns the current coordinates of the
-       virtual screen cursor in <I>y</I> and <I>x</I>.  If <B>leaveok</B> is currently
-       <B>TRUE</B>,  then <B>-1</B>,<B>-1</B> is returned.  If lines have been removed
-       from the top of the screen,  using  <B>ripoffline</B>,  <I>y</I>  and  <I>x</I>
-       include  these  lines;  therefore,  <I>y</I> and <I>x</I> should be used
-       only as arguments for <B>setsyx</B>.
-
-       The <B>setsyx</B> routine sets the virtual screen cursor to <I>y</I>, <I>x</I>.
-       If <I>y</I> and <I>x</I> are both <B>-1</B>, then <B>leaveok</B> is set.  The two rou-
-       tines <B>getsyx</B> and <B>setsyx</B> are  designed  to  be  used  by  a
-       library routine, which manipulates <B>curses</B> windows but does
+       The <STRONG>resetty</STRONG> and <STRONG>savetty</STRONG>  routines  save  and  restore  the
+       state  of  the  terminal modes.  <STRONG>savetty</STRONG> saves the current
+       state in a buffer and <STRONG>resetty</STRONG> restores the state  to  what
+       it was at the last call to <STRONG>savetty</STRONG>.
+
+       The  <STRONG>getsyx</STRONG> routine returns the current coordinates of the
+       virtual screen cursor in <EM>y</EM> and <EM>x</EM>.  If <STRONG>leaveok</STRONG> is currently
+       <STRONG>TRUE</STRONG>,  then <STRONG>-1</STRONG>,<STRONG>-1</STRONG> is returned.  If lines have been removed
+       from the top of the screen, using <STRONG>ripoffline</STRONG>, <EM>y</EM> and <EM>x</EM>  in-
+       clude  these lines; therefore, <EM>y</EM> and <EM>x</EM> should be used only
+       as arguments for <STRONG>setsyx</STRONG>.
+
+       The <STRONG>setsyx</STRONG> routine sets the virtual screen cursor to <EM>y</EM>, <EM>x</EM>.
+       If <EM>y</EM> and <EM>x</EM> are both <STRONG>-1</STRONG>, then <STRONG>leaveok</STRONG> is set.  The two rou-
+       tines <STRONG>getsyx</STRONG> and <STRONG>setsyx</STRONG> are designed to be used by  a  li-
+       brary  routine,  which manipulates <STRONG>curses</STRONG> windows but does
        not want to change the current position of  the  program's
-       cursor.   The  library  routine  would  call <B>getsyx</B> at the
-       beginning, do its manipulation of its own  windows,  do  a
-       <B>wnoutrefresh</B>  on  its  windows, call <B>setsyx</B>, and then call
-       <B>doupdate</B>.
-
-       The <B>ripoffline</B> routine provides access to the same  facil-
-       ity  that  <B>slk_init</B>  [see <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B>] uses to reduce the
-       size of the screen.   <B>ripoffline</B>  must  be  called  before
-       <B>initscr</B> or <B>newterm</B> is called.  If <I>line</I> is positive, a line
-       is removed from the top of <B>stdscr</B>; if <I>line</I> is negative,  a
+       cursor.   The library routine would call <STRONG>getsyx</STRONG> at the be-
+       ginning, do its manipulation of  its  own  windows,  do  a
+       <STRONG>wnoutrefresh</STRONG>  on  its  windows, call <STRONG>setsyx</STRONG>, and then call
+       <STRONG>doupdate</STRONG>.
+
+       The <STRONG>ripoffline</STRONG> routine provides access to the same facili-
+       ty  that  <STRONG>slk_init</STRONG>  [see  <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>] uses to reduce the
+       size of the screen.   <STRONG>ripoffline</STRONG>  must  be  called  before
+       <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> is called.  If <EM>line</EM> is positive, a line
+       is removed from the top of <STRONG>stdscr</STRONG>; if <EM>line</EM> is negative,  a
        line is removed from the bottom.  When this is done inside
-       <B>initscr</B>, the routine <B>init</B> (supplied by the user) is called
+       <STRONG>initscr</STRONG>, the routine <STRONG>init</STRONG> (supplied by the user) is called
        with  two arguments: a window pointer to the one-line win-
        dow that has been allocated and an integer with the number
        of columns in the window.  Inside this initialization rou-
-       tine, the integer variables <B>LINES</B>  and  <B>COLS</B>  (defined  in
-       <B>&lt;curses.h&gt;</B>) are not guaranteed to be accurate and <B>wrefresh</B>
-       or <B>doupdate</B> must not be called.  It is allowable  to  call
-       <B>wnoutrefresh</B> during the initialization routine.
+       tine, the integer variables <STRONG>LINES</STRONG>  and  <STRONG>COLS</STRONG>  (defined  in
+       <STRONG>&lt;curses.h&gt;</STRONG>) are not guaranteed to be accurate and <STRONG>wrefresh</STRONG>
+       or <STRONG>doupdate</STRONG> must not be called.  It is allowable  to  call
+       <STRONG>wnoutrefresh</STRONG> during the initialization routine.
 
-       <B>ripoffline</B>  can  be called up to five times before calling
-       <B>initscr</B> or <B>newterm</B>.
+       <STRONG>ripoffline</STRONG>  can  be called up to five times before calling
+       <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>.
 
-       The <B>curs_set</B> routine sets  the  cursor  state  is  set  to
-       invisible, normal, or very visible for <B>visibility</B> equal to
-       <B>0</B>, <B>1</B>, or <B>2</B> respectively.  If  the  terminal  supports  the
-       <I>visibility</I>   requested,   the  previous  <I>cursor</I>  state  is
-       returned; otherwise, <B>ERR</B> is returned.
+       The <STRONG>curs_set</STRONG> routine sets the cursor state  to  invisible,
+       normal, or very visible for <STRONG>visibility</STRONG> equal to <STRONG>0</STRONG>, <STRONG>1</STRONG>, or <STRONG>2</STRONG>
+       respectively.  If the terminal supports the <EM>visibility</EM> re-
+       quested, the previous <EM>cursor</EM> state is returned; otherwise,
+       <STRONG>ERR</STRONG> is returned.
 
-       The <B>napms</B> routine is used to sleep for <I>ms</I> milliseconds.
-
-
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
-       Except for <B>curs_set</B>,  these  routines  always  return  <B>OK</B>.
-       <B>curs_set</B>  returns the previous cursor state, or <B>ERR</B> if the
-       requested <I>visibility</I> is not supported.
+       The <STRONG>napms</STRONG> routine is used to sleep for <EM>ms</EM> milliseconds.
 
 
 </PRE>
-<H2>NOTES</H2><PRE>
-       Note that <B>getsyx</B> is a macro, so <B>&amp;</B> is not necessary  before
-       the variables <I>y</I> and <I>x</I>.
+<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+       Except for <STRONG>curs_set</STRONG>, these routines always return <STRONG>OK</STRONG>.
 
-       Older  SVr4  man  pages  warn  that  the  return  value of
-       <B>curs_set</B> "is currently  incorrect".   This  implementation
-       gets  it  right, but it may be unwise to count on the cor-
-       rectness of the return value anywhere else.
-
-       Both ncurses and SVr4 will  call  <B>curs_set</B>  in  <B>endwin</B>  if
-       <B>curs_set</B>  has  been  called  to make the cursor other than
-       normal, i.e., either visible or very visible.  There is no
-       way  for  ncurses to determine the initial cursor state to
-       restore that.
+       <STRONG>curs_set</STRONG> returns the previous cursor state, or <STRONG>ERR</STRONG> if  the
+       requested <EM>visibility</EM> is not supported.
 
+       X/Open  defines  no error conditions.  In this implementa-
+       tion
 
-</PRE>
-<H2>PORTABILITY</H2><PRE>
-       The functions <B>setsyx</B> and <B>getsyx</B> are not described  in  the
-       XSI  Curses standard, Issue 4.  All other functions are as
-       described in XSI Curses.
+              <STRONG>def_prog_mode</STRONG>, <STRONG>def_shell_mode</STRONG>, <STRONG>reset_prog_mode</STRONG>, <STRONG>re-</STRONG>
+              <STRONG>set_shell_mode</STRONG>
+                   return  an  error if the terminal was not ini-
+                   tialized, or if the I/O  call  to  obtain  the
+                   terminal settings fails.
 
-       The SVr4 documentation describes <B>setsyx</B> and <B>getsyx</B> as hav-
-       ing  return  type  int.  This  is  misleading, as they are
-       macros with no documented semantics for the return  value.
+              <STRONG>ripoffline</STRONG>
+                   returns  an  error  if  the  maximum number of
+                   ripped-off lines exceeds the maximum (NRIPS  =
+                   5).
 
 
 </PRE>
-<H2>SEE ALSO</H2><PRE>
-       <B><A HREF="ncurses.3x.html">curses(3x)</A></B>,       <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>,      <B><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></B>,
-       <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>, <B><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></B>, <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+       Note  that <STRONG>getsyx</STRONG> is a macro, so <STRONG>&amp;</STRONG> is not necessary before
+       the variables <EM>y</EM> and <EM>x</EM>.
 
+       Older SVr4  man  pages  warn  that  the  return  value  of
+       <STRONG>curs_set</STRONG>  "is  currently  incorrect".  This implementation
+       gets it right, but it may be unwise to count on  the  cor-
+       rectness of the return value anywhere else.
 
+       Both  ncurses  and  SVr4  will  call <STRONG>curs_set</STRONG> in <STRONG>endwin</STRONG> if
+       <STRONG>curs_set</STRONG> 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.
 
 
+</PRE>
+<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+       The  functions  <STRONG>setsyx</STRONG> and <STRONG>getsyx</STRONG> are not described in the
+       XSI Curses standard, Issue 4.  All other functions are  as
+       described in XSI Curses.
 
+       The SVr4 documentation describes <STRONG>setsyx</STRONG> and <STRONG>getsyx</STRONG> as hav-
+       ing return type int.  This  is  misleading,  as  they  are
+       macros with no documented semantics for the return value.
 
 
+</PRE>
+<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,  <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>,  <STRONG><A HREF="curs_outopts.3x.html">curs_outopts(3x)</A></STRONG>, <STRONG>curs_re-</STRONG>
+       <STRONG><A HREF="curs_refresh.3x.html">fresh(3x)</A></STRONG>,  <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>,  <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>,   <STRONG>curs_vari-</STRONG>
+       <STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>.
 
 
 
+                                                        <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
 </PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+</ul>
+</div>
 </BODY>
 </HTML>