1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
3 ****************************************************************************
4 * Copyright (c) 1998,2000 Free Software Foundation, Inc. *
6 * Permission is hereby granted, free of charge, to any person obtaining a *
7 * copy of this software and associated documentation files (the *
8 * "Software"), to deal in the Software without restriction, including *
9 * without limitation the rights to use, copy, modify, merge, publish, *
10 * distribute, distribute with modifications, sublicense, and/or sell *
11 * copies of the Software, and to permit persons to whom the Software is *
12 * furnished to do so, subject to the following conditions: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
25 * Except as contained in this notice, the name(s) of the above copyright *
26 * holders shall not be used in advertising or otherwise to promote the *
27 * sale, use or other dealings in this Software without prior written *
29 ****************************************************************************
30 * @Id: curs_scr_dump.3x,v 1.2 2000/07/01 20:06:53 tom Exp @
34 <TITLE>curs_scr_dump 3x</TITLE>
35 <link rev=made href="mailto:bug-ncurses@gnu.org">
36 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 <H1>curs_scr_dump 3x</H1>
42 <!-- Manpage converted by man2html 3.0.1 -->
46 <STRONG>scr_dump</STRONG>, <STRONG>scr_restore</STRONG>, <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG> - read (write) a
47 <STRONG>curses</STRONG> screen from (to) a file
51 <H2>SYNOPSIS</H2><PRE>
52 <STRONG>#include</STRONG> <STRONG><curses.h></STRONG>
54 <STRONG>int</STRONG> <STRONG>scr_dump(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
55 <STRONG>int</STRONG> <STRONG>scr_restore(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
56 <STRONG>int</STRONG> <STRONG>scr_init(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
57 <STRONG>int</STRONG> <STRONG>scr_set(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
61 <H2>DESCRIPTION</H2><PRE>
62 The <STRONG>scr_dump</STRONG> routine dumps the current contents of the
63 virtual screen to the file <EM>filename</EM>.
65 The <STRONG>scr_restore</STRONG> routine sets the virtual screen to the
66 contents of <EM>filename</EM>, which must have been written using
67 <STRONG>scr_dump</STRONG>. The next call to <STRONG>doupdate</STRONG> restores the screen
68 to the way it looked in the dump file.
70 The <STRONG>scr_init</STRONG> routine reads in the contents of <EM>filename</EM> and
71 uses them to initialize the <STRONG>curses</STRONG> data structures about
72 what the terminal currently has on its screen. If the
73 data is determined to be valid, <STRONG>curses</STRONG> bases its next
74 update of the screen on this information rather than
75 clearing the screen and starting from scratch. <STRONG>scr_init</STRONG>
76 is used after <STRONG>initscr</STRONG> or a <STRONG>system</STRONG> [see <STRONG>system</STRONG>(BA_LIB)]
77 call to share the screen with another process which has
78 done a <STRONG>scr_dump</STRONG> after its <STRONG>endwin</STRONG> call. The data is
79 declared invalid if the terminfo capabilities <STRONG>rmcup</STRONG> and
80 <STRONG>nrrmc</STRONG> exist; also if the terminal has been written to
81 since the preceding <STRONG>scr_dump</STRONG> call.
83 The <STRONG>scr_set</STRONG> routine is a combination of <STRONG>scr_restore</STRONG> and
84 <STRONG>scr_init</STRONG>. It tells the program that the information in
85 <EM>filename</EM> is what is currently on the screen, and also what
86 the program wants on the screen. This can be thought of
87 as a screen inheritance function.
89 To read (write) a window from (to) a file, use the <STRONG>getwin</STRONG>
90 and <STRONG>putwin</STRONG> routines [see <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>].
94 <H2>RETURN VALUE</H2><PRE>
95 All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
101 Note that <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG>, and <STRONG>scr_restore</STRONG> may be
106 <H2>PORTABILITY</H2><PRE>
107 The XSI Curses standard, Issue 4, describes these func-
108 tions (adding the const qualifiers).
109 The SVr4 docs merely say under <STRONG>scr_init</STRONG> that the dump data
110 is also considered invalid "if the time-stamp of the tty
111 is old" but don't define "old".
115 <H2>SEE ALSO</H2><PRE>
116 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>,
117 <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="system.3S.html">system(3S)</A></STRONG>
168 Man(1) output converted with
169 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>