Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / ae271bcd1ff942b3c4cb099f04bb5882f812da13 / . / doc / html / man / curs_termcap.3x.html
blob: 36c4e7acdd9440ca030b81168ebfd76ba72eabe3 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]3 * Copyright (c) 1998-2013,2015 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]29 * @Id: curs_termcap.3x,v 1.31 2015/04/26 00:49:10 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]30-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]31<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]32<HTML>
33<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]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">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]36<TITLE>curs_termcap 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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]41<H1 class="no-header">curs_termcap 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]42<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG> <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
44
45
46
47
48</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]49<H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>PC</STRONG>, <STRONG>UP</STRONG>, <STRONG>BC</STRONG>, <STRONG>ospeed</STRONG>, <STRONG>tgetent</STRONG>, <STRONG>tgetflag</STRONG>, <STRONG>tgetnum</STRONG>, <STRONG>tgetstr</STRONG>,
51 <STRONG>tgoto</STRONG>, <STRONG>tputs</STRONG> - direct <STRONG>curses</STRONG> interface to the terminfo
52 capability database
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]53
54
55</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]56<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]57 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
58 <STRONG>#include</STRONG> <STRONG>&lt;term.h&gt;</STRONG>
59
60 <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>PC;</STRONG>
61 <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>UP;</STRONG>
62 <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>BC;</STRONG>
63 <STRONG>extern</STRONG> <STRONG>short</STRONG> <STRONG>ospeed;</STRONG>
64
65 <STRONG>int</STRONG> <STRONG>tgetent(char</STRONG> <STRONG>*bp,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*name);</STRONG>
66 <STRONG>int</STRONG> <STRONG>tgetflag(char</STRONG> <STRONG>*id);</STRONG>
67 <STRONG>int</STRONG> <STRONG>tgetnum(char</STRONG> <STRONG>*id);</STRONG>
68 <STRONG>char</STRONG> <STRONG>*tgetstr(char</STRONG> <STRONG>*id,</STRONG> <STRONG>char</STRONG> <STRONG>**area);</STRONG>
69 <STRONG>char</STRONG> <STRONG>*tgoto(const</STRONG> <STRONG>char</STRONG> <STRONG>*cap,</STRONG> <STRONG>int</STRONG> <STRONG>col,</STRONG> <STRONG>int</STRONG> <STRONG>row);</STRONG>
70 <STRONG>int</STRONG> <STRONG>tputs(const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>int</STRONG> <STRONG>affcnt,</STRONG> <STRONG>int</STRONG> <STRONG>(*putc)(int));</STRONG>
71
72
73</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]74<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
75 These routines are included as a conversion aid for pro-
76 grams that use the <EM>termcap</EM> library. Their parameters are
77 the same and the routines are emulated using the <EM>terminfo</EM>
78 database. Thus, they can only be used to query the capa-
79 bilities of entries for which a terminfo entry has been
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]80 compiled.
81
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]82
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]83</PRE>
84<H3><a name="h3-INITIALIZATION">INITIALIZATION</a></H3><PRE>
85 The <STRONG>tgetent</STRONG> routine loads the entry for <EM>name</EM>. It returns:
86
87 1 on success,
88
89 0 if there is no such entry (or that it is a generic
90 type, having too little information for curses ap-
91 plications to run), and
92
93 -1 if the terminfo database could not be found.
94
95 This differs from the <EM>termcap</EM> library in two ways:
96
97 <STRONG>o</STRONG> The emulation ignores the buffer pointer <EM>bp</EM>. The
98 <EM>termcap</EM> library would store a copy of the terminal
99 description in the area referenced by this pointer.
100 However, ncurses stores its terminal descriptions
101 in compiled binary form, which is not the same
102 thing.
103
104 <STRONG>o</STRONG> There is a difference in return codes. The <EM>termcap</EM>
105 library does not check if the terminal description
106 is marked with the <EM>generic</EM> capability, or if the
107 terminal description has cursor-addressing.
108
109
110</PRE>
111<H3><a name="h3-CAPABILITY-VALUES">CAPABILITY VALUES</a></H3><PRE>
112 The <STRONG>tgetflag</STRONG> routine gets the boolean entry for <EM>id</EM>, or ze-
113 ro if it is not available.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]114
115 The <STRONG>tgetnum</STRONG> routine gets the numeric entry for <EM>id</EM>, or -1
116 if it is not available.
117
118 The <STRONG>tgetstr</STRONG> routine returns the string entry for <EM>id</EM>, or
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]119 zero if it is not available. Use <STRONG>tputs</STRONG> to output the re-
120 turned string. The <EM>area</EM> parameter is used as follows:
121
122 <STRONG>o</STRONG> It is assumed to be the address of a pointer to a
123 buffer managed by the calling application.
124
125 <STRONG>o</STRONG> However, ncurses checks to ensure that <STRONG>area</STRONG> is not
126 NULL, and also that the resulting buffer pointer is
127 not NULL. If either check fails, the <EM>area</EM> parame-
128 ter is ignored.
129
130 <STRONG>o</STRONG> If the checks succeed, ncurses also copies the re-
131 turn value to the buffer pointed to by <EM>area</EM>, and
132 the <EM>area</EM> value will be updated to point past the
133 null ending this value.
134
135 <STRONG>o</STRONG> The return value itself is an address in the termi-
136 nal description which is loaded into memory.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]137
138 Only the first two characters of the <STRONG>id</STRONG> parameter of <STRONG>tget-</STRONG>
139 <STRONG>flag</STRONG>, <STRONG>tgetnum</STRONG> and <STRONG>tgetstr</STRONG> are compared in lookups.
140
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]141
142</PRE>
143<H3><a name="h3-FORMATTING-CAPABILITIES">FORMATTING CAPABILITIES</a></H3><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]144 The <STRONG>tgoto</STRONG> routine instantiates the parameters into the
145 given capability. The output from this routine is to be
146 passed to <STRONG>tputs</STRONG>.
147
148 The <STRONG>tputs</STRONG> routine is described on the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
149 manual page. It can retrieve capabilities by either term-
150 cap or terminfo name.
151
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]152
153</PRE>
154<H3><a name="h3-GLOBAL-VARIABLES">GLOBAL VARIABLES</a></H3><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]155 The variables <STRONG>PC</STRONG>, <STRONG>UP</STRONG> and <STRONG>BC</STRONG> are set by <STRONG>tgetent</STRONG> to the ter-
156 minfo entry's data for <STRONG>pad_char</STRONG>, <STRONG>cursor_up</STRONG> and
157 <STRONG>backspace_if_not_bs</STRONG>, respectively. <STRONG>UP</STRONG> is not used by
158 ncurses. <STRONG>PC</STRONG> is used in the <STRONG>tdelay_output</STRONG> function. <STRONG>BC</STRONG> is
159 used in the <STRONG>tgoto</STRONG> emulation. The variable <STRONG>ospeed</STRONG> is set
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]160 by ncurses in a system-specific coding to reflect the ter-
161 minal speed.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]162
163
164</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]165<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
166 Except where explicitly noted, routines that return an in-
167 teger return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 only specifies
168 "an integer value other than <STRONG>ERR</STRONG>") upon successful comple-
169 tion.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]170
171 Routines that return pointers return <STRONG>NULL</STRONG> on error.
172
173
174</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]175<H2><a name="h2-BUGS">BUGS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]176 If you call <STRONG>tgetstr</STRONG> to fetch <STRONG>ca</STRONG> or any other parameterized
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]177 string, be aware that it will be returned in terminfo no-
178 tation, not the older and not-quite-compatible termcap no-
179 tation. This will not cause problems if all you do with
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]180 it is call <STRONG>tgoto</STRONG> or <STRONG>tparm</STRONG>, which both expand terminfo-
181 style strings as terminfo. (The <STRONG>tgoto</STRONG> function, if con-
182 figured to support termcap, will check if the string is
183 indeed terminfo-style by looking for "%p" parameters or
184 "$&lt;..&gt;" delays, and invoke a termcap-style parser if the
185 string does not appear to be terminfo).
186
187 Because terminfo conventions for representing padding in
188 string capabilities differ from termcap's, <STRONG>tputs("50");</STRONG>
189 will put out a literal "50" rather than busy-waiting for
190 50 milliseconds. Cope with it.
191
192 Note that termcap has nothing analogous to terminfo's <STRONG>sgr</STRONG>
193 string. One consequence of this is that termcap applica-
194 tions assume me (terminfo <STRONG>sgr0</STRONG>) does not reset the alter-
195 nate character set. This implementation checks for, and
196 modifies the data shown to the termcap interface to accom-
197 modate termcap's limitation in this respect.
198
199
200</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]201<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]202 The XSI Curses standard, Issue 4 describes these func-
203 tions. However, they are marked TO BE WITHDRAWN and may
204 be removed in future versions.
205
206 Neither the XSI Curses standard nor the SVr4 man pages
207 documented the return values of <STRONG>tgetent</STRONG> correctly, though
208 all three were in fact returned ever since SVr1. In par-
209 ticular, an omission in the XSI Curses documentation has
210 been misinterpreted to mean that <STRONG>tgetent</STRONG> returns <STRONG>OK</STRONG> or
211 <STRONG>ERR</STRONG>. Because the purpose of these functions is to provide
212 compatibility with the <EM>termcap</EM> library, that is a defect
213 in XCurses, Issue 4, Version 2 rather than in ncurses.
214
215 External variables are provided for support of certain
216 termcap applications. However, termcap applications' use
217 of those variables is poorly documented, e.g., not distin-
218 guishing between input and output. In particular, some
219 applications are reported to declare and/or modify <STRONG>ospeed</STRONG>.
220
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]221 The comment that only the first two characters of the <STRONG>id</STRONG>
222 parameter are used escapes many application developers.
223 The original BSD 4.2 termcap library (and historical
224 relics thereof) did not require a trailing null NUL on the
225 parameter name passed to <STRONG>tgetstr</STRONG>, <STRONG>tgetnum</STRONG> and <STRONG>tgetflag</STRONG>.
226 Some applications assume that the termcap interface does
227 not require the trailing NUL for the parameter name. Tak-
228 ing into account these issues:
229
230 <STRONG>o</STRONG> As a special case, <STRONG>tgetflag</STRONG> matched against a single-
231 character identifier provided that was at the end of
232 the terminal description. You should not rely upon
233 this behavior in portable programs. This implementa-
234 tion disallows matches against single-character capa-
235 bility names.
236
237 <STRONG>o</STRONG> This implementation disallows matches by the termcap
238 interface against extended capability names which are
239 longer than two characters.
240
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]241
242</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]243<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
244 <STRONG><A HREF="ncurses.3x.html">curses(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>, <STRONG>putc(3)</STRONG>.
245
246 http://invisible-island.net/ncurses/tctest.html
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]247
248
249
250 <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
251</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]252<div class="nav">
253<ul>
254<li><a href="#h2-NAME">NAME</a></li>
255<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
256<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
257<ul>
258<li><a href="#h3-INITIALIZATION">INITIALIZATION</a></li>
259<li><a href="#h3-CAPABILITY-VALUES">CAPABILITY VALUES</a></li>
260<li><a href="#h3-FORMATTING-CAPABILITIES">FORMATTING CAPABILITIES</a></li>
261<li><a href="#h3-GLOBAL-VARIABLES">GLOBAL VARIABLES</a></li>
262</ul>
263</li>
264<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
265<li><a href="#h2-BUGS">BUGS</a></li>
266<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
267<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
268</ul>
269</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]270</BODY>
271</HTML>