scr_dump(3curses)

Synopsis

#include <curses.h>

int scr_dump(const char *filename);

int scr_init(const char *filename);

int scr_restore(const char *filename);

int scr_set(const char *filename);

Description

The scr_restore(3curses) function sets the virtual screen to the contents of the file named by filename, which must have been written using scr_dump(3curses). The next refresh operation restores the screen to the way it looked in the dump file.

The scr_init(3curses) 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 operation bases any updates on this information, unless either of the following 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 scr_set(3curses) function is a combination of scr_restore(3curses) and scr_init(3curses). 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

Errors

Usage

To read a window from a file, call getwin(3curses); to write a window to a file, call putwin(3curses).

Standards Conformance

References