doc/html/man/term_variables.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright (c) 2011,2013 Free Software Foundation, Inc.                   *
   4   *                                                                          *
   5   * Permission is hereby granted, free of charge, to any person obtaining a  *
   6   * copy of this software and associated documentation files (the            *
   7   * "Software"), to deal in the Software without restriction, including      *
   8   * without limitation the rights to use, copy, modify, merge, publish,      *
   9   * distribute, distribute with modifications, sublicense, and/or sell       *
  10   * copies of the Software, and to permit persons to whom the Software is    *
  11   * furnished to do so, subject to the following conditions:                 *
  12   *                                                                          *
  13   * The above copyright notice and this permission notice shall be included  *
  14   * in all copies or substantial portions of the Software.                   *
  15   *                                                                          *
  16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23   *                                                                          *
  24   * Except as contained in this notice, the name(s) of the above copyright   *
  25   * holders shall not be used in advertising or otherwise to promote the     *
  26   * sale, use or other dealings in this Software without prior written       *
  27   * authorization.                                                           *
  28   ****************************************************************************
  29   * @Id: term_variables.3x,v 1.4 2013/12/21 22:17:39 tom Exp @
  30 -->
  31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  32 <HTML>
  33 <HEAD>
  34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  36 <TITLE>term_variables 3x</TITLE>
  37 <link rev=made href="mailto:bug-ncurses@gnu.org">
  38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  39 </HEAD>
  40 <BODY>
  41 <H1>term_variables 3x</H1>
  42 <HR>
  43 <PRE>
  44 <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>                                   <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>SP</STRONG>, <STRONG>acs_map</STRONG>, <STRONG>boolcodes</STRONG>, <STRONG>boolfnames</STRONG>, <STRONG>boolnames</STRONG>, <STRONG>cur_term</STRONG>,
  52        <STRONG>numcodes</STRONG>, <STRONG>numfnames</STRONG>, <STRONG>numnames</STRONG>, <STRONG>strcodes</STRONG>, <STRONG>strfnames</STRONG>,
  53        <STRONG>strnames</STRONG>, <STRONG>ttytype</STRONG> - <STRONG>curses</STRONG> terminfo global variables
  54
  55
  56 </PRE>
  57 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  58        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  59        <STRONG>#include</STRONG> <STRONG>&lt;term.h&gt;</STRONG>
  60
  61        <STRONG>chtype</STRONG> <STRONG>acs_map[];</STRONG>
  62        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolcodes;</STRONG>
  63        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolfnames;</STRONG>
  64        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>boolnames;</STRONG>
  65        <STRONG>TERMINAL</STRONG> <STRONG>*</STRONG> <STRONG>cur_term;</STRONG>
  66        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numcodes;</STRONG>
  67        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numfnames;</STRONG>
  68        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>numnames;</STRONG>
  69        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strcodes;</STRONG>
  70        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strfnames;</STRONG>
  71        <STRONG>NCURSES_CONST</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>const</STRONG> <STRONG>*</STRONG> <STRONG>strnames;</STRONG>
  72        <STRONG>char</STRONG> <STRONG>ttytype[];</STRONG>
  73
  74
  75 </PRE>
  76 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  77        This  page summarizes variables provided by the <STRONG>curses</STRONG> li-
  78        brary's low-level terminfo interface.  A more complete de-
  79        scription is given in the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> manual page.
  80
  81        Depending  on the configuration, these may be actual vari-
  82        ables, or  macros  (see  <STRONG><A HREF="curs_threads.3x.html">curs_threads(3x)</A></STRONG>)  which  provide
  83        read-only  access  to <EM>curses</EM>'s state.  In either case, ap-
  84        plications should treat them as read-only to avoid confus-
  85        ing the library.
  86
  87
  88 </PRE>
  89 <H3><a name="h3-Alternate-Character-Set-Mapping">Alternate Character Set Mapping</a></H3><PRE>
  90        After  initializing the curses or terminfo interfaces, the
  91        <STRONG>acs_map</STRONG> array holds information used  to  translate  cells
  92        with  the  <STRONG>A_ALTCHARSET</STRONG>  video attribute into line-drawing
  93        characters.
  94
  95        The encoding of the information in this array has  changed
  96        periodically.   Application developers need only know that
  97        it is used for the "ACS_" constants in &lt;curses.h&gt;.
  98
  99        The comparable data for the wide-character  library  is  a
 100        private variable.
 101
 102
 103 </PRE>
 104 <H3><a name="h3-Current-Terminal-Data">Current Terminal Data</a></H3><PRE>
 105        After  initializing the curses or terminfo interfaces, the
 106        <STRONG>cur_term</STRONG> contains data describing  the  current  terminal.
 107        This variable is also set as a side-effect of <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
 108        and <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>.
 109
 110        It is possible to save a value of <STRONG>cur_term</STRONG> for  subsequent
 111        use  as  a  parameter  to  <STRONG>set_term</STRONG>, for switching between
 112        screens.  Alternatively, one can  save  the  return  value
 113        from <STRONG>newterm</STRONG> or <STRONG>setupterm</STRONG> to reuse in <STRONG>set_term</STRONG>.
 114
 115
 116 </PRE>
 117 <H3><a name="h3-Terminfo-Names">Terminfo Names</a></H3><PRE>
 118        The  <STRONG><A HREF="tic.1m.html">tic(1m)</A></STRONG>  and <STRONG><A HREF="infocmp.1m.html">infocmp(1m)</A></STRONG> programs use lookup tables for
 119        the long and short names of terminfo capabilities, as well
 120        as  the  corresponding  names  for  termcap  capabilities.
 121        These are available  to  other  applications,  though  the
 122        hash-tables are not available.
 123
 124        The  long  terminfo  capability  names  use a "l" (ell) in
 125        their names: boolfnames numfnames strfnames
 126
 127        These are the short names for terminfo capabilities: bool-
 128        names, numnames, and strnames.
 129
 130        These  are  the  corresponding  names used for termcap de-
 131        scriptions: boolcodes, numcodes, and strcodes.
 132
 133
 134 </PRE>
 135 <H3><a name="h3-Terminal-Type">Terminal Type</a></H3><PRE>
 136        On initialization of the curses  or  terminfo  interfaces,
 137        <STRONG>setupterm</STRONG> copies the terminal name to the array <STRONG>ttytype</STRONG>.
 138
 139
 140 </PRE>
 141 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 142        The  low-level  terminfo  interface  is  initialized using
 143        <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>.  The upper-level curses interface uses  the
 144        low-level terminfo interface, internally.
 145
 146
 147 </PRE>
 148 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 149        X/Open  Curses  does  not describe any of these except for
 150        <STRONG>cur_term</STRONG>.  (The inclusion of <STRONG>cur_term</STRONG>  appears  to  be  an
 151        oversight, since other comparable low-level information is
 152        omitted by X/Open).
 153
 154        Other implementations may have comparable variables.  Some
 155        implementations  provide the variables in their libraries,
 156        but omit them from the header files.
 157
 158
 159 </PRE>
 160 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 161        <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>,
 162        <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
 163
 164
 165
 166                                                      <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>
 167 </PRE>
 168 <div class="nav">
 169 <ul>
 170 <li><a href="#h2-NAME">NAME</a></li>
 171 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 172 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 173 <ul>
 174 <li><a href="#h3-Alternate-Character-Set-Mapping">Alternate Character Set Mapping</a></li>
 175 <li><a href="#h3-Current-Terminal-Data">Current Terminal Data</a></li>
 176 <li><a href="#h3-Terminfo-Names">Terminfo Names</a></li>
 177 <li><a href="#h3-Terminal-Type">Terminal Type</a></li>
 178 </ul>
 179 </li>
 180 <li><a href="#h2-NOTES">NOTES</a></li>
 181 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 182 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 183 </ul>
 184 </div>
 185 </BODY>
 186 </HTML>