2002-10-13 11:35:53 +08:00
|
|
|
<!--
|
|
|
|
|
****************************************************************************
|
2016-10-16 08:57:24 +08:00
|
|
|
* Copyright (c) 1998-2015,2016 Free Software Foundation, Inc. *
|
2002-10-13 11:35:53 +08:00
|
|
|
* *
|
|
|
|
|
* 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. *
|
|
|
|
|
****************************************************************************
|
2016-10-16 08:57:24 +08:00
|
|
|
* @Id: curs_initscr.3x,v 1.25 2016/10/15 17:02:31 tom Exp @
|
2002-10-13 11:35:53 +08:00
|
|
|
-->
|
2015-02-15 09:42:27 +08:00
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
|
2000-07-09 10:46:08 +08:00
|
|
|
<HTML>
|
2002-10-13 11:35:53 +08:00
|
|
|
<HEAD>
|
2015-02-15 09:42:27 +08:00
|
|
|
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
|
|
|
|
|
<meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
|
2002-10-13 11:35:53 +08:00
|
|
|
<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>
|
2000-07-09 10:46:08 +08:00
|
|
|
<BODY>
|
2015-05-17 05:01:22 +08:00
|
|
|
<H1 class="no-header">curs_initscr 3x</H1>
|
2000-07-09 10:46:08 +08:00
|
|
|
<PRE>
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG> <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
|
2004-02-09 10:15:26 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG>initscr</STRONG>, <STRONG>newterm</STRONG>, <STRONG>endwin</STRONG>, <STRONG>isendwin</STRONG>, <STRONG>set_term</STRONG>, <STRONG>delscreen</STRONG> -
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>curses</STRONG> screen initialization and manipulation routines
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>WINDOW</STRONG> <STRONG>*initscr(void);</STRONG>
|
|
|
|
|
<STRONG>int</STRONG> <STRONG>endwin(void);</STRONG>
|
|
|
|
|
<STRONG>bool</STRONG> <STRONG>isendwin(void);</STRONG>
|
ncurses 6.0 - patch 20150725
+ updated llib-* files.
+ build-fixes for ncurses library "test_progs" rule.
+ use alternate workaround for gcc 5.x feature (adapted from patch by
Mikhail Peselnik).
+ add status line to tmux via xterm+sl (patch by Nicholas Marriott).
+ fixes for st 0.5 from testing with tack -TD
+ review/improve several manual pages to break up wall-of-text:
curs_add_wch.3x, curs_attr.3x, curs_bkgd.3x, curs_bkgrnd.3x,
curs_getcchar.3x, curs_getch.3x, curs_kernel.3x, curs_mouse.3x,
curs_outopts.3x, curs_overlay.3x, curs_pad.3x, curs_termattrs.3x
curs_trace.3x, and curs_window.3x
2015-07-26 08:58:34 +08:00
|
|
|
<STRONG>SCREEN</STRONG> <STRONG>*newterm(char</STRONG> <STRONG>*</STRONG><EM>type</EM><STRONG>,</STRONG> <STRONG>FILE</STRONG> <STRONG>*</STRONG><EM>outfd</EM><STRONG>,</STRONG> <STRONG>FILE</STRONG> <STRONG>*</STRONG><EM>infd</EM><STRONG>);</STRONG>
|
|
|
|
|
<STRONG>SCREEN</STRONG> <STRONG>*set_term(SCREEN</STRONG> <STRONG>*</STRONG><EM>new</EM><STRONG>);</STRONG>
|
|
|
|
|
<STRONG>void</STRONG> <STRONG>delscreen(SCREEN*</STRONG> <EM>sp</EM><STRONG>);</STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
|
2015-07-20 08:44:14 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H3><a name="h3-initscr">initscr</a></H3><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<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>.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
The initscr code determines the terminal type and initial-
|
2002-10-13 11:35:53 +08:00
|
|
|
izes all <STRONG>curses</STRONG> data structures. <STRONG>initscr</STRONG> also causes the
|
2005-10-10 02:41:57 +08:00
|
|
|
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>.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2015-07-20 08:44:14 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H3><a name="h3-newterm">newterm</a></H3><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
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
|
2000-07-09 10:46:08 +08:00
|
|
|
it can continue to run in a line-oriented mode if the ter-
|
|
|
|
|
minal cannot support a screen-oriented program, would also
|
2002-10-13 11:35:53 +08:00
|
|
|
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.
|
ncurses 5.9 - patch 20140524
+ fix typo in ncurses manpage for the NCURSES_NO_MAGIC_COOKIE
environment variable.
+ improve discussion of input-echoing in curs_getch.3x
+ clarify discussion in curs_addch.3x of wrapping.
+ modify parametrized.h to make fln non-padded.
+ correct several entries which had termcap-style padding used in
terminfo: adm21, aj510, alto-h19, att605-pc, x820 -TD
+ correct syntax for padding in some entries: dg211, h19 -TD
+ correct ti924-8 which had confused padding versus octal escapes -TD
+ correct padding in sbi entry -TD
+ fix an old bug in the termcap emulation; "%i" was ignored in tparm()
because the parameters to be incremented were already on the internal
stack (report by Corinna Vinschen).
+ modify tic's "-c" option to take into account the "-C" option to
activate additional checks which compare the results from running
tparm() on the terminfo expressions versus the translated termcap
expressions.
+ modify tic to allow it to read from FIFOs (report by Matthieu Fronton,
cf: 20120324).
> patches by Nicolas Boulenguez:
+ explicit dereferences to suppress some style warnings.
+ when c_varargs_to_ada.c includes its header, use double quotes
instead of <>.
+ samples/ncurses2-util.adb: removed unused with clause. The warning
was removed by an obsolete pragma.
+ replaced Unreferenced pragmas with Warnings (Off). The latter,
available with older GNATs, needs no configure test. This also
replaces 3 untested Unreferenced pragmas.
+ simplified To_C usage in trace handling. Using two parameters allows
some basic formatting, and avoids a warning about security with some
compiler flags.
+ for generated Ada sources, replace many snippets with one pure
package.
+ removed C_Chtype and its conversions.
+ removed C_AttrType and its conversions.
+ removed conversions between int, Item_Option_Set, Menu_Option_Set.
+ removed int, Field_Option_Set, Item_Option_Set conversions.
+ removed C_TraceType, Attribute_Option_Set conversions.
+ replaced C.int with direct use of Eti_Error, now enumerated. As it
was used in a case statement, values were tested by the Ada compiler
to be consecutive anyway.
+ src/Makefile.in: remove duplicate stanza
+ only consider using a project for shared libraries.
+ style. Silent gnat-4.9 warning about misplaced "then".
+ generate shared library project to honor ADAFLAGS, LDFLAGS.
2014-05-25 09:22:18 +08:00
|
|
|
<STRONG>newterm</STRONG>'s arguments are
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> the <EM>type</EM> of the terminal to be used in place of <STRONG>$TERM</STRONG>,
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> a file pointer for output to the terminal, and
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> another file pointer for input from the terminal
|
|
|
|
|
|
|
|
|
|
If the <EM>type</EM> parameter is <STRONG>NULL</STRONG>, <STRONG>$TERM</STRONG> will be used.
|
|
|
|
|
|
2015-07-20 08:44:14 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H3><a name="h3-endwin">endwin</a></H3><PRE>
|
ncurses 5.9 - patch 20140524
+ fix typo in ncurses manpage for the NCURSES_NO_MAGIC_COOKIE
environment variable.
+ improve discussion of input-echoing in curs_getch.3x
+ clarify discussion in curs_addch.3x of wrapping.
+ modify parametrized.h to make fln non-padded.
+ correct several entries which had termcap-style padding used in
terminfo: adm21, aj510, alto-h19, att605-pc, x820 -TD
+ correct syntax for padding in some entries: dg211, h19 -TD
+ correct ti924-8 which had confused padding versus octal escapes -TD
+ correct padding in sbi entry -TD
+ fix an old bug in the termcap emulation; "%i" was ignored in tparm()
because the parameters to be incremented were already on the internal
stack (report by Corinna Vinschen).
+ modify tic's "-c" option to take into account the "-C" option to
activate additional checks which compare the results from running
tparm() on the terminfo expressions versus the translated termcap
expressions.
+ modify tic to allow it to read from FIFOs (report by Matthieu Fronton,
cf: 20120324).
> patches by Nicolas Boulenguez:
+ explicit dereferences to suppress some style warnings.
+ when c_varargs_to_ada.c includes its header, use double quotes
instead of <>.
+ samples/ncurses2-util.adb: removed unused with clause. The warning
was removed by an obsolete pragma.
+ replaced Unreferenced pragmas with Warnings (Off). The latter,
available with older GNATs, needs no configure test. This also
replaces 3 untested Unreferenced pragmas.
+ simplified To_C usage in trace handling. Using two parameters allows
some basic formatting, and avoids a warning about security with some
compiler flags.
+ for generated Ada sources, replace many snippets with one pure
package.
+ removed C_Chtype and its conversions.
+ removed C_AttrType and its conversions.
+ removed conversions between int, Item_Option_Set, Menu_Option_Set.
+ removed int, Field_Option_Set, Item_Option_Set conversions.
+ removed C_TraceType, Attribute_Option_Set conversions.
+ replaced C.int with direct use of Eti_Error, now enumerated. As it
was used in a case statement, values were tested by the Ada compiler
to be consecutive anyway.
+ src/Makefile.in: remove duplicate stanza
+ only consider using a project for shared libraries.
+ style. Silent gnat-4.9 warning about misplaced "then".
+ generate shared library project to honor ADAFLAGS, LDFLAGS.
2014-05-25 09:22:18 +08:00
|
|
|
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
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> restores tty modes,
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> moves the cursor to the lower left-hand corner of the
|
|
|
|
|
screen and
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> resets the terminal into the proper non-visual mode.
|
|
|
|
|
|
|
|
|
|
Calling <STRONG>refresh</STRONG> or <STRONG>doupdate</STRONG> after a temporary escape caus-
|
|
|
|
|
es the program to resume visual mode.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2015-07-20 08:44:14 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H3><a name="h3-isendwin">isendwin</a></H3><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
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>
|
2000-07-09 10:46:08 +08:00
|
|
|
otherwise.
|
|
|
|
|
|
2015-07-20 08:44:14 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H3><a name="h3-set_term">set_term</a></H3><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
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
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG>SCREEN</STRONG> pointers; all other routines affect only the cur-
|
|
|
|
|
rent terminal.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2015-07-20 08:44:14 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H3><a name="h3-delscreen">delscreen</a></H3><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
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.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<STRONG>endwin</STRONG> returns the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> upon
|
2000-07-09 10:46:08 +08:00
|
|
|
successful completion.
|
|
|
|
|
|
2002-10-13 11:35:53 +08:00
|
|
|
Routines that return pointers always return <STRONG>NULL</STRONG> on error.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2010-08-01 08:45:28 +08:00
|
|
|
X/Open defines no error conditions. In this implementa-
|
ncurses 5.9 - patch 20140524
+ fix typo in ncurses manpage for the NCURSES_NO_MAGIC_COOKIE
environment variable.
+ improve discussion of input-echoing in curs_getch.3x
+ clarify discussion in curs_addch.3x of wrapping.
+ modify parametrized.h to make fln non-padded.
+ correct several entries which had termcap-style padding used in
terminfo: adm21, aj510, alto-h19, att605-pc, x820 -TD
+ correct syntax for padding in some entries: dg211, h19 -TD
+ correct ti924-8 which had confused padding versus octal escapes -TD
+ correct padding in sbi entry -TD
+ fix an old bug in the termcap emulation; "%i" was ignored in tparm()
because the parameters to be incremented were already on the internal
stack (report by Corinna Vinschen).
+ modify tic's "-c" option to take into account the "-C" option to
activate additional checks which compare the results from running
tparm() on the terminfo expressions versus the translated termcap
expressions.
+ modify tic to allow it to read from FIFOs (report by Matthieu Fronton,
cf: 20120324).
> patches by Nicolas Boulenguez:
+ explicit dereferences to suppress some style warnings.
+ when c_varargs_to_ada.c includes its header, use double quotes
instead of <>.
+ samples/ncurses2-util.adb: removed unused with clause. The warning
was removed by an obsolete pragma.
+ replaced Unreferenced pragmas with Warnings (Off). The latter,
available with older GNATs, needs no configure test. This also
replaces 3 untested Unreferenced pragmas.
+ simplified To_C usage in trace handling. Using two parameters allows
some basic formatting, and avoids a warning about security with some
compiler flags.
+ for generated Ada sources, replace many snippets with one pure
package.
+ removed C_Chtype and its conversions.
+ removed C_AttrType and its conversions.
+ removed conversions between int, Item_Option_Set, Menu_Option_Set.
+ removed int, Field_Option_Set, Item_Option_Set conversions.
+ removed C_TraceType, Attribute_Option_Set conversions.
+ replaced C.int with direct use of Eti_Error, now enumerated. As it
was used in a case statement, values were tested by the Ada compiler
to be consecutive anyway.
+ src/Makefile.in: remove duplicate stanza
+ only consider using a project for shared libraries.
+ style. Silent gnat-4.9 warning about misplaced "then".
+ generate shared library project to honor ADAFLAGS, LDFLAGS.
2014-05-25 09:22:18 +08:00
|
|
|
tion
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> <STRONG>endwin</STRONG> returns an error if the terminal was not ini-
|
|
|
|
|
tialized.
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> <STRONG>newterm</STRONG> returns an error if it cannot allocate the da-
|
|
|
|
|
ta structures for the screen, or for the top-level
|
|
|
|
|
windows within the screen, i.e., <STRONG>curscr</STRONG>, <STRONG>newscr</STRONG>, or
|
|
|
|
|
<STRONG>stdscr</STRONG>.
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> <STRONG>set_term</STRONG> returns no error.
|
2005-10-10 02:41:57 +08:00
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
Note that <STRONG>initscr</STRONG> and <STRONG>newterm</STRONG> may be macros.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
|
2015-07-20 08:44:14 +08:00
|
|
|
These functions were described in the XSI Curses standard,
|
|
|
|
|
Issue 4. As of 2015, the current document is X/Open Curs-
|
|
|
|
|
es, Issue 7.
|
|
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H3><a name="h3-Differences">Differences</a></H3><PRE>
|
2015-07-20 08:44:14 +08:00
|
|
|
X/Open specifies that portable applications must not call
|
|
|
|
|
<STRONG>initscr</STRONG> more than once:
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> The portable way to use <STRONG>initscr</STRONG> is once only, using
|
|
|
|
|
<STRONG>refresh</STRONG> (see <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>) to restore the screen
|
|
|
|
|
after <STRONG>endwin</STRONG>.
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> This implementation allows using <STRONG>initscr</STRONG> after <STRONG>endwin</STRONG>.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
Old versions of curses, e.g., BSD 4.4, may have returned a
|
2015-07-20 08:44:14 +08:00
|
|
|
null pointer from <STRONG>initscr</STRONG> when an error is detected,
|
|
|
|
|
rather than exiting. It is safe but redundant to check
|
2002-10-13 11:35:53 +08:00
|
|
|
the return value of <STRONG>initscr</STRONG> in XSI Curses.
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2015-07-20 08:44:14 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H3><a name="h3-Unset-TERM-Variable">Unset TERM Variable</a></H3><PRE>
|
2013-12-22 07:12:46 +08:00
|
|
|
If the TERM variable is missing or empty, <STRONG>initscr</STRONG> uses the
|
2015-07-20 08:44:14 +08:00
|
|
|
value "unknown", which normally corresponds to a terminal
|
|
|
|
|
entry with the <EM>generic</EM> (<EM>gn</EM>) capability. Generic entries
|
|
|
|
|
are detected by <STRONG>setupterm</STRONG> (see <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>) and can-
|
|
|
|
|
not be used for full-screen operation. Other implementa-
|
|
|
|
|
tions may handle a missing/empty TERM variable different-
|
|
|
|
|
ly.
|
|
|
|
|
|
|
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H3><a name="h3-Signal-Handlers">Signal Handlers</a></H3><PRE>
|
2015-07-20 08:44:14 +08:00
|
|
|
Quoting from X/Open Curses, section 3.1.1:
|
|
|
|
|
|
|
|
|
|
<EM>Curses</EM> <EM>implementations</EM> <EM>may</EM> <EM>provide</EM> <EM>for</EM> <EM>special</EM> <EM>han-</EM>
|
|
|
|
|
<EM>dling</EM> <EM>of</EM> <EM>the</EM> <EM>SIGINT,</EM> <EM>SIGQUIT</EM> <EM>and</EM> <EM>SIGTSTP</EM> <EM>signals</EM> <EM>if</EM>
|
2016-10-16 08:57:24 +08:00
|
|
|
<EM>their</EM> <EM>disposition</EM> <EM>is</EM> <EM>SIG</EM><STRONG>_</STRONG><EM>DFL</EM> <EM>at</EM> <EM>the</EM> <EM>time</EM> <STRONG>initscr</STRONG> <EM>is</EM>
|
2015-07-20 08:44:14 +08:00
|
|
|
<EM>called</EM> <STRONG>...</STRONG>
|
|
|
|
|
|
|
|
|
|
<EM>Any</EM> <EM>special</EM> <EM>handling</EM> <EM>for</EM> <EM>these</EM> <EM>signals</EM> <EM>may</EM> <EM>remain</EM> <EM>in</EM>
|
|
|
|
|
<EM>effect</EM> <EM>for</EM> <EM>the</EM> <EM>life</EM> <EM>of</EM> <EM>the</EM> <EM>process</EM> <EM>or</EM> <EM>until</EM> <EM>the</EM>
|
|
|
|
|
<EM>process</EM> <EM>changes</EM> <EM>the</EM> <EM>disposition</EM> <EM>of</EM> <EM>the</EM> <EM>signal.</EM>
|
|
|
|
|
|
|
|
|
|
<EM>None</EM> <EM>of</EM> <EM>the</EM> <EM>Curses</EM> <EM>functions</EM> <EM>are</EM> <EM>required</EM> <EM>to</EM> <EM>be</EM> <EM>safe</EM>
|
|
|
|
|
<EM>with</EM> <EM>respect</EM> <EM>to</EM> <EM>signals</EM> ...
|
|
|
|
|
|
|
|
|
|
This implementation establishes signal handlers during
|
|
|
|
|
initialization, e.g., <STRONG>initscr</STRONG> or <STRONG>newterm</STRONG>. Applications
|
|
|
|
|
which must handle these signals should set up the corre-
|
|
|
|
|
sponding handlers <EM>after</EM> initializing the library:
|
|
|
|
|
|
|
|
|
|
<STRONG>SIGINT</STRONG>
|
|
|
|
|
The handler <EM>attempts</EM> to cleanup the screen on exit.
|
|
|
|
|
Although it <EM>usually</EM> works as expected, there are lim-
|
|
|
|
|
itations:
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> Walking the <STRONG>SCREEN</STRONG> list is unsafe, since all list
|
|
|
|
|
management is done without any signal blocking.
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> On systems which have <STRONG>REENTRANT</STRONG> turned on,
|
|
|
|
|
<STRONG>set_term</STRONG> uses functions which could deadlock or
|
|
|
|
|
misbehave in other ways.
|
|
|
|
|
|
|
|
|
|
<STRONG>o</STRONG> <STRONG>endwin</STRONG> calls other functions, many of which use
|
|
|
|
|
stdio or other library functions which are clear-
|
|
|
|
|
ly unsafe.
|
|
|
|
|
|
|
|
|
|
<STRONG>SIGTERM</STRONG>
|
|
|
|
|
This uses the same handler as <STRONG>SIGINT</STRONG>, with the same
|
|
|
|
|
limitations. It is not mentioned in X/Open Curses,
|
|
|
|
|
but is more suitable for this purpose than <STRONG>SIGQUIT</STRONG>
|
|
|
|
|
(which is used in debugging).
|
|
|
|
|
|
|
|
|
|
<STRONG>SIGTSTP</STRONG>
|
|
|
|
|
This handles the <EM>stop</EM> signal, used in job control.
|
|
|
|
|
When resuming the process, this implementation dis-
|
|
|
|
|
cards pending input with <STRONG>flushinput</STRONG> (see
|
|
|
|
|
<STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>), and repaints the screen assuming that
|
|
|
|
|
it has been completely altered. It also updates the
|
|
|
|
|
saved terminal modes with <STRONG>def_shell_mode</STRONG> (see
|
|
|
|
|
<STRONG><A HREF="curs_kernel.3x.html">curs_kernel(3x)</A></STRONG>).
|
|
|
|
|
|
|
|
|
|
<STRONG>SIGWINCH</STRONG>
|
|
|
|
|
This handles the window-size changes which were ini-
|
|
|
|
|
tially ignored in the standardization efforts. The
|
|
|
|
|
handler sets a (signal-safe) variable which is later
|
|
|
|
|
tested in <STRONG>wgetch</STRONG> (see <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>). If <STRONG>keypad</STRONG> has
|
|
|
|
|
been enabled for the corresponding window, <STRONG>wgetch</STRONG> re-
|
|
|
|
|
turns the key symbol <STRONG>KEY_RESIZE</STRONG>. At the same time,
|
|
|
|
|
<STRONG>wgetch</STRONG> calls <STRONG>resizeterm</STRONG> to adjust the standard screen
|
|
|
|
|
<STRONG>stdscr</STRONG>, and update other data such as <STRONG>LINES</STRONG> and <STRONG>COLS</STRONG>.
|
2013-12-22 07:12:46 +08:00
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
2016-01-31 10:15:39 +08:00
|
|
|
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
|
2002-10-13 11:35:53 +08:00
|
|
|
<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>,
|
2013-12-22 07:12:46 +08:00
|
|
|
<STRONG><A HREF="curs_slk.3x.html">curs_slk(3x)</A></STRONG>, <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG>, <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG>curs_vari-</STRONG>
|
|
|
|
|
<STRONG><A HREF="curs_variables.3x.html">ables(3x)</A></STRONG>.
|
2002-10-13 11:35:53 +08:00
|
|
|
|
2000-07-09 10:46:08 +08:00
|
|
|
|
|
|
|
|
|
2005-10-10 02:41:57 +08:00
|
|
|
<STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>
|
2000-07-09 10:46:08 +08:00
|
|
|
</PRE>
|
2015-02-15 09:42:27 +08:00
|
|
|
<div class="nav">
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#h2-NAME">NAME</a></li>
|
|
|
|
|
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
|
2015-07-20 08:44:14 +08:00
|
|
|
<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#h3-initscr">initscr</a></li>
|
|
|
|
|
<li><a href="#h3-newterm">newterm</a></li>
|
|
|
|
|
<li><a href="#h3-endwin">endwin</a></li>
|
|
|
|
|
<li><a href="#h3-isendwin">isendwin</a></li>
|
|
|
|
|
<li><a href="#h3-set_term">set_term</a></li>
|
|
|
|
|
<li><a href="#h3-delscreen">delscreen</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2015-02-15 09:42:27 +08:00
|
|
|
<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
|
|
|
|
|
<li><a href="#h2-NOTES">NOTES</a></li>
|
2015-07-20 08:44:14 +08:00
|
|
|
<li><a href="#h2-PORTABILITY">PORTABILITY</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li><a href="#h3-Differences">Differences</a></li>
|
|
|
|
|
<li><a href="#h3-Unset-TERM-Variable">Unset TERM Variable</a></li>
|
|
|
|
|
<li><a href="#h3-Signal-Handlers">Signal Handlers</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2015-02-15 09:42:27 +08:00
|
|
|
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
2000-07-09 10:46:08 +08:00
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|