1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
3 ****************************************************************************
4 * Copyright (c) 1998-2012,2013 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: curs_termcap.3x,v 1.30 2013/01/19 15:58:48 tom Exp @
34 <TITLE>curs_termcap 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 <H1>curs_termcap 3x</H1>
42 <!-- Manpage converted by man2html 3.0.1 -->
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>
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
56 <H2>SYNOPSIS</H2><PRE>
57 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
58 <STRONG>#include</STRONG> <STRONG><term.h></STRONG>
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>
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>
74 <H2>DESCRIPTION</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
82 <STRONG>INITIALIZATION</STRONG>
83 The <STRONG>tgetent</STRONG> routine loads the entry for <EM>name</EM>. It returns:
87 0 if there is no such entry (or that it is a generic
88 type, having too little information for curses ap-
89 plications to run), and
91 -1 if the terminfo database could not be found.
93 This differs from the <EM>termcap</EM> library in two ways:
95 <STRONG>o</STRONG> The emulation ignores the buffer pointer <EM>bp</EM>. The
96 <EM>termcap</EM> library would store a copy of the terminal
97 description in the area referenced by this pointer.
98 However, ncurses stores its terminal descriptions
99 in compiled binary form, which is not the same
102 <STRONG>o</STRONG> There is a difference in return codes. The <EM>termcap</EM>
103 library does not check if the terminal description
104 is marked with the <EM>generic</EM> capability, or if the
105 terminal description has cursor-addressing.
107 <STRONG>CAPABILITY</STRONG> <STRONG>VALUES</STRONG>
108 The <STRONG>tgetflag</STRONG> routine gets the boolean entry for <EM>id</EM>, or ze-
109 ro if it is not available.
111 The <STRONG>tgetnum</STRONG> routine gets the numeric entry for <EM>id</EM>, or -1
112 if it is not available.
114 The <STRONG>tgetstr</STRONG> routine returns the string entry for <EM>id</EM>, or
115 zero if it is not available. Use <STRONG>tputs</STRONG> to output the re-
116 turned string. The return value will also be copied to
117 the buffer pointed to by <EM>area</EM>, and the <EM>area</EM> value will be
118 updated to point past the null ending this value.
120 Only the first two characters of the <STRONG>id</STRONG> parameter of <STRONG>tget-</STRONG>
121 <STRONG>flag</STRONG>, <STRONG>tgetnum</STRONG> and <STRONG>tgetstr</STRONG> are compared in lookups.
123 <STRONG>FORMATTING</STRONG> <STRONG>CAPABILITIES</STRONG>
124 The <STRONG>tgoto</STRONG> routine instantiates the parameters into the
125 given capability. The output from this routine is to be
126 passed to <STRONG>tputs</STRONG>.
128 The <STRONG>tputs</STRONG> routine is described on the <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
129 manual page. It can retrieve capabilities by either term-
130 cap or terminfo name.
132 <STRONG>GLOBAL</STRONG> <STRONG>VARIABLES</STRONG>
133 The variables <STRONG>PC</STRONG>, <STRONG>UP</STRONG> and <STRONG>BC</STRONG> are set by <STRONG>tgetent</STRONG> to the ter-
134 minfo entry's data for <STRONG>pad_char</STRONG>, <STRONG>cursor_up</STRONG> and
135 <STRONG>backspace_if_not_bs</STRONG>, respectively. <STRONG>UP</STRONG> is not used by
136 ncurses. <STRONG>PC</STRONG> is used in the <STRONG>tdelay_output</STRONG> function. <STRONG>BC</STRONG> is
137 used in the <STRONG>tgoto</STRONG> emulation. The variable <STRONG>ospeed</STRONG> is set
138 by ncurses in a system-specific coding to reflect the ter-
143 <H2>RETURN VALUE</H2><PRE>
144 Except where explicitly noted, routines that return an in-
145 teger return <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 only specifies
146 "an integer value other than <STRONG>ERR</STRONG>") upon successful comple-
149 Routines that return pointers return <STRONG>NULL</STRONG> on error.
154 If you call <STRONG>tgetstr</STRONG> to fetch <STRONG>ca</STRONG> or any other parameterized
155 string, be aware that it will be returned in terminfo no-
156 tation, not the older and not-quite-compatible termcap no-
157 tation. This will not cause problems if all you do with
158 it is call <STRONG>tgoto</STRONG> or <STRONG>tparm</STRONG>, which both expand terminfo-
159 style strings as terminfo. (The <STRONG>tgoto</STRONG> function, if con-
160 figured to support termcap, will check if the string is
161 indeed terminfo-style by looking for "%p" parameters or
162 "$<..>" delays, and invoke a termcap-style parser if the
163 string does not appear to be terminfo).
165 Because terminfo conventions for representing padding in
166 string capabilities differ from termcap's, <STRONG>tputs("50");</STRONG>
167 will put out a literal "50" rather than busy-waiting for
168 50 milliseconds. Cope with it.
170 Note that termcap has nothing analogous to terminfo's <STRONG>sgr</STRONG>
171 string. One consequence of this is that termcap applica-
172 tions assume me (terminfo <STRONG>sgr0</STRONG>) does not reset the alter-
173 nate character set. This implementation checks for, and
174 modifies the data shown to the termcap interface to accom-
175 modate termcap's limitation in this respect.
179 <H2>PORTABILITY</H2><PRE>
180 The XSI Curses standard, Issue 4 describes these func-
181 tions. However, they are marked TO BE WITHDRAWN and may
182 be removed in future versions.
184 Neither the XSI Curses standard nor the SVr4 man pages
185 documented the return values of <STRONG>tgetent</STRONG> correctly, though
186 all three were in fact returned ever since SVr1. In par-
187 ticular, an omission in the XSI Curses documentation has
188 been misinterpreted to mean that <STRONG>tgetent</STRONG> returns <STRONG>OK</STRONG> or
189 <STRONG>ERR</STRONG>. Because the purpose of these functions is to provide
190 compatibility with the <EM>termcap</EM> library, that is a defect
191 in XCurses, Issue 4, Version 2 rather than in ncurses.
193 External variables are provided for support of certain
194 termcap applications. However, termcap applications' use
195 of those variables is poorly documented, e.g., not distin-
196 guishing between input and output. In particular, some
197 applications are reported to declare and/or modify <STRONG>ospeed</STRONG>.
199 The comment that only the first two characters of the <STRONG>id</STRONG>
200 parameter are used escapes many application developers.
201 The original BSD 4.2 termcap library (and historical
202 relics thereof) did not require a trailing null NUL on the
203 parameter name passed to <STRONG>tgetstr</STRONG>, <STRONG>tgetnum</STRONG> and <STRONG>tgetflag</STRONG>.
204 Some applications assume that the termcap interface does
205 not require the trailing NUL for the parameter name. Tak-
206 ing into account these issues:
208 <STRONG>o</STRONG> As a special case, <STRONG>tgetflag</STRONG> matched against a single-
209 character identifier provided that was at the end of
210 the terminal description. You should not rely upon
211 this behavior in portable programs. This implementa-
212 tion disallows matches against single-character capa-
215 <STRONG>o</STRONG> This implementation disallows matches by the termcap
216 interface against extended capability names which are
217 longer than two characters.
221 <H2>SEE ALSO</H2><PRE>
222 <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>.
224 http://invisible-island.net/ncurses/tctest.html
228 <STRONG><A HREF="curs_termcap.3x.html">curs_termcap(3x)</A></STRONG>
231 Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a>