+ curses provides applications the ability to write the contents of the
+ screen to a file and read them back. To read/write a window (rather
+ than the whole screen) from/to a file, use getwin(3x) and putwin(3x),
+ respectively.
+
- The scr_dump routine dumps the current contents of the virtualscreen
- to the file filename.
+ scr_dump writes to filename the contents of the virtual screen; see
+ curscr(3x).
- The scr_restore routine sets the virtualscreen to the contents of
- filename, which must have been written using scr_dump. The next call
- to doupdate restores the physicalscreen to the way it looked in the
- dump file.
+ scr_restore updates the virtual screen to contain the contents of
+ filename (if it was validly written with scr_dump). No refresh is
+ performed; after performing any further desired updates, call
+ doupdate(3x) or similar.
- 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(3x) or a system(3) call to share the screen with another
- process which has done a scr_dump after its endwin(3x) call. The data
- is declared invalid
+ scr_init reads filename, using it to initialize curses data structures
+ describing the state of the terminal screen. If these data are valid,
+ curses bases its next update of the screen on this information rather
+ than clearing it and starting from scratch.
+
+ The data fail the validity check
+
+ o if the terminal employs terminfo capabilities exit_ca_mode (rmcup)
+ or non_rev_rmcup (nrrmc) are defined, or
- o if the terminfo capabilities rmcup and nrrmc exist, also
+ o if curses knows that the terminal has been written to since the
+ preceding scr_dump call.
- o if the terminal has been written to since the preceding scr_dump
- call.
+ scr_init could be used after initscr(3x) or system(3) to share the
+ screen with another process that has done a scr_dump after endwin(3x).
- The scr_set routine is a combination of scr_restore and scr_init. It
+ 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(3x)].
-
- All routines return the integer ERR upon failure and OK upon success.
+ These functions return OK on success and ERR on failure.
- X/Open defines no error conditions. In this implementation, each will
- return an error if the file cannot be opened.
+ X/Open defines no failure conditions. In this implementation, each
+ function fails if it cannot open filename.
- These functions are described in the XSI Curses standard, Issue 4,
- which adds const qualifiers to the arguments.
+ X/Open Curses, Issue 4 describes these functions.
+
+ SVr4 omitted 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
+ SVr4 documentation describes scr_init such that the dump data is also
+ considered invalid "if the time-stamp of the tty is old" but does not
define "old".
@@ -126,7 +131,7 @@
-ncurses 6.4 2023-11-25 curs_scr_dump(3x)
+ncurses 6.5 2024-04-20 curs_scr_dump(3x)