diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man/curs_scr_dump.3x.html')
| -rw-r--r-- | ncurses-5.2/doc/html/man/curs_scr_dump.3x.html | 134 |
1 files changed, 134 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/curs_scr_dump.3x.html b/ncurses-5.2/doc/html/man/curs_scr_dump.3x.html new file mode 100644 index 0000000..7931102 --- /dev/null +++ b/ncurses-5.2/doc/html/man/curs_scr_dump.3x.html @@ -0,0 +1,134 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>scr_dump</B>, <B>scr_restore</B>, <B>scr_init</B>, <B>scr_set</B> - read (write) a + <B>curses</B> screen from (to) a file + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><curses.h></B> + + <B>int</B> <B>scr_dump(const</B> <B>char</B> <B>*filename);</B> + <B>int</B> <B>scr_restore(const</B> <B>char</B> <B>*filename);</B> + <B>int</B> <B>scr_init(const</B> <B>char</B> <B>*filename);</B> + <B>int</B> <B>scr_set(const</B> <B>char</B> <B>*filename);</B> + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The <B>scr_dump</B> routine dumps the current contents of the + virtual screen to the file <I>filename</I>. + + The <B>scr_restore</B> routine sets the virtual screen to the + contents of <I>filename</I>, which must have been written using + <B>scr_dump</B>. The next call to <B>doupdate</B> restores the screen + to the way it looked in the dump file. + + The <B>scr_init</B> routine reads in the contents of <I>filename</I> and + uses them to initialize the <B>curses</B> data structures about + what the terminal currently has on its screen. If the + data is determined to be valid, <B>curses</B> bases its next + update of the screen on this information rather than + clearing the screen and starting from scratch. <B>scr_init</B> + is used after <B>initscr</B> or a <B>system</B> [see <B>system</B>(BA_LIB)] + call to share the screen with another process which has + done a <B>scr_dump</B> after its <B>endwin</B> call. The data is + declared invalid if the terminfo capabilities <B>rmcup</B> and + <B>nrrmc</B> exist; also if the terminal has been written to + since the preceding <B>scr_dump</B> call. + + The <B>scr_set</B> routine is a combination of <B>scr_restore</B> and + <B>scr_init</B>. It tells the program that the information in + <I>filename</I> 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 <B>getwin</B> + and <B>putwin</B> routines [see <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B>]. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + All routines return the integer <B>ERR</B> upon failure and <B>OK</B> + upon success. + + +</PRE> +<H2>NOTES</H2><PRE> + Note that <B>scr_init</B>, <B>scr_set</B>, and <B>scr_restore</B> may be + macros. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + The XSI Curses standard, Issue 4, describes these func- + tions (adding the const qualifiers). + The SVr4 docs merely say under <B>scr_init</B> that the dump data + is also considered invalid "if the time-stamp of the tty + is old" but don't define "old". + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></B>, <B><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></B>, + <B><A HREF="curs_util.3x.html">curs_util(3x)</A></B>, <B><A HREF="system.3S.html">system(3S)</A></B> + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |