cursscrdump(3X)                                            cursscrdump(3X)



NAME
       scrdump, scrrestore, scrinit, scrset - read (write) a curses screen
       from (to) a file

SYNOPSIS
       ##include <>

       int scrdump(const char **filename);;
       int scrrestore(const char **filename);;
       int scrinit(const char **filename);;
       int scrset(const char **filename);;

DESCRIPTION
       The scrdump routine dumps the current contents of the  virtual  screen
       to the file filename.

       The  scrrestore  routine  sets  the  virtual screen to the contents of
       filename, which must have been written using scrdump.  The  next  call
       to  doupdate restores the screen to the way it looked in the dump file.

       The scrinit routine reads in the contents of filename and uses them to
       initialize the curses data structures about what the terminal currently
       has on its screen.  If the data is determined to be valid, curses bases
       its  next update of the screen on this information rather than clearing
       the screen and starting from scratch.  scrinit is used  after  initscr
       or  a  system  call  to share the screen with another process which has
       done a scrdump after its endwin call.  The data is declared invalid if
       the  terminfo  capabilities rmcup and nrrmc exist; also if the terminal
       has been written to since the preceding scrdump call.

       The scrset routine is a combination of scrrestore and  scrinit.   It
       tells the program that the information in filename is what is currently
       on the screen, and also what the program wants on the screen.  This can
       be thought of as a screen inheritance function.

       To  read  (write)  a window from (to) a file, use the getwin and putwin
       routines [see cursutil(3X)].

RETURN VALUE
       All routines return the integer ER upon failure and OK upon success.

NOTES
       Note that scrinit, scrset, and scrrestore may be macros.

PORTABILITY
       The XSI Curses standard, Issue 4, describes these functions (adding the
       const qualifiers).

       The SVr4 docs merely say under scrinit that the dump data is also con-
       sidered invalid "if the time-stamp of the tty is old" but don't  define
       "old".

SEE ALSO
       curses(3X),  cursinitscr(3X),  cursrefresh(3X),  cursutil(3X),  sys-
       tem(3S)



                                                             cursscrdump(3X)