ncurses 5.3
[ncurses.git] / doc / html / man / curs_initscr.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   ****************************************************************************
4   * Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
5   *                                                                          *
6   * Permission is hereby granted, free of charge, to any person obtaining a  *
7   * copy of this software and associated documentation files (the            *
8   * "Software"), to deal in the Software without restriction, including      *
9   * without limitation the rights to use, copy, modify, merge, publish,      *
10   * distribute, distribute with modifications, sublicense, and/or sell       *
11   * copies of the Software, and to permit persons to whom the Software is    *
12   * furnished to do so, subject to the following conditions:                 *
13   *                                                                          *
14   * The above copyright notice and this permission notice shall be included  *
15   * in all copies or substantial portions of the Software.                   *
16   *                                                                          *
17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24   *                                                                          *
25   * Except as contained in this notice, the name(s) of the above copyright   *
26   * holders shall not be used in advertising or otherwise to promote the     *
27   * sale, use or other dealings in this Software without prior written       *
28   * authorization.                                                           *
29   ****************************************************************************
30   * @Id: curs_initscr.3x,v 1.11 2002/07/20 14:51:04 tom Exp @
31 -->
32 <HTML>
33 <HEAD>
34 <TITLE>curs_initscr 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
37 </HEAD>
38 <BODY>
39 <H1>curs_initscr 3x</H1>
40 <HR>
41 <PRE>
42 <!-- Manpage converted by man2html 3.0.1 -->
43
44 </PRE>
45 <H2>NAME</H2><PRE>
46        <STRONG>initscr</STRONG>,  <STRONG>newterm</STRONG>, <STRONG>endwin</STRONG>, <STRONG>isendwin</STRONG>, <STRONG>set_term</STRONG>, <STRONG>delscreen</STRONG> -
47        <STRONG>curses</STRONG> screen initialization and manipulation routines
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
53
54        <STRONG>WINDOW</STRONG> <STRONG>*initscr(void);</STRONG>
55        <STRONG>int</STRONG> <STRONG>endwin(void);</STRONG>
56        <STRONG>bool</STRONG> <STRONG>isendwin(void);</STRONG>
57        <STRONG>SCREEN</STRONG> <STRONG>*newterm(char</STRONG> <STRONG>*type,</STRONG> <STRONG>FILE</STRONG> <STRONG>*outfd,</STRONG> <STRONG>FILE</STRONG> <STRONG>*infd);</STRONG>
58        <STRONG>SCREEN</STRONG> <STRONG>*set_term(SCREEN</STRONG> <STRONG>*new);</STRONG>
59        <STRONG>void</STRONG> <STRONG>delscreen(SCREEN*</STRONG> <STRONG>sp);</STRONG>
60
61
62 </PRE>
63 <H2>DESCRIPTION</H2><PRE>
64        <STRONG>initscr</STRONG> is normally the first <STRONG>curses</STRONG> routine to call  when
65        initializing  a program.  A few special routines sometimes
66        need to be called before it; these are  <STRONG>slk_init</STRONG>,  <STRONG>filter</STRONG>,
67        <STRONG>ripoffline</STRONG>,  <STRONG>use_env</STRONG>.  For multiple-terminal applications,
68        <STRONG>newterm</STRONG> may be called before <STRONG>initscr</STRONG>.
69
70        The initscr code determines the terminal type and initial-
71        izes  all <STRONG>curses</STRONG> data structures.  <STRONG>initscr</STRONG> also causes the
72        first call to <STRONG>refresh</STRONG> to  clear  the  screen.   If  errors
73        occur,  <STRONG>initscr</STRONG>  writes  an  appropriate  error message to
74        standard error and exits; otherwise, a pointer is returned
75        to <STRONG>stdscr</STRONG>.
76
77        A  program  that  outputs to more than one terminal should
78        use the <STRONG>newterm</STRONG>  routine  for  each  terminal  instead  of
79        <STRONG>initscr</STRONG>.  A program that needs to inspect capabilities, so
80        it can continue to run in a line-oriented mode if the ter-
81        minal cannot support a screen-oriented program, would also
82        use <STRONG>newterm</STRONG>.  The routine <STRONG>newterm</STRONG> should  be  called  once
83        for each terminal.  It returns a variable of type <STRONG>SCREEN</STRONG> <STRONG>*</STRONG>
84        which should be saved as a  reference  to  that  terminal.
85        The  arguments  are the <EM>type</EM> of the terminal to be used in
86        place of <STRONG>$TERM</STRONG>, a file pointer for output to the terminal,
87        and  another  file pointer for input from the terminal (if
88        <EM>type</EM> is <STRONG>NULL</STRONG>, <STRONG>$TERM</STRONG> will be used).  The program must  also
89        call  <STRONG>endwin</STRONG>  for  each terminal being used before exiting
90        from <STRONG>curses</STRONG>.  If <STRONG>newterm</STRONG> is called more than once for  the
91        same  terminal, the first terminal referred to must be the
92        last one for which <STRONG>endwin</STRONG> is called.
93
94        A program should always  call  <STRONG>endwin</STRONG>  before  exiting  or
95        escaping  from  <STRONG>curses</STRONG>  mode  temporarily.   This  routine
96        restores tty modes, moves the cursor to  the  lower  left-
97        hand corner of the screen and resets the terminal into the
98        proper non-visual mode.  Calling <STRONG>refresh</STRONG> or <STRONG>doupdate</STRONG> after
99        a  temporary  escape  causes  the program to resume visual
100        mode.
101
102        The <STRONG>isendwin</STRONG> routine  returns  <STRONG>TRUE</STRONG>  if  <STRONG>endwin</STRONG>  has  been
103        called without any subsequent calls to <STRONG>wrefresh</STRONG>, and <STRONG>FALSE</STRONG>
104        otherwise.
105
106        The <STRONG>set_term</STRONG> routine is used to switch  between  different
107        terminals.   The screen reference <STRONG>new</STRONG> becomes the new cur-
108        rent terminal.  The previous terminal is returned  by  the
109        routine.   This  is  the  only  routine  which manipulates
110        <STRONG>SCREEN</STRONG> pointers; all other routines affect only  the  cur-
111        rent terminal.
112
113        The  <STRONG>delscreen</STRONG>  routine  frees storage associated with the
114        <STRONG>SCREEN</STRONG> data structure.  The <STRONG>endwin</STRONG>  routine  does  not  do
115        this, so <STRONG>delscreen</STRONG> should be called after <STRONG>endwin</STRONG> if a par-
116        ticular <STRONG>SCREEN</STRONG> is no longer needed.
117
118
119 </PRE>
120 <H2>RETURN VALUE</H2><PRE>
121        <STRONG>endwin</STRONG> returns the integer <STRONG>ERR</STRONG> upon failure  and  <STRONG>OK</STRONG>  upon
122        successful completion.
123
124        Routines that return pointers always return <STRONG>NULL</STRONG> on error.
125
126
127 </PRE>
128 <H2>NOTES</H2><PRE>
129        Note that <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG> may be macros.
130
131
132 </PRE>
133 <H2>PORTABILITY</H2><PRE>
134        These functions are described in the XSI Curses  standard,
135        Issue 4.  It specifies that portable applications must not
136        call <STRONG>initscr</STRONG> more than once.
137
138        Old versions of curses, e.g., BSD 4.4, may have returned a
139        null  pointer  from  <STRONG>initscr</STRONG>  when  an  error is detected,
140        rather than exiting.  It is safe but  redundant  to  check
141        the return value of <STRONG>initscr</STRONG> in XSI Curses.
142
143
144 </PRE>
145 <H2>SEE ALSO</H2><PRE>
146        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>,       <STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>,       <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>,
147        <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165 </PRE>
166 <HR>
167 <ADDRESS>
168 Man(1) output converted with
169 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
170 </ADDRESS>
171 </BODY>
172 </HTML>