cursscrdump(3X) cursscrdump(3X)

NAME
       ssccrrdduummpp, ssccrrrreessttoorree, ssccrriinniitt, ssccrrsseett - read (write) a ccuurrsseess screen
       from (to) a file

SYNOPSIS
       ##iinncclluuddee <>

       iinntt ssccrrdduummpp((ccoonnsstt cchhaarr **ffiilleennaammee));;
       iinntt ssccrrrreessttoorree((ccoonnsstt cchhaarr **ffiilleennaammee));;
       iinntt ssccrriinniitt((ccoonnsstt cchhaarr **ffiilleennaammee));;
       iinntt ssccrrsseett((ccoonnsstt cchhaarr **ffiilleennaammee));;

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

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

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

       The ssccrrsseett routine is a combination of ssccrrrreessttoorree and  ssccrriinniitt.   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 ggeettwwiinn and ppuuttwwiinn
       routines [see ccuurrssuuttiill(3X)].

RREETTUURRNN VVAALLUUEE
       All routines return the integer EERRRR upon failure and OOKK upon success.

       X/Open defines no error conditions.  In this implementation, each  will
       return an error if the file cannot be opened.

NNOOTTEESS
       Note that ssccrriinniitt, ssccrrsseett, and ssccrrrreessttoorree may be macros.

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

       The SVr4 docs merely say under ssccrriinniitt that the dump data is also con-
       sidered invalid "if the time-stamp of the tty is old" but do not define
       "old".

SEE ALSO
       ccuurrsseess(3X),  ccuurrssiinniittssccrr(3X),  ccuurrssrreeffrreesshh(3X),  ccuurrssuuttiill(3X),  ssyyss-
       tteemm(3S)



                                                             cursscrdump(3X)