missing ncurses sources
[tomato.git] / release / src / router / libncurses / doc / html / man / curs_terminfo.3x.html
blob9a640e9f8bc4ab9ee30445be9b6004c9f2ab5685
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!--
3 ****************************************************************************
4 * Copyright (c) 1999-2008,2010 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_terminfo.3x,v 1.35 2010/12/04 18:38:55 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_terminfo 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_terminfo 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43 <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
48 </PRE>
49 <H2>NAME</H2><PRE>
50 <STRONG>del_curterm</STRONG>, <STRONG>mvcur</STRONG>, <STRONG>putp</STRONG>, <STRONG>restartterm</STRONG>, <STRONG>set_curterm</STRONG>,
51 <STRONG>setterm</STRONG>, <STRONG>setupterm</STRONG>, <STRONG>tigetflag</STRONG>, <STRONG>tigetnum</STRONG>, <STRONG>tigetstr</STRONG>, <STRONG>tiparm</STRONG>,
52 <STRONG>tparm</STRONG>, <STRONG>tputs</STRONG>, <STRONG>vid_attr</STRONG>, <STRONG>vid_puts</STRONG>, <STRONG>vidattr</STRONG>, <STRONG>vidputs</STRONG> -
53 <STRONG>curses</STRONG> interfaces to terminfo database
56 </PRE>
57 <H2>SYNOPSIS</H2><PRE>
58 <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
59 <STRONG>#include</STRONG> <STRONG>&lt;term.h&gt;</STRONG>
61 <STRONG>int</STRONG> <STRONG>setupterm(char</STRONG> <STRONG>*</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>fildes</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>errret</EM><STRONG>);</STRONG>
62 <STRONG>int</STRONG> <STRONG>setterm(char</STRONG> <STRONG>*</STRONG><EM>term</EM><STRONG>);</STRONG>
63 <STRONG>TERMINAL</STRONG> <STRONG>*set_curterm(TERMINAL</STRONG> <STRONG>*</STRONG><EM>nterm</EM><STRONG>);</STRONG>
64 <STRONG>int</STRONG> <STRONG>del_curterm(TERMINAL</STRONG> <STRONG>*</STRONG><EM>oterm</EM><STRONG>);</STRONG>
65 <STRONG>int</STRONG> <STRONG>restartterm(char</STRONG> <STRONG>*</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>fildes</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>errret</EM><STRONG>);</STRONG>
66 <STRONG>char</STRONG> <STRONG>*tparm(char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
67 <STRONG>int</STRONG> <STRONG>tputs(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>affcnt</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>putc</EM><STRONG>)(int));</STRONG>
68 <STRONG>int</STRONG> <STRONG>putp(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>);</STRONG>
69 <STRONG>int</STRONG> <STRONG>vidputs(chtype</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>putc</EM><STRONG>)(int));</STRONG>
70 <STRONG>int</STRONG> <STRONG>vidattr(chtype</STRONG> <EM>attrs</EM><STRONG>);</STRONG>
71 <STRONG>int</STRONG> <STRONG>vid_puts(attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>(*</STRONG><EM>putc</EM><STRONG>)(char));</STRONG>
72 <STRONG>int</STRONG> <STRONG>vid_attr(attr_t</STRONG> <EM>attrs</EM><STRONG>,</STRONG> <STRONG>short</STRONG> <EM>pair</EM><STRONG>,</STRONG> <STRONG>void</STRONG> <STRONG>*</STRONG><EM>opts</EM><STRONG>);</STRONG>
73 <STRONG>int</STRONG> <STRONG>mvcur(int</STRONG> <EM>oldrow</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>oldcol</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>newrow</EM>, int <EM>newcol</EM><STRONG>);</STRONG>
74 <STRONG>int</STRONG> <STRONG>tigetflag(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
75 <STRONG>int</STRONG> <STRONG>tigetnum(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
76 <STRONG>char</STRONG> <STRONG>*tigetstr(char</STRONG> <STRONG>*</STRONG><EM>capname</EM><STRONG>);</STRONG>
77 <STRONG>char</STRONG> <STRONG>*tiparm(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>...);</STRONG>
80 </PRE>
81 <H2>DESCRIPTION</H2><PRE>
82 These low-level routines must be called by programs that
83 have to deal directly with the <STRONG>terminfo</STRONG> database to handle
84 certain terminal capabilities, such as programming func-
85 tion keys. For all other functionality, <STRONG>curses</STRONG> routines
86 are more suitable and their use is recommended.
88 Initially, <STRONG>setupterm</STRONG> should be called. Note that <STRONG>se-</STRONG>
89 <STRONG>tupterm</STRONG> is automatically called by <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG>.
90 This defines the set of terminal-dependent variables
91 [listed in <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>]. The <STRONG>terminfo</STRONG> variables <STRONG>lines</STRONG> and
92 <STRONG>columns</STRONG> are initialized by <STRONG>setupterm</STRONG> as follows:
94 If <STRONG>use_env(FALSE)</STRONG> has been called, values for <STRONG>lines</STRONG>
95 and <STRONG>columns</STRONG> specified in <STRONG>terminfo</STRONG> are used.
97 Otherwise, if the environment variables <STRONG>LINES</STRONG> and
98 <STRONG>COLUMNS</STRONG> exist, their values are used. If these en-
99 vironment variables do not exist and the program is
100 running in a window, the current window size is
101 used. Otherwise, if the environment variables do
102 not exist, the values for <STRONG>lines</STRONG> and <STRONG>columns</STRONG> speci-
103 fied in the <STRONG>terminfo</STRONG> database are used.
105 The header files <STRONG>curses.h</STRONG> and <STRONG>term.h</STRONG> should be included
106 (in this order) to get the definitions for these strings,
107 numbers, and flags. Parameterized strings should be
108 passed through <STRONG>tparm</STRONG> to instantiate them. All <STRONG>terminfo</STRONG>
109 strings [including the output of <STRONG>tparm</STRONG>] should be printed
110 with <STRONG>tputs</STRONG> or <STRONG>putp</STRONG>. Call the <STRONG>reset_shell_mode</STRONG> to restore
111 the tty modes before exiting [see <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>]. Pro-
112 grams which use cursor addressing should output <STRONG>en-</STRONG>
113 <STRONG>ter_ca_mode</STRONG> upon startup and should output <STRONG>exit_ca_mode</STRONG>
114 before exiting. Programs desiring shell escapes should
115 call
117 <STRONG>reset_shell_mode</STRONG> and output <STRONG>exit_ca_mode</STRONG> before the shell
118 is called and should output <STRONG>enter_ca_mode</STRONG> and call <STRONG>re-</STRONG>
119 <STRONG>set_prog_mode</STRONG> after returning from the shell.
121 The <STRONG>setupterm</STRONG> routine reads in the <STRONG>terminfo</STRONG> database, ini-
122 tializing the <STRONG>terminfo</STRONG> structures, but does not set up the
123 output virtualization structures used by <STRONG>curses</STRONG>. The ter-
124 minal type is the character string <EM>term</EM>; if <EM>term</EM> is null,
125 the environment variable <STRONG>TERM</STRONG> is used. All output is to
126 file descriptor <STRONG>fildes</STRONG> which is initialized for output.
127 If <EM>errret</EM> is not null, then <STRONG>setupterm</STRONG> returns <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>
128 and stores a status value in the integer pointed to by <EM>er-</EM>
129 <EM>rret</EM>. A return value of <STRONG>OK</STRONG> combined with status of <STRONG>1</STRONG> in
130 <EM>errret</EM> is normal. If <STRONG>ERR</STRONG> is returned, examine <EM>errret</EM>:
132 <STRONG>1</STRONG> means that the terminal is hardcopy, cannot be
133 used for curses applications.
135 <STRONG>0</STRONG> means that the terminal could not be found, or
136 that it is a generic type, having too little
137 information for curses applications to run.
139 <STRONG>-1</STRONG> means that the <STRONG>terminfo</STRONG> database could not be
140 found.
142 If <EM>errret</EM> is null, <STRONG>setupterm</STRONG> prints an error message upon
143 finding an error and exits. Thus, the simplest call is:
145 <STRONG>setupterm((char</STRONG> <STRONG>*)0,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0);</STRONG>,
147 which uses all the defaults and sends the output to <STRONG>std-</STRONG>
148 <STRONG>out</STRONG>.
150 The <STRONG>setterm</STRONG> routine is being replaced by <STRONG>setupterm</STRONG>. The
151 call:
153 <STRONG>setupterm(</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0)</STRONG>
155 provides the same functionality as <STRONG>setterm(</STRONG><EM>term</EM><STRONG>)</STRONG>. The
156 <STRONG>setterm</STRONG> routine is included here for BSD compatibility,
157 and is not recommended for new programs.
159 The <STRONG>set_curterm</STRONG> routine sets the variable <STRONG>cur_term</STRONG> to
160 <EM>nterm</EM>, and makes all of the <STRONG>terminfo</STRONG> boolean, numeric, and
161 string variables use the values from <EM>nterm</EM>. It returns
162 the old value of <STRONG>cur_term</STRONG>.
164 The <STRONG>del_curterm</STRONG> routine frees the space pointed to by
165 <EM>oterm</EM> and makes it available for further use. If <EM>oterm</EM> is
166 the same as <STRONG>cur_term</STRONG>, references to any of the <STRONG>terminfo</STRONG>
167 boolean, numeric, and string variables thereafter may re-
168 fer to invalid memory locations until another <STRONG>setupterm</STRONG>
169 has been called.
171 The <STRONG>restartterm</STRONG> routine is similar to <STRONG>setupterm</STRONG> and
172 <STRONG>initscr</STRONG>, except that it is called after restoring memory
173 to a previous state (for example, when reloading a game
174 saved as a core image dump). It assumes that the windows
175 and the input and output options are the same as when mem-
176 ory was saved, but the terminal type and baud rate may be
177 different. Accordingly, it saves various tty state bits,
178 calls <STRONG>setupterm</STRONG>, and then restores the bits.
180 The <STRONG>tparm</STRONG> routine instantiates the string <EM>str</EM> with parame-
181 ters <EM>pi</EM>. A pointer is returned to the result of <EM>str</EM> with
182 the parameters applied.
184 <STRONG>tiparm</STRONG> is a newer form of <STRONG>tparm</STRONG> which uses <EM>&lt;stdarg.h&gt;</EM>
185 rather than a fixed-parameter list. Its numeric parame-
186 ters are integers (int) rather than longs.
188 The <STRONG>tputs</STRONG> routine applies padding information to the
189 string <EM>str</EM> and outputs it. The <EM>str</EM> must be a terminfo
190 string variable or the return value from <STRONG>tparm</STRONG>, <STRONG>tgetstr</STRONG>,
191 or <STRONG>tgoto</STRONG>. <EM>affcnt</EM> is the number of lines affected, or 1 if
192 not applicable. <EM>putc</EM> is a <STRONG>putchar</STRONG>-like routine to which
193 the characters are passed, one at a time.
195 The <STRONG>putp</STRONG> routine calls <STRONG>tputs(</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>putchar)</STRONG>. Note that
196 the output of <STRONG>putp</STRONG> always goes to <STRONG>stdout</STRONG>, not to the
197 <EM>fildes</EM> specified in <STRONG>setupterm</STRONG>.
199 The <STRONG>vidputs</STRONG> routine displays the string on the terminal in
200 the video attribute mode <EM>attrs</EM>, which is any combination
201 of the attributes listed in <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>. The characters
202 are passed to the <STRONG>putchar</STRONG>-like routine <EM>putc</EM>.
204 The <STRONG>vidattr</STRONG> routine is like the <STRONG>vidputs</STRONG> routine, except
205 that it outputs through <STRONG>putchar</STRONG>.
207 The <STRONG>vid_attr</STRONG> and <STRONG>vid_puts</STRONG> routines correspond to vidattr
208 and vidputs, respectively. They use a set of arguments
209 for representing the video attributes plus color, i.e.,
210 one of type attr_t for the attributes and one of short for
211 the color_pair number. The <STRONG>vid_attr</STRONG> and <STRONG>vid_puts</STRONG> routines
212 are designed to use the attribute constants with the <EM>WA</EM><STRONG>_</STRONG>
213 prefix. The opts argument is reserved for future use.
214 Currently, applications must provide a null pointer for
215 that argument.
217 The <STRONG>mvcur</STRONG> routine provides low-level cursor motion. It
218 takes effect immediately (rather than at the next re-
219 fresh).
221 The <STRONG>tigetflag</STRONG>, <STRONG>tigetnum</STRONG> and <STRONG>tigetstr</STRONG> routines return the
222 value of the capability corresponding to the <STRONG>terminfo</STRONG> <EM>cap-</EM>
223 <EM>name</EM> passed to them, such as <STRONG>xenl</STRONG>.
225 The <STRONG>tigetflag</STRONG> routine returns the value <STRONG>-1</STRONG> if <EM>capname</EM> is
226 not a boolean capability, or <STRONG>0</STRONG> if it is canceled or absent
227 from the terminal description.
229 The <STRONG>tigetnum</STRONG> routine returns the value <STRONG>-2</STRONG> if <EM>capname</EM> is
230 not a numeric capability, or <STRONG>-1</STRONG> if it is canceled or ab-
231 sent from the terminal description.
233 The <STRONG>tigetstr</STRONG> routine returns the value <STRONG>(char</STRONG> <STRONG>*)-1</STRONG> if <EM>cap-</EM>
234 <EM>name</EM> is not a string capability, or <STRONG>0</STRONG> if it is canceled or
235 absent from the terminal description.
237 The <EM>capname</EM> for each capability is given in the table col-
238 umn entitled <EM>capname</EM> code in the capabilities section of
239 <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>.
241 <STRONG>char</STRONG> <STRONG>*boolnames[]</STRONG>, <STRONG>*boolcodes[]</STRONG>, <STRONG>*boolfnames[]</STRONG>
243 <STRONG>char</STRONG> <STRONG>*numnames[]</STRONG>, <STRONG>*numcodes[]</STRONG>, <STRONG>*numfnames[]</STRONG>
245 <STRONG>char</STRONG> <STRONG>*strnames[]</STRONG>, <STRONG>*strcodes[]</STRONG>, <STRONG>*strfnames[]</STRONG>
247 These null-terminated arrays contain the <EM>capnames</EM>, the
248 <STRONG>termcap</STRONG> codes, and the full C names, for each of the <STRONG>ter-</STRONG>
249 <STRONG>minfo</STRONG> variables.
252 </PRE>
253 <H2>RETURN VALUE</H2><PRE>
254 Routines that return an integer return <STRONG>ERR</STRONG> upon failure
255 and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
256 <STRONG>ERR</STRONG>") upon successful completion, unless otherwise noted
257 in the preceding routine descriptions.
259 Routines that return pointers always return <STRONG>NULL</STRONG> on error.
261 X/Open defines no error conditions. In this implementa-
262 tion
264 <STRONG>del_curterm</STRONG>
265 returns an error if its terminal parameter is
266 null.
268 <STRONG>putp</STRONG> calls <STRONG>tputs</STRONG>, returning the same error-codes.
270 <STRONG>restartterm</STRONG>
271 returns an error if the associated call to <STRONG>se-</STRONG>
272 <STRONG>tupterm</STRONG> returns an error.
274 <STRONG>setupterm</STRONG>
275 returns an error if it cannot allocate enough
276 memory, or create the initial windows (stdscr,
277 curscr, newscr). Other error conditions are
278 documented above.
280 <STRONG>tputs</STRONG>
281 returns an error if the string parameter is
282 null. It does not detect I/O errors: X/Open
283 states that <STRONG>tputs</STRONG> ignores the return value of
284 the output function <EM>putc</EM>.
287 </PRE>
288 <H2>NOTES</H2><PRE>
289 The <STRONG>setupterm</STRONG> routine should be used in place of <STRONG>setterm</STRONG>.
290 It may be useful when you want to test for terminal capa-
291 bilities without committing to the allocation of storage
292 involved in <STRONG>initscr</STRONG>.
294 Note that <STRONG>vidattr</STRONG> and <STRONG>vidputs</STRONG> may be macros.
297 </PRE>
298 <H2>PORTABILITY</H2><PRE>
299 The function <STRONG>setterm</STRONG> is not described by X/Open and must
300 be considered non-portable. All other functions are as
301 described by X/Open.
303 <STRONG>setupterm</STRONG> copies the terminal name to the array <STRONG>ttytype</STRONG>.
304 This is not part of X/Open Curses, but is assumed by some
305 applications.
307 In System V Release 4, <STRONG>set_curterm</STRONG> has an <STRONG>int</STRONG> return type
308 and returns <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>. We have chosen to implement the
309 X/Open Curses semantics.
311 In System V Release 4, the third argument of <STRONG>tputs</STRONG> has the
312 type <STRONG>int</STRONG> <STRONG>(*putc)(char)</STRONG>.
314 At least one implementation of X/Open Curses (Solaris) re-
315 turns a value other than OK/ERR from <STRONG>tputs</STRONG>. That returns
316 the length of the string, and does no error-checking.
318 X/Open Curses prototypes <STRONG>tparm</STRONG> with a fixed number of pa-
319 rameters, rather than a variable argument list. This im-
320 plementation uses a variable argument list, but can be
321 configured to use the fixed-parameter list. Portable ap-
322 plications should provide 9 parameters after the format;
323 zeroes are fine for this purpose.
325 In response to comments by Thomas E. Dickey, X/Open Curses
326 Issue 7 proposed the <STRONG>tiparam</STRONG> function in mid-2009.
328 X/Open notes that after calling <STRONG>mvcur</STRONG>, the curses state
329 may not match the actual terminal state, and that an ap-
330 plication should touch and refresh the window before re-
331 suming normal curses calls. Both ncurses and System V Re-
332 lease 4 curses implement <STRONG>mvcur</STRONG> using the SCREEN data allo-
333 cated in either <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>. So though it is docu-
334 mented as a terminfo function, <STRONG>mvcur</STRONG> is really a curses
335 function which is not well specified.
337 X/Open states that the old location must be given for
338 <STRONG>mvcur</STRONG>. This implementation allows the caller to use -1's
339 for the old ordinates. In that case, the old location is
340 unknown.
342 Extended terminal capability names, e.g., as defined by
343 <STRONG>tic</STRONG> <STRONG>-x</STRONG>, are not stored in the arrays described in this
344 section.
347 </PRE>
348 <H2>SEE ALSO</H2><PRE>
349 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>, <STRONG>curs_term-</STRONG>
350 <STRONG><A HREF="curs_termcap.3x.html">cap(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="term_variables.3x.html">term_variables(3x)</A></STRONG>, <STRONG><A HREF="putc.3.html">putc(3)</A></STRONG>,
351 <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>
355 <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>
356 </PRE>
357 <HR>
358 <ADDRESS>
359 Man(1) output converted with
360 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
361 </ADDRESS>
362 </BODY>
363 </HTML>