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