bb5c8ca6cfa3fe746e6e0c2c7d1266017cbfcff1
[ncurses.git] / man / curs_terminfo.3x
1 .\"***************************************************************************
2 .\" Copyright (c) 1999,2000 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_terminfo.3x,v 1.13 2000/07/01 20:07:34 tom Exp $
30 .TH curs_terminfo 3X ""
31 .ds n 5
32 .SH NAME
33 \fBsetupterm\fR,
34 \fBsetterm\fR,
35 \fBset_curterm\fR,
36 \fBdel_curterm\fR,
37 \fBrestartterm\fR,
38 \fBtparm\fR,
39 \fBtputs\fR,
40 \fBputp\fR,
41 \fBvidputs\fR,
42 \fBvidattr\fR,
43 \fBmvcur\fR,
44 \fBtigetflag\fR,
45 \fBtigetnum\fR,
46 \fBtigetstr\fR - \fBcurses\fR interfaces to terminfo database
47 .SH SYNOPSIS
48 \fB#include <curses.h>\fR
49 .br
50 \fB#include <term.h>\fR
51
52 \fBint setupterm(const char *term, int fildes, int *errret);\fR
53 .br
54 \fBint setterm(const char *term);\fR
55 .br
56 \fBTERMINAL *set_curterm(TERMINAL *nterm);\fR
57 .br
58 \fBint del_curterm(TERMINAL *oterm);\fR
59 .br
60 \fBint restartterm(const char *term, int fildes, int *errret);\fR
61 .br
62 \fBchar *tparm(const char *str, ...);\fR
63 .br
64 \fBint tputs(const char *str, int affcnt, int (*putc)(int));\fR
65 .br
66 \fBint putp(const char *str);\fR
67 .br
68 \fBint vidputs(chtype attrs, int (*putc)(char));\fR
69 .br
70 \fBint vidattr(chtype attrs);\fR
71 .br
72 \fBint mvcur(int oldrow, int oldcol, int newrow, int newcol);\fR
73 .br
74 \fBint tigetflag(const char *capname);\fR
75 .br
76 \fBint tigetnum(const char *capname);\fR
77 .br
78 \fBchar *tigetstr(const char *capname);\fR
79 .br
80 .SH DESCRIPTION
81 These low-level routines must be called by programs that have to deal
82 directly with the \fBterminfo\fR database to handle certain terminal
83 capabilities, such as programming function keys.  For all other
84 functionality, \fBcurses\fR routines are more suitable and their use is
85 recommended.
86
87 Initially, \fBsetupterm\fR should be called.  Note that
88 \fBsetupterm\fR is automatically called by \fBinitscr\fR and
89 \fBnewterm\fR.  This defines the set of terminal-dependent variables
90 [listed in \fBterminfo\fR(\*n)].  The \fBterminfo\fR variables
91 \fBlines\fR and \fBcolumns\fR are initialized by \fBsetupterm\fR as
92 follows: If \fBuse_env(FALSE)\fR has been called, values for
93 \fBlines\fR and \fBcolumns\fR specified in \fBterminfo\fR are used.
94 Otherwise, if the environment variables \fBLINES\fR and \fBCOLUMNS\fR
95 exist, their values are used.  If these environment variables do not
96 exist and the program is running in a window, the current window size
97 is used.  Otherwise, if the environment variables do not exist, the
98 values for \fBlines\fR and \fBcolumns\fR specified in the
99 \fBterminfo\fR database are used.
100
101 The header files \fBcurses.h\fR and \fBterm.h\fR should be included (in this
102 order) to get the definitions for these strings, numbers, and flags.
103 Parameterized strings should be passed through \fBtparm\fR to instantiate them.  
104 All \fBterminfo\fR strings [including the output of \fBtparm\fR] should be printed
105 with \fBtputs\fR or \fBputp\fR.  Call the \fBreset_shell_mode\fR to restore the
106 tty modes before exiting [see \fBcurs_kernel\fR(3X)].  Programs which use
107 cursor addressing should output \fBenter_ca_mode\fR upon startup and should
108 output \fBexit_ca_mode\fR before exiting.  Programs desiring shell escapes
109 should call
110
111 \fBreset_shell_mode\fR and output \fBexit_ca_mode\fR before the shell
112 is called and should output \fBenter_ca_mode\fR and call
113 \fBreset_prog_mode\fR after returning from the shell.
114
115 The \fBsetupterm\fR routine reads in the \fBterminfo\fR database,
116 initializing the \fBterminfo\fR structures, but does not set up the
117 output virtualization structures used by \fBcurses\fR.  The terminal
118 type is the character string \fIterm\fR; if \fIterm\fR is null, the
119 environment variable \fBTERM\fR is used.
120 All output is to file descriptor \fBfildes\fR which is initialized for output.
121 If \fIerrret\fR is not null,
122 then \fBsetupterm\fR returns \fBOK\fR or
123 \fBERR\fR and stores a status value in the integer pointed to by
124 \fIerrret\fR.
125 A return value of \fBOK\fR combined with status of \fB1\fR in \fIerrret\fR
126 is normal.
127 If \fBERR\fR is returned, examine \fIerrret\fR:
128 .RS
129 .TP 5
130 .B 1
131 means that the terminal is hardcopy, cannot be used for curses applications.
132 .TP 5
133 .B 0
134 means that the terminal could not be found,
135 or that it is a generic type,
136 having too little information for curses applications to run.
137 .TP 5
138 .B -1
139 means that the \fBterminfo\fR database could not be found.
140 .RE
141 .PP
142 If \fIerrret\fR is
143 null, \fBsetupterm\fR prints an error message upon finding an error
144 and exits.  Thus, the simplest call is:
145
146       \fBsetupterm((char *)0, 1, (int *)0);\fR,
147
148 which uses all the defaults and sends the output to \fBstdout\fR.
149
150 The \fBsetterm\fR routine is being replaced by \fBsetupterm\fR.  The call:
151
152       \fBsetupterm(\fR\fIterm\fR\fB, 1, (int *)0)\fR
153
154 provides the same functionality as \fBsetterm(\fR\fIterm\fR\fB)\fR.
155 The \fBsetterm\fR routine is included here for BSD compatibility, and
156 is not recommended for new programs.
157
158 The \fBset_curterm\fR routine sets the variable \fBcur_term\fR to
159 \fInterm\fR, and makes all of the \fBterminfo\fR boolean, numeric, and
160 string variables use the values from \fInterm\fR.  It returns the old value
161 of \fBcur_term\fR.
162
163 The \fBdel_curterm\fR routine frees the space pointed to by
164 \fIoterm\fR and makes it available for further use.  If \fIoterm\fR is
165 the same as \fBcur_term\fR, references to any of the \fBterminfo\fR
166 boolean, numeric, and string variables thereafter may refer to invalid
167 memory locations until another \fBsetupterm\fR has been called.
168
169 The \fBrestartterm\fR routine is similar to \fBsetupterm\fR and \fBinitscr\fR,
170 except that it is called after restoring memory to a previous state (for
171 example, when reloading a game saved as a core image dump).  It assumes that
172 the windows and the input and output options are the same as when memory was
173 saved, but the terminal type and baud rate may be different.  Accordingly,
174 it saves various tty state bits, does a setupterm, and then restores the bits.
175
176 The \fBtparm\fR routine instantiates the string \fIstr\fR with
177 parameters \fIpi\fR.  A pointer is returned to the result of \fIstr\fR
178 with the parameters applied.
179
180 The \fBtputs\fR routine applies padding information to the string
181 \fIstr\fR and outputs it.  The \fIstr\fR must be a terminfo string
182 variable or the return value from \fBtparm\fR, \fBtgetstr\fR, or
183 \fBtgoto\fR.  \fIaffcnt\fR is the number of lines affected, or 1 if
184 not applicable.  \fIputc\fR is a \fBputchar\fR-like routine to which
185 the characters are passed, one at a time.
186
187 The \fBputp\fR routine calls \fBtputs(\fR\fIstr\fR\fB, 1, putchar)\fR.
188 Note that the output of \fBputp\fR always goes to \fBstdout\fR, not to
189 the \fIfildes\fR specified in \fBsetupterm\fR.
190
191 The \fBvidputs\fR routine displays the string on the terminal in the
192 video attribute mode \fIattrs\fR, which is any combination of the
193 attributes listed in \fBcurses\fR(3X).  The characters are passed to
194 the \fBputchar\fR-like routine \fIputc\fR.
195
196 The \fBvidattr\fR routine is like the \fBvidputs\fR routine, except
197 that it outputs through \fBputchar\fR.
198
199 The \fBmvcur\fR routine provides low-level cursor motion.  It takes
200 effect immediately (rather than at the next refresh).
201
202 The \fBtigetflag\fR, \fBtigetnum\fR and \fBtigetstr\fR routines return
203 the value of the capability corresponding to the \fBterminfo\fR
204 \fIcapname\fR passed to them, such as \fBxenl\fR.
205
206 The \fBtigetflag\fR routine returns the value \fB-1\fR if
207 \fIcapname\fR is not a boolean capability,
208 or \fB0\fR if it is canceled or absent from the terminal description.
209
210 The \fBtigetnum\fR routine returns the value \fB-2\fR if
211 \fIcapname\fR is not a numeric capability,
212 or \fB-1\fR if it is canceled or absent from the terminal description.
213
214 The \fBtigetstr\fR routine returns the value \fB(char *)-1\fR
215 if \fIcapname\fR is not a string capability,
216 or \fB0\fR if it is canceled or absent from the terminal description.
217
218 The \fIcapname\fR for each capability is given in the table column entitled
219 \fIcapname\fR code in the capabilities section of \fBterminfo\fR(\*n).
220
221 \fBchar *boolnames\fR, \fB*boolcodes\fR, \fB*boolfnames\fR
222
223 \fBchar *numnames\fR, \fB*numcodes\fR, \fB*numfnames\fR
224
225 \fBchar *strnames\fR, \fB*strcodes\fR, \fB*strfnames\fR
226
227 These null-terminated arrays contain the \fIcapnames\fR, the
228 \fBtermcap\fR codes, and the full C names, for each of the
229 \fBterminfo\fR variables.
230 .SH RETURN VALUE
231 Routines that return an integer return \fBERR\fR upon failure and \fBOK\fR
232 (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
233 completion, unless otherwise noted in the preceding routine descriptions.
234
235 Routines that return pointers always return \fBNULL\fR on error.
236 .SH NOTES
237 The \fBsetupterm\fR routine should be used in place of \fBsetterm\fR.
238 It may be useful when you want to test for terminal capabilities without
239 committing to the allocation of storage involved in \fBinitscr\fR.
240
241 Note that \fBvidattr\fR and \fBvidputs\fR may be macros.
242 .SH PORTABILITY
243 The function \fBsetterm\fR is not described in the XSI Curses standard and must
244 be considered non-portable.  All other functions are as described in the XSI
245 curses standard.
246
247 In System V Release 4, \fBset_curterm\fR has an \fBint\fR return type and
248 returns \fBOK\fR or \fBERR\fR.  We have chosen to implement the XSI Curses
249 semantics.
250
251 In System V Release 4, the third argument of \fBtputs\fR has the type
252 \fBint (*putc)(char)\fR.
253
254 The XSI Curses standard prototypes \fBtparm\fR with a fixed number of parameters,
255 rather than a variable argument list.
256
257 XSI notes that after calling \fBmvcur\fR, the curses state may not match the
258 actual terminal state, and that an application should touch and refresh
259 the window before resuming normal curses calls.
260 Both ncurses and System V Release 4 curses implement \fBmvcur\fR using
261 the SCREEN data allocated in either \fBinitscr\fR or \fBnewterm\fR. 
262 So though it is documented as a terminfo function,
263 \fBmvcur\fR is really a curses function which is not well specified.
264 .SH SEE ALSO
265 \fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_kernel\fR(3X), \fBcurs_termcap\fR(3X),
266 \fBputc\fR(3S), \fBterminfo\fR(\*n)
267 .\"#
268 .\"# The following sets edit modes for GNU EMACS
269 .\"# Local Variables:
270 .\"# mode:nroff
271 .\"# fill-column:79
272 .\"# End: