2 <BODY BGCOLOR="#99ccbb" TEXT="#000000" LINK="#4060b0" VLINK="#000080" ALINK="#ff4040">
4 <STRONG>setupterm</STRONG>, <STRONG>setterm</STRONG>, <STRONG>set_curterm</STRONG>, <STRONG>del_curterm</STRONG>, <STRONG>restartterm</STRONG>,
5 <STRONG>tparm</STRONG>, <STRONG>tputs</STRONG>, <STRONG>putp</STRONG>, <STRONG>vidputs</STRONG>, <STRONG>vidattr</STRONG>, <STRONG>mvcur</STRONG>, <STRONG>tigetflag</STRONG>,
6 <STRONG>tigetnum</STRONG>, <STRONG>tigetstr</STRONG> - <STRONG>curses</STRONG> interfaces to terminfo
11 <H2>SYNOPSIS</H2><PRE>
12 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
13 <STRONG>#include</STRONG> <STRONG><term.h></STRONG>
15 <STRONG>int</STRONG> <STRONG>setupterm(const</STRONG> <STRONG>char</STRONG> <STRONG>*term,</STRONG> <STRONG>int</STRONG> <STRONG>fildes,</STRONG> <STRONG>int</STRONG> <STRONG>*errret);</STRONG>
16 <STRONG>int</STRONG> <STRONG>setterm(const</STRONG> <STRONG>char</STRONG> <STRONG>*term);</STRONG>
17 <STRONG>TERMINAL</STRONG> <STRONG>*set_curterm(TERMINAL</STRONG> <STRONG>*nterm);</STRONG>
18 <STRONG>int</STRONG> <STRONG>del_curterm(TERMINAL</STRONG> <STRONG>*oterm);</STRONG>
19 <STRONG>int</STRONG> <STRONG>restartterm(const</STRONG> <STRONG>char</STRONG> <STRONG>*term,</STRONG> <STRONG>int</STRONG> <STRONG>fildes,</STRONG> <STRONG>int</STRONG>
20 <STRONG>*errret);</STRONG>
21 <STRONG>char</STRONG> <STRONG>*tparm(const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>...);</STRONG>
22 <STRONG>char</STRONG> <STRONG>*tparam(const</STRONG> <STRONG>char</STRONG> <STRONG>*str,</STRONG> <STRONG>char</STRONG> <STRONG>*buffer,</STRONG> <STRONG>int</STRONG> <STRONG>size,</STRONG>
23 <STRONG>...);</STRONG>
24 <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>
25 <STRONG>int</STRONG> <STRONG>putp(const</STRONG> <STRONG>char</STRONG> <STRONG>*str);</STRONG>
26 <STRONG>int</STRONG> <STRONG>vidputs(chtype</STRONG> <STRONG>attrs,</STRONG> <STRONG>int</STRONG> <STRONG>(*putc)(char));</STRONG>
27 <STRONG>int</STRONG> <STRONG>vidattr(chtype</STRONG> <STRONG>attrs);</STRONG>
28 <STRONG>int</STRONG> <STRONG>mvcur(int</STRONG> <STRONG>oldrow,</STRONG> <STRONG>int</STRONG> <STRONG>oldcol,</STRONG> <STRONG>int</STRONG> <STRONG>newrow,</STRONG> <STRONG>int</STRONG> <STRONG>newcol);</STRONG>
29 <STRONG>int</STRONG> <STRONG>tigetflag(const</STRONG> <STRONG>char</STRONG> <STRONG>*capname);</STRONG>
30 <STRONG>int</STRONG> <STRONG>tigetnum(const</STRONG> <STRONG>char</STRONG> <STRONG>*capname);</STRONG>
31 <STRONG>char</STRONG> <STRONG>*tigetstr(const</STRONG> <STRONG>char</STRONG> <STRONG>*capname);</STRONG>
35 <H2>DESCRIPTION</H2><PRE>
36 These low-level routines must be called by programs that
37 have to deal directly with the <STRONG>terminfo</STRONG> database to handle
38 certain terminal capabilities, such as programming func-
39 tion keys. For all other functionality, <STRONG>curses</STRONG> routines
40 are more suitable and their use is recommended.
42 Initially, <STRONG>setupterm</STRONG> should be called. Note that
43 <STRONG>setupterm</STRONG> is automatically called by <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG>.
44 This defines the set of terminal-dependent variables
45 [listed in <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>]. The <STRONG>terminfo</STRONG> variables <STRONG>lines</STRONG> and
46 <STRONG>columns</STRONG> are initialized by <STRONG>setupterm</STRONG> as follows: If
47 <STRONG>use_env(FALSE)</STRONG> has been called, values for <STRONG>lines</STRONG> and
48 <STRONG>columns</STRONG> specified in <STRONG>terminfo</STRONG> are used. Otherwise, if the
49 environment variables <STRONG>LINES</STRONG> and <STRONG>COLUMNS</STRONG> exist, their val-
50 ues are used. If these environment variables do not exist
51 and the program is running in a window, the current window
52 size is used. Otherwise, if the environment variables do
53 not exist, the values for <STRONG>lines</STRONG> and <STRONG>columns</STRONG> specified in
54 the <STRONG>terminfo</STRONG> database are used.
56 The header files <STRONG>curses.h</STRONG> and <STRONG>term.h</STRONG> should be included
57 (in this order) to get the definitions for these strings,
58 numbers, and flags. Parameterized strings should be
59 passed through <STRONG>tparm</STRONG> to instantiate them. All <STRONG>terminfo</STRONG>
60 the tty modes before exiting [see <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3X)</A></STRONG>]. Pro-
61 grams which use cursor addressing should output
62 <STRONG>enter_ca_mode</STRONG> upon startup and should output <STRONG>exit_ca_mode</STRONG>
63 before exiting. Programs desiring shell escapes should
66 <STRONG>reset_shell_mode</STRONG> and output <STRONG>exit_ca_mode</STRONG> before the shell
67 is called and should output <STRONG>enter_ca_mode</STRONG> and call
68 <STRONG>reset_prog_mode</STRONG> after returning from the shell.
70 The <STRONG>setupterm</STRONG> routine reads in the <STRONG>terminfo</STRONG> database, ini-
71 tializing the <STRONG>terminfo</STRONG> structures, but does not set up the
72 output virtualization structures used by <STRONG>curses</STRONG>. The ter-
73 minal type is the character string <EM>term</EM>; if <EM>term</EM> is null,
74 the environment variable <STRONG>TERM</STRONG> is used. All output is to
75 file descriptor <STRONG>fildes</STRONG> which is initialized for output.
76 If <EM>errret</EM> is not null, then <STRONG>setupterm</STRONG> returns <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>
77 and stores a status value in the integer pointed to by
78 <EM>errret</EM>. A status of <STRONG>1</STRONG> in <EM>errret</EM> is normal, <STRONG>0</STRONG> means that
79 the terminal could not be found, and <STRONG>-1</STRONG> means that the
80 <STRONG>terminfo</STRONG> database could not be found. If <EM>errret</EM> is null,
81 <STRONG>setupterm</STRONG> prints an error message upon finding an error
82 and exits. Thus, the simplest call is:
84 <STRONG>setupterm((char</STRONG> <STRONG>*)0,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0);</STRONG>,
86 which uses all the defaults and sends the output to <STRONG>std-</STRONG>
89 The <STRONG>setterm</STRONG> routine is being replaced by <STRONG>setupterm</STRONG>. The
92 <STRONG>setupterm(</STRONG><EM>term</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>(int</STRONG> <STRONG>*)0)</STRONG>
94 provides the same functionality as <STRONG>setterm(</STRONG><EM>term</EM><STRONG>)</STRONG>. The
95 <STRONG>setterm</STRONG> routine is included here for BSD compatibility,
96 and is not recommended for new programs.
98 The <STRONG>set_curterm</STRONG> routine sets the variable <STRONG>cur_term</STRONG> to
99 <EM>nterm</EM>, and makes all of the <STRONG>terminfo</STRONG> boolean, numeric, and
100 string variables use the values from <EM>nterm</EM>. It returns
101 the old value of <STRONG>cur_term</STRONG>.
103 The <STRONG>del_curterm</STRONG> routine frees the space pointed to by
104 <EM>oterm</EM> and makes it available for further use. If <EM>oterm</EM> is
105 the same as <STRONG>cur_term</STRONG>, references to any of the <STRONG>terminfo</STRONG>
106 boolean, numeric, and string variables thereafter may
107 refer to invalid memory locations until another <STRONG>setupterm</STRONG>
110 The <STRONG>restartterm</STRONG> routine is similar to <STRONG>setupterm</STRONG> and
111 <STRONG>initscr</STRONG>, except that it is called after restoring memory
112 and the input and output options are the same as when mem-
113 ory was saved, but the terminal type and baud rate may be
114 different. Accordingly, it saves various tty state bits,
115 does a setupterm, and then restores the bits.
117 The <STRONG>tparm</STRONG> routine instantiates the string <EM>str</EM> with parame-
118 ters <EM>pi</EM>. A pointer is returned to the result of <EM>str</EM> with
119 the parameters applied.
121 The <STRONG>tparam</STRONG> routine is included for compatibility with the
122 GNU termcap implementation. It works like <STRONG>tparm</STRONG> but you
123 specify a buffer and buffer size to be filled with the
126 The <STRONG>tputs</STRONG> routine applies padding information to the
127 string <EM>str</EM> and outputs it. The <EM>str</EM> must be a terminfo
128 string variable or the return value from <STRONG>tparm</STRONG>, <STRONG>tgetstr</STRONG>,
129 or <STRONG>tgoto</STRONG>. <EM>affcnt</EM> is the number of lines affected, or 1 if
130 not applicable. <EM>putc</EM> is a <STRONG>putchar</STRONG>-like routine to which
131 the characters are passed, one at a time.
133 The <STRONG>putp</STRONG> routine calls <STRONG>tputs(</STRONG><EM>str</EM><STRONG>,</STRONG> <STRONG>1,</STRONG> <STRONG>putchar)</STRONG>. Note that
134 the output of <STRONG>putp</STRONG> always goes to <STRONG>stdout</STRONG>, not to the
135 <EM>fildes</EM> specified in <STRONG>setupterm</STRONG>.
137 The <STRONG>vidputs</STRONG> routine displays the string on the terminal in
138 the video attribute mode <EM>attrs</EM>, which is any combination
139 of the attributes listed in <STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>. The characters
140 are passed to the <STRONG>putchar</STRONG>-like routine <EM>putc</EM>.
142 The <STRONG>vidattr</STRONG> routine is like the <STRONG>vidputs</STRONG> routine, except
143 that it outputs through <STRONG>putchar</STRONG>.
145 The <STRONG>mvcur</STRONG> routine provides low-level cursor motion. It
146 takes effect immediately (rather than at the next
149 The <STRONG>tigetflag</STRONG>, <STRONG>tigetnum</STRONG> and <STRONG>tigetstr</STRONG> routines return the
150 value of the capability corresponding to the <STRONG>terminfo</STRONG> <EM>cap-</EM>
151 <EM>name</EM> passed to them, such as <STRONG>xenl</STRONG>.
153 The <STRONG>tigetflag</STRONG> routine returns the value <STRONG>-1</STRONG> if <EM>capname</EM> is
154 not a boolean capability.
156 The <STRONG>tigetnum</STRONG> routine returns the value <STRONG>-2</STRONG> if <EM>capname</EM> is
157 not a numeric capability.
159 The <STRONG>tigetstr</STRONG> routine returns the value <STRONG>(char</STRONG> <STRONG>*)-1</STRONG> if <EM>cap-</EM>
160 <EM>name</EM> is not a string capability.
162 The <EM>capname</EM> for each capability is given in the table col-
163 umn entitled <EM>capname</EM> code in the capabilities section of
165 <STRONG>char</STRONG> <STRONG>*numnames</STRONG>, <STRONG>*numcodes</STRONG>, <STRONG>*numfnames</STRONG>
167 <STRONG>char</STRONG> <STRONG>*strnames</STRONG>, <STRONG>*strcodes</STRONG>, <STRONG>*strfnames</STRONG>
169 These null-terminated arrays contain the <EM>capnames</EM>, the
170 <STRONG>termcap</STRONG> codes, and the full C names, for each of the <STRONG>ter-</STRONG>
171 <STRONG>minfo</STRONG> variables.
175 <H2>RETURN VALUE</H2><PRE>
176 Routines that return an integer return <STRONG>ERR</STRONG> upon failure
177 and <STRONG>OK</STRONG> (SVr4 only specifies "an integer value other than
178 <STRONG>ERR</STRONG>") upon successful completion, unless otherwise noted
179 in the preceding routine descriptions.
181 Routines that return pointers always return <STRONG>NULL</STRONG> on error.
186 The <STRONG>setupterm</STRONG> routine should be used in place of <STRONG>setterm</STRONG>.
187 It may be useful when you want to test for terminal capa-
188 bilities without committing to the allocation of storage
189 involved in <STRONG>initscr</STRONG>.
191 Note that <STRONG>vidattr</STRONG> and <STRONG>vidputs</STRONG> may be macros.
195 <H2>PORTABILITY</H2><PRE>
196 The function <STRONG>setterm</STRONG> is not described in the XSI Curses
197 standard and must be considered non-portable. All other
198 functions are as described in the XSI curses standard.
200 In System V Release 4, <STRONG>set_curterm</STRONG> has an <STRONG>int</STRONG> return type
201 and returns <STRONG>OK</STRONG> or <STRONG>ERR</STRONG>. We have chosen to implement the
202 XSI Curses semantics.
204 In System V Release 4, the third argument of <STRONG>tputs</STRONG> has the
205 type <STRONG>int</STRONG> <STRONG>(*putc)(char)</STRONG>.
207 The XSI Curses standard prototypes <STRONG>tparm</STRONG> with a fixed num-
208 ber of parameters, rather than a variable argument list.
212 <H2>SEE ALSO</H2><PRE>
213 <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>
214 <STRONG><A HREF="cap.3x.html">cap(3X)</A></STRONG>, <STRONG><A HREF="putc.3s.html">putc(3S)</A></STRONG>, <STRONG><A HREF="terminfo.5.html">terminfo(5)</A></STRONG>