scr_dump(3X) scr_dump(3X)
NAME
scrdump, scrinit, scrrestore, scrset - screen file input/output
functions
SYNOPSIS
cc [flag ...] file ... -lcurses [library ...]
#include <curses.h>
int scrdump(const char *filename);
int scrinit(const char *filename);
int scrrestore(const char *filename);
int scrset(const char *filename);
DESCRIPTION
The scrdump() function writes the current contents of the virtual
screen to the file named by filename in an unspecified format.
The scrrestore() function sets the virtual screen to the contents of
the file named by filename, which must have been written using
scrdump(). The next refresh operation restores the screen to the way
it looked in the dump file.
The scrinit() function reads the contents of the file named by
filename and uses them to initialise the Curses data structures to
what the terminal currently has on its screen. The next refresh opera-
tion bases any updates on this information, unless either of the fol-
lowing conditions is true:
- The terminal has been written to since the virtual screen was
dumped to filename
- The terminfo capabilities rmcup and nrrmc are defined for the
current terminal.
The scrset() function is a combination of scrrestore() and
scrinit(). It tells the program that the information in the file
named by 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.
RETURN VALUE
On successful completion, these functions return OK. Otherwise, they
return ERR.
ERRORS
No errors are defined.
Page 1 Reliant UNIX 5.44 Printed 11/98
scr_dump(3X) scr_dump(3X)
NOTES
The scrinit() function is called after initscr() or a system() call
to share the screen with another process that has done a scrdump()
after its endwin() call.
To read a window from a file, call getwin(); to write a window to a
file, call putwin().
SEE ALSO
open(2), read(2), write(2), curses(3X), delscreen(3X), doupdate(3X),
endwin(3X), getwin(3X), terminfo(4), curses(5).
Page 2 Reliant UNIX 5.44 Printed 11/98