usr/src/man/man3curses/curs_termattrs.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_TERMATTRS 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 curs_termattrs, baudrate, erasechar, has_ic, has_il, killchar, longname,
  10 termattrs, termname \- curses environment query routines
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lcurses\fR [ \fIlibrary\fR ... ]
  15 #include <curses.h>
  16
  17 \fBint\fR \fBbaudrate\fR(\fBvoid\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBchar\fR \fBerasechar\fR(\fBvoid\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBhas_ic\fR(\fBvoid\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBint\fR \fBhas_il\fR(\fBvoid\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBchar\fR \fBkillchar\fR(\fBvoid\fR);
  38 .fi
  39
  40 .LP
  41 .nf
  42 \fBchar *\fR\fBlongname\fR(\fBvoid\fR);
  43 .fi
  44
  45 .LP
  46 .nf
  47 \fBchtype\fR \fBtermattrs\fR(\fBvoid\fR);
  48 .fi
  49
  50 .LP
  51 .nf
  52 \fBchar *\fR\fBtermname\fR(\fBvoid\fR);
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The \fBbaudrate()\fR routine returns the output speed of the terminal. The
  59 number returned is in bits per second, for example \fB9600\fR, and is an
  60 integer.
  61 .sp
  62 .LP
  63 With the \fBerasechar()\fR routine, the user's current erase character is
  64 returned.
  65 .sp
  66 .LP
  67 The \fBhas_ic()\fR routine is true if the terminal has insert- and
  68 delete-character capabilities.
  69 .sp
  70 .LP
  71 The \fBhas_il()\fR routine is true if the terminal has insert- and delete-line
  72 capabilities, or can simulate them using scrolling regions. This might be used
  73 to determine if it would be appropriate to turn on physical scrolling using
  74 \fBscrollok()\fR.
  75 .sp
  76 .LP
  77 With the \fBkillchar()\fR routine, the user's current line kill character is
  78 returned.
  79 .sp
  80 .LP
  81 The \fBlongname()\fR routine returns a pointer to a static area containing a
  82 verbose description of the current terminal. The maximum length of a verbose
  83 description is 128 characters. It is defined only after the call to
  84 \fBinitscr()\fR or \fBnewterm()\fR. The area is overwritten by each call to
  85 \fBnewterm()\fR and is not restored by \fBset_term()\fR, so the value should be
  86 saved between calls to \fBnewterm()\fR if \fBlongname()\fR is going to be used
  87 with multiple terminals.
  88 .sp
  89 .LP
  90 If a given terminal doesn't support a video attribute that an application
  91 program is trying to use, \fBcurses\fR may substitute a different video
  92 attribute for it. The \fBtermattrs()\fR function returns a logical OR of all
  93 video attributes supported by the terminal. This information is useful when a
  94 \fBcurses\fR program needs complete control over the appearance of the screen.
  95 .sp
  96 .LP
  97 The \fBtermname()\fR routine returns the value of the environment variable
  98 \fBTERM\fR (truncated to 14 characters).
  99 .SH RETURN VALUES
 100 .sp
 101 .LP
 102 \fBlongname()\fR and \fBtermname()\fR return \fINULL\fR on error.
 103 .sp
 104 .LP
 105 Routines that return an integer return \fBERR\fR upon failure and an integer
 106 value other than \fBERR\fR upon successful completion.
 107 .SH ATTRIBUTES
 108 .sp
 109 .LP
 110 See \fBattributes\fR(5) for descriptions of the following attributes:
 111 .sp
 112
 113 .sp
 114 .TS
 115 box;
 116 c | c
 117 l | l .
 118 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 119 _
 120 MT-Level        Unsafe
 121 .TE
 122
 123 .SH SEE ALSO
 124 .sp
 125 .LP
 126 \fBcurs_initscr\fR(3CURSES), \fBcurs_outopts\fR(3CURSES),
 127 \fBcurses\fR(3CURSES), \fBattributes\fR(5)
 128 .SH NOTES
 129 .sp
 130 .LP
 131 The header <\fBcurses.h\fR> automatically includes the headers  <\fBstdio.h\fR>
 132 and <\fBunctrl.h\fR>.
 133 .sp
 134 .LP
 135 Note that \fBtermattrs()\fR may be a macro.