Description |
 |
Within CURSES, setupterm() is automatically called by
initscr() and newterm(). This routine can be also be used outside of CURSES when the program has to deal directly with the TERMINFO database to handle certain terminal capabilities. The use of appropriate CURSES routines is recommended in all other situations.
The setupterm() routine defines terminal-dependent
variables for the terminfo layer of CURSES. The setupterm() routine initializes the terminfo variables lines and columns such that if use_env(FALSE) has been called, the TERMINFO values are used regardless of the environmental variables LINES and COLUMNS or the program's window dimensions. When use_env(TRUE) has been called, which is the default, the environment variables LINES and COLUMNS are used, if they exist. If the environment variables do not exist and the program is running in a window, the current window size is used.
The term parameter of setupterm() specifies the terminal; if null, terminal type is taken from the TERM
environment variable. All output is sent to fildes which is initialized for output. If errret is not
null, OK or ERR is returned and a status value is stored in the integer pointed to by errret. The status values that may be returned are shown in Table 4-7 “Status Values”.
Table 4-7 Status Values
| Value | Description |
|---|
| 1 | Normal |
| 0 | Terminal could not be found |
| -1 | TERMINFO database could not be found
|
If erret is null, an error message is printed, and
setupterm() exits.
The setterm() routine is an older version of setupterm(). It is included for compatibility with previous versions of CURSES. New programs should use setupterm().
