ncurses 5.3
[ncurses.git] / doc / html / man / curs_termcap.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998-2001,2002 Free Software Foundation, Inc.              *
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.16 2002/02/16 19:26:41 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
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">
37 </HEAD>
38 <BODY>
39 <H1>curs_termcap 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43
44 </PRE>
45 <H2>NAME</H2><PRE>
46        <STRONG>tgetent</STRONG>, <STRONG>tgetflag</STRONG>, <STRONG>tgetnum</STRONG>, <STRONG>tgetstr</STRONG>, <STRONG>tgoto</STRONG>, <STRONG>tputs</STRONG> - direct
47        <STRONG>curses</STRONG> interface to the terminfo capability database
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
53        <STRONG>#include</STRONG> <STRONG>&lt;term.h&gt;</STRONG>
54        <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>PC;</STRONG> <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>UP;</STRONG> <STRONG>extern</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG> <STRONG>BC;</STRONG> <STRONG>extern</STRONG>
55        <STRONG>short</STRONG> <STRONG>ospeed;</STRONG>
56        <STRONG>int</STRONG> <STRONG>tgetent(char</STRONG> <STRONG>*bp,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*name);</STRONG>
57        <STRONG>int</STRONG> <STRONG>tgetflag(char</STRONG> <STRONG>*id);</STRONG>
58        <STRONG>int</STRONG> <STRONG>tgetnum(char</STRONG> <STRONG>*id);</STRONG>
59        <STRONG>char</STRONG> <STRONG>*tgetstr(char</STRONG> <STRONG>*id,</STRONG> <STRONG>char</STRONG> <STRONG>**area);</STRONG>
60        <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>
61        <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>
62
63
64 </PRE>
65 <H2>DESCRIPTION</H2><PRE>
66        These  routines  are included as a conversion aid for pro-
67        grams that use the <EM>termcap</EM> library.  Their parameters  are
68        the  same and the routines are emulated using the <EM>terminfo</EM>
69        database.  Thus, they can only be used to query the  capa-
70        bilities  of  entries  for which a terminfo entry has been
71        compiled.
72
73        The <STRONG>tgetent</STRONG> routine loads the entry for <EM>name</EM>.  It  returns
74        1  on  success, 0 if there is no such entry, and -1 if the
75        terminfo database  could  not  be  found.   The  emulation
76        ignores the buffer pointer <EM>bp</EM>.
77
78        The  <STRONG>tgetflag</STRONG>  routine  gets  the boolean entry for <EM>id</EM>, or
79        zero if it is not available.
80
81        The <STRONG>tgetnum</STRONG> routine gets the numeric entry for <EM>id</EM>,  or  -1
82        if it is not available.
83
84        The  <STRONG>tgetstr</STRONG>  routine  returns the string entry for <EM>id</EM>, or
85        zero if it is not available.   Use  <STRONG>tputs</STRONG>  to  output  the
86        returned  string.  The return value will also be copied to
87        the buffer pointed to by <EM>area</EM>, and the <EM>area</EM> value will  be
88        updated to point past the null ending this value.
89
90        Only the first two characters of the <STRONG>id</STRONG> parameter of <STRONG>tget-</STRONG>
91        <STRONG>flag</STRONG>, <STRONG>tgetnum</STRONG> and <STRONG>tgetstr</STRONG> are compared in lookups.
92
93        The <STRONG>tgoto</STRONG> routine instantiates  the  parameters  into  the
94        given  capability.   The output from this routine is to be
95        passed to <STRONG>tputs</STRONG>.
96
97        The <STRONG>tputs</STRONG> routine is described  on  the  <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
98        manual page.  It can retrieve capabilities by either term-
99        cap or terminfo name.
100
101        The variables <STRONG>PC</STRONG>, <STRONG>UP</STRONG> and <STRONG>BC</STRONG> are set by <STRONG>tgetent</STRONG> to the ter-
102        minfo   entry's   data   for   <STRONG>pad_char</STRONG>,   <STRONG>cursor_up</STRONG>   and
103        <STRONG>backspace_if_not_bs</STRONG>, respectively.   <STRONG>UP</STRONG>  is  not  used  by
104        ncurses.  <STRONG>PC</STRONG> is used in the <STRONG>tdelay_output</STRONG> function.  <STRONG>BC</STRONG> is
105        used in the <STRONG>tgoto</STRONG> emulation.  The variable <STRONG>ospeed</STRONG>  is  set
106        by ncurses in a system-specific coding to reflect the ter-
107        minal speed.
108
109
110
111 </PRE>
112 <H2>RETURN VALUE</H2><PRE>
113        Except where explicitly noted,  routines  that  return  an
114        integer  return  <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> (SVr4 only speci-
115        fies "an integer value other than  <STRONG>ERR</STRONG>")  upon  successful
116        completion.
117
118        Routines that return pointers return <STRONG>NULL</STRONG> on error.
119
120
121 </PRE>
122 <H2>BUGS</H2><PRE>
123        If you call <STRONG>tgetstr</STRONG> to fetch <STRONG>ca</STRONG> or any other parameterized
124        string, be aware that it  will  be  returned  in  terminfo
125        notation,  not  the older and not-quite-compatible termcap
126        notation.  This won't cause problems if all you do with it
127        is  call  <STRONG>tgoto</STRONG> or <STRONG>tparm</STRONG>, which both expand terminfo-style
128        strings as terminfo.  (The <STRONG>tgoto</STRONG> function,  if  configured
129        to  support  termcap,  will  check if the string is indeed
130        terminfo-style by looking for "%p" parameters  or  "$&lt;..&gt;"
131        delays,  and  invoke  a termcap-style parser if the string
132        does not appear to be terminfo).
133
134        Because terminfo conventions for representing  padding  in
135        string  capabilities  differ  from termcap's, <STRONG>tputs("50");</STRONG>
136        will put out a literal "50" rather than  busy-waiting  for
137        50 milliseconds.  Cope with it.
138
139
140 </PRE>
141 <H2>PORTABILITY</H2><PRE>
142        The  XSI  Curses  standard,  Issue 4 describes these func-
143        tions.  However, they are marked TO BE WITHDRAWN  and  may
144        be removed in future versions.
145
146        Neither  the  XSI  Curses  standard nor the SVr4 man pages
147        documented the return values of <STRONG>tgetent</STRONG> correctly,  though
148        all  three were in fact returned ever since SVr1.  In par-
149        ticular, an omission in the XSI Curses  documentation  has
150        been  misinterpreted  to  mean  that <STRONG>tgetent</STRONG> returns <STRONG>OK</STRONG> or
151        <STRONG>ERR</STRONG>.  Because the purpose of these functions is to provide
152        compatibility  with  the <EM>termcap</EM> library, that is a defect
153        in XCurses, Issue 4, Version 2 rather than in ncurses.
154
155        External variables are provided  for  support  of  certain
156        termcap  applications.  However, termcap applications' use
157        of those variables is poorly documented, e.g., not distin-
158        guishing  between  input  and output.  In particular, some
159        applications are reported to declare and/or modify <STRONG>ospeed</STRONG>.
160
161
162 </PRE>
163 <H2>SEE ALSO</H2><PRE>
164        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>, <STRONG><A HREF="putc.3S.html">putc(3S)</A></STRONG>.
165 </PRE>
166 <HR>
167 <ADDRESS>
168 Man(1) output converted with
169 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
170 </ADDRESS>
171 </BODY>
172 </HTML>