ncurses 5.9 - patch 20131221
[ncurses.git] / doc / html / man / curs_initscr.3x.html
index f8ba9ac6dfdd62466c9b417e25408cfc1f80dd42..b61b21dcb60008e1e006eb44831580242f2964f6 100644 (file)
@@ -1,7 +1,7 @@
-<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <!-- 
   ****************************************************************************
-  * Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *
+  * Copyright (c) 1998-2012,2013 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            *
@@ -27,7 +27,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_initscr.3x,v 1.12 2003/05/10 20:33:49 jmc Exp @
+  * @Id: curs_initscr.3x,v 1.19 2013/07/20 19:34:14 tom Exp @
 -->
 <HTML>
 <HEAD>
 <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>
+<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>
-       <STRONG>initscr</STRONG>,  <STRONG>newterm</STRONG>, <STRONG>endwin</STRONG>, <STRONG>isendwin</STRONG>, <STRONG>set_term</STRONG>, <STRONG>delscreen</STRONG> -
+       <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
 
 
 
        The initscr code determines the terminal type and initial-
        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
-       occur,  <STRONG>initscr</STRONG>  writes  an  appropriate  error message to
-       standard error and exits; otherwise, a pointer is returned
-       to <STRONG>stdscr</STRONG>.
+       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
        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
-       escaping  from  <STRONG>curses</STRONG>  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
+       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.
        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
-       current terminal.
+       <STRONG>SCREEN</STRONG> pointers; all other routines affect only  the  cur-
+       rent terminal.
 
        The  <STRONG>delscreen</STRONG>  routine  frees storage associated with the
        <STRONG>SCREEN</STRONG> data structure.  The <STRONG>endwin</STRONG>  routine  does  not  do
 
        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>
 
 </PRE>
 <H2>PORTABILITY</H2><PRE>
-       These functions are described in the XSI Curses  standard,
+       These  functions are described in the XSI Curses standard,
        Issue 4.  It specifies that portable applications must not
        call <STRONG>initscr</STRONG> more than once.
 
        Old versions of curses, e.g., BSD 4.4, may have returned a
-       null  pointer  from  <STRONG>initscr</STRONG>  when  an  error is detected,
-       rather than exiting.  It is safe but  redundant  to  check
+       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 <STRONG>initscr</STRONG> in XSI Curses.
 
+       If the TERM variable is missing or empty, <STRONG>initscr</STRONG> uses the
+       value  "unknown", which normally corresponds to a terminal
+       entry with the <EM>generic</EM> (<EM>gn</EM>) capability.   Generic  entries
+       are detected by <STRONG><A HREF="curs_terminfo.3x.html">curs_terminfo(3x)</A></STRONG> and cannot be used for full-
+       screen operation.   Other  implementations  may  handle  a
+       missing/empty TERM variable differently.
+
 
 </PRE>
 <H2>SEE ALSO</H2><PRE>
        <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_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>.
 
 
 
-                                                 <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>
 <HR>
 <ADDRESS>