]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/curs_termattrs.3x.html
projects / ncurses.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
ncurses 6.5 - patch 20240504
[ncurses.git] / doc / html / man / curs_termattrs.3x.html
diff --git a/doc/html/man/curs_termattrs.3x.html b/doc/html/man/curs_termattrs.3x.html
index 5593ed0d3b32398e9131223cff96b2efeacfada5..386b4b4b39a64300377f965d403af4a7dab3198d 100644 (file)
--- a/doc/html/man/curs_termattrs.3x.html
+++ b/doc/html/man/curs_termattrs.3x.html
@@ -1,6 +1,6 @@
 <!--
   ****************************************************************************
 <!--
   ****************************************************************************
-  * Copyright 2018,2020 Thomas E. Dickey                                     *
+  * Copyright 2018-2023,2024 Thomas E. Dickey                                *
   * Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
   * Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
   *                                                                          *
   * Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,129 +27,129 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_termattrs.3x,v 1.15 2020/02/02 23:34:34 tom Exp @
+  * @Id: curs_termattrs.3x,v 1.41 2024/04/20 21:20:07 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">
 -->
 <!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</TITLE>
+<TITLE>curs_termattrs 3x 2024-04-20 ncurses 6.5 Library calls</TITLE>
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
 <link rel="author" href="mailto:bug-ncurses@gnu.org">
-<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+
 </HEAD>
 <BODY>
 </HEAD>
 <BODY>
-<H1 class="no-header">curs_termattrs 3X</H1>
+<H1 class="no-header">curs_termattrs 3x 2024-04-20 ncurses 6.5 Library calls</H1>
 <PRE>
 <PRE>
-<B><A HREF="curs_termattrs.3X.html">curs_termattrs(3X)</A></B>                                          <B><A HREF="curs_termattrs.3X.html">curs_termattrs(3X)</A></B>
+<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>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <B>baudrate</B>,  <B>erasechar</B>,  <B>erasewchar</B>, <B>has_ic</B>, <B>has_il</B>, <B>killchar</B>, <B>killwchar</B>,
-       <B>longname</B>, <B>term_attrs</B>, <B>termattrs</B>, <B>termname</B> -  <B>curses</B>  environment  query
+       <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> -  <EM>curses</EM>  environment  query
        routines
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
        routines
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
-       <B>#include</B> <B>&lt;curses.h&gt;</B>
+       <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
 
 
-       <B>int</B> <B>baudrate(void);</B>
-       <B>char</B> <B>erasechar(void);</B>
-       <B>int</B> <B>erasewchar(wchar_t</B> <B>*</B><I>ch</I><B>);</B>
-       <B>bool</B> <B>has_ic(void);</B>
-       <B>bool</B> <B>has_il(void);</B>
-       <B>char</B> <B>killchar(void);</B>
-       <B>int</B> <B>killwchar(wchar_t</B> <B>*</B><I>ch</I><B>);</B>
-       <B>char</B> <B>*longname(void);</B>
-       <B>attr_t</B> <B>term_attrs(void);</B>
-       <B>chtype</B> <B>termattrs(void);</B>
-       <B>char</B> <B>*termname(void);</B>
+       <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>*longname(void);</STRONG>
+       <STRONG>attr_t</STRONG> <STRONG>term_attrs(void);</STRONG>
+       <STRONG>chtype</STRONG> <STRONG>termattrs(void);</STRONG>
+       <STRONG>char</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>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
 
 </PRE><H3><a name="h3-baudrate">baudrate</a></H3><PRE>
-       The  <B>baudrate</B>  routine  returns  the output speed of the terminal.  The
-       number returned is in bits per second, for  example  <B>9600</B>,  and  is  an
+       The  <STRONG>baudrate</STRONG>  routine  returns  the output speed of the terminal.  The
+       number returned is in bits per second, for  example  <STRONG>9600</STRONG>,  and  is  an
        integer.
 
 
        integer.
 
 
