Blame - doc/html/man/term_variables.3x.html - android_external_libncurses

Steve Kondik

ae271bc

2015-11-15 02:50:53 +0100

[diff] [blame^]

1

<!--

2

****************************************************************************

3

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.6 2015/04/22 00:34:49 tom Exp @

30

-->

31

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

<HTML>

<HEAD>

<TITLE>term_variables 3x</TITLE>

</HEAD>

<BODY>

<H1 class="no-header">term_variables 3x</H1>

42

<PRE>

43

<A HREF="term_variables.3x.html">term_variables(3x)</A> <A HREF="term_variables.3x.html">term_variables(3x)</A>

</PRE>

SP, acs_map, boolcodes, boolfnames, boolnames, cur_term,

51

numcodes, numfnames, numnames, strcodes, strfnames,

52

strnames, ttytype - curses terminfo global variables

</PRE>

<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>

#include <curses.h>

#include <term.h>

chtype acs_map[];

TERMINAL * cur_term;

char ttytype[];

NCURSES_CONST char * const * boolcodes;

67

NCURSES_CONST char * const * boolfnames;

68

NCURSES_CONST char * const * boolnames;

69

70

NCURSES_CONST char * const * numcodes;

71

NCURSES_CONST char * const * numfnames;

72

NCURSES_CONST char * const * numnames;

73

74

NCURSES_CONST char * const * strcodes;

75

NCURSES_CONST char * const * strfnames;

76

NCURSES_CONST char * const * strnames;

</PRE>

<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>

81

This page summarizes variables provided by the curses li-

82

brary's low-level terminfo interface. A more complete de-

83

scription is given in the <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A> manual page.

84

85

Depending on the configuration, these may be actual vari-

86

ables, or macros (see <A HREF="curs_threads.3x.html">curs_threads(3x)</A>) which provide

87

read-only access to curses's state. In either case, ap-

88

plications should treat them as read-only to avoid confus-

ing the library.

</PRE>

<H3><a name="h3-Alternate-Character-Set-Mapping">Alternate Character Set Mapping</a></H3><PRE>

94

After initializing the curses or terminfo interfaces, the

95

acs_map array holds information used to translate cells

96

with the A_ALTCHARSET video attribute into line-drawing

97

characters.

98

99

The encoding of the information in this array has changed

100

periodically. Application developers need only know that

101

it is used for the "ACS_" constants in <curses.h>.

102

103

The comparable data for the wide-character library is a

private variable.

</PRE>

<H3><a name="h3-Current-Terminal-Data">Current Terminal Data</a></H3><PRE>

109

After initializing the curses or terminfo interfaces, the

110

cur_term contains data describing the current terminal.

111

This variable is also set as a side-effect of <A HREF="curs_initscr.3x.html">curs_initscr(3x)</A>

112

and <A HREF="curs_initscr.3x.html">curs_initscr(3x)</A>.

113

114

It is possible to save a value of cur_term for subsequent

115

use as a parameter to set_term, for switching between

116

screens. Alternatively, one can save the return value

117

from newterm or setupterm to reuse in set_term.

</PRE>

<H3><a name="h3-Terminfo-Names">Terminfo Names</a></H3><PRE>

122

The <A HREF="tic.1m.html">tic(1m)</A> and <A HREF="infocmp.1m.html">infocmp(1m)</A> programs use lookup tables for

123

the long and short names of terminfo capabilities, as well

124

as the corresponding names for termcap capabilities.

125

These are available to other applications, although the

126

hash-tables used by the terminfo and termcap functions are

127

not available.

128

129

The long terminfo capability names use a "l" (ell) in

130

their names: boolfnames, numfnames, and strfnames.

131

132

These are the short names for terminfo capabilities: bool-

133

names, numnames, and strnames.

134

135

These are the corresponding names used for termcap de-

136

scriptions: boolcodes, numcodes, and strcodes.

</PRE>

<H3><a name="h3-Terminal-Type">Terminal Type</a></H3><PRE>

141

On initialization of the curses or terminfo interfaces,

142

setupterm copies the terminal name to the array ttytype.

</PRE>

<H3><a name="h3-Terminfo-Names">Terminfo Names</a></H3><PRE>

147

In addition to the variables, <term.h> also defines a sym-

148

bol for each terminfo capability long name. These are in

149

terms of the symbol CUR, which is defined

150

151

#define CUR cur_term->type.

152

153

These symbols provide a faster method of accessing termin-

154

fo capabilities than using <A HREF="tigetstr.3x.html">tigetstr(3x)</A>, etc.

</PRE>

<H2><a name="h2-NOTES">NOTES</a></H2><PRE>

159

The low-level terminfo interface is initialized using

160

<A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>. The upper-level curses interface uses the

161

low-level terminfo interface, internally.

</PRE>

<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>

166

X/Open Curses does not describe any of these except for

167

cur_term. (The inclusion of cur_term appears to be an

168

oversight, since other comparable low-level information is

169

omitted by X/Open).

170

171

Other implementations may have comparable variables. Some

172

implementations provide the variables in their libraries,

173

but omit them from the header files.

174

175

All implementations which provide terminfo interfaces add

176

definitions as described in the Terminfo Names section.

177

Most, but not all, base the definition upon the cur_term

variable.

</PRE>

<A HREF="ncurses.3x.html">curses(3x)</A>, <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>, <A HREF="curs_threads.3x.html">curs_threads(3x)</A>,

184

<A HREF="terminfo.5.html">terminfo(5)</A>.

<A HREF="term_variables.3x.html">term_variables(3x)</A>

</PRE>

<ul>

<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>

194

<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>

195

<ul>

196

<li><a href="#h3-Alternate-Character-Set-Mapping">Alternate Character Set Mapping</a></li>

197

<li><a href="#h3-Current-Terminal-Data">Current Terminal Data</a></li>

198

<li><a href="#h3-Terminfo-Names">Terminfo Names</a></li>

199

<li><a href="#h3-Terminal-Type">Terminal Type</a></li>

200

<li><a href="#h3-Terminfo-Names">Terminfo Names</a></li>

201

</ul>

202

</li>

203

<li><a href="#h2-NOTES">NOTES</a></li>

204

<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>

</ul>

</div>

</BODY>

</HTML>