ncurses 5.7 - patch 20100102
[ncurses.git] / man / curs_termcap.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc.              *
3 .\"                                                                          *
4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
5 .\" copy of this software and associated documentation files (the            *
6 .\" "Software"), to deal in the Software without restriction, including      *
7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
9 .\" copies of the Software, and to permit persons to whom the Software is    *
10 .\" furnished to do so, subject to the following conditions:                 *
11 .\"                                                                          *
12 .\" The above copyright notice and this permission notice shall be included  *
13 .\" in all copies or substantial portions of the Software.                   *
14 .\"                                                                          *
15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22 .\"                                                                          *
23 .\" Except as contained in this notice, the name(s) of the above copyright   *
24 .\" holders shall not be used in advertising or otherwise to promote the     *
25 .\" sale, use or other dealings in this Software without prior written       *
26 .\" authorization.                                                           *
27 .\"***************************************************************************
28 .\"
29 .\" $Id: curs_termcap.3x,v 1.22 2007/06/02 20:40:07 tom Exp $
30 .TH curs_termcap 3X ""
31 .ds n 5
32 .SH NAME
33 \fBtgetent\fR,
34 \fBtgetflag\fR,
35 \fBtgetnum\fR,
36 \fBtgetstr\fR,
37 \fBtgoto\fR,
38 \fBtputs\fR - direct \fBcurses\fR interface to the terminfo capability database
39 .SH SYNOPSIS
40 \fB#include <curses.h>\fR
41 .br
42 \fB#include <term.h>\fR
43 .sp
44 \fBextern char PC;\fR
45 .br
46 \fBextern char * UP;\fR
47 .br
48 \fBextern char * BC;\fR
49 .br
50 \fBextern @NCURSES_OSPEED@ ospeed;\fR
51 .sp
52 \fBint tgetent(char *bp, const char *name);\fR
53 .br
54 \fBint tgetflag(char *id);\fR
55 .br
56 \fBint tgetnum(char *id);\fR
57 .br
58 \fBchar *tgetstr(char *id, char **area);\fR
59 .br
60 \fBchar *tgoto(const char *cap, int col, int row);\fR
61 .br
62 \fBint tputs(const char *str, int affcnt, int (*putc)(int));\fR
63 .br
64 .SH DESCRIPTION
65 These routines are included as a conversion aid for programs that use
66 the \fItermcap\fR library.  Their parameters are the same and the
67 routines are emulated using the \fIterminfo\fR database.  Thus, they
68 can only be used to query the capabilities of entries for which a
69 terminfo entry has been compiled.
70 .PP
71 The \fBtgetent\fR routine loads the entry for \fIname\fR.
72 It returns 1 on success, 0 if there is no such entry, and -1 if the
73 terminfo database could not be found.
74 The emulation ignores the buffer pointer \fIbp\fR.
75 .PP
76 The \fBtgetflag\fR routine gets the boolean entry for \fIid\fR,
77 or zero if it is not available.
78 .PP
79 The \fBtgetnum\fR routine gets the numeric entry for \fIid\fR,
80 or -1 if it is not available.
81 .PP
82 The \fBtgetstr\fR routine returns the string entry for \fIid\fR,
83 or zero if it is not available.
84 Use \fBtputs\fR to output the returned string.
85 The return value will also be copied to the buffer pointed to by \fIarea\fR,
86 and the \fIarea\fR value will be updated to point past the null ending
87 this value.
88 .PP
89 Only the first two characters of the \fBid\fR parameter of
90 \fBtgetflag\fR,
91 \fBtgetnum\fR and
92 \fBtgetstr\fR are compared in lookups.
93 .PP
94 The \fBtgoto\fR routine instantiates the parameters into the given capability.
95 The output from this routine is to be passed to \fBtputs\fR.
96 .PP
97 The \fBtputs\fR routine is described on the \fBcurs_terminfo\fR(3X) manual
98 page.  It can retrieve capabilities by either termcap or terminfo name.
99 .PP
100 The variables
101 \fBPC\fR,
102 \fBUP\fR and
103 \fBBC\fR
104 are set by \fBtgetent\fR to the terminfo entry's data for
105 \fBpad_char\fR,
106 \fBcursor_up\fR and
107 \fBbackspace_if_not_bs\fR,
108 respectively.
109 \fBUP\fR is not used by ncurses.
110 \fBPC\fR is used in the \fBtdelay_output\fR function.
111 \fBBC\fR is used in the \fBtgoto\fR emulation.
112 The variable \fBospeed\fR is set by ncurses in a system-specific coding
113 to reflect the terminal speed.
114 .
115 .SH RETURN VALUE
116 Except where explicitly noted,
117 routines that return an integer return \fBERR\fR upon failure and \fBOK\fR
118 (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
119 completion.
120 .PP
121 Routines that return pointers return \fBNULL\fR on error.
122 .SH BUGS
123 If you call \fBtgetstr\fR to fetch \fBca\fR or any other parameterized string,
124 be aware that it will be returned in terminfo notation, not the older and
125 not-quite-compatible termcap notation.  This will not cause problems if all
126 you do with it is call \fBtgoto\fR or \fBtparm\fR, which both expand
127 terminfo-style strings as terminfo.
128 (The \fBtgoto\fR function, if configured to support termcap, will check
129 if the string is indeed terminfo-style by looking for "%p" parameters or
130 "$<..>" delays, and invoke a termcap-style parser if the string does not
131 appear to be terminfo).
132 .PP
133 Because terminfo conventions for representing padding in string capabilities
134 differ from termcap's, \fBtputs("50");\fR will put out a literal "50" rather
135 than busy-waiting for 50 milliseconds.  Cope with it.
136 .PP
137 Note that termcap has nothing analogous to terminfo's \fBsgr\fR string.
138 One consequence of this is that termcap applications assume \fRme\fR
139 (terminfo \fBsgr0\fR) does not reset the alternate character set.
140 This implementation checks for, and modifies the data shown to the
141 termcap interface to accommodate termcap's limitation in this respect.
142 .SH PORTABILITY
143 The XSI Curses standard, Issue 4 describes these functions.  However, they
144 are marked TO BE WITHDRAWN and may be removed in future versions.
145 .PP
146 Neither the XSI Curses standard nor the SVr4 man pages documented the return
147 values of \fBtgetent\fR correctly, though all three were in fact returned ever
148 since SVr1.
149 In particular, an omission in the XSI Curses documentation has been
150 misinterpreted to mean that \fBtgetent\fR returns \fBOK\fR or \fBERR\fR.
151 Because the purpose of these functions is to provide compatibility with
152 the \fItermcap\fR library, that is a defect in XCurses, Issue 4, Version 2
153 rather than in ncurses.
154 .PP
155 External variables are provided for support of certain termcap applications.
156 However, termcap applications' use of those variables is poorly documented,
157 e.g., not distinguishing between input and output.
158 In particular, some applications are reported to declare and/or
159 modify \fBospeed\fR.
160 .SH SEE ALSO
161 \fBcurses\fR(3X), \fBterminfo\fR(\*n), \fBputc\fR(3).
162 .\"#
163 .\"# The following sets edit modes for GNU EMACS
164 .\"# Local Variables:
165 .\"# mode:nroff
166 .\"# fill-column:79
167 .\"# End: