lib/libncurses/man/curs_termcap.3

   1 .\"***************************************************************************
   2 .\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *
   3 .\"                                                                          *
   4 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   5 .\" copy of this software and associated documentation files (the            *
   6 .\" "Software"), to deal in the Software without restriction, including      *
   7 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   8 .\" distribute, distribute with modifications, sublicense, and/or sell       *
   9 .\" copies of the Software, and to permit persons to whom the Software is    *
  10 .\" furnished to do so, subject to the following conditions:                 *
  11 .\"                                                                          *
  12 .\" The above copyright notice and this permission notice shall be included  *
  13 .\" in all copies or substantial portions of the Software.                   *
  14 .\"                                                                          *
  15 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  16 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  17 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  18 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  19 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  20 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  21 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  22 .\"                                                                          *
  23 .\" Except as contained in this notice, the name(s) of the above copyright   *
  24 .\" holders shall not be used in advertising or otherwise to promote the     *
  25 .\" sale, use or other dealings in this Software without prior written       *
  26 .\" authorization.                                                           *
  27 .\"***************************************************************************
  28 .\"
  29 .\" $Id: curs_termcap.3x,v 1.18 2003/02/08 22:25:47 tom Exp $
  30 .\" $DragonFly: src/lib/libncurses/man/curs_termcap.3,v 1.1 2005/03/12 19:13:54 eirikn Exp $
  31 .TH curs_termcap 3X ""
  32 .ds n 5
  33 .SH NAME
  34 \fBtgetent\fR,
  35 \fBtgetflag\fR,
  36 \fBtgetnum\fR,
  37 \fBtgetstr\fR,
  38 \fBtgoto\fR,
  39 \fBtputs\fR - direct \fBcurses\fR interface to the terminfo capability database
  40 .SH SYNOPSIS
  41 \fB#include <curses.h>\fR
  42 .br
  43 \fB#include <term.h>\fR
  44 .br
  45 \fBextern char PC;\fR
  46 \fBextern char * UP;\fR
  47 \fBextern char * BC;\fR
  48 \fBextern short ospeed;\fR
  49 .br
  50 \fBint tgetent(char *bp, const char *name);\fR
  51 .br
  52 \fBint tgetflag(char *id);\fR
  53 .br
  54 \fBint tgetnum(char *id);\fR
  55 .br
  56 \fBchar *tgetstr(char *id, char **area);\fR
  57 .br
  58 \fBchar *tgoto(const char *cap, int col, int row);\fR
  59 .br
  60 \fBint tputs(const char *str, int affcnt, int (*putc)(int));\fR
  61 .br
  62 .SH DESCRIPTION
  63 These routines are included as a conversion aid for programs that use
  64 the \fItermcap\fR library.  Their parameters are the same and the
  65 routines are emulated using the \fIterminfo\fR database.  Thus, they
  66 can only be used to query the capabilities of entries for which a
  67 terminfo entry has been compiled.
  68
  69 The \fBtgetent\fR routine loads the entry for \fIname\fR.
  70 It returns 1 on success, 0 if there is no such entry, and -1 if the
  71 terminfo database could not be found.
  72 The emulation ignores the buffer pointer \fIbp\fR.
  73
  74 The \fBtgetflag\fR routine gets the boolean entry for \fIid\fR,
  75 or zero if it is not available.
  76
  77 The \fBtgetnum\fR routine gets the numeric entry for \fIid\fR,
  78 or -1 if it is not available.
  79
  80 The \fBtgetstr\fR routine returns the string entry for \fIid\fR,
  81 or zero if it is not available.
  82 Use \fBtputs\fR to output the returned string.
  83 The return value will also be copied to the buffer pointed to by \fIarea\fR,
  84 and the \fIarea\fR value will be updated to point past the null ending
  85 this value.
  86
  87 Only the first two characters of the \fBid\fR parameter of
  88 \fBtgetflag\fR,
  89 \fBtgetnum\fR and
  90 \fBtgetstr\fR are compared in lookups.
  91
  92 The \fBtgoto\fR routine instantiates the parameters into the given capability.
  93 The output from this routine is to be passed to \fBtputs\fR.
  94
  95 The \fBtputs\fR routine is described on the \fBcurs_terminfo\fR(3X) manual
  96 page.  It can retrieve capabilities by either termcap or terminfo name.
  97
  98 The variables
  99 \fBPC\fR,
 100 \fBUP\fR and
 101 \fBBC\fR
 102 are set by \fBtgetent\fR to the terminfo entry's data for
 103 \fBpad_char\fR,
 104 \fBcursor_up\fR and
 105 \fBbackspace_if_not_bs\fR,
 106 respectively.
 107 \fBUP\fR is not used by ncurses.
 108 \fBPC\fR is used in the \fBtdelay_output\fR function.
 109 \fBBC\fR is used in the \fBtgoto\fR emulation.
 110 The variable \fBospeed\fR is set by ncurses in a system-specific coding
 111 to reflect the terminal speed.
 112
 113 .SH RETURN VALUE
 114 Except where explicitly noted,
 115 routines that return an integer return \fBERR\fR upon failure and \fBOK\fR
 116 (SVr4 only specifies "an integer value other than \fBERR\fR") upon successful
 117 completion.
 118
 119 Routines that return pointers return \fBNULL\fR on error.
 120 .SH BUGS
 121 If you call \fBtgetstr\fR to fetch \fBca\fR or any other parameterized string,
 122 be aware that it will be returned in terminfo notation, not the older and
 123 not-quite-compatible termcap notation.  This won't cause problems if all
 124 you do with it is call \fBtgoto\fR or \fBtparm\fR, which both expand
 125 terminfo-style strings as terminfo.
 126 (The \fBtgoto\fR function, if configured to support termcap, will check
 127 if the string is indeed terminfo-style by looking for "%p" parameters or
 128 "$<..>" delays, and invoke a termcap-style parser if the string does not
 129 appear to be terminfo).
 130
 131 Because terminfo conventions for representing padding in string capabilities
 132 differ from termcap's, \fBtputs("50");\fR will put out a literal "50" rather
 133 than busy-waiting for 50 milliseconds.  Cope with it.
 134
 135 Note that termcap has nothing analogous to terminfo's \fBsgr\fR string.
 136 One consequence of this is that termcap applications assume \fRme\fR
 137 (terminfo \fBsgr0\fR) does not reset the alternate character set.
 138 This implementation checks for, and modifies the data shown to the
 139 termcap interface to accommodate termcap's limitation in this respect.
 140 .SH PORTABILITY
 141 The XSI Curses standard, Issue 4 describes these functions.  However, they
 142 are marked TO BE WITHDRAWN and may be removed in future versions.
 143
 144 Neither the XSI Curses standard nor the SVr4 man pages documented the return
 145 values of \fBtgetent\fR correctly, though all three were in fact returned ever
 146 since SVr1.
 147 In particular, an omission in the XSI Curses documentation has been
 148 misinterpreted to mean that \fBtgetent\fR returns \fBOK\fR or \fBERR\fR.
 149 Because the purpose of these functions is to provide compatibility with
 150 the \fItermcap\fR library, that is a defect in XCurses, Issue 4, Version 2
 151 rather than in ncurses.
 152
 153 External variables are provided for support of certain termcap applications.
 154 However, termcap applications' use of those variables is poorly documented,
 155 e.g., not distinguishing between input and output.
 156 In particular, some applications are reported to declare and/or
 157 modify \fBospeed\fR.
 158 .SH SEE ALSO
 159 \fBcurses\fR(3X), \fBterminfo\fR(\*n), \fBputc\fR(3S).
 160 .\"#
 161 .\"# The following sets edit modes for GNU EMACS
 162 .\"# Local Variables:
 163 .\"# mode:nroff
 164 .\"# fill-column:79
 165 .\"# End: