usr/src/man/man3curses/curs_termcap.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH CURS_TERMCAP 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_termcap, tgetent, tgetflag, tgetnum, tgetstr, tgoto \- curses interfaces
  10 (emulated) to the termcap library
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ]
  15 #include <curses.h>
  16 #include <term.h>
  17
  18 \fBint\fR \fBtgetent\fR(\fBchar *\fR\fIbp\fR, \fBchar *\fR\fIname\fR);
  19 .fi
  20
  21 .LP
  22 .nf
  23 \fBint\fR \fBtgetflag\fR(\fBchar\fR \fIid\fR[2]);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBtgetnum\fR(\fBchar\fR \fIid\fR[2]);
  29 .fi
  30
  31 .LP
  32 .nf
  33 \fBchar *\fR\fBtgetstr\fR(\fBchar\fR \fIid\fR[2], \fBchar **\fR\fIarea\fR);
  34 .fi
  35
  36 .LP
  37 .nf
  38 \fBchar *\fR\fBtgoto\fR(\fBchar *\fR\fIcap\fR, \fBint\fR \fIcol\fR, \fBint\fR \fIrow\fR);
  39 .fi
  40
  41 .LP
  42 .nf
  43 \fBint\fR \fBtputs\fR(\fBchar *\fR\fIstr\fR, \fBint\fR \fIaffcnt\fR, \fBint (*\fR\fIputc\fR)(void));
  44 .fi
  45
  46 .SH DESCRIPTION
  47 .sp
  48 .LP
  49 These routines are included as a conversion aid for programs that use the
  50 \fItermcap\fR library. Their parameters are the same and the routines are
  51 emulated using the \fIterminfo\fR database. These routines are supported at
  52 Level 2 and should not be used in new applications.
  53 .sp
  54 .LP
  55 The \fBtgetent()\fR routine looks up the termcap entry for \fIname\fR. The
  56 emulation ignores the buffer pointer \fIbp\fR.
  57 .sp
  58 .LP
  59 The \fBtgetflag()\fR routine gets the boolean entry for \fIid\fR.
  60 .sp
  61 .LP
  62 The \fBtgetnum()\fR routine gets the numeric entry for \fIid\fR.
  63 .sp
  64 .LP
  65 The \fBtgetstr()\fR routine returns the string entry for \fIid\fR. Use
  66 \fBtputs()\fR to output the returned string.
  67 .sp
  68 .LP
  69 The \fBtgoto()\fR routine instantiates the parameters into the given
  70 capability. The output from this routine is to be passed to \fBtputs()\fR.
  71 .sp
  72 .LP
  73 The \fBtputs()\fR routine is described on the \fBcurs_terminfo\fR(3CURSES)
  74 manual page.
  75 .SH RETURN VALUES
  76 .sp
  77 .LP
  78 Routines that return an integer return \fBERR\fR upon failure and an integer
  79 value other than \fBERR\fR upon successful completion.
  80 .sp
  81 .LP
  82 Routines that return pointers return \fINULL\fR on error.
  83 .SH ATTRIBUTES
  84 .sp
  85 .LP
  86 See \fBattributes\fR(5) for descriptions of the following attributes:
  87 .sp
  88
  89 .sp
  90 .TS
  91 box;
  92 c | c
  93 l | l .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 MT-Level        Unsafe
  97 .TE
  98
  99 .SH SEE ALSO
 100 .sp
 101 .LP
 102 \fBcurs_terminfo\fR(3CURSES), \fBcurses\fR(3CURSES), \fBputc\fR(3C),
 103 \fBattributes\fR(5)
 104 .SH NOTES
 105 .sp
 106 .LP
 107 The header <\fBcurses.h\fR> automatically includes the headers  <\fBstdio.h\fR>
 108 and <\fBunctrl.h\fR>.