X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_initscr.3x.html;h=dc06eaddc6592b318dfc74d6d917e8f87d413e1c;hp=b61b21dcb60008e1e006eb44831580242f2964f6;hb=db5f7f4f146a91ba8ec7f1df8e9d7f9d2d7c74fd;hpb=2e5d72d6396bb38a8d1d1b3534f62e28aebaa600 diff --git a/doc/html/man/curs_initscr.3x.html b/doc/html/man/curs_initscr.3x.html index b61b21dc..dc06eadd 100644 --- a/doc/html/man/curs_initscr.3x.html +++ b/doc/html/man/curs_initscr.3x.html @@ -1,7 +1,6 @@ - + + + curs_initscr 3x -

curs_initscr 3x

-
+

curs_initscr 3x

-
 curs_initscr(3x)                                       curs_initscr(3x)
-

NAME

+
NAME
        initscr, newterm, endwin, isendwin, set_term, delscreen -
        curses screen initialization and manipulation routines
 
 
 

-
SYNOPSIS
+
SYNOPSIS
        #include <curses.h>
 
        WINDOW *initscr(void);
@@ -64,7 +64,7 @@
 
 
 

-
DESCRIPTION
+
DESCRIPTION
        initscr is normally the first curses routine to call  when
        initializing  a program.  A few special routines sometimes
        need to be called before it; these are  slk_init,  filter,
@@ -86,22 +86,34 @@
        use newterm.  The routine newterm should  be  called  once
        for each terminal.  It returns a variable of type SCREEN *
        which should be saved as a  reference  to  that  terminal.
-       The  arguments  are the type of the terminal to be used in
-       place of $TERM, a file pointer for output to the terminal,
-       and  another  file pointer for input from the terminal (if
-       type is NULL, $TERM will be used).  The program must  also
-       call  endwin  for  each terminal being used before exiting
-       from curses.  If newterm is called more than once for  the
-       same  terminal, the first terminal referred to must be the
-       last one for which endwin is called.
-
-       A program should always call endwin before exiting or  es-
-       caping  from  curses  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 refresh or doupdate after
-       a  temporary  escape  causes  the program to resume visual
-       mode.
+       newterm's arguments are
+
+       o   the type of the terminal to be used in place of $TERM,
+
+       o   a file pointer for output to the terminal, and
+
+       o   another file pointer for input from the terminal
+
+       If the type parameter is NULL, $TERM will be used.
+
+       The  program must also call endwin for each terminal being
+       used before exiting from curses.   If  newterm  is  called
+       more  than  once for the same terminal, the first terminal
+       referred to must be the  last  one  for  which  endwin  is
+       called.
+
+       A  program should always call endwin before exiting or es-
+       caping from curses mode temporarily.  This routine
+
+       o   restores tty modes,
+
+       o   moves the cursor to the lower left-hand corner of  the
+           screen and
+
+       o   resets the terminal into the proper non-visual mode.
+
+       Calling refresh or doupdate after a temporary escape caus-
+       es the program to resume visual mode.
 
        The isendwin routine  returns  TRUE  if  endwin  has  been
        called without any subsequent calls to wrefresh, and FALSE
@@ -121,43 +133,52 @@
 
 
 

-
RETURN VALUE
+
RETURN VALUE
        endwin returns the integer ERR upon failure  and  OK  upon
        successful completion.
 
        Routines that return pointers always return NULL on error.
 
        X/Open  defines  no error conditions.  In this implementa-
-       tion endwin returns an error if the terminal was not  ini-
-       tialized.
+       tion
+
+       o   endwin returns an error if the terminal was  not  ini-
+           tialized.
+
+       o   newterm 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., curscr, newscr, or
+           stdscr.
+
+       o   set_term returns no error.
 
 
 

-
NOTES
+
NOTES
        Note that initscr and newterm may be macros.
 
 
 

-
PORTABILITY
-       These  functions are described in the XSI Curses standard,
+
PORTABILITY
+       These functions are described in the XSI Curses  standard,
        Issue 4.  It specifies that portable applications must not
        call initscr more than once.
 
        Old versions of curses, e.g., BSD 4.4, may have returned a
-       null pointer from  initscr  when  an  error  is  detected,
-       rather  than  exiting.   It is safe but redundant to check
+       null  pointer  from  initscr  when  an  error is detected,
+       rather than exiting.  It is safe but  redundant  to  check
        the return value of initscr in XSI Curses.
 
        If the TERM variable is missing or empty, initscr uses the
-       value  "unknown", which normally corresponds to a terminal
-       entry with the generic (gn) capability.   Generic  entries
+       value "unknown", which normally corresponds to a  terminal
+       entry  with  the generic (gn) capability.  Generic entries
        are detected by curs_terminfo(3x) and cannot be used for full-
-       screen operation.   Other  implementations  may  handle  a
+       screen  operation.   Other  implementations  may  handle a
        missing/empty TERM variable differently.
 
 
 

-
SEE ALSO
+
SEE ALSO
        curses(3x),       curs_kernel(3x),       curs_refresh(3x),
        curs_slk(3x), curs_terminfo(3x), curs_util(3x), curs_vari-
        ables(3x).
@@ -166,10 +187,16 @@
 
                                                        curs_initscr(3x)
 

-

-

-Man(1) output converted with
-man2html
-

+

+
+