ncurses 6.2 - patch 20201212
[ncurses.git] / man / curs_scr_dump.3x
1 .\"***************************************************************************
2 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
3 .\" Copyright 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 .\"
30 .\" $Id: curs_scr_dump.3x,v 1.16 2020/10/24 09:44:43 tom Exp $
31 .TH curs_scr_dump 3X ""
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .de bP
37 .ie n  .IP \(bu 4
38 .el    .IP \(bu 2
39 ..
40 .na
41 .hy 0
42 .SH NAME
43 \fBscr_dump\fR,
44 \fBscr_restore\fR,
45 \fBscr_init\fR,
46 \fBscr_set\fR \- read (write) a \fBcurses\fR screen from (to) a file
47 .ad
48 .hy
49 .SH SYNOPSIS
50 \fB#include <curses.h>\fR
51 .sp
52 \fBint scr_dump(const char *\fP\fIfilename\fP\fB);\fR
53 .br
54 \fBint scr_restore(const char *\fP\fIfilename\fP\fB);\fR
55 .br
56 \fBint scr_init(const char *\fP\fIfilename\fP\fB);\fR
57 .br
58 \fBint scr_set(const char *\fP\fIfilename\fP\fB);\fR
59 .br
60 .SH DESCRIPTION
61 The \fBscr_dump\fR routine dumps the current contents
62 of the \fIvirtual screen\fP
63 to the file \fIfilename\fR.
64 .PP
65 The \fBscr_restore\fR routine sets the \fIvirtual screen\fP to the contents
66 of \fIfilename\fR, which must have been written using \fBscr_dump\fR.
67 The next call to \fBdoupdate\fR restores
68 the \fIphysical screen\fP to the way it looked in the dump file.
69 .PP
70 The \fBscr_init\fR routine reads in the contents of \fIfilename\fR and uses
71 them to initialize the \fBcurses\fR data structures about what the terminal
72 currently has on its screen.
73 If the data is determined to be valid,
74 \fBcurses\fR bases its next update of the screen on this information rather
75 than clearing the screen and starting from scratch.
76 \fBscr_init\fR is used
77 after \fBinitscr\fR or a \fBsystem\fR call to share
78 the screen with another process which has done a \fBscr_dump\fR after its
79 \fBendwin\fR(3X) call.
80 The data is declared invalid
81 .bP
82 if the terminfo capabilities \fBrmcup\fR and \fBnrrmc\fR exist, also
83 .bP
84 if the terminal has been written to since the preceding \fBscr_dump\fR call.
85 .PP
86 The \fBscr_set\fR routine is a combination of \fBscr_restore\fR and
87 \fBscr_init\fR.  It tells the program that the information in \fIfilename\fR is
88 what is currently on the screen, and also what the program wants on the screen.
89 This can be thought of as a screen inheritance function.
90 .PP
91 To read (write) a window from (to) a file, use the \fBgetwin\fR and
92 \fBputwin\fR routines [see \fBcurs_util\fR(3X)].
93 .SH RETURN VALUE
94 All routines return the integer \fBERR\fR upon failure and \fBOK\fR
95 upon success.
96 .PP
97 X/Open defines no error conditions.
98 In this implementation,
99 each will return an error if the file cannot be opened.
100 .SH NOTES
101 Note that \fBscr_init\fR, \fBscr_set\fR, and \fBscr_restore\fR may be macros.
102 .SH PORTABILITY
103 The XSI Curses standard, Issue 4, describes these functions (adding the const
104 qualifiers).
105 .PP
106 The SVr4 docs merely say under \fBscr_init\fR that the dump data is also
107 considered invalid "if the time-stamp of the tty is old" but do not define
108 \*(``old\*(''.
109 .SH SEE ALSO
110 \fBcurses\fR(3X),
111 \fBcurs_initscr\fR(3X),
112 \fBcurs_refresh\fR(3X),
113 \fBcurs_util\fR(3X),
114 \fBscr_dump\fR(5),
115 \fBsystem\fR(3)