termlib(3)
NAME
tgetent, tgetnum, tgetflag, tgetstr, tgoto, tputs − terminal independent operation routines
SYNTAX
char PC;
char *BC;
char *UP;
short ospeed;
tgetent(bp, name)
char *bp, *name;
tgetnum(id)
char *id;
tgetflag(id)
char *id;
char *
tgetstr(id, area)
char *id, **area;
char *
tgoto(cm, destcol, destline)
char *cm;
tputs(cp, affcnt, outc)
register char *cp;
int affcnt;
int (*outc)();
DESCRIPTION
These functions extract and use capabilities from the terminal capability data base termcap(5). These are low level routines. For a higher level package, see curses(3x).
The tgetent subroutine extracts the entry for terminal name into the buffer at bp, which should be a character buffer of size 1024 and must be retained through all subsequent calls to tgetnum, tgetflag, and tgetstr. The tgetent subroutine returns −1 if it cannot open the termcap file, 0 if the terminal name given does not have an entry, and 1 if successful. It will look in the environment for a TERMCAP variable. If found, and the value does not begin with a slash, and the terminal type name is the same as the environment string TERM, the TERMCAP string is used instead of reading the termcap file. If it does begin with a slash, the string is used as a path name rather than /etc/termcap. This can speed up entry into programs that call tgetent, as well as to help debug new terminal descriptions or to make one for your terminal if you can’t write the file /etc/termcap.
The tgetnum subroutine gets the numeric value of capability id and returns −1 if it is not given for the terminal. The tgetflag subroutine returns 1 if the specified capability is present in the terminal’s entry, 0 if it is not. The tgetstr subroutine gets the string value of capability id, places it in the buffer at area, advances the area pointer. It decodes the abbreviations for this field described in termcap(5), except for cursor addressing and padding information.
The tgoto subroutine returns a cursor addressing string decoded from cm to go to column destcol in line destline. It uses the external variables UP (from the up capability) and BC (if bc is given rather than bs) if necessary to avoid placing \n, ^D or ^@ in the returned string. (Programs which call tgoto should be sure to turn off the XTABS bit(s), since tgoto may now output a tab. Programs using termcap should in general turn off XTABS anyway since some terminals use control I for other functions, such as nondestructive space.) If a % sequence is given which is not understood, then tgoto returns “OOPS”.
The tputs subroutine decodes the leading padding information of the string cp. The affcnt gives the number of lines affected by the operation, or 1 if this is not applicable. The outc is a routine which is called with each character in turn. The external variable ospeed should contain the output speed of the terminal as encoded by stty(1). The external variable PC should contain a pad character to be used (from the pc capability) if a null (^@) is inappropriate.
FILES
/usr/lib/libtermlib.a−ltermlib library
/etc/termcapdata base