X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fhtml%2Fman%2Fcurs_scr_dump.3x.html;h=66806000db902abef26906ae15e2d538a25c74e1;hb=HEAD;hp=0b1e50ba61428dc3da9bd845bde7db948dd1ba6a;hpb=d97989d1e0db7282c723cabb44b991b951790006;p=ncurses.git diff --git a/doc/html/man/curs_scr_dump.3x.html b/doc/html/man/curs_scr_dump.3x.html index 0b1e50ba..f1759cb3 100644 --- a/doc/html/man/curs_scr_dump.3x.html +++ b/doc/html/man/curs_scr_dump.3x.html @@ -1,6 +1,7 @@ -
--curs_scr_dump(3x) curs_scr_dump(3x) +curs_scr_dump(3x) Library calls curs_scr_dump(3x)
- scr_dump, scr_restore, scr_init, scr_set - read (write) a curses screen - from (to) a file + 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); + 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. + 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. + + +
+ scr_dump writes to filename the contents of the virtual screen; see + curscr(3x). + + +
+ 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_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. +
+ 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 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 - or a system call to share the screen with another process which has - done a scr_dump after its endwin(3x) call. The data is declared in- - valid + The data fail the validity check - o if the terminfo capabilities rmcup and nrrmc exist, also + o if the terminal employs terminfo capabilities exit_ca_mode (rmcup) + or non_rev_rmcup (nrrmc) are defined, or - o if the terminal has been written to since the preceding scr_dump - call. + o if curses knows that 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 + 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 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.
- Note that scr_init, scr_set, and scr_restore may be macros. + scr_init, scr_set, and scr_restore may be macros.
- The XSI Curses standard, Issue 4, describes these functions (adding the - const qualifiers). + X/Open Curses, Issue 4 describes these functions. - The SVr4 docs merely say under scr_init that the dump data is also con- - sidered invalid "if the time-stamp of the tty is old" but do not define - "old". + SVr4 omitted the const qualifiers. + + 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".
curses(3x), curs_initscr(3x), curs_refresh(3x), curs_util(3x), - scr_dump(5), system(3) + system(3), scr_dump(5) - curs_scr_dump(3x) +ncurses 6.5 2024-04-20 curs_scr_dump(3x)