Curses Library Functions                    cursinitscr(3CURSES)



NAME
     cursinitscr, initscr, newterm, endwin, isendwin,  setterm,
     delscreen  -  curses  screen initialization and manipulation
     routines

SYNOPSIS
     cc [ flag ... ] file ... -lcurses [ library ... ]
     #include 

     WINDOW *initscr(void);


     int endwin(void);


     int isendwin(void);


     SCREN *newterm(char *type, FILE *outfd, FILE *infd);


     SCREN *setterm(SCREN *new);


     void delscreen(SCREN * sp);


DESCRIPTION
     initscr() is almost always the first routine that should  be
     called  (the  exceptions  are  slkinit(), filter(), ripoff-
     line(), useenv() and, for  multiple-terminal  applications,
     newterm().)  This  determines the terminal type and initial-
     izes all curses data structures. initscr() also  causes  the
     first  call  to  refresh()  to  clear  the screen. If errors
     occur, initscr() writes  an  appropriate  error  message  to
     standard  error  and exits; otherwise, a pointer is returned
     to stdscr(). If the program needs  an  indication  of  error
     conditions,  newterm() should be used instead of  initscr();
     initscr() should only be called once per application.


     A program that outputs to more than one terminal should  use
     the   newterm()   routine   for  each  terminal  instead  of
     initscr(). A program that needs an indication of error  con-
     ditions,  so  it can continue to run in a line-oriented mode
     if the terminal cannot support  a  screen-oriented  program,
     would  also  use this routine. The routine  newterm() should
     be called once for each terminal. It returns a  variable  of
     type  SCREN  * 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



SunOS 5.11          Last change: 31 Dec 1996                    1






Curses Library Functions                    cursinitscr(3CURSES)



     terminal (if type is NUL, $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
     escaping from curses 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 refresh() or doupdate()  after  a  tem-
     porary escape causes the program to resume visual mode.


     The isendwin() routine returns TRUE  if  endwin()  has  been
     called without any subsequent calls to wrefresh(), and FALSE
     otherwise.


     The setterm() routine is used to switch  between  different
     terminals.  The screen reference new becomes the new current
     terminal. The previous terminal is returned by the  routine.
     This  is the only routine which manipulates SCREN pointers;
     all other routines affect only the current terminal.


     The delscreen() routine frees storage  associated  with  the
     SCREN  data  structure.   The  endwin() routine does not do
     this, so delscreen() should be called after  endwin()  if  a
     particular SCREN is no longer needed.

RETURN VALUES
     endwin() returns the integer ER upon failure  and  OK  upon
     successful completion.


     Routines that return pointers always return NUL on error.

ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:













SunOS 5.11          Last change: 31 Dec 1996                    2






Curses Library Functions                    cursinitscr(3CURSES)



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     MT-Level                     Unsafe                      
    


SEE ALSO
     curskernel(3CURSES),                 cursrefresh(3CURSES),
     cursslk(3CURSES),    cursutil(3CURSES),   curses(3CURSES),
     attributes(5)

NOTES
     The header   automatically  includes  the  headers
      and .


     Note that initscr() and newterm() may be macros.





































SunOS 5.11          Last change: 31 Dec 1996                    3