1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 1998-2000,2002 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: curs_termattrs.3x,v 1.8 2002/05/11 21:32:26 tom Exp @
34 <TITLE>curs_termattrs 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 <H1>curs_termattrs 3x</H1>
42 <!-- Manpage converted by man2html 3.0.1 -->
46 <STRONG>baudrate</STRONG>, <STRONG>erasechar</STRONG>, <STRONG>erasewchar</STRONG>, <STRONG>has_ic</STRONG>, <STRONG>has_il</STRONG>, <STRONG>killchar</STRONG>,
47 <STRONG>killwchar</STRONG>, <STRONG>longname</STRONG>, <STRONG>term_attrs</STRONG>, <STRONG>termattrs</STRONG>, <STRONG>termname</STRONG> -
48 <STRONG>curses</STRONG> environment query routines
52 <H2>SYNOPSIS</H2><PRE>
53 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
55 <STRONG>int</STRONG> <STRONG>baudrate(void);</STRONG>
56 <STRONG>char</STRONG> <STRONG>erasechar(void);</STRONG>
57 <STRONG>int</STRONG> <STRONG>erasewchar(wchar_t</STRONG> <STRONG>*</STRONG><EM>ch</EM><STRONG>);</STRONG>
58 <STRONG>bool</STRONG> <STRONG>has_ic(void);</STRONG>
59 <STRONG>bool</STRONG> <STRONG>has_il(void);</STRONG>
60 <STRONG>char</STRONG> <STRONG>killchar(void);</STRONG>
61 <STRONG>int</STRONG> <STRONG>killwchar(wchar_t</STRONG> <STRONG>*</STRONG><EM>ch</EM><STRONG>);</STRONG>
62 <STRONG>char</STRONG> <STRONG>*longname(void);</STRONG>
63 <STRONG>attr_t</STRONG> <STRONG>term_attrs(void);</STRONG>
64 <STRONG>chtype</STRONG> <STRONG>termattrs(void);</STRONG>
65 <STRONG>char</STRONG> <STRONG>*termname(void);</STRONG>
69 <H2>DESCRIPTION</H2><PRE>
70 The <STRONG>baudrate</STRONG> routine returns the output speed of the ter-
71 minal. The number returned is in bits per second, for
72 example <STRONG>9600</STRONG>, and is an integer.
74 The <STRONG>erasechar</STRONG> routine returns the user's current erase
77 The <STRONG>erasewchar</STRONG> routine stores the current erase character
78 in the location referenced by <EM>ch</EM>. If no erase character
79 has been defined, the routine fails and the location ref-
80 erenced by <EM>ch</EM> is not changed.
82 The <STRONG>has_ic</STRONG> routine is true if the terminal has insert- and
83 delete- character capabilities.
85 The <STRONG>has_il</STRONG> routine is true if the terminal has insert- and
86 delete-line capabilities, or can simulate them using
87 scrolling regions. This might be used to determine if it
88 would be appropriate to turn on physical scrolling using
89 <STRONG>scrollok</STRONG>.
91 The <STRONG>killchar</STRONG> routine returns the user's current line kill
94 The <STRONG>killwchar</STRONG> routine stores the current line-kill charac-
95 ter in the location referenced by <EM>ch</EM>. If no line-kill
96 character has been defined, the routine fails and the
97 location referenced by <EM>ch</EM> is not changed.
99 The <STRONG>longname</STRONG> routine returns a pointer to a static area
100 containing a verbose description of the current terminal.
101 The maximum length of a verbose description is 128 charac-
102 ters. It is defined only after the call to <STRONG>initscr</STRONG> or
103 <STRONG>newterm</STRONG>. The area is overwritten by each call to <STRONG>newterm</STRONG>
104 and is not restored by <STRONG>set_term</STRONG>, so the value should be
105 saved between calls to <STRONG>newterm</STRONG> if <STRONG>longname</STRONG> is going to be
106 used with multiple terminals.
108 If a given terminal doesn't support a video attribute that
109 an application program is trying to use, <STRONG>curses</STRONG> may sub-
110 stitute a different video attribute for it. The <STRONG>termattrs</STRONG>
111 and <STRONG>term_attrs</STRONG> functions return a logical <STRONG>OR</STRONG> of all video
112 attributes supported by the terminal using <EM>A</EM><STRONG>_</STRONG> and <EM>WA</EM><STRONG>_</STRONG> con-
113 stants respectively. This information is useful when a
114 <STRONG>curses</STRONG> program needs complete control over the appearance
117 The <STRONG>termname</STRONG> routine returns the value of the environmen-
118 tal variable <STRONG>TERM</STRONG> (truncated to 14 characters).
122 <H2>RETURN VALUE</H2><PRE>
123 <STRONG>longname</STRONG> and <STRONG>termname</STRONG> return <STRONG>NULL</STRONG> on error.
125 Routines that return an integer return <STRONG>ERR</STRONG> upon failure
126 and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
127 <STRONG>ERR</STRONG>") upon successful completion.
132 Note that <STRONG>termattrs</STRONG> may be a macro.
136 <H2>PORTABILITY</H2><PRE>
137 The XSI Curses standard, Issue 4 describes these func-
138 tions. It changes the return type of <STRONG>termattrs</STRONG> to the new
139 type <STRONG>attr_t</STRONG>.
143 <H2>SEE ALSO</H2><PRE>
144 <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>
168 Man(1) output converted with
169 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>