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

Amit Daniel Kachhap

e6a01f5

2011-07-20 11:45:59 +0530

[diff] [blame^]

1

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">

2

<!--

3

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

4

5

* *

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: *

13

* *

14

* The above copyright notice and this permission notice shall be included *

15

* in all copies or substantial portions of the Software. *

16

* *

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. *

24

* *

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 *

28

* authorization. *

29

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

30

* @Id: curs_termcap.3x,v 1.22 2007/06/02 20:40:07 tom Exp @

-->

<HTML>

<HEAD>

<TITLE>curs_termcap 3x</TITLE>

</HEAD>

<BODY>

<H1>curs_termcap 3x</H1>

40

<HR>

41

<PRE>

42

43

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

</PRE>

tgetent, tgetflag, tgetnum, tgetstr, tgoto, tputs - direct

51

curses interface to the terminfo capability database

</PRE>

<H2>SYNOPSIS</H2><PRE>

#include <curses.h>

#include <term.h>

extern char PC;

extern char * UP;

extern char * BC;

extern short ospeed;

int tgetent(char *bp, const char *name);

65

int tgetflag(char *id);

66

int tgetnum(char *id);

67

char *tgetstr(char *id, char **area);

68

char *tgoto(const char *cap, int col, int row);

69

int tputs(const char *str, int affcnt, int (*putc)(int));

</PRE>

<H2>DESCRIPTION</H2><PRE>

74

These routines are included as a conversion aid for pro-

75

grams that use the termcap library. Their parameters are

76

the same and the routines are emulated using the terminfo

77

database. Thus, they can only be used to query the capa-

78

bilities of entries for which a terminfo entry has been

79

compiled.

80

81

The tgetent routine loads the entry for name. It returns

82

1 on success, 0 if there is no such entry, and -1 if the

83

terminfo database could not be found. The emulation

84

ignores the buffer pointer bp.

85

86

The tgetflag routine gets the boolean entry for id, or

87

zero if it is not available.

88

89

The tgetnum routine gets the numeric entry for id, or -1

90

if it is not available.

91

92

The tgetstr routine returns the string entry for id, or

93

zero if it is not available. Use tputs to output the

94

returned string. The return value will also be copied to

95

the buffer pointed to by area, and the area value will be

96

updated to point past the null ending this value.

97

98

Only the first two characters of the id parameter of tget-

99

flag, tgetnum and tgetstr are compared in lookups.

100

101

The tgoto routine instantiates the parameters into the

102

given capability. The output from this routine is to be

103

passed to tputs.

104

105

The tputs routine is described on the <A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A>

106

manual page. It can retrieve capabilities by either term-

107

cap or terminfo name.

108

109

The variables PC, UP and BC are set by tgetent to the ter-

110

minfo entry's data for pad_char, cursor_up and

111

backspace_if_not_bs, respectively. UP is not used by

112

ncurses. PC is used in the tdelay_output function. BC is

113

used in the tgoto emulation. The variable ospeed is set

114

by ncurses in a system-specific coding to reflect the

terminal speed.

</PRE>

<H2>RETURN VALUE</H2><PRE>

120

Except where explicitly noted, routines that return an

121

integer return ERR upon failure and OK (SVr4 only speci-

122

fies "an integer value other than ERR") upon successful

123

completion.

124

125

Routines that return pointers return NULL on error.

</PRE>

If you call tgetstr to fetch ca or any other parameterized

131

string, be aware that it will be returned in terminfo

132

notation, not the older and not-quite-compatible termcap

133

notation. This will not cause problems if all you do with

134

it is call tgoto or tparm, which both expand terminfo-

135

style strings as terminfo. (The tgoto function, if con-

136

figured to support termcap, will check if the string is

137

indeed terminfo-style by looking for "%p" parameters or

138

"$<..>" delays, and invoke a termcap-style parser if the

139

string does not appear to be terminfo).

140

141

Because terminfo conventions for representing padding in

142

string capabilities differ from termcap's, tputs("50");

143

will put out a literal "50" rather than busy-waiting for

144

50 milliseconds. Cope with it.

145

146

Note that termcap has nothing analogous to terminfo's sgr

147

string. One consequence of this is that termcap applica-

148

tions assume me (terminfo sgr0) does not reset the alter-

149

nate character set. This implementation checks for, and

150

modifies the data shown to the termcap interface to accom-

151

modate termcap's limitation in this respect.

</PRE>

<H2>PORTABILITY</H2><PRE>

156

The XSI Curses standard, Issue 4 describes these func-

157

tions. However, they are marked TO BE WITHDRAWN and may

158

be removed in future versions.

159

160

Neither the XSI Curses standard nor the SVr4 man pages

161

documented the return values of tgetent correctly, though

162

all three were in fact returned ever since SVr1. In par-

163

ticular, an omission in the XSI Curses documentation has

164

been misinterpreted to mean that tgetent returns OK or

165

ERR. Because the purpose of these functions is to provide

166

compatibility with the termcap library, that is a defect

167

in XCurses, Issue 4, Version 2 rather than in ncurses.

168

169

External variables are provided for support of certain

170

termcap applications. However, termcap applications' use

171

of those variables is poorly documented, e.g., not distin-

172

guishing between input and output. In particular, some

173

applications are reported to declare and/or modify ospeed.

</PRE>

<A HREF="ncurses.3x.html">curses(3x)</A>, <A HREF="terminfo.5.html">terminfo(5)</A>, <A HREF="putc.3.html">putc(3)</A>.

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

</PRE>

<HR>

Man(1) output converted with

</ADDRESS>

</BODY>

</HTML>