-</PRE><H3><a name="h3-erasechar_-erasewchar">erasechar, erasewchar</a></H3><PRE>
-       The <B>erasechar</B> routine returns the user's current erase character.
+</PRE><H3><a name="h3-erasechar_erasewchar">erasechar, erasewchar</a></H3><PRE>
+       The <STRONG>erasechar</STRONG> routine returns the user's current erase character.
 
 
-       The  <B>erasewchar</B>  routine  stores  the  current  erase  character in the
-       location referenced by <I>ch</I>.  If no erase character has been defined, the
-       routine fails and the location referenced by <I>ch</I> is not changed.
+       The  <STRONG>erasewchar</STRONG>  routine  stores  the  current  erase  character in the
+       location referenced by <EM>wc</EM>.  If no erase character has been defined, the
+       routine fails and the location referenced by <EM>wc</EM> is not changed.
 
 
 
 
-</PRE><H3><a name="h3-has_is_-has_il">has_is, has_il</a></H3><PRE>
-       The  <B>has_ic</B>  routine  is  true  if the terminal has insert- and delete-
+</PRE><H3><a name="h3-has_ic_has_il">has_ic, has_il</a></H3><PRE>
+       The  <STRONG>has_ic</STRONG>  routine  is  true  if the terminal has insert- and delete-
        character capabilities.
 
        character capabilities.
 
-       The <B>has_il</B> routine is true if the terminal has insert- and  delete-line
+       The <STRONG>has_il</STRONG> routine is true if the terminal has insert- and  delete-line
        capabilities, or can simulate them using scrolling regions.  This might
        be used to determine if it would be appropriate  to  turn  on  physical
        capabilities, or can simulate them using scrolling regions.  This might
        be used to determine if it would be appropriate  to  turn  on  physical
-       scrolling using <B>scrollok</B>.
+       scrolling using <STRONG><A HREF="scrollok.3x.html">scrollok(3x)</A></STRONG>.
 
 
 
 
-</PRE><H3><a name="h3-killchar_-killwchar">killchar, killwchar</a></H3><PRE>
-       The <B>killchar</B> routine returns the user's current line kill character.
+</PRE><H3><a name="h3-killchar_killwchar">killchar, killwchar</a></H3><PRE>
+       The <STRONG>killchar</STRONG> routine returns the user's current line kill character.
 
 
-       The  <B>killwchar</B>  routine  stores  the current line-kill character in the
-       location referenced by <I>ch</I>.  If no line-kill character has been defined,
-       the routine fails and the location referenced by <I>ch</I> is not changed.
+       The  <STRONG>killwchar</STRONG>  routine  stores  the current line-kill character in the
+       location referenced by <EM>wc</EM>.  If no line-kill character has been defined,
+       the routine fails and the location referenced by <EM>wc</EM> is not changed.
 
 
 </PRE><H3><a name="h3-longname">longname</a></H3><PRE>
 
 
 </PRE><H3><a name="h3-longname">longname</a></H3><PRE>
-       The  <B>longname</B>  routine  returns a pointer to a static area containing a
+       The  <STRONG>longname</STRONG>  routine  returns a pointer to a static area containing a
        verbose description of the current terminal.  The maximum length  of  a
        verbose  description  is  128 characters.  It is defined only after the
        verbose description of the current terminal.  The maximum length  of  a
        verbose  description  is  128 characters.  It is defined only after the
-       call to <B>initscr</B> or <B>newterm</B>.  The area is overwritten by  each  call  to
-       <B>newterm</B>  and  is not restored by <B>set_term</B>, so the value should be saved
-       between calls to <B>newterm</B> if <B>longname</B> is going to be used with  multiple
+       call to <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>.  The area is overwritten by  each  call  to
+       <STRONG>newterm</STRONG>  and  is not restored by <STRONG>set_term</STRONG>, so the value should be saved
+       between calls to <STRONG>newterm</STRONG> if <STRONG>longname</STRONG> is going to be used with  multiple
        terminals.
 
 
        terminals.
 
 
