xref: /illumos-gate/usr/src/man/man3xcurses/initscr.3xcurses (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, 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]
INITSCR 3XCURSES "Jun 5, 2002"
NAME
initscr, newterm - screen initialization functions
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

WINDOW *initscr(void);

SCREEN *newterm(char *type, FILE *outfp, FILE *infp);
PARAMETERS
type

Is a string defining the terminal type to be used in place of TERM.

outfp

Is a pointer to a file to be used for output to the terminal.

infp

Is the pointer to a file to be used for input to the terminal.

DESCRIPTION

The initscr() function initializes X/Open Curses data structures, determines the terminal type, and ensures the first call to refresh(3XCURSES) clears the screen.

The newterm() function opens a new terminal with each call. It should be used instead of initscr() when the program interacts with more than one terminal. It returns a variable of type SCREEN, which should be used for later reference to that terminal. Before program termination, endwin() should be called for each terminal.

The only functions that you can call before calling initscr() or newterm() are filter(3XCURSES), ripoffline(3XCURSES), slk_init(3XCURSES), and use_env(3XCURSES).

RETURN VALUES

On success, the initscr() function returns a pointer to stdscr; otherwise, initscr() does not return.

On success, the newterm() function returns a pointer to the specified terminal; otherwise, a null pointer is returned.

ERRORS

None.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

del_curterm (3XCURSES), delscreen (3XCURSES), doupdate (3XCURSES), endwin (3XCURSES), filter (3XCURSES), libcurses (3XCURSES), slk_attroff (3XCURSES), use_env (3XCURSES), attributes (7), standards (7)