tgetflag(3x) [hpux man page]
termcap(3X) termcap(3X) NAME
termcap: tgetent(), tgetflag(), tgetnum(), tgetstr(), tgoto(), tputs() - emulate /usr/share/lib/termcap access routines SYNOPSIS
DESCRIPTION
These functions extract and use capabilities from the compiled terminal capability data bases (see terminfo(4)). They are emulation rou- tines. Extracts the compiled entry for terminal name into buffers accessible by the programmer. Unlike previous termcap routines, all capability strings (except cursor addressing and padding information) are already compiled and stored internally upon return from The buffer pointer bp is redundant in the emulation, and is ignored. It should not be relied upon to point to meaningful infor- mation. returns -1 if it cannot access the terminfo directory or if there is no capability file for name, and 0 if all goes well. If a environment variable is set, first looks for (where is the first character of name), and if that file is not accessible, it looks for Gets the numeric value of capability id, returning -1 if it is not given for the terminal. is useful only with capabilities having numeric values. Returns 1 if the specified capability is present in the terminal's entry, and 0 if it is not. is useful only with capabilities that are boolean in nature (i.e. either present or missing in terminfo(4)). Returns a pointer to the string value of capability id. In addition, if area is not a NULL pointer, places the capability in the buffer at area and advances the area pointer. The returned string capability is compiled except for cursor addressing and padding information. is useful only with capabilities having string values. Returns a cursor addressing string decoded from cm to go to column destcol in line destline. (Programs that call should be sure to turn off the TAB3 bit or bits, since can now output a tab. See termio(7)). Note that programs using should in general turn off TAB3 anyway since some terminals use Ctrl-I for other functions, such as nondestructive space.) If a sequence is given that is not understood, returns [OOPS]. Decodes the padding information of the string cp. affcnt gives the number of lines affected by the operation, or 1 if this is not applicable. outc is a routine that is called with each character in turn. The variable pad_char should contain a pad character to be used (from the pc capability) if a null is inappropriate. WARNINGS
These routines are not meant to be used by programs running in the background. Obsolescent Interfaces and are to be obsoleted at a future date. FILES
library data bases SEE ALSO
ex(1), terminfo(4), termio(7). TO BE OBSOLETED termcap(3X)
Check Out this Related Man Page
TERMCAP(3X) TERMCAP(3X) NAME
tgetent, tgetnum, tgetflag, tgetstr, tgoto, tputs - terminal independent operation routines SYNOPSIS
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; see curses(3X) for a higher level package. Tgetent extracts the entry for terminal name into the buffer at bp. Bp should be a character buffer of size 1024 and must be retained through all subsequent calls to tgetnum, tgetflag, and tgetstr. Tgetent returns -1 if it cannot open the termcap file, 0 if the terminal name given does not have an entry, and 1 if all goes well. 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. Tgetnum gets the numeric value of capability id, returning -1 if is not given for the terminal. Tgetflag returns 1 if the specified capa- bility is present in the terminal's entry, 0 if it is not. Tgetstr returns the string value of the capability id, places it in the buffer at area, and advances the area pointer. It decodes the abbreviations for this field described in termcap(5), except for cursor addressing and padding information. Tgetstr returns NULL if the capability was not found. Tgoto 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 , ^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. Note that 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". Tputs decodes the leading padding information of the string cp; affcnt gives the number of lines affected by the operation, or 1 if this is not applicable, 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(3). The external variable PC should contain a pad character to be used (from the pc capability) if a null (^@) is inappropriate. FILES
/usr/lib/libtermcap.a -ltermcap library /etc/termcap data base SEE ALSO
ex(1), curses(3X), termcap(5) AUTHOR
William Joy 4th Berkeley Distribution May 15, 1985 TERMCAP(3X)