X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scr_dump.3x.html;h=ff5b924d4cbd1f2d3291794fb76a6477db12ee7f;hp=4666ecd6dcc8d4e79616e388363ca2b57a0355ef;hb=8f6d94b8d6211a2323caef53fa4c96c475ec9a62;hpb=58552e8c761a70f8f0bd591fecdf576fa8216e3e diff --git a/doc/html/man/curs_scr_dump.3x.html b/doc/html/man/curs_scr_dump.3x.html index 4666ecd6..ff5b924d 100644 --- a/doc/html/man/curs_scr_dump.3x.html +++ b/doc/html/man/curs_scr_dump.3x.html @@ -1,6 +1,6 @@
- +-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
@@ -60,66 +60,64 @@
- 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(3x) - call. The data is declared invalid if the terminfo capa- - bilities 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)]. + 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 + 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 + + o if the terminfo capabilities rmcup and nrrmc exist, also + + o 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)].
- All routines return the integer ERR upon failure and OK - upon success. + 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. + 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. + Note that scr_init, scr_set, and scr_restore may be macros.
- The XSI Curses standard, Issue 4, describes these func- - tions (adding the const qualifiers). + 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". + 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), system(3) + curses(3x), curs_initscr(3x), curs_refresh(3x), curs_util(3x), + scr_dump(5), system(3) - curs_scr_dump(3x) + curs_scr_dump(3x)