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

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, 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 INITSCR 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 initscr, newterm \- screen initialization functions
   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 \fBWINDOW *\fR\fBinitscr\fR(\fBvoid\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBSCREEN *\fR\fBnewterm\fR(\fBchar *\fR\fItype\fR, \fBFILE *\fR\fIoutfp\fR, \fBFILE *\fR\fIinfp\fR);
  25 .fi
  26
  27 .SH PARAMETERS
  28 .sp
  29 .ne 2
  30 .na
  31 \fB\fBtype\fR\fR
  32 .ad
  33 .RS 9n
  34 Is a string defining the terminal type to be used in place of \fBTERM\fR.
  35 .RE
  36
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fIoutfp\fR\fR
  41 .ad
  42 .RS 9n
  43 Is a pointer to a file to be used for output to the terminal.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fIinfp\fR\fR
  50 .ad
  51 .RS 9n
  52 Is the pointer to a file to be used for input to the terminal.
  53 .RE
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The \fBinitscr()\fR function initializes X/Open Curses data structures,
  59 determines the terminal type, and ensures the first call to
  60 \fBrefresh\fR(3XCURSES) clears the screen.
  61 .sp
  62 .LP
  63 The \fBnewterm()\fR function opens a new terminal with each call.  It should be
  64 used instead of \fBinitscr()\fR when the program interacts with more than one
  65 terminal.  It returns a variable of type \fBSCREEN\fR, which should be used for
  66 later  reference to that terminal. Before program termination, \fBendwin()\fR
  67 should be called for each terminal.
  68 .sp
  69 .LP
  70 The only functions that you can call before calling \fBinitscr()\fR or
  71 \fBnewterm()\fR are \fBfilter\fR(3XCURSES), \fBripoffline\fR(3XCURSES),
  72 \fBslk_init\fR(3XCURSES), and \fBuse_env\fR(3XCURSES).
  73 .SH RETURN VALUES
  74 .sp
  75 .LP
  76 On success, the \fBinitscr()\fR function returns a pointer to \fBstdscr\fR;
  77 otherwise, \fBinitscr()\fR does not return.
  78 .sp
  79 .LP
  80 On success, the \fBnewterm()\fR function returns a pointer to the specified
  81 terminal; otherwise, a null pointer is returned.
  82 .SH ERRORS
  83 .sp
  84 .LP
  85 None.
  86 .SH ATTRIBUTES
  87 .sp
  88 .LP
  89 See \fBattributes\fR(5) for descriptions of the following attributes:
  90 .sp
  91
  92 .sp
  93 .TS
  94 box;
  95 c | c
  96 l | l .
  97 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  98 _
  99 Interface Stability     Standard
 100 _
 101 MT-Level        Unsafe
 102 .TE
 103
 104 .SH SEE ALSO
 105 .sp
 106 .LP
 107 \fBdel_curterm\fR(3XCURSES), \fBdelscreen\fR(3XCURSES),
 108 \fBdoupdate\fR(3XCURSES), \fBendwin\fR(3XCURSES), \fBfilter\fR(3XCURSES),
 109 \fBlibcurses\fR(3XCURSES), \fBslk_attroff\fR(3XCURSES),
 110 \fBuse_env\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5)