-</PRE>
-<H2><a name="h2-NAME">NAME</a></H2><PRE>
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
<STRONG>delay_output</STRONG>, <STRONG>filter</STRONG>, <STRONG>flushinp</STRONG>, <STRONG>getwin</STRONG>, <STRONG>key_name</STRONG>, <STRONG>keyname</STRONG>,
<STRONG>nofilter</STRONG>, <STRONG>putwin</STRONG>, <STRONG>unctrl</STRONG>, <STRONG>use_env</STRONG>, <STRONG>use_tioctl</STRONG>, <STRONG>wunctrl</STRONG> -
miscellaneous <STRONG>curses</STRONG> utility routines
-</PRE>
-<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
<STRONG>char</STRONG> <STRONG>*unctrl(chtype</STRONG> <STRONG>c);</STRONG>
<STRONG>int</STRONG> <STRONG>flushinp(void);</STRONG>
-</PRE>
-<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
-</PRE>
-<H3><a name="h3-unctrl">unctrl</a></H3><PRE>
+</PRE><H3><a name="h3-unctrl">unctrl</a></H3><PRE>
The <STRONG>unctrl</STRONG> routine returns a character string which is a
printable representation of the character <EM>c</EM>, ignoring at-
tributes. Control characters are displayed in the <STRONG>^</STRONG><EM>X</EM> no-
of a wide character.
-</PRE>
-<H3><a name="h3-keyname_key_name">keyname/key_name</a></H3><PRE>
+</PRE><H3><a name="h3-keyname_key_name">keyname/key_name</a></H3><PRE>
The <STRONG>keyname</STRONG> routine returns a character string correspond-
ing to the key <EM>c</EM>:
ter.
-</PRE>
-<H3><a name="h3-filter_nofilter">filter/nofilter</a></H3><PRE>
+</PRE><H3><a name="h3-filter_nofilter">filter/nofilter</a></H3><PRE>
The <STRONG>filter</STRONG> routine, if used, must be called before <STRONG>initscr</STRONG>
or <STRONG>newterm</STRONG> are called. The effect is that, during those
calls, <STRONG>LINES</STRONG> is set to 1; the capabilities <STRONG>clear</STRONG>, <STRONG>cup</STRONG>,
modifies the in-memory copy of the terminal information.
-</PRE>
-<H3><a name="h3-use_env">use_env</a></H3><PRE>
+</PRE><H3><a name="h3-use_env">use_env</a></H3><PRE>
The <STRONG>use_env</STRONG> routine, if used, should be called before
<STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> are called (because those compute the
screen size). It modifies the way <STRONG>ncurses</STRONG> treats environ-
environment variables,
-</PRE>
-<H3><a name="h3-use_tioctl">use_tioctl</a></H3><PRE>
+</PRE><H3><a name="h3-use_tioctl">use_tioctl</a></H3><PRE>
The <STRONG>use_tioctl</STRONG> routine, if used, should be called before
<STRONG>initscr</STRONG> or <STRONG>newterm</STRONG> are called (because those compute the
screen size). After <STRONG>use_tioctl</STRONG> is called with <STRONG>TRUE</STRONG> as an
to determine size.
-</PRE>
-<H3><a name="h3-putwin_getwin">putwin/getwin</a></H3><PRE>
+</PRE><H3><a name="h3-putwin_getwin">putwin/getwin</a></H3><PRE>
The <STRONG>putwin</STRONG> routine writes all data associated with window
(or pad) <EM>win</EM> into the file to which <EM>filep</EM> points. This
information can be later retrieved using the <STRONG>getwin</STRONG> func-
will not be colored when the window is refreshed.
-</PRE>
-<H3><a name="h3-delay_output">delay_output</a></H3><PRE>
+</PRE><H3><a name="h3-delay_output">delay_output</a></H3><PRE>
The <STRONG>delay_output</STRONG> routine inserts an <EM>ms</EM> millisecond pause
in output. This routine should not be used extensively
because padding characters are used rather than a CPU
<STRONG>napms</STRONG> to perform the delay.
-</PRE>
-<H3><a name="h3-flushinp">flushinp</a></H3><PRE>
+</PRE><H3><a name="h3-flushinp">flushinp</a></H3><PRE>
The <STRONG>flushinp</STRONG> routine throws away any typeahead that has
been typed by the user and has not yet been read by the
program.
-</PRE>
-<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Except for <STRONG>flushinp</STRONG>, routines that return an integer re-
turn <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 specifies only "an in-
teger value other than <STRONG>ERR</STRONG>") upon successful completion.
return an error.
-</PRE>
-<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
-</PRE>
-<H3><a name="h3-filter">filter</a></H3><PRE>
+</PRE><H3><a name="h3-filter">filter</a></H3><PRE>
The SVr4 documentation describes the action of <STRONG>filter</STRONG> only
in the vaguest terms. The description here is adapted
from the XSI Curses standard (which erroneously fails to
describe the disabling of <STRONG>cuu</STRONG>).
-</PRE>
-<H3><a name="h3-keyname">keyname</a></H3><PRE>
+</PRE><H3><a name="h3-keyname">keyname</a></H3><PRE>
The <STRONG>keyname</STRONG> function may return the names of user-defined
string capabilities which are defined in the terminfo en-
try via the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>. This implementation auto-
brary.
-</PRE>
-<H3><a name="h3-nofilter_use_tioctl">nofilter/use_tioctl</a></H3><PRE>
+</PRE><H3><a name="h3-nofilter_use_tioctl">nofilter/use_tioctl</a></H3><PRE>
The <STRONG>nofilter</STRONG> and <STRONG>use_tioctl</STRONG> routines are specific to
ncurses. They were not supported on Version 7, BSD or
System V implementations. It is recommended that any code
NCURSES_VERSION.
-</PRE>
-<H3><a name="h3-putwin_getwin">putwin/getwin</a></H3><PRE>
+</PRE><H3><a name="h3-putwin_getwin">putwin/getwin</a></H3><PRE>
The <STRONG>putwin</STRONG> and <STRONG>getwin</STRONG> functions have several issues with
portability:
may not be successful.
-</PRE>
-<H3><a name="h3-unctrl_wunctrl">unctrl/wunctrl</a></H3><PRE>
+</PRE><H3><a name="h3-unctrl_wunctrl">unctrl/wunctrl</a></H3><PRE>
The XSI Curses standard, Issue 4 describes these func-
tions. It states that <STRONG>unctrl</STRONG> and <STRONG>wunctrl</STRONG> will return a
null pointer if unsuccessful, but does not define any er-
"M-^A", etc.
-</PRE>
-<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
<STRONG><A HREF="legacy_coding.3x.html">legacy_coding(3x)</A></STRONG>, <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG>curs_ker-</STRONG>
<STRONG><A HREF="curs_kernel.3x.html">nel(3x)</A></STRONG>, <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG>lega-</STRONG>
<STRONG><A HREF="legacy_coding.3x.html">cy_coding(3x)</A></STRONG>.
projects / ncurses.git / blobdiff