icon Top 9 categories map      RocketAware > man pages >


Tips: Browse or Search all pages for efficient awareness of more than 6000 of the most popular reusable and open source applications, functions, libraries, and FAQs.

The "RKT couplings" below include links to source code, updates, additional information, advice, FAQs, and overviews.


Search all pages


By activity
Professions, Sciences, Humanities, Business, ...

User Interface
Text-based, GUI, Audio, Video, Keyboards, Mouse, Images,...

Text Strings
Conversions, tests, processing, manipulation,...

Integer, Floating point, Matrix, Statistics, Boolean, ...

Algorithms, Memory, Process control, Debugging, ...

Stored Data
Data storage, Integrity, Encryption, Compression, ...

Networks, protocols, Interprocess, Remote, Client Server, ...

Hard World
Timing, Calendar and Clock, Audio, Video, Printer, Controls...

File System
Management, Filtering, File & Directory access, Viewers, ...


RocketLink!--> Man page versions:

TERMCAP(3)                OpenBSD Programmer's Manual               TERMCAP(3)

     tgetent, tgetnum, tgetflag, tgetstr, tgoto, tputs - terminal independent
     operation routines

     char PC;
     char *BC;
     char *UP;
     short ospeed;

     tgetent(char *bp, char *name);

     tgetnum(char *id);

     tgetflag(char *id);

     char *
     tgetstr(char *id, char **area);

     char *
     tgoto(char *cm, destcol, destline);

     tputs(register char *cp, int affcnt, int (*outc)());

     These functions extract and use capabilities from a terminal capability
     data base, usually /usr/share/misc/termcap, the format of which is de-
     scribed in termcap(5).  This version of these routines has been deprecat-
     ed in favor of the emulation provided by termcap(3).  This library is
     provided solely for old applications that require behavior that is not

     The tgetent() function extracts the entry for terminal name into the
     buffer at bp. The bp argument should be a character buffer of size 1024
     and must be retained through all subsequent calls to tgetnum(),
     tgetflag(), and tgetstr().  As an extension tgetent() can be passed NULL
     for the bp argument, in which case an internal buffer will be used.  If
     repeated calls to tgetent() is made with a NULL bp argument, some memory
     will be leaked on each call subsequent to the first.  The tgetent() func-
     tion returns -1 if none of the termcap data base files could be opened, 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 in-
     stead of reading a termcap file.  If it does begin with a slash, the
     string is used as a path name of the termcap file to search.  If TERMCAP
     does not begin with a slash and name is different from TERM, tgetent()
     searches the files $HOME/.termcap and /usr/share/misc/termcap, in that
     order, unless the environment variable TERMPATH exists, in which case it
     specifies a list of file pathnames (separated by spaces or colons) to be
     searched instead.  Whenever multiple files are searched and a tc field
     occurs in the requested entry, the entry it names must be found in the
     same file or one of the succeeding files.  This can speed up entry into
     programs that call tgetent(), as well as help debug new terminal descrip-
     tions or make one for your terminal if you can't write the file

     The tgetnum() function gets the numeric value of capability id, returning
     -1 if it is not given for the terminal.  The tgetflag() function returns
     1 if the specified capability is present in the terminal's entry, 0 if it
     is not.  The tgetstr() function returns the string value of the capabili-
     ty id, places it in the buffer at area, and advances the area pointer.
     It decodes the abbreviations for this field described in termcap(5),  ex-
     cept for cursor addressing and padding information.  The tgetstr() func-
     tion returns NULL if the capability was not found.

     The tgoto() function 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.  (Pro-
     grams 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).

     The tputs() function 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 out-
     put speed of the terminal as encoded by stty(3).  The external variable
     PC should contain a pad character to be used (from the capability) if a
     null (^@) is inappropriate.

     /usr/lib/libotermcap.a   -l lotermcap library
     /usr/share/misc/termcap  standard terminal capability data base
     $HOME/.termcap           user's terminal capability data base

     ex(1),  curses(3),  termcap(3),  termcap(5)

     The tgetent functions appeared in 4.0BSD.

OpenBSD 2.6                    December 11, 1993                             2

Source: OpenBSD 2.6 man pages. Copyright: Portions are copyrighted by BERKELEY
SOFTWARE DESIGN, INC., The Regents of the University of California, Massachusetts
Institute of Technology, Free Software Foundation, FreeBSD Inc., and others.

(Corrections, notes, and links courtesy of RocketAware.com)

[Detailed Topics]

[Overview Topics]

RocketLink!--> Man page versions:

Rapid-Links: Search | About | Comments | Submit Path: RocketAware > man pages > otermcap.3/
RocketAware.com is a service of Mib Software
Copyright 1999, Forrest J. Cavalier III. All Rights Reserved.
We welcome submissions and comments