ncurses 5.7 - patch 20100731
[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-2005,2010 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.15 2010/07/31 16:11:27 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 <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>                                       <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
44
45
46
47
48 </PRE>
49 <H2>NAME</H2><PRE>
50        <STRONG>initscr</STRONG>, <STRONG>newterm</STRONG>, <STRONG>endwin</STRONG>, <STRONG>isendwin</STRONG>, <STRONG>set_term</STRONG>, <STRONG>delscreen</STRONG> -
51        <STRONG>curses</STRONG> screen initialization and manipulation routines
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
57
58        <STRONG>WINDOW</STRONG> <STRONG>*initscr(void);</STRONG>
59        <STRONG>int</STRONG> <STRONG>endwin(void);</STRONG>
60        <STRONG>bool</STRONG> <STRONG>isendwin(void);</STRONG>
61        <STRONG>SCREEN</STRONG> <STRONG>*newterm(char</STRONG> <STRONG>*type,</STRONG> <STRONG>FILE</STRONG> <STRONG>*outfd,</STRONG> <STRONG>FILE</STRONG> <STRONG>*infd);</STRONG>
62        <STRONG>SCREEN</STRONG> <STRONG>*set_term(SCREEN</STRONG> <STRONG>*new);</STRONG>
63        <STRONG>void</STRONG> <STRONG>delscreen(SCREEN*</STRONG> <STRONG>sp);</STRONG>
64
65
66 </PRE>
67 <H2>DESCRIPTION</H2><PRE>
68        <STRONG>initscr</STRONG> is normally the first <STRONG>curses</STRONG> routine to call  when
69        initializing  a program.  A few special routines sometimes
70        need to be called before it; these are  <STRONG>slk_init</STRONG>,  <STRONG>filter</STRONG>,
71        <STRONG>ripoffline</STRONG>,  <STRONG>use_env</STRONG>.  For multiple-terminal applications,
72        <STRONG>newterm</STRONG> may be called before <STRONG>initscr</STRONG>.
73
74        The initscr code determines the terminal type and initial-
75        izes  all <STRONG>curses</STRONG> data structures.  <STRONG>initscr</STRONG> also causes the
76        first call to <STRONG>refresh</STRONG> to clear the screen.  If errors  oc-
77        cur,  <STRONG>initscr</STRONG> writes an appropriate error message to stan-
78        dard error and exits; otherwise, a pointer is returned  to
79        <STRONG>stdscr</STRONG>.
80
81        A  program  that  outputs to more than one terminal should
82        use the <STRONG>newterm</STRONG>  routine  for  each  terminal  instead  of
83        <STRONG>initscr</STRONG>.  A program that needs to inspect capabilities, so
84        it can continue to run in a line-oriented mode if the ter-
85        minal cannot support a screen-oriented program, would also
86        use <STRONG>newterm</STRONG>.  The routine <STRONG>newterm</STRONG> should  be  called  once
87        for each terminal.  It returns a variable of type <STRONG>SCREEN</STRONG> <STRONG>*</STRONG>
88        which should be saved as a  reference  to  that  terminal.
89        The  arguments  are the <EM>type</EM> of the terminal to be used in
90        place of <STRONG>$TERM</STRONG>, a file pointer for output to the terminal,
91        and  another  file pointer for input from the terminal (if
92        <EM>type</EM> is <STRONG>NULL</STRONG>, <STRONG>$TERM</STRONG> will be used).  The program must  also
93        call  <STRONG>endwin</STRONG>  for  each terminal being used before exiting
94        from <STRONG>curses</STRONG>.  If <STRONG>newterm</STRONG> is called more than once for  the
95        same  terminal, the first terminal referred to must be the
96        last one for which <STRONG>endwin</STRONG> is called.
97
98        A program should always call <STRONG>endwin</STRONG> before exiting or  es-
99        caping  from  <STRONG>curses</STRONG>  mode  temporarily.  This routine re-
100        stores tty modes, moves the cursor to the lower  left-hand
101        corner  of  the  screen  and  resets the terminal into the
102        proper non-visual mode.  Calling <STRONG>refresh</STRONG> or <STRONG>doupdate</STRONG> after
103        a  temporary  escape  causes  the program to resume visual
104        mode.
105
106        The <STRONG>isendwin</STRONG> routine  returns  <STRONG>TRUE</STRONG>  if  <STRONG>endwin</STRONG>  has  been
107        called without any subsequent calls to <STRONG>wrefresh</STRONG>, and <STRONG>FALSE</STRONG>
108        otherwise.
109
110        The <STRONG>set_term</STRONG> routine is used to switch  between  different
111        terminals.   The screen reference <STRONG>new</STRONG> becomes the new cur-
112        rent terminal.  The previous terminal is returned  by  the
113        routine.   This  is  the  only  routine  which manipulates
114        <STRONG>SCREEN</STRONG> pointers; all other routines affect only  the  cur-
115        rent terminal.
116
117        The  <STRONG>delscreen</STRONG>  routine  frees storage associated with the
118        <STRONG>SCREEN</STRONG> data structure.  The <STRONG>endwin</STRONG>  routine  does  not  do
119        this, so <STRONG>delscreen</STRONG> should be called after <STRONG>endwin</STRONG> if a par-
120        ticular <STRONG>SCREEN</STRONG> is no longer needed.
121
122
123 </PRE>
124 <H2>RETURN VALUE</H2><PRE>
125        <STRONG>endwin</STRONG> returns the integer <STRONG>ERR</STRONG> upon failure  and  <STRONG>OK</STRONG>  upon
126        successful completion.
127
128        Routines that return pointers always return <STRONG>NULL</STRONG> on error.
129
130        X/Open  defines  no error conditions.  In this implementa-
131        tion <STRONG>endwin</STRONG> returns an error if the terminal was not  ini-
132        tialized.
133
134
135 </PRE>
136 <H2>NOTES</H2><PRE>
137        Note that <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG> may be macros.
138
139
140 </PRE>
141 <H2>PORTABILITY</H2><PRE>
142        These  functions are described in the XSI Curses standard,
143        Issue 4.  It specifies that portable applications must not
144        call <STRONG>initscr</STRONG> more than once.
145
146        Old versions of curses, e.g., BSD 4.4, may have returned a
147        null pointer from  <STRONG>initscr</STRONG>  when  an  error  is  detected,
148        rather  than  exiting.   It is safe but redundant to check
149        the return value of <STRONG>initscr</STRONG> in XSI Curses.
150
151
152 </PRE>
153 <H2>SEE ALSO</H2><PRE>
154        <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>,
155        <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>
156
157
158
159                                                        <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
160 </PRE>
161 <HR>
162 <ADDRESS>
163 Man(1) output converted with
164 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
165 </ADDRESS>
166 </BODY>
167 </HTML>