diff options
Diffstat (limited to 'doc/html/man/term_variables.3x.html')
| -rw-r--r-- | doc/html/man/term_variables.3x.html | 165 |
1 files changed, 165 insertions, 0 deletions
diff --git a/doc/html/man/term_variables.3x.html b/doc/html/man/term_variables.3x.html new file mode 100644 index 000000000000..bc1f9baba8b4 --- /dev/null +++ b/doc/html/man/term_variables.3x.html @@ -0,0 +1,165 @@ +<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN"> +<!-- + **************************************************************************** + * Copyright (c) 2010 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: term_variables.3x,v 1.2 2010/12/04 18:38:55 tom Exp @ +--> +<HTML> +<HEAD> +<TITLE>term_variables 3x</TITLE> +<link rev=made href="mailto:bug-ncurses@gnu.org"> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</HEAD> +<BODY> +<H1>term_variables 3x</H1> +<HR> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> +<STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG> <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG> + + + + +</PRE> +<H2>NAME</H2><PRE> + <STRONG>SP</STRONG>, <STRONG>acs_map</STRONG>, <STRONG>boolcodes</STRONG>, <STRONG>boolfnames</STRONG>, <STRONG>boolnames</STRONG>, <STRONG>cur_term</STRONG>, + <STRONG>numcodes</STRONG>, <STRONG>numfnames</STRONG>, <STRONG>numnames</STRONG>, <STRONG>strcodes</STRONG>, <STRONG>strfnames</STRONG>, + <STRONG>strnames</STRONG>, <STRONG>ttytype</STRONG> - <STRONG>curses</STRONG> terminfo global variables + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> + <STRONG>#include</STRONG> <STRONG><term.h></STRONG> + + <STRONG>chtype</STRONG> <STRONG>acs_map[];</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolcodes;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolfnames;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolnames;</STRONG> + <STRONG>TERMINAL</STRONG> <STRONG>*</STRONG> <STRONG>cur_term;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numcodes;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numfnames;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numnames;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strcodes;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strfnames;</STRONG> + <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strnames;</STRONG> + <STRONG>char</STRONG> <STRONG>ttytype[];</STRONG> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + This page summarizes variables provided by the <STRONG>curses</STRONG> li- + brary's low-level terminfo interface. A more complete de- + scription is given in the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> manual page. + + Depending on the configuration, these may be actual vari- + ables, or macros (see <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>) which provide + read-only access to <EM>curses</EM>'s state. In either case, ap- + plications should treat them as read-only to avoid confus- + ing the library. + + <STRONG>Alternate</STRONG> <STRONG>Character</STRONG> <STRONG>Set</STRONG> <STRONG>Mapping</STRONG> + After initializing the curses or terminfo interfaces, the + <STRONG>acs_map</STRONG> array holds information used to translate cells + with the <STRONG>A_ALTCHARSET</STRONG> video attribute into line-drawing + characters. + + The encoding of the information in this array has changed + periodically. Application developers need only know that + it is used for the "ACS_" constants in <curses.h>. + + The comparable data for the wide-character library is a + private variable. + + <STRONG>Current</STRONG> <STRONG>Terminal</STRONG> <STRONG>Data</STRONG> + After initializing the curses or terminfo interfaces, the + <STRONG>cur_term</STRONG> contains data describing the current terminal. + This variable is also set as a side-effect of <STRONG><A HREF="set_term.3x.html">set_term(3x)</A></STRONG> + and <STRONG><A HREF="delscreen.3x.html">delscreen(3x)</A></STRONG>. + + It is possible to save a value of <STRONG>cur_term</STRONG> for subsequent + use as a parameter to <STRONG>set_term</STRONG>, for switching between + screens. Alternatively, one can save the return value + from <STRONG>newterm</STRONG> or <STRONG>setupterm</STRONG> to reuse in <STRONG>set_term</STRONG>. + + <STRONG>Terminfo</STRONG> <STRONG>Names</STRONG> + The <STRONG><A HREF="tic.1.html">tic(1)</A></STRONG> and <STRONG><A HREF="infocmp.1.html">infocmp(1)</A></STRONG> programs use lookup tables for + the long and short names of terminfo capabilities, as well + as the corresponding names for termcap capabilities. + These are available to other applications, though the + hash-tables are not available. + + The long terminfo capability names use a "l" (ell) in + their names: boolfnames numfnames strfnames + + These are the short names for terminfo capabilities: bool- + names, numnames, and strnames. + + These are the corresponding names used for termcap de- + scriptions: boolcodes, numcodes, and strcodes. + + <STRONG>Terminal</STRONG> <STRONG>Type</STRONG> + On initialization of the curses or terminfo interfaces, + <STRONG>setupterm</STRONG> copies the terminal name to the array <STRONG>ttytype</STRONG>. + + +</PRE> +<H2>NOTES</H2><PRE> + The low-level terminfo interface is initialized using <STRONG>se-</STRONG> + <STRONG><A HREF="setupterm.3x.html">tupterm(3x)</A></STRONG>. The upper-level curses interface uses the + low-level terminfo interface, internally. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + X/Open Curses does not describe any of these except for + <STRONG>cur_term</STRONG>. (The inclusion of <STRONG>cur_term</STRONG> appears to be an + oversight, since other comparable low-level information is + omitted by X/Open). + + Other implementations may have comparable variables. Some + implementations provide the variables in their libraries, + but omit them from the header files. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>, <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>, <STRONG>termin-</STRONG> + <STRONG><A HREF="terminfo.3x.html">fo(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>. + + + + <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG> +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |