Files
RedBear-OS/recipes/libs/ncurses/source/doc/html/man/curs_termattrs.3x.html
T
vasilito ff4ff35918 feat: track all source trees in git — full fork offline-first model
Red Bear OS is a full fork. All sources must be available from git clone
with zero network access. Removed gitignore rules that excluded fetched
source trees under recipes/*/source/, local/recipes/kde/*/source/,
local/recipes/qt/*/source/, and vendor source trees.

Build artifacts (target/, build/, source.tar, *.o, *.so) remain excluded.

127291 files added — kernel, relibc, base, bootloader, pkgar, all KDE/Qt
frameworks, mesa, wayland, DRM drivers, and every other recipe source.
2026-05-14 10:55:53 +01:00

191 lines
10 KiB
HTML

<!--
****************************************************************************
* Copyright 2018-2024,2025 Thomas E. Dickey *
* Copyright 1998-2010,2015 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_termattrs.3x,v 1.61 2025/08/23 22:39:20 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 https://invisible-island.net/scripts/readme.html#others_scripts">
<TITLE>curs_termattrs 3x 2025-08-23 ncurses 6.6 Library calls</TITLE>
<link rel="author" href="mailto:bug-ncurses@gnu.org">
</HEAD>
<BODY>
<H1 class="no-header">curs_termattrs 3x 2025-08-23 ncurses 6.6 Library calls</H1>
<PRE>
<STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG> Library calls <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
<STRONG>baudrate</STRONG>, <STRONG>erasechar</STRONG>, <STRONG>erasewchar</STRONG>, <STRONG>has_ic</STRONG>, <STRONG>has_il</STRONG>, <STRONG>killchar</STRONG>, <STRONG>killwchar</STRONG>,
<STRONG>longname</STRONG>, <STRONG>term_attrs</STRONG>, <STRONG>termattrs</STRONG>, <STRONG>termname</STRONG> - get and set terminal
attributes with <EM>curses</EM>
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
<STRONG>int</STRONG> <STRONG>baudrate(void);</STRONG>
<STRONG>char</STRONG> <STRONG>erasechar(void);</STRONG>
<STRONG>int</STRONG> <STRONG>erasewchar(wchar_t</STRONG> <STRONG>*</STRONG> <EM>wc</EM><STRONG>);</STRONG>
<STRONG>bool</STRONG> <STRONG>has_ic(void);</STRONG>
<STRONG>bool</STRONG> <STRONG>has_il(void);</STRONG>
<STRONG>char</STRONG> <STRONG>killchar(void);</STRONG>
<STRONG>int</STRONG> <STRONG>killwchar(wchar_t</STRONG> <STRONG>*</STRONG> <EM>wc</EM><STRONG>);</STRONG>
<STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>longname(void);</STRONG>
<STRONG>attr_t</STRONG> <STRONG>term_attrs(void);</STRONG>
<STRONG>chtype</STRONG> <STRONG>termattrs(void);</STRONG>
<STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>termname(void);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
</PRE><H3><a name="h3-baudrate">baudrate</a></H3><PRE>
<STRONG>baudrate</STRONG> returns the line speed of the terminal, an integer value
measured in bits per second, for example <STRONG>9600</STRONG>.
</PRE><H3><a name="h3-erasechar_erasewchar">erasechar, erasewchar</a></H3><PRE>
<STRONG>erasechar</STRONG> returns the terminal's erase character.
<STRONG>erasewchar</STRONG> stores the erase character in the location referenced by <EM>wc</EM>.
If no erase character has been defined, it fails and the location
referenced by <EM>wc</EM> is not changed.
</PRE><H3><a name="h3-has_ic_has_il">has_ic, has_il</a></H3><PRE>
<STRONG>has_ic</STRONG> returns <STRONG>TRUE</STRONG> if the terminal has insert- and delete-character
capabilities.
<STRONG>has_il</STRONG> returns <STRONG>TRUE</STRONG> if the terminal has insert- and delete-line
capabilities, or can simulate them using scrolling regions. It might
be used to determine whether it would be appropriate to use
<STRONG><A HREF="scrollok.3x.html">scrollok(3x)</A></STRONG> to turn on scrolling.
</PRE><H3><a name="h3-killchar_killwchar">killchar, killwchar</a></H3><PRE>
<STRONG>killchar</STRONG> returns the terminal's line kill character.
<STRONG>killwchar</STRONG> stores the line-kill character in the location referenced by
<EM>wc</EM>. If no line-kill character has been defined, it fails and the
location referenced by <EM>wc</EM> is not changed.
</PRE><H3><a name="h3-longname">longname</a></H3><PRE>
<STRONG>longname</STRONG> returns a pointer to static storage containing a verbose
description of the terminal being managed by <EM>curses</EM>. The maximum
length of a verbose description is 128 characters. The storage is
populated only after <STRONG><A HREF="curs_initscr.3x.html">initscr(3x)</A></STRONG> or <STRONG><A HREF="curs_initscr.3x.html">newterm(3x)</A></STRONG> is called. This
storage is overwritten by each call to <STRONG>newterm</STRONG> and not restored by
<STRONG><A HREF="curs_initscr.3x.html">set_term(3x)</A></STRONG>, so its contents should be saved between calls to <STRONG>initscr</STRONG>
or <STRONG>newterm</STRONG> if <STRONG>longname</STRONG> is to be used with multiple terminals.
</PRE><H3><a name="h3-termattrs_term_attrs">termattrs, term_attrs</a></H3><PRE>
If a given terminal does not support a video attribute that an
application program is trying to use, <EM>curses</EM> may substitute a different
video attribute for it. <STRONG>termattrs</STRONG> and <STRONG>term_attrs</STRONG> return a logical "or"
of all video attributes supported by the terminal using <STRONG>A_</STRONG> and <STRONG>WA_</STRONG>
constants respectively. This information is useful when a <EM>curses</EM>
program needs complete control over the appearance of the screen.
</PRE><H3><a name="h3-termname">termname</a></H3><PRE>
<STRONG>termname</STRONG> returns the terminal name used by <STRONG><A HREF="curs_terminfo.3x.html">setupterm(3x)</A></STRONG>.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
<STRONG>longname</STRONG> and <STRONG>termname</STRONG> return <EM>NULL</EM> on error.
Functions that return an integer return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> upon
success.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
<STRONG>erasewchar</STRONG>, <STRONG>killwchar</STRONG>, and <STRONG>term_attrs</STRONG> are part of <EM>ncurses</EM>'s wide-
character API, and are not available in its non-wide-character
configuration.
<STRONG>termattrs</STRONG> may be implemented as a macro.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
X/Open Curses Issue 4 describes these functions.
SVr4 describes a successful return value only as "an integer value
other than <EM>ERR</EM>".
Most versions of <EM>curses</EM> truncate the string returned by <EM>termname</EM> to 14
characters.
</PRE><H2><a name="h2-HISTORY">HISTORY</a></H2><PRE>
4BSD (1980) introduced <EM>longname</EM>.
SVr2 (1984) added <EM>baudrate</EM>, <EM>erasechar</EM>, <EM>killchar</EM>, <EM>has</EM><STRONG>_</STRONG><EM>ic</EM>, and <EM>has</EM><STRONG>_</STRONG><EM>il</EM>.
SVr3 (1987) supplied <EM>termname</EM>. Later that year, SVr3.1 brought
<EM>termattrs</EM>.
X/Open Curses Issue 4 (1995) specified <EM>erasewchar</EM>, <EM>killwchar</EM>, and
<EM>term</EM><STRONG>_</STRONG><EM>attrs</EM>.
</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>
ncurses 6.6 2025-08-23 <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
</PRE>
<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>
<ul>
<li><a href="#h3-baudrate">baudrate</a></li>
<li><a href="#h3-erasechar_erasewchar">erasechar, erasewchar</a></li>
<li><a href="#h3-has_ic_has_il">has_ic, has_il</a></li>
<li><a href="#h3-killchar_killwchar">killchar, killwchar</a></li>
<li><a href="#h3-longname">longname</a></li>
<li><a href="#h3-termattrs_term_attrs">termattrs, term_attrs</a></li>
<li><a href="#h3-termname">termname</a></li>
</ul>
</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-HISTORY">HISTORY</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
</ul>
</div>
</BODY>
</HTML>