ncurses 6.0 - patch 20170114
[ncurses.git] / doc / html / man / curs_scr_dump.3x.html
1 <!-- 
2   ****************************************************************************
3   * Copyright (c) 1998-2010,2017 Free Software Foundation, Inc.              *
4   *                                                                          *
5   * Permission is hereby granted, free of charge, to any person obtaining a  *
6   * copy of this software and associated documentation files (the            *
7   * "Software"), to deal in the Software without restriction, including      *
8   * without limitation the rights to use, copy, modify, merge, publish,      *
9   * distribute, distribute with modifications, sublicense, and/or sell       *
10   * copies of the Software, and to permit persons to whom the Software is    *
11   * furnished to do so, subject to the following conditions:                 *
12   *                                                                          *
13   * The above copyright notice and this permission notice shall be included  *
14   * in all copies or substantial portions of the Software.                   *
15   *                                                                          *
16   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23   *                                                                          *
24   * Except as contained in this notice, the name(s) of the above copyright   *
25   * holders shall not be used in advertising or otherwise to promote the     *
26   * sale, use or other dealings in this Software without prior written       *
27   * authorization.                                                           *
28   ****************************************************************************
29   * @Id: curs_scr_dump.3x,v 1.10 2017/01/07 19:25:15 tom Exp @
30 -->
31 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
32 <HTML>
33 <HEAD>
34 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
35 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
36 <TITLE>curs_scr_dump 3x</TITLE>
37 <link rev=made href="mailto:bug-ncurses@gnu.org">
38 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
39 </HEAD>
40 <BODY>
41 <H1 class="no-header">curs_scr_dump 3x</H1>
42 <PRE>
43 <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>                                     <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
44
45
46
47
48 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
49        <STRONG>scr_dump</STRONG>, <STRONG>scr_restore</STRONG>, <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG> - read (write) a
50        <STRONG>curses</STRONG> screen from (to) a file
51
52
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
55
56        <STRONG>int</STRONG> <STRONG>scr_dump(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
57        <STRONG>int</STRONG> <STRONG>scr_restore(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
58        <STRONG>int</STRONG> <STRONG>scr_init(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
59        <STRONG>int</STRONG> <STRONG>scr_set(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG>
60
61
62 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63        The <STRONG>scr_dump</STRONG> routine dumps the  current  contents  of  the
64        virtual screen to the file <EM>filename</EM>.
65
66        The  <STRONG>scr_restore</STRONG>  routine  sets  the virtual screen to the
67        contents of <EM>filename</EM>, which must have been  written  using
68        <STRONG>scr_dump</STRONG>.   The  next call to <STRONG>doupdate</STRONG> restores the screen
69        to the way it looked in the dump file.
70
71        The <STRONG>scr_init</STRONG> routine reads in the contents of <EM>filename</EM> and
72        uses  them  to initialize the <STRONG>curses</STRONG> data structures about
73        what the terminal currently has on its screen.  If the da-
74        ta is determined to be valid, <STRONG>curses</STRONG> bases its next update
75        of the screen on this information rather than clearing the
76        screen  and starting from scratch.  <STRONG>scr_init</STRONG> is used after
77        <STRONG>initscr</STRONG> or a <STRONG>system</STRONG> call to share the screen with  another
78        process  which  has  done  a <STRONG>scr_dump</STRONG> after its <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG>
79        call.  The data is declared invalid if the terminfo  capa-
80        bilities  <STRONG>rmcup</STRONG>  and <STRONG>nrrmc</STRONG> exist; also if the terminal has
81        been written to since the preceding <STRONG>scr_dump</STRONG> call.
82
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.
88
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>].
91
92
93 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
94        All  routines  return  the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
95        upon success.
96
97        X/Open defines no error conditions.  In  this  implementa-
98        tion,  each  will  return  an  error if the file cannot be
99        opened.
100
101
102 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
103        Note  that  <STRONG>scr_init</STRONG>,  <STRONG>scr_set</STRONG>,  and  <STRONG>scr_restore</STRONG>  may  be
104        macros.
105
106
107 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
108        The  XSI  Curses  standard, Issue 4, describes these func-
109        tions (adding the const qualifiers).
110
111        The SVr4 docs merely say under <STRONG>scr_init</STRONG> that the dump data
112        is  also  considered invalid "if the time-stamp of the tty
113        is old" but do not define "old".
114
115
116 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
117        <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>,
118        <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG>system(3)</STRONG>
119
120
121
122                                                       <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
123 </PRE>
124 <div class="nav">
125 <ul>
126 <li><a href="#h2-NAME">NAME</a></li>
127 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
128 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
129 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
130 <li><a href="#h2-NOTES">NOTES</a></li>
131 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
132 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
133 </ul>
134 </div>
135 </BODY>
136 </HTML>