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