* t
****************************************************************************
* Copyright 2018-2019,2020 Thomas E. Dickey *
* t
****************************************************************************
* Copyright 2018-2019,2020 Thomas E. Dickey *
<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">
<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">
<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
- <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>
+ <B>delay_output</B>, <B>filter</B>, <B>flushinp</B>, <B>getwin</B>, <B>key_name</B>, <B>keyname</B>, <B>nofilter</B>,
+ <B>putwin</B>, <B>unctrl</B>, <B>use_env</B>, <B>use_tioctl</B>, <B>wunctrl</B> - miscellaneous <B>curses</B>
- <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*unctrl(chtype</STRONG> <EM>c</EM><STRONG>);</STRONG>
- <STRONG>wchar_t</STRONG> <STRONG>*wunctrl(cchar_t</STRONG> <STRONG>*</STRONG><EM>c</EM><STRONG>);</STRONG>
+ <B>const</B> <B>char</B> <B>*unctrl(chtype</B> <I>c</I><B>);</B>
+ <B>wchar_t</B> <B>*wunctrl(cchar_t</B> <B>*</B><I>c</I><B>);</B>
- <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*keyname(int</STRONG> <EM>c</EM><STRONG>);</STRONG>
- <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*key_name(wchar_t</STRONG> <EM>w</EM><STRONG>);</STRONG>
+ <B>const</B> <B>char</B> <B>*keyname(int</B> <I>c</I><B>);</B>
+ <B>const</B> <B>char</B> <B>*key_name(wchar_t</B> <I>w</I><B>);</B>
- <STRONG>void</STRONG> <STRONG>use_env(bool</STRONG> <EM>f</EM><STRONG>);</STRONG>
- <STRONG>void</STRONG> <STRONG>use_tioctl(bool</STRONG> <EM>f</EM><STRONG>);</STRONG>
+ <B>void</B> <B>use_env(bool</B> <I>f</I><B>);</B>
+ <B>void</B> <B>use_tioctl(bool</B> <I>f</I><B>);</B>
- <STRONG>int</STRONG> <STRONG>putwin(WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>,</STRONG> <STRONG>FILE</STRONG> <STRONG>*</STRONG><EM>filep</EM><STRONG>);</STRONG>
- <STRONG>WINDOW</STRONG> <STRONG>*getwin(FILE</STRONG> <STRONG>*</STRONG><EM>filep</EM><STRONG>);</STRONG>
+ <B>int</B> <B>putwin(WINDOW</B> <B>*</B><I>win</I><B>,</B> <B>FILE</B> <B>*</B><I>filep</I><B>);</B>
+ <B>WINDOW</B> <B>*getwin(FILE</B> <B>*</B><I>filep</I><B>);</B>
- <STRONG>int</STRONG> <STRONG>delay_output(int</STRONG> <EM>ms</EM><STRONG>);</STRONG>
- <STRONG>int</STRONG> <STRONG>flushinp(void);</STRONG>
+ <B>int</B> <B>delay_output(int</B> <I>ms</I><B>);</B>
+ <B>int</B> <B>flushinp(void);</B>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
</PRE><H3><a name="h3-unctrl">unctrl</a></H3><PRE>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
</PRE><H3><a name="h3-unctrl">unctrl</a></H3><PRE>
- The <STRONG>unctrl</STRONG> routine returns a character string which is a printable rep-
- resentation of the character <EM>c</EM>, ignoring attributes. Control charac-
- ters are displayed in the <STRONG>^</STRONG><EM>X</EM> notation. Printing characters are dis-
- played as is. The corresponding <STRONG>wunctrl</STRONG> returns a printable represen-
+ The <B>unctrl</B> routine returns a character string which is a printable rep-
+ resentation of the character <I>c</I>, ignoring attributes. Control charac-
+ ters are displayed in the <B>^</B><I>X</I> notation. Printing characters are dis-
+ played as is. The corresponding <B>wunctrl</B> returns a printable represen-
- <STRONG>o</STRONG> Values above 128 are either meta characters (if the screen has not
- been initialized, or if <STRONG><A HREF="curs_inopts.3x.html">meta(3x)</A></STRONG> has been called with a <STRONG>TRUE</STRONG> param-
- eter), shown in the <STRONG>M-</STRONG><EM>X</EM> notation, or are displayed as themselves.
+ <B>o</B> Values above 128 are either meta characters (if the screen has not
+ been initialized, or if <B><A HREF="curs_inopts.3X.html">meta(3X)</A></B> has been called with a <B>TRUE</B> param-
+ eter), shown in the <B>M-</B><I>X</I> notation, or are displayed as themselves.
In the latter case, the values may not be printable; this follows
the X/Open specification.
In the latter case, the values may not be printable; this follows
the X/Open specification.
null, to denote an error. X/Open also lists an "UNKNOWN KEY" re-
turn value, which some implementations return rather than null.
null, to denote an error. X/Open also lists an "UNKNOWN KEY" re-
turn value, which some implementations return rather than null.
- The corresponding <STRONG>key_name</STRONG> returns a character string corresponding to
- the wide-character value <EM>w</EM>. The two functions do not return the same
+ The corresponding <B>key_name</B> returns a character string corresponding to
+ the wide-character value <I>w</I>. The two functions do not return the same
set of strings; the latter returns null where the former would display
a meta character.
</PRE><H3><a name="h3-filter_nofilter">filter/nofilter</a></H3><PRE>
set of strings; the latter returns null where the former would display
a meta character.
</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. Calling <STRONG>filter</STRONG> causes these changes in initialization:
+ The <B>filter</B> routine, if used, must be called before <B>initscr</B> or <B>newterm</B>
+ are called. Calling <B>filter</B> causes these changes in initialization:
- <STRONG>o</STRONG> the capabilities <STRONG>clear</STRONG>, <STRONG>cud1</STRONG>, <STRONG>cud</STRONG>, <STRONG>cup</STRONG>, <STRONG>cuu1</STRONG>, <STRONG>cuu</STRONG>, <STRONG>vpa</STRONG> are dis-
+ <B>o</B> the capabilities <B>clear</B>, <B>cud1</B>, <B>cud</B>, <B>cup</B>, <B>cuu1</B>, <B>cuu</B>, <B>vpa</B> are dis-
- using a different value of <STRONG>$TERM</STRONG>. The limitation arises because the
- <STRONG>filter</STRONG> routine modifies the in-memory copy of the terminal information.
+ using a different value of <B>$TERM</B>. The limitation arises because the
+ <B>filter</B> routine modifies the in-memory copy of the terminal information.
- 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 modi-
- fies the way <STRONG>ncurses</STRONG> treats environment variables when determining the
+ The <B>use_env</B> routine, if used, should be called before <B>initscr</B> or
+ <B>newterm</B> are called (because those compute the screen size). It modi-
+ fies the way <B>ncurses</B> treats environment variables when determining the
- If <STRONG>use_env</STRONG> was called with <STRONG>FALSE</STRONG> for parameter, it stops here un-
- less <STRONG>use_tioctl</STRONG> was also called with <STRONG>TRUE</STRONG> for parameter.
+ If <B>use_env</B> was called with <B>FALSE</B> for parameter, it stops here un-
+ less <B>use_tioctl</B> was also called with <B>TRUE</B> for parameter.
- <STRONG>o</STRONG> Finally (unless <STRONG>use_env</STRONG> was called with <STRONG>FALSE</STRONG> parameter), <STRONG>ncurses</STRONG>
- examines the <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> environment variables, using a value
+ <B>o</B> Finally (unless <B>use_env</B> was called with <B>FALSE</B> parameter), <B>ncurses</B>
+ examines the <B>LINES</B> or <B>COLUMNS</B> environment variables, using a value
- <STRONG>Ncurses</STRONG> also updates the screen size in response to <STRONG>SIGWINCH</STRONG>, un-
- less overridden by the <STRONG>LINES</STRONG> or <STRONG>COLUMNS</STRONG> environment variables,
+ <B>Ncurses</B> also updates the screen size in response to <B>SIGWINCH</B>, un-
+ less overridden by the <B>LINES</B> or <B>COLUMNS</B> environment variables,
- 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 argument, <STRONG>ncurses</STRONG> modifies the
+ The <B>use_tioctl</B> routine, if used, should be called before <B>initscr</B> or
+ <B>newterm</B> are called (because those compute the screen size). After
+ <B>use_tioctl</B> is called with <B>TRUE</B> as an argument, <B>ncurses</B> modifies the
- 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 re-
- trieved using the <STRONG>getwin</STRONG> function.
+ The <B>putwin</B> routine writes all data associated with window (or pad) <I>win</I>
+ into the file to which <I>filep</I> points. This information can be later re-
+ trieved using the <B>getwin</B> function.
- The <STRONG>getwin</STRONG> routine reads window related data stored in the file by
- <STRONG>putwin</STRONG>. The routine then creates and initializes a new window using
+ The <B>getwin</B> routine reads window related data stored in the file by
+ <B>putwin</B>. The routine then creates and initializes a new window using
- <STRONG>o</STRONG> the window's character cells contain the color pair <EM>value</EM>, but not
- the actual color <EM>numbers</EM>. If cells in the retrieved window use
+ <B>o</B> the window's character cells contain the color pair <I>value</I>, but not
+ the actual color <I>numbers</I>. If cells in the retrieved window use
This routine should not be used extensively because padding characters
are used rather than a CPU pause. If no padding character is speci-
This routine should not be used extensively because padding characters
are used rather than a CPU pause. If no padding character is speci-
the user and has not yet been read by the program.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
the user and has not yet been read by the program.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- Except for <STRONG>flushinp</STRONG>, routines that return an integer return <STRONG>ERR</STRONG> upon
- failure and <STRONG>OK</STRONG> (SVr4 specifies only "an integer value other than <STRONG>ERR</STRONG>")
+ Except for <B>flushinp</B>, routines that return an integer return <B>ERR</B> upon
+ failure and <B>OK</B> (SVr4 specifies only "an integer value other than <B>ERR</B>")
ror.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
</PRE><H3><a name="h3-filter">filter</a></H3><PRE>
ror.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
</PRE><H3><a name="h3-filter">filter</a></H3><PRE>
- The <STRONG>keyname</STRONG> function may return the names of user-defined string capa-
- bilities which are defined in the terminfo entry via the <STRONG>-x</STRONG> option of
- <STRONG>tic</STRONG>. This implementation automatically assigns at run-time keycodes to
+ The <B>keyname</B> function may return the names of user-defined string capa-
+ bilities which are defined in the terminfo entry via the <B>-x</B> option of
+ <B>tic</B>. This implementation automatically assigns at run-time keycodes to
user-defined strings which begin with "k". The keycodes start at
KEY_MAX, but are not guaranteed to be the same value for different runs
because user-defined codes are merged from all terminal descriptions
user-defined strings which begin with "k". The keycodes start at
KEY_MAX, but are not guaranteed to be the same value for different runs
because user-defined codes are merged from all terminal descriptions
whether this data is loaded when the terminal description is read by
the library.
</PRE><H3><a name="h3-nofilter_use_tioctl">nofilter/use_tioctl</a></H3><PRE>
whether this data is loaded when the terminal description is read by
the library.
</PRE><H3><a name="h3-nofilter_use_tioctl">nofilter/use_tioctl</a></H3><PRE>
tion-specific format. Although the format is an obvious target for
standardization, it has been overlooked.
Interestingly enough, according to the copyright dates in Solaris
tion-specific format. Although the format is an obvious target for
standardization, it has been overlooked.
Interestingly enough, according to the copyright dates in Solaris
the University of California, Berkeley (in 1982) and were later (in
1988) incorporated into SVr4. Oddly, there are no such functions
in the 4.3BSD curses sources.
the University of California, Berkeley (in 1982) and were later (in
1988) incorporated into SVr4. Oddly, there are no such functions
in the 4.3BSD curses sources.
variant of Solaris curses, dated 1995) uses textual dumps.
The implementations which use binary dumps use block-I/O (the
variant of Solaris curses, dated 1995) uses textual dumps.
The implementations which use binary dumps use block-I/O (the
buffered-I/O. A few applications may happen to write extra data in
the file using these functions. Doing that can run into problems
mixing block- and buffered-I/O. This implementation reduces the
buffered-I/O. A few applications may happen to write extra data in
the file using these functions. Doing that can run into problems
mixing block- and buffered-I/O. This implementation reduces the
</PRE><H3><a name="h3-unctrl_wunctrl">unctrl/wunctrl</a></H3><PRE>
The XSI Curses standard, Issue 4 describes these functions. It states
</PRE><H3><a name="h3-unctrl_wunctrl">unctrl/wunctrl</a></H3><PRE>
The XSI Curses standard, Issue 4 describes these functions. It states
- <STRONG>o</STRONG> the parameter is in the range 128-159, i.e., a C1 control code. If
- <STRONG><A HREF="legacy_coding.3x.html">use_legacy_coding(3x)</A></STRONG> has been called with a <STRONG>2</STRONG> parameter, <STRONG>unctrl</STRONG>
+ <B>o</B> the parameter is in the range 128-159, i.e., a C1 control code. If
+ <B><A HREF="legacy_coding.3X.html">use_legacy_coding(3X)</A></B> has been called with a <B>2</B> parameter, <B>unctrl</B>
returns the parameter, i.e., a one-character string with the param-
eter as the first character. Otherwise, it returns "~@", "~A",
etc., analogous to "^@", "^A", C0 controls.
returns the parameter, i.e., a one-character string with the param-
eter as the first character. Otherwise, it returns "~@", "~A",
etc., analogous to "^@", "^A", C0 controls.
initializing curses. This implementation permits that, and returns
the "~@", etc., values in that case.
initializing curses. This implementation permits that, and returns
the "~@", etc., values in that case.
compile time, showing C1 controls from the upper-128 codes with a "~"
prefix rather than "^". Other implementations have different conven-
tions. For example, they may show both sets of control characters with
"^", and strip the parameter to 7 bits. Or they may ignore C1 controls
and treat all of the upper-128 codes as printable. This implementation
uses 8 bits but does not modify the string to reflect locale. The
compile time, showing C1 controls from the upper-128 codes with a "~"
prefix rather than "^". Other implementations have different conven-
tions. For example, they may show both sets of control characters with
"^", and strip the parameter to 7 bits. Or they may ignore C1 controls
and treat all of the upper-128 codes as printable. This implementation
uses 8 bits but does not modify the string to reflect locale. The
- Likewise, the <STRONG><A HREF="curs_inopts.3x.html">meta(3x)</A></STRONG> function allows the caller to change the output
- of <STRONG>keyname</STRONG>, i.e., it determines whether to use the "M-" prefix for
- "meta" keys (codes in the range 128 to 255). Both <STRONG>use_legacy_cod-</STRONG>
- <STRONG><A HREF="use_legacy_coding.3x.html">ing(3x)</A></STRONG> and <STRONG><A HREF="curs_inopts.3x.html">meta(3x)</A></STRONG> succeed only after curses is initialized. X/Open
+ Likewise, the <B><A HREF="curs_inopts.3X.html">meta(3X)</A></B> function allows the caller to change the output
+ of <B>keyname</B>, i.e., it determines whether to use the "M-" prefix for
+ "meta" keys (codes in the range 128 to 255). Both <B>use_legacy_cod-</B>
+ <B><A HREF="use_legacy_coding.3X.html">ing(3X)</A></B> and <B><A HREF="curs_inopts.3X.html">meta(3X)</A></B> succeed only after curses is initialized. X/Open
ing curses), this implementation returns strings "M-^@", "M-^A", etc.
ing curses), this implementation returns strings "M-^@", "M-^A", etc.
- X/Open Curses documents <STRONG>unctrl</STRONG> as declared in <STRONG><unctrl.h></STRONG>, which <STRONG>ncurses</STRONG>
- does. However, <STRONG>ncurses</STRONG>' <STRONG><curses.h></STRONG> includes <STRONG><unctrl.h></STRONG>, matching the
+ X/Open Curses documents <B>unctrl</B> as declared in <B><unctrl.h></B>, which <B>ncurses</B>
+ does. However, <B>ncurses</B>' <B><curses.h></B> includes <B><unctrl.h></B>, matching the
behavior of SVr4 curses. Other implementations may not do that.
</PRE><H3><a name="h3-use_env_use_tioctl">use_env/use_tioctl</a></H3><PRE>
behavior of SVr4 curses. Other implementations may not do that.
</PRE><H3><a name="h3-use_env_use_tioctl">use_env/use_tioctl</a></H3><PRE>
- If <STRONG>ncurses</STRONG> is configured to provide the sp-functions extension, the
- state of <STRONG>use_env</STRONG> and <STRONG>use_tioctl</STRONG> may be updated before creating each
- <EM>screen</EM> rather than once only (<STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG>). This feature of
- <STRONG>use_env</STRONG> is not provided by other implementation of curses.
+ If <B>ncurses</B> is configured to provide the sp-functions extension, the
+ state of <B>use_env</B> and <B>use_tioctl</B> may be updated before creating each
+ <I>screen</I> rather than once only (<B><A HREF="curs_sp_funcs.3X.html">curs_sp_funcs(3X)</A></B>). This feature of
+ <B>use_env</B> is not provided by other implementation of curses.
- <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_inopts.3x.html">curs_inopts(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>,
- <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>, <STRONG><A HREF="curs_sp_funcs.3x.html">curs_sp_funcs(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG>legacy_cod-</STRONG>
- <STRONG><A HREF="legacy_coding.3x.html">ing(3x)</A></STRONG>.
+ <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_inopts.3X.html">curs_inopts(3X)</A></B>, <B><A HREF="curs_kernel.3X.html">curs_kernel(3X)</A></B>,
+ <B><A HREF="curs_scr_dump.3X.html">curs_scr_dump(3X)</A></B>, <B><A HREF="curs_sp_funcs.3X.html">curs_sp_funcs(3X)</A></B>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>, <B>legacy_cod-</B>
+ <B><A HREF="legacy_coding.3X.html">ing(3X)</A></B>.
projects / ncurses.git / blobdiff