diff options
author | Richard Lowe <richlowe@richlowe.net> | 2011-03-14 14:05:30 -0400 |
---|---|---|
committer | Richard Lowe <richlowe@richlowe.net> | 2011-03-14 14:05:30 -0400 |
commit | c10c16dec587a0662068f6e2991c29ed3a9db943 (patch) | |
tree | f414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3xcurses/use_env.3xcurses | |
parent | 68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff) | |
download | illumos-gate-c10c16dec587a0662068f6e2991c29ed3a9db943.tar.gz |
243 system manual pages should live with the software
Reviewed by: garrett@nexenta.com
Reviewed by: gwr@nexenta.com
Reviewed by: trisk@opensolaris.org
Approved by: gwr@nexenta.com
--HG--
extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb
Diffstat (limited to 'usr/src/man/man3xcurses/use_env.3xcurses')
-rw-r--r-- | usr/src/man/man3xcurses/use_env.3xcurses | 78 |
1 files changed, 78 insertions, 0 deletions
diff --git a/usr/src/man/man3xcurses/use_env.3xcurses b/usr/src/man/man3xcurses/use_env.3xcurses new file mode 100644 index 0000000000..0527a9023a --- /dev/null +++ b/usr/src/man/man3xcurses/use_env.3xcurses @@ -0,0 +1,78 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" 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. +.\" 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. +.\" 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] +.TH use_env 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +use_env \- specify source of screen size information +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBvoid\fR \fBuse_env\fR(\fBbool\fR \fIboolval\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIboolval\fR\fR +.ad +.RS 11n +.rt +Is a Boolean expression. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBuse_env()\fR function specifies the technique by which the +implementation determines the size of the screen. If \fIboolval\fR is +\fBFALSE\fR, the implementation uses the values of \fIlines\fR and +\fIcolumns\fR specified in the \fBterminfo\fR database. If \fIboolval\fR is +\fBTRUE\fR, the implementation uses the \fBLINES\fR and \fBCOLUMNS\fR +environmental variables. The initial value is \fBTRUE\fR. +.sp +.LP +Any call to \fBuse_env()\fR must precede calls to \fBinitscr\fR(3XCURSES), +\fBnewterm\fR(3XCURSES), or \fBsetupterm\fR(3XCURSES). +.SH RETURN VALUES +.sp +.LP +The \fBuse_env()\fR function does not return a value. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdel_curterm\fR(3XCURSES), \fBinitscr\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) |