lib/libcurses/PSD.doc/intro.2

   1 .\"     $NetBSD: intro.2,v 1.8 2003/08/07 16:44:28 agc Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)intro.2     8.1 (Berkeley) 6/4/93
  31 .\"
  32 .sh 1 Variables
  33 .pp
  34 Many variables which are used to describe the terminal environment
  35 are available to the programmer.
  36 They are:
  37 .(b
  38 .TS
  39 expand;
  40 lw(6m) lw(8n) lw(50n).
  41 type    name    description
  42 _
  43 WINDOW *        curscr  T{
  44 .fi
  45 current version of the screen (terminal screen).
  46 T}
  47 WINDOW *        stdscr  T{
  48 standard screen.
  49 Most updates are usually done here.
  50 T}
  51 char *  Def\*_term      T{
  52 default terminal type if type cannot be determined
  53 T}
  54 bool    My\*_term       T{
  55 use the terminal specification in \fIDef\*_term\fR as terminal,
  56 irrelevant of real terminal type
  57 T}
  58 char *  ttytype T{
  59 full name of the current terminal.
  60 T}
  61 int     LINES   T{
  62 number of lines on the terminal
  63 T}
  64 int     COLS    T{
  65 number of columns on the terminal
  66 T}
  67 int     COLORS  T{
  68 number of colors on the terminal
  69 T}
  70 int     COLOR_PAIRS     T{
  71 number of color pairs on the terminal
  72 T}
  73 int     ERR     T{
  74 error flag returned by routines on a fail.
  75 T}
  76 int     OK      T{
  77 flag returned by routines upon success.
  78 T}
  79 .TE
  80 .fi
  81 .)b
  82 .lp