lib/libcurses/curses_termcap.3

   1 .\"     $NetBSD: curses_termcap.3,v 1.3 2003/02/14 16:29:12 grant Exp $
   2 .\"
   3 .\" Copyright (c) 2002
   4 .\"     Brett Lymn (blymn@NetBSD.org, brett_lymn@yahoo.com.au)
   5 .\"
   6 .\" This code is donated to the NetBSD Foundation by the Author.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. The name of the Author may not be used to endorse or promote
  17 .\"    products derived from this software without specific prior written
  18 .\"    permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"
  33 .Dd August 12, 2002
  34 .Dt CURSES_TERMCAP 3
  35 .Os
  36 .Sh NAME
  37 .Nm curses_termcap ,
  38 .Nm fullname ,
  39 .Nm getcap ,
  40 .Nm longname
  41 .Nd curses termcap querying routines
  42 .Sh LIBRARY
  43 .Lb libcurses
  44 .Sh SYNOPSIS
  45 .In curses.h
  46 .Ft char *
  47 .Fn fullname "char *termbuf" "char *name"
  48 .Ft char *
  49 .Fn getcap "char *name"
  50 .Ft char *
  51 .Fn longname "void"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn fullname
  55 function takes the termcap entry in
  56 .Fa termbuf
  57 and copies the full name of the terminal from the entry into the
  58 target variable
  59 .Fa name .
  60 The full name of the terminal is assumed to be the last alias in the
  61 termcap entry name.
  62 It is assumed that the
  63 .Fa name
  64 variable has sufficient storage to hold the full name of the terminal.
  65 .Pp
  66 A termcap entry can be retrieved by calling the
  67 .Fn getcap
  68 function with the name of the capability in
  69 .Fa name .
  70 The matching capability string for the terminal is returned.
  71 .Pp
  72 The
  73 .Fn longname
  74 function returns a verbose description of the terminal which is taken
  75 from the last name alias in the termcap description for the terminal.
  76 This string will be at most 128 characters long and will only be
  77 defined after a call to
  78 .Fn initscr
  79 or
  80 .Fn newterm .
  81 .Sh RETURN VALUES
  82 Functions returning pointers will return
  83 .Dv NULL
  84 if an error is detected.
  85 The functions that return an int will return one of the following
  86 values:
  87 .Pp
  88 .Bl -tag -width ERR -compact
  89 .It Er OK
  90 The function completed successfully.
  91 .It Er ERR
  92 An error occurred in the function.
  93 .El
  94 .Sh SEE ALSO
  95 .Xr termcap 5
  96 .Sh STANDARDS
  97 The
  98 .Lb libcurses
  99 library complies with the X/Open Curses specification, part of the
 100 Single Unix Specification.
 101 .Sh HISTORY
 102 The Curses package appeared in
 103 .Bx 4.0 .