X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scr_dump.3x.html;h=7f964c92bb33ab20cbc5102808993f70d8f9cfb9;hb=87154b424ea0f67c2965d00e861ddfb134082d94;hp=8dd6321fd300a42b93df0b5f89b91b1baeb9a14b;hpb=f70db18a0c3c6a828d8a5999be37239f01c9d98a;p=ncurses.git diff --git a/doc/html/man/curs_scr_dump.3x.html b/doc/html/man/curs_scr_dump.3x.html index 8dd6321f..7f964c92 100644 --- a/doc/html/man/curs_scr_dump.3x.html +++ b/doc/html/man/curs_scr_dump.3x.html @@ -1,7 +1,7 @@ - - +
+ +- -curs_scr_dump(3x) curs_scr_dump(3x) +curs_scr_dump(3x) 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. - - 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 - what the terminal currently has on its screen. If the da- - ta 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 call. - The data is declared invalid if the terminfo capabilities - rmcup and nrrmc exist; also if the terminal has been writ- - ten 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)]. +
+
+ The scr_dump routine dumps the current contents of the virtual screen + to the file filename. --
- All routines return the integer ERR upon failure and OK - upon success. - X/Open defines no error conditions. In this implementa- - tion, each will return an error if the file cannot be - opened. +
+ 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. --
- Note that scr_init, scr_set, and scr_restore may be - macros. +
+ 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 + o if the terminfo capabilities rmcup and nrrmc exist, also --
- The XSI Curses standard, Issue 4, describes these func- - tions (adding the const qualifiers). + o if the terminal has been written to since the preceding scr_dump + call. - 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". +
+ 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. --
- curses(3x), curs_initscr(3x), curs_refresh(3x), - curs_util(3x), system(3) + 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. + + 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 con- + sidered invalid "if the time-stamp of the tty is old" but do not define + "old". + + +
+ curses(3x), curs_initscr(3x), curs_refresh(3x), curs_util(3x), + scr_dump(5), system(3) - curs_scr_dump(3x) + curs_scr_dump(3x)-