.\"***************************************************************************
-.\" Copyright 2018-2021,2022 Thomas E. Dickey *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey *
.\" Copyright 1998-2010,2017 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: curs_scr_dump.3x,v 1.21 2022/02/12 20:05:11 tom Exp $
-.TH curs_scr_dump 3X 2022-02-12 "ncurses 6.4" "Library calls"
+.\" $Id: curs_scr_dump.3x,v 1.24 2023/07/01 15:43:20 tom Exp $
+.TH curs_scr_dump 3X 2023-07-01 "ncurses 6.4" "Library calls"
.ie \n(.g .ds `` \(lq
.el .ds `` ``
.ie \n(.g .ds '' \(rq
\fBint scr_init(const char *\fIfilename\fB);\fR
.br
\fBint scr_set(const char *\fIfilename\fB);\fR
-.br
.SH DESCRIPTION
.SS scr_dump
-.PP
The \fBscr_dump\fP routine dumps the current contents
of the \fIvirtual screen\fP
to the file \fIfilename\fP.
.SS scr_restore
-.PP
The \fBscr_restore\fP routine sets the \fIvirtual screen\fP to the contents
of \fIfilename\fP, which must have been written using \fBscr_dump\fP.
The next call to \fBdoupdate\fP restores
the \fIphysical screen\fP to the way it looked in the dump file.
.SS scr_init
-.PP
The \fBscr_init\fP routine reads in the contents of \fIfilename\fP and uses
them to initialize the \fBcurses\fP data structures about what the terminal
currently has on its screen.
.bP
if the terminal has been written to since the preceding \fBscr_dump\fP call.
.SS scr_set
-.PP
The \fBscr_set\fP routine is a combination of \fBscr_restore\fP and
\fBscr_init\fP. It tells the program that the information in \fIfilename\fP is
what is currently on the screen, and also what the program wants on the screen.