curstermcap(3X) curstermcap(3X)

NAME
       ttggeetteenntt,  ttggeettffllaagg,  ttggeettnnuumm,  ttggeettssttrr,  ttggoottoo,  ttppuuttss  - direct ccuurrsseess
       interface to the terminfo capability database

SYNOPSIS
       ##iinncclluuddee <>
       ##iinncclluuddee <>
       eexxtteerrnn cchhaarr PPCC;; eexxtteerrnn cchhaarr **  UUPP;;  eexxtteerrnn  cchhaarr  **  BBCC;;  eexxtteerrnn  sshhoorrtt
       oossppeeeedd;;
       iinntt ttggeetteenntt((cchhaarr **bbpp,, ccoonnsstt cchhaarr **nnaammee));;
       iinntt ttggeettffllaagg((cchhaarr **iidd));;
       iinntt ttggeettnnuumm((cchhaarr **iidd));;
       cchhaarr **ttggeettssttrr((cchhaarr **iidd,, cchhaarr ****aarreeaa));;
       cchhaarr **ttggoottoo((ccoonnsstt cchhaarr **ccaapp,, iinntt ccooll,, iinntt rrooww));;
       iinntt ttppuuttss((ccoonnsstt cchhaarr **ssttrr,, iinntt aaffffccnntt,, iinntt ((**ppuuttcc))((iinntt))));;

DESCRIPTION
       These  routines  are included as a conversion aid for programs that use
       the termcap library.  Their parameters are the same  and  the  routines
       are  emulated using the terminfo database.  Thus, they can only be used
       to query the capabilities of entries for which  a  terminfo  entry  has
       been compiled.

       The ttggeetteenntt routine loads the entry for name.  It returns 1 on success,
       0 if there is no such entry, and -1 if the terminfo database could  not
       be found.  The emulation ignores the buffer pointer bp.

       The  ttggeettffllaagg  routine  gets the boolean entry for id, or zero if it is
       not available.

       The ttggeettnnuumm routine gets the numeric entry for id, or -1 if it  is  not
       available.

       The  ttggeettssttrr  routine returns the string entry for id, or zero if it is
       not available.  Use ttppuuttss to output the returned  string.   The  return
       value  will  also  be  copied to the buffer pointed to by area, and the
       area value will be updated to point past the null ending this value.

       Only the first two characters of the iidd parameter of ttggeettffllaagg,  ttggeettnnuumm
       and ttggeettssttrr are compared in lookups.

       The  ttggoottoo  routine instantiates the parameters into the given capabil-
       ity.  The output from this routine is to be passed to ttppuuttss.

       The ttppuuttss routine is described on the  ccuurrsstteerrmmiinnffoo(3X)  manual  page.
       It can retrieve capabilities by either termcap or terminfo name.

       The  variables PPCC, UUPP and BBCC are set by ttggeetteenntt to the terminfo entry's
       data for ppaaddcchhaarr, ccuurrssoorruupp and bbaacckkssppaacceeiiffnnoottbbss, respectively.  UUPP
       is  not used by ncurses.  PPCC is used in the ttddeellaayyoouuttppuutt function.  BBCC
       is used in the ttggoottoo emulation.  The variable oossppeeeedd is set by  ncurses
       in a system-specific coding to reflect the terminal speed.


RREETTUURRNN VVAALLUUEE
       Except  where  explicitly noted, routines that return an integer return
       EERRRR upon failure and OOKK (SVr4 only specifies "an  integer  value  other
       than EERRRR") upon successful completion.

       Routines that return pointers return NNUULLLL on error.

BUGS
       If  you  call ttggeettssttrr to fetch ccaa or any other parameterized string, be
       aware that it will be returned in terminfo notation, not the older  and
       not-quite-compatible  termcap  notation.   This won't cause problems if
       all you do with it is call ttggoottoo or ttppaarrmm, which both expand  terminfo-
       style  strings as terminfo.  (The ttggoottoo function, if configured to sup-
       port termcap, will check if the  string  is  indeed  terminfo-style  by
       looking  for  "%p"  parameters or "$<..>" delays, and invoke a termcap-
       style parser if the string does not appear to be terminfo).

       Because terminfo conventions for representing padding in  string  capa-
       bilities  differ  from  termcap's,  ttppuuttss((""5500""));; will put out a literal
       "50" rather than busy-waiting for 50 milliseconds.  Cope with it.

       Note that termcap has nothing analogous to terminfo's ssggrr string.   One
       consequence  of  this  is that termcap applications assume me (terminfo
       ssggrr00) does not reset the alternate character set.  This  implementation
       checks  for,  and  modifies  the data shown to the termcap interface to
       accommodate termcap's limitation in this respect.

PPOORRTTAABBIILLIITTYY
       The XSI Curses standard, Issue 4 describes these  functions.   However,
       they  are marked TO BE WITHDRAWN and may be removed in future versions.

       Neither the XSI Curses standard nor the SVr4 man pages  documented  the
       return  values  of  ttggeetteenntt  correctly,  though  all three were in fact
       returned ever since SVr1.  In particular, an omission in the XSI Curses
       documentation  has  been misinterpreted to mean that ttggeetteenntt returns OOKK
       or EERRRR.  Because the purpose of these functions is to provide  compati-
       bility  with the termcap library, that is a defect in XCurses, Issue 4,
       Version 2 rather than in ncurses.

       External variables are provided for support of certain termcap applica-
       tions.  However, termcap applications' use of those variables is poorly
       documented, e.g., not distinguishing between input and output.  In par-
       ticular,  some  applications  are  reported  to  declare  and/or modify
       oossppeeeedd.

SEE ALSO
       ccuurrsseess(3X), tteerrmmiinnffoo(5), ppuuttcc(3S).



                                                              curstermcap(3X)