<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_kernel 3X</TITLE>
+<TITLE>curs_kernel 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_kernel 3X</H1>
+<H1 class="no-header">curs_kernel 3x</H1>
<PRE>
-<B><A HREF="curs_kernel.3X.html">curs_kernel(3X)</A></B> <B><A HREF="curs_kernel.3X.html">curs_kernel(3X)</A></B>
+<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><a name="h2-NAME">NAME</a></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>ripoffline</B>, <B>curs_set</B>, <B>napms</B> - low-
- level <B>curses</B> routines
+ <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><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <B>#include</B> <B><curses.h></B>
+ <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
- <B>int</B> <B>def_prog_mode(void);</B>
- <B>int</B> <B>def_shell_mode(void);</B>
+ <STRONG>int</STRONG> <STRONG>def_prog_mode(void);</STRONG>
+ <STRONG>int</STRONG> <STRONG>def_shell_mode(void);</STRONG>
- <B>int</B> <B>reset_prog_mode(void);</B>
- <B>int</B> <B>reset_shell_mode(void);</B>
+ <STRONG>int</STRONG> <STRONG>reset_prog_mode(void);</STRONG>
+ <STRONG>int</STRONG> <STRONG>reset_shell_mode(void);</STRONG>
- <B>int</B> <B>resetty(void);</B>
- <B>int</B> <B>savetty(void);</B>
+ <STRONG>int</STRONG> <STRONG>resetty(void);</STRONG>
+ <STRONG>int</STRONG> <STRONG>savetty(void);</STRONG>
- <B>void</B> <B>getsyx(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>);</B>
- <B>void</B> <B>setsyx(int</B> <I>y</I><B>,</B> <B>int</B> <I>x</I><B>);</B>
+ <STRONG>void</STRONG> <STRONG>getsyx(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
+ <STRONG>void</STRONG> <STRONG>setsyx(int</STRONG> <EM>y</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>x</EM><STRONG>);</STRONG>
- <B>int</B> <B>ripoffline(int</B> <I>line</I><B>,</B> <B>int</B> <B>(*</B><I>init</I><B>)(WINDOW</B> <B>*,</B> <B>int));</B>
- <B>int</B> <B>curs_set(int</B> <I>visibility</I><B>);</B>
- <B>int</B> <B>napms(int</B> <I>ms</I><B>);</B>
+ <STRONG>int</STRONG> <STRONG>ripoffline(int</STRONG> <EM>line</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>init</EM><STRONG>)(WINDOW</STRONG> <STRONG>*,</STRONG> <STRONG>int));</STRONG>
+ <STRONG>int</STRONG> <STRONG>curs_set(int</STRONG> <EM>visibility</EM><STRONG>);</STRONG>
+ <STRONG>int</STRONG> <STRONG>napms(int</STRONG> <EM>ms</EM><STRONG>);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- The following routines give low-level access to various <B>curses</B> capabil-
+ The following routines give low-level access to various <STRONG>curses</STRONG> capabil-
ities. These routines typically are used inside library routines.
</PRE><H3><a name="h3-def_prog_mode_-def_shell_mode">def_prog_mode, def_shell_mode</a></H3><PRE>
- 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 <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>reset_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>.
</PRE><H3><a name="h3-reset_prog_mode_-reset_shell_mode">reset_prog_mode, reset_shell_mode</a></H3><PRE>
- 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><A HREF="curs_initscr.3X.html">endwin(3X)</A></B> and, after an <B>endwin</B>, by <B>doupdate</B>, so
+ 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><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG> and, after an <STRONG>endwin</STRONG>, by <STRONG>doupdate</STRONG>, so
they normally are not called.
</PRE><H3><a name="h3-resetty_-savetty">resetty, savetty</a></H3><PRE>
- The <B>resetty</B> and <B>savetty</B> routines save and restore the state of the ter-
- minal 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 <STRONG>resetty</STRONG> and <STRONG>savetty</STRONG> routines save and restore the state of the ter-
+ minal 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>.
</PRE><H3><a name="h3-getsyx">getsyx</a></H3><PRE>
- The <B>getsyx</B> routine returns the current coordinates of the <I>virtual</I>
- <I>screen</I> 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
+ The <STRONG>getsyx</STRONG> routine returns the current coordinates of the <EM>virtual</EM>
+ <EM>screen</EM> 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
- <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>.
+ <STRONG>ripoffline</STRONG>, <EM>y</EM> and <EM>x</EM> include these lines; therefore, <EM>y</EM> and <EM>x</EM> should be
+ used only as arguments for <STRONG>setsyx</STRONG>.
- Few applications will use this feature, most use <B>getyx</B> instead.
+ Few applications will use this feature, most use <STRONG>getyx</STRONG> instead.
</PRE><H3><a name="h3-setsyx">setsyx</a></H3><PRE>
- The <B>setsyx</B> routine sets the <I>virtual</I> <I>screen</I> 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 routines <B>getsyx</B> and <B>setsyx</B>
- are designed to be used by a library routine, which manipulates <B>curses</B>
+ The <STRONG>setsyx</STRONG> routine sets the <EM>virtual</EM> <EM>screen</EM> 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 routines <STRONG>getsyx</STRONG> and <STRONG>setsyx</STRONG>
+ are designed to be used by a library routine, which manipulates <STRONG>curses</STRONG>
windows but does not want to change the current position of the pro-
- gram'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 win-
- dows, call <B>setsyx</B>, and then call <B>doupdate</B>.
+ gram's cursor. The library routine would call <STRONG>getsyx</STRONG> at the beginning,
+ do its manipulation of its own windows, do a <STRONG>wnoutrefresh</STRONG> on its win-
+ dows, call <STRONG>setsyx</STRONG>, and then call <STRONG>doupdate</STRONG>.
- Few applications will use this feature, most use <B>wmove</B> instead.
+ Few applications will use this feature, most use <STRONG>wmove</STRONG> instead.
</PRE><H3><a name="h3-ripoffline">ripoffline</a></H3><PRE>
- The <B>ripoffline</B> routine provides access to the same facility 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, to pre-
+ The <STRONG>ripoffline</STRONG> routine provides access to the same facility 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, to pre-
pare these initial actions:
- <B>o</B> If <I>line</I> is positive, a line is removed from the top of <B>stdscr</B>.
+ <STRONG>o</STRONG> If <EM>line</EM> is positive, a line is removed from the top of <STRONG>stdscr</STRONG>.
- <B>o</B> if <I>line</I> is negative, a line is removed from the bottom.
+ <STRONG>o</STRONG> if <EM>line</EM> is negative, a line is removed from the bottom.
- When the resulting initialization is done inside <B>initscr</B>, the routine
- <B>init</B> (supplied by the user) is called with two arguments:
+ When the resulting initialization is done inside <STRONG>initscr</STRONG>, the routine
+ <STRONG>init</STRONG> (supplied by the user) is called with two arguments:
- <B>o</B> a window pointer to the one-line window that has been allocated and
+ <STRONG>o</STRONG> a window pointer to the one-line window that has been allocated and
- <B>o</B> an integer with the number of columns in the window.
+ <STRONG>o</STRONG> an integer with the number of columns in the window.
- Inside this initialization routine, the integer variables <B>LINES</B> and
- <B>COLS</B> (defined in <B><curses.h></B>) are not guaranteed to be accurate and <B>wre-</B>
- <B>fresh</B> or <B>doupdate</B> must not be called. It is allowable to call <B>wnoutre-</B>
- <B>fresh</B> during the initialization routine.
+ Inside this initialization routine, the integer variables <STRONG>LINES</STRONG> and
+ <STRONG>COLS</STRONG> (defined in <STRONG><curses.h></STRONG>) are not guaranteed to be accurate and <STRONG>wre-</STRONG>
+ <STRONG>fresh</STRONG> or <STRONG>doupdate</STRONG> must not be called. It is allowable to call <STRONG>wnoutre-</STRONG>
+ <STRONG>fresh</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>.
</PRE><H3><a name="h3-curs_set">curs_set</a></H3><PRE>
- The <B>curs_set</B> routine sets the cursor state 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> requested, the previous <EM>cursor</EM> state
+ is returned; otherwise, <STRONG>ERR</STRONG> is returned.
</PRE><H3><a name="h3-napms">napms</a></H3><PRE>
- The <B>napms</B> routine is used to sleep for <I>ms</I> milliseconds.
+ The <STRONG>napms</STRONG> routine is used to sleep for <EM>ms</EM> milliseconds.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- Except for <B>curs_set</B>, these routines always return <B>OK</B>.
+ Except for <STRONG>curs_set</STRONG>, these routines always return <STRONG>OK</STRONG>.
- <B>curs_set</B> returns the previous cursor state, or <B>ERR</B> if the requested
- <I>visibility</I> is not supported.
+ <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 implementation
- <B>def_prog_mode</B>, <B>def_shell_mode</B>, <B>reset_prog_mode</B>, <B>reset_shell_mode</B>
+ <STRONG>def_prog_mode</STRONG>, <STRONG>def_shell_mode</STRONG>, <STRONG>reset_prog_mode</STRONG>, <STRONG>reset_shell_mode</STRONG>
return an error if the terminal was not initialized, or if the I/O
call to obtain the terminal settings fails.
- <B>ripoffline</B>
+ <STRONG>ripoffline</STRONG>
returns an error if the maximum number of ripped-off lines exceeds
the maximum (NRIPS = 5).
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- Note that <B>getsyx</B> is a macro, so <B>&</B> is not necessary before the variables
- <I>y</I> and <I>x</I>.
+ Note that <STRONG>getsyx</STRONG> is a macro, so <STRONG>&</STRONG> is not necessary before the variables
+ <EM>y</EM> and <EM>x</EM>.
- Older SVr4 man pages warn that the return value of <B>curs_set</B> "is cur-
+ Older SVr4 man pages warn that the return value of <STRONG>curs_set</STRONG> "is cur-
rently 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 <B>curs_set</B> in <B>endwin</B> if <B>curs_set</B> has been
+ 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 <I>virtual</I> <I>screen</I> functions <B>setsyx</B> and <B>getsyx</B> are not described in the
+ The <EM>virtual</EM> <EM>screen</EM> 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 <B>setsyx</B> and <B>getsyx</B> as having return
+ The SVr4 documentation describes <STRONG>setsyx</STRONG> and <STRONG>getsyx</STRONG> as having 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>
- <B><A HREF="curses.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>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>.
+ <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><A HREF="curs_refresh.3x.html">curs_refresh(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><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
- <B><A HREF="curs_kernel.3X.html">curs_kernel(3X)</A></B>
+ <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff