$OpenBSD: curs_scr_dump.3,v 1.4 2023/10/17 09:52:08 nicm Exp $

***************************************************************************
Copyright 2018-2022,2023 Thomas E. Dickey *
Copyright 1998-2010,2017 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: curs_scr_dump.3,v 1.4 2023/10/17 09:52:08 nicm Exp $
.. scr_dump, scr_restore, scr_init, scr_set - read (write) a curses screen from (to) a file #include <curses.h> int scr_dump(const char *filename);

int scr_restore(const char *filename);

int scr_init(const char *filename);

int scr_set(const char *filename);

The scr_dump routine dumps the current contents of the virtual screen to the file filename. The scr_restore routine sets the virtual screen to the contents of filename, which must have been written using scr_dump. The next call to doupdate restores the physical screen to the way it looked in the dump file. The scr_init 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. scr_init is used after initscr(3) or a system(3) call to share the screen with another process which has done a scr_dump after its endwin(3) call. The data is declared invalid .bP if the terminfo capabilities rmcup and nrrmc exist, also .bP if the terminal has been written to since the preceding scr_dump call. The scr_set routine is a combination of scr_restore and scr_init. 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 curs_util(3)].

All routines return the integer ERR upon failure and OK upon success.

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

Note that scr_init, scr_set, and scr_restore may be macros. The XSI Curses standard, Issue 4, describes these functions (adding the const qualifiers).

The SVr4 docs merely say under scr_init that the dump data is also considered invalid "if the time-stamp of the tty is old" but do not define \*(``old\*(''.

curses(3), curs_initscr(3), curs_refresh(3), curs_util(3), scr_dump(5), system(3)