-</PRE><H3><a name="h3-termattrs_-term_attrs">termattrs, term_attrs</a></H3><PRE>
+</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
        If  a  given  terminal  does  not  support  a  video  attribute that an
-       application program is trying to use, <B>curses</B> may substitute a different
-       video  attribute for it.  The <B>termattrs</B> and <B>term_attrs</B> functions return
-       a logical <B>OR</B> of all video attributes supported by the terminal using <I>A</I><B>_</B>
-       and  <I>WA</I><B>_</B>  constants  respectively.   This  information is useful when a
-       <B>curses</B> program needs  complete  control  over  the  appearance  of  the
+       application program is trying to use, <STRONG>curses</STRONG> may substitute a different
+       video  attribute for it.  The <STRONG>termattrs</STRONG> and <STRONG>term_attrs</STRONG> functions return
+       a logical <STRONG>OR</STRONG> of all video attributes supported by the terminal using <STRONG>A_</STRONG>
+       and  <STRONG>WA_</STRONG>  constants  respectively.   This  information is useful when a
+       <STRONG>curses</STRONG> program needs  complete  control  over  the  appearance  of  the
        screen.
 
 
 </PRE><H3><a name="h3-termname">termname</a></H3><PRE>
        screen.
 
 
 </PRE><H3><a name="h3-termname">termname</a></H3><PRE>
-       The <B>termname</B> routine returns the terminal name used by <B>setupterm</B>.
+       The <STRONG>termname</STRONG> routine returns the terminal name used by <STRONG>setupterm</STRONG>.
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
-       <B>longname</B> and <B>termname</B> return <B>NULL</B> on error.
+       <STRONG>longname</STRONG> and <STRONG>termname</STRONG> return <STRONG>NULL</STRONG> on error.
 
 
-       Routines  that  return  an integer return <B>ERR</B> upon failure and <B>OK</B> (SVr4
-       only specifies "an integer  value  other  than  <B>ERR</B>")  upon  successful
+       Routines  that  return  an integer return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4
+       only specifies "an integer  value  other  than  <STRONG>ERR</STRONG>")  upon  successful
        completion.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
        completion.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
-       Note that <B>termattrs</B> may be a macro.
+       Note that <STRONG>termattrs</STRONG> may be a macro.
 
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
-       The XSI Curses standard, Issue 4 describes these functions.  It changes
-       the return type of <B>termattrs</B> to the new type <B>attr_t</B>.  Most versions  of
-       curses truncate the result returned by <B>termname</B> to 14 characters.
+       X/Open  Curses,  Issue  4  describes  these  functions.  It changes the
+       return type of <STRONG>termattrs</STRONG> to the new  type  <STRONG>attr_t</STRONG>.   Most  versions  of
+       curses truncate the result returned by <STRONG>termname</STRONG> to 14 characters.
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 
 
 </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>
+       <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>
 
 
 
 
 
 
-                                                            <B><A HREF="curs_termattrs.3X.html">curs_termattrs(3X)</A></B>
+ncurses 6.5                       2024-04-20                <STRONG><A HREF="curs_termattrs.3x.html">curs_termattrs(3x)</A></STRONG>
 </PRE>
 <div class="nav">
 <ul>
 </PRE>
 <div class="nav">
 <ul>
@@ -158,11 +158,11 @@
 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 <ul>
 <li><a href="#h3-baudrate">baudrate</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_is_-has_il">has_is, has_il</a></li>
-<li><a href="#h3-killchar_-killwchar">killchar, killwchar</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-longname">longname</a></li>
-<li><a href="#h3-termattrs_-term_attrs">termattrs, term_attrs</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="#h3-termname">termname</a></li>
 </ul>
 </li>
ncurses, with patches starting at ncurses-5.6; new users should use https://github.com/ThomasDickey/ncurses-snapshots/