X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scr_dump.3x.html;h=c64c48ce4415d4970e26067adaca3df30e421030;hp=7931102dcb7248174703da007827864e72bf86da;hb=refs%2Ftags%2Fv5.3;hpb=c633e5103a29a38532cf1925257b91cea33fd090 diff --git a/doc/html/man/curs_scr_dump.3x.html b/doc/html/man/curs_scr_dump.3x.html index 7931102d..c64c48ce 100644 --- a/doc/html/man/curs_scr_dump.3x.html +++ b/doc/html/man/curs_scr_dump.3x.html @@ -1,66 +1,104 @@ + + +
+- 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> + #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. + 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 screen + 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 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 + 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 + 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 [see system(BA_LIB)] + clearing the screen and starting from scratch. scr_init + is used after initscr or a system [see system(BA_LIB)] call to share the screen with another process which has - done a scr_dump after its endwin call. The data is - declared invalid if the terminfo capabilities rmcup and - nrrmc exist; also 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 + done a scr_dump after its endwin call. The data is + declared invalid if the terminfo capabilities rmcup and + nrrmc exist; also 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(3x)]. + 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 + All routines return the integer ERR upon failure and OK upon success.
- Note that scr_init, scr_set, and scr_restore may be + Note that scr_init, scr_set, and scr_restore may be macros. @@ -68,15 +106,15 @@PORTABILITY
The XSI Curses standard, Issue 4, describes these func- tions (adding the const qualifiers). - The SVr4 docs merely say under scr_init that the dump data + 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 don't define "old".SEE ALSO
- curses(3x), curs_initscr(3x), curs_refresh(3x), - curs_util(3x), system(3S) + curses(3x), curs_initscr(3x), curs_refresh(3x), + curs_util(3x), system(3S)