+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!--
+ ****************************************************************************
+ * Copyright (c) 1998-2005,2010 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: curs_initscr.3x,v 1.16 2010/10/02 23:19:57 tom Exp @
+-->
<HTML>
+<HEAD>
+<TITLE>curs_initscr 3x</TITLE>
+<link rev=made href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<H1>curs_initscr 3x</H1>
+<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
+
+
+
</PRE>
<H2>NAME</H2><PRE>
- <B>initscr</B>, <B>newterm</B>, <B>endwin</B>, <B>isendwin</B>, <B>set_term</B>, <B>delscreen</B> -
- <B>curses</B> screen initialization and manipulation routines
+ <STRONG>initscr</STRONG>, <STRONG>newterm</STRONG>, <STRONG>endwin</STRONG>, <STRONG>isendwin</STRONG>, <STRONG>set_term</STRONG>, <STRONG>delscreen</STRONG> -
+ <STRONG>curses</STRONG> screen initialization and manipulation routines
</PRE>
<H2>SYNOPSIS</H2><PRE>
- <B>#include</B> <B><curses.h></B>
+ <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
- <B>WINDOW</B> <B>*initscr(void);</B>
- <B>int</B> <B>endwin(void);</B>
- <B>bool</B> <B>isendwin(void);</B>
- <B>SCREEN</B> <B>*newterm(const</B> <B>char</B> <B>*type,</B> <B>FILE</B> <B>*outfd,</B> <B>FILE</B>
- <B>*infd);</B>
- <B>SCREEN</B> <B>*set_term(SCREEN</B> <B>*new);</B>
- <B>void</B> <B>delscreen(SCREEN*</B> <B>sp);</B>
+ <STRONG>WINDOW</STRONG> <STRONG>*initscr(void);</STRONG>
+ <STRONG>int</STRONG> <STRONG>endwin(void);</STRONG>
+ <STRONG>bool</STRONG> <STRONG>isendwin(void);</STRONG>
+ <STRONG>SCREEN</STRONG> <STRONG>*newterm(char</STRONG> <STRONG>*type,</STRONG> <STRONG>FILE</STRONG> <STRONG>*outfd,</STRONG> <STRONG>FILE</STRONG> <STRONG>*infd);</STRONG>
+ <STRONG>SCREEN</STRONG> <STRONG>*set_term(SCREEN</STRONG> <STRONG>*new);</STRONG>
+ <STRONG>void</STRONG> <STRONG>delscreen(SCREEN*</STRONG> <STRONG>sp);</STRONG>
</PRE>
<H2>DESCRIPTION</H2><PRE>
- <B>initscr</B> is normally the first <B>curses</B> routine to call when
- initializing a program. A few special routines sometimes
- need to be called before it; these are <B>slk_init</B>, <B>filter</B>,
- <B>ripoffline</B>, <B>use_env</B>. For multiple-terminal applications,
- <B>newterm</B> may be called before <B>initscr</B>.
+ <STRONG>initscr</STRONG> is normally the first <STRONG>curses</STRONG> routine to call when
+ initializing a program. A few special routines sometimes
+ need to be called before it; these are <STRONG>slk_init</STRONG>, <STRONG>filter</STRONG>,
+ <STRONG>ripoffline</STRONG>, <STRONG>use_env</STRONG>. For multiple-terminal applications,
+ <STRONG>newterm</STRONG> may be called before <STRONG>initscr</STRONG>.
The initscr code determines the terminal type and initial-
- izes all <B>curses</B> data structures. <B>initscr</B> also causes the
- first call to <B>refresh</B> to clear the screen. If errors
- occur, <B>initscr</B> writes an appropriate error message to
- standard error and exits; otherwise, a pointer is returned
- to <B>stdscr</B>.
-
- A program that outputs to more than one terminal should
- use the <B>newterm</B> routine for each terminal instead of
- <B>initscr</B>. A program that needs to inspect capabilities, so
+ izes all <STRONG>curses</STRONG> data structures. <STRONG>initscr</STRONG> also causes the
+ first call to <STRONG>refresh</STRONG> to clear the screen. If errors oc-
+ cur, <STRONG>initscr</STRONG> writes an appropriate error message to stan-
+ dard error and exits; otherwise, a pointer is returned to
+ <STRONG>stdscr</STRONG>.
+
+ A program that outputs to more than one terminal should
+ use the <STRONG>newterm</STRONG> routine for each terminal instead of
+ <STRONG>initscr</STRONG>. A program that needs to inspect capabilities, so
it can continue to run in a line-oriented mode if the ter-
minal cannot support a screen-oriented program, would also
- use <B>newterm</B>. The routine <B>newterm</B> should be called once
- for each terminal. It returns a variable of type <B>SCREEN</B> <B>*</B>
- which should be saved as a reference to that terminal.
- The arguments are the <I>type</I> of the terminal to be used in
- place of <B>$TERM</B>, a file pointer for output to the terminal,
- and another file pointer for input from the terminal (if
- <I>type</I> is <B>NULL</B>, <B>$TERM</B> will be used). The program must also
- call <B>endwin</B> for each terminal being used before exiting
- from <B>curses</B>. If <B>newterm</B> is called more than once for the
- same terminal, the first terminal referred to must be the
- last one for which <B>endwin</B> is called.
-
- A program should always call <B>endwin</B> before exiting or
- escaping from <B>curses</B> mode temporarily. This routine
- restores tty modes, moves the cursor to the lower left-
- hand corner of the screen and resets the terminal into the
- proper non-visual mode. Calling <B>refresh</B> or <B>doupdate</B> after
- a temporary escape causes the program to resume visual
+ use <STRONG>newterm</STRONG>. The routine <STRONG>newterm</STRONG> should be called once
+ for each terminal. It returns a variable of type <STRONG>SCREEN</STRONG> <STRONG>*</STRONG>
+ which should be saved as a reference to that terminal.
+ The arguments are the <EM>type</EM> of the terminal to be used in
+ place of <STRONG>$TERM</STRONG>, a file pointer for output to the terminal,
+ and another file pointer for input from the terminal (if
+ <EM>type</EM> is <STRONG>NULL</STRONG>, <STRONG>$TERM</STRONG> will be used). The program must also
+ call <STRONG>endwin</STRONG> for each terminal being used before exiting
+ from <STRONG>curses</STRONG>. If <STRONG>newterm</STRONG> is called more than once for the
+ same terminal, the first terminal referred to must be the
+ last one for which <STRONG>endwin</STRONG> is called.
+
+ A program should always call <STRONG>endwin</STRONG> before exiting or es-
+ caping from <STRONG>curses</STRONG> mode temporarily. This routine re-
+ stores tty modes, moves the cursor to the lower left-hand
+ corner of the screen and resets the terminal into the
+ proper non-visual mode. Calling <STRONG>refresh</STRONG> or <STRONG>doupdate</STRONG> after
+ a temporary escape causes the program to resume visual
mode.
- The <B>isendwin</B> routine returns <B>TRUE</B> if <B>endwin</B> has been
- called without any subsequent calls to <B>wrefresh</B>, and <B>FALSE</B>
+ The <STRONG>isendwin</STRONG> routine returns <STRONG>TRUE</STRONG> if <STRONG>endwin</STRONG> has been
+ called without any subsequent calls to <STRONG>wrefresh</STRONG>, and <STRONG>FALSE</STRONG>
otherwise.
- The <B>set_term</B> routine is used to switch between different
- terminals. The screen reference <B>new</B> becomes the new cur-
- rent terminal. The previous terminal is returned by the
- routine. This is the only routine which manipulates
- <B>SCREEN</B> pointers; all other routines affect only the cur-
+ The <STRONG>set_term</STRONG> routine is used to switch between different
+ terminals. The screen reference <STRONG>new</STRONG> becomes the new cur-
+ rent terminal. The previous terminal is returned by the
+ routine. This is the only routine which manipulates
+ <STRONG>SCREEN</STRONG> pointers; all other routines affect only the cur-
rent terminal.
- The <B>delscreen</B> routine frees storage associated with the
- <B>SCREEN</B> data structure. The <B>endwin</B> routine does not do
- this, so <B>delscreen</B> should be called after <B>endwin</B> if a par-
- ticular <B>SCREEN</B> is no longer needed.
+ The <STRONG>delscreen</STRONG> routine frees storage associated with the
+ <STRONG>SCREEN</STRONG> data structure. The <STRONG>endwin</STRONG> routine does not do
+ this, so <STRONG>delscreen</STRONG> should be called after <STRONG>endwin</STRONG> if a par-
+ ticular <STRONG>SCREEN</STRONG> is no longer needed.
</PRE>
<H2>RETURN VALUE</H2><PRE>
- <B>endwin</B> returns the integer <B>ERR</B> upon failure and <B>OK</B> upon
+ <STRONG>endwin</STRONG> returns the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> upon
successful completion.
- Routines that return pointers always return <B>NULL</B> on error.
+ Routines that return pointers always return <STRONG>NULL</STRONG> on error.
+
+ X/Open defines no error conditions. In this implementa-
+ tion <STRONG>endwin</STRONG> returns an error if the terminal was not ini-
+ tialized.
</PRE>
<H2>NOTES</H2><PRE>
- Note that <B>initscr</B> and <B>newterm</B> may be macros.
+ Note that <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG> may be macros.
</PRE>
<H2>PORTABILITY</H2><PRE>
These functions are described in the XSI Curses standard,
Issue 4. It specifies that portable applications must not
- call <B>initscr</B> more than once.
+ call <STRONG>initscr</STRONG> more than once.
Old versions of curses, e.g., BSD 4.4, may have returned a
- null pointer from <B>initscr</B> when an error is detected,
+ null pointer from <STRONG>initscr</STRONG> when an error is detected,
rather than exiting. It is safe but redundant to check
- the return value of <B>initscr</B> in XSI Curses.
+ the return value of <STRONG>initscr</STRONG> in XSI Curses.
</PRE>
<H2>SEE ALSO</H2><PRE>
- <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>,
- <B><A HREF="curs_slk.3x.html">curs_slk(3x)</A></B>, <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B>
-
-
-
-
-
-
-
-
-
-
-
-
-
+ <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>,
+ <STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>.
+ <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
</PRE>
<HR>
<ADDRESS>
projects / ncurses.git / blobdiff