2 ****************************************************************************
3 * Copyright 2018-2019,2020 Thomas E. Dickey *
4 * Copyright 1998-2010,2017 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.16 2020/10/24 09:44:43 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>curs_scr_dump 3X</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">curs_scr_dump 3X</H1>
44 <B><A HREF="curs_scr_dump.3X.html">curs_scr_dump(3X)</A></B> <B><A HREF="curs_scr_dump.3X.html">curs_scr_dump(3X)</A></B>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <B>scr_dump</B>, <B>scr_restore</B>, <B>scr_init</B>, <B>scr_set</B> - read (write) a <B>curses</B> screen
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <B>#include</B> <B><curses.h></B>
57 <B>int</B> <B>scr_dump(const</B> <B>char</B> <B>*</B><I>filename</I><B>);</B>
58 <B>int</B> <B>scr_restore(const</B> <B>char</B> <B>*</B><I>filename</I><B>);</B>
59 <B>int</B> <B>scr_init(const</B> <B>char</B> <B>*</B><I>filename</I><B>);</B>
60 <B>int</B> <B>scr_set(const</B> <B>char</B> <B>*</B><I>filename</I><B>);</B>
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64 The <B>scr_dump</B> routine dumps the current contents of the <I>virtual</I> <I>screen</I>
65 to the file <I>filename</I>.
67 The <B>scr_restore</B> routine sets the <I>virtual</I> <I>screen</I> to the contents of
68 <I>filename</I>, which must have been written using <B>scr_dump</B>. The next call
69 to <B>doupdate</B> restores the <I>physical</I> <I>screen</I> to the way it looked in the
72 The <B>scr_init</B> routine reads in the contents of <I>filename</I> and uses them to
73 initialize the <B>curses</B> data structures about what the terminal currently
74 has on its screen. If the data is determined to be valid, <B>curses</B> bases
75 its next update of the screen on this information rather than clearing
76 the screen and starting from scratch. <B>scr_init</B> is used after <B>initscr</B>
77 or a <B>system</B> call to share the screen with another process which has
78 done a <B>scr_dump</B> after its <B><A HREF="curs_initscr.3X.html">endwin(3X)</A></B> call. The data is declared in-
81 <B>o</B> if the terminfo capabilities <B>rmcup</B> and <B>nrrmc</B> exist, also
83 <B>o</B> if the terminal has been written to since the preceding <B>scr_dump</B>
86 The <B>scr_set</B> routine is a combination of <B>scr_restore</B> and <B>scr_init</B>. It
87 tells the program that the information in <I>filename</I> is what is currently
88 on the screen, and also what the program wants on the screen. This can
89 be thought of as a screen inheritance function.
91 To read (write) a window from (to) a file, use the <B>getwin</B> and <B>putwin</B>
92 routines [see <B><A HREF="curs_util.3X.html">curs_util(3X)</A></B>].
95 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
96 All routines return the integer <B>ERR</B> upon failure and <B>OK</B> upon success.
98 X/Open defines no error conditions. In this implementation, each will
99 return an error if the file cannot be opened.
102 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
103 Note that <B>scr_init</B>, <B>scr_set</B>, and <B>scr_restore</B> may be macros.
106 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
107 The XSI Curses standard, Issue 4, describes these functions (adding the
110 The SVr4 docs merely say under <B>scr_init</B> that the dump data is also con-
111 sidered invalid "if the time-stamp of the tty is old" but do not define
115 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
116 <B><A HREF="curses.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>,
117 <B><A HREF="scr_dump.5.html">scr_dump(5)</A></B>, <B>system(3)</B>
121 <B><A HREF="curs_scr_dump.3X.html">curs_scr_dump(3X)</A></B>
125 <li><a href="#h2-NAME">NAME</a></li>
126 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
127 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
128 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
129 <li><a href="#h2-NOTES">NOTES</a></li>
130 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
131 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>