usr/src/man/man3xcurses/use_env.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1999, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH USE_ENV 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 use_env \- specify source of screen size information
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  13 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  14
  15 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  16
  17 #include <curses.h>
  18
  19 \fBvoid\fR \fBuse_env\fR(\fBbool\fR \fIboolval\fR);
  20 .fi
  21
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fIboolval\fR\fR
  27 .ad
  28 .RS 11n
  29 Is a Boolean expression.
  30 .RE
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBuse_env()\fR function specifies the technique by which the
  36 implementation determines the size of the screen. If \fIboolval\fR is
  37 \fBFALSE\fR, the implementation uses the values of \fIlines\fR and
  38 \fIcolumns\fR specified in the \fBterminfo\fR database. If \fIboolval\fR is
  39 \fBTRUE\fR, the implementation uses the \fBLINES\fR and \fBCOLUMNS\fR
  40 environmental variables. The initial value is \fBTRUE\fR.
  41 .sp
  42 .LP
  43 Any call to \fBuse_env()\fR must precede calls to \fBinitscr\fR(3XCURSES),
  44 \fBnewterm\fR(3XCURSES), or \fBsetupterm\fR(3XCURSES).
  45 .SH RETURN VALUES
  46 .sp
  47 .LP
  48 The \fBuse_env()\fR function does not return a value.
  49 .SH ERRORS
  50 .sp
  51 .LP
  52 No errors are defined.
  53 .SH ATTRIBUTES
  54 .sp
  55 .LP
  56 See \fBattributes\fR(5) for descriptions of the following attributes:
  57 .sp
  58
  59 .sp
  60 .TS
  61 box;
  62 c | c
  63 l | l .
  64 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  65 _
  66 Interface Stability     Standard
  67 _
  68 MT-Level        Unsafe
  69 .TE
  70
  71 .SH SEE ALSO
  72 .sp
  73 .LP
  74 \fBdel_curterm\fR(3XCURSES), \fBinitscr\fR(3XCURSES),
  75 \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)