X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_scr_dump.3x;h=7829fade996abc8fcffab3370a6b819977dd8828;hb=3183ac61c6bf0a75ee65dc8cbebf54f7c143df46;hp=a925ea56d9414e01d1f260dd3d0ee1f77ec69207;hpb=a8987e73ec254703634802b4f7ee30d3a485524d;p=ncurses.git diff --git a/man/curs_scr_dump.3x b/man/curs_scr_dump.3x index a925ea56..7829fade 100644 --- a/man/curs_scr_dump.3x +++ b/man/curs_scr_dump.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2000,2003 Free Software Foundation, Inc. * +.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -26,69 +27,94 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scr_dump.3x,v 1.3 2003/10/25 20:34:06 tom Exp $ +.\" $Id: curs_scr_dump.3x,v 1.20 2022/02/12 20:05:11 tom Exp $ .TH curs_scr_dump 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. +.na +.hy 0 .SH NAME -\fBscr_dump\fR, -\fBscr_restore\fR, -\fBscr_init\fR, -\fBscr_set\fR - read (write) a \fBcurses\fR screen from (to) a file +\fBscr_dump\fP, +\fBscr_restore\fP, +\fBscr_init\fP, +\fBscr_set\fP \- read (write) a \fBcurses\fP screen from (to) a file +.ad +.hy .SH SYNOPSIS -\fB#include \fR - -\fBint scr_dump(const char *filename);\fR +\fB#include \fP +.sp +\fBint scr_dump(const char *\fIfilename\fB);\fR .br -\fBint scr_restore(const char *filename);\fR +\fBint scr_restore(const char *\fIfilename\fB);\fR .br -\fBint scr_init(const char *filename);\fR +\fBint scr_init(const char *\fIfilename\fB);\fR .br -\fBint scr_set(const char *filename);\fR +\fBint scr_set(const char *\fIfilename\fB);\fR .br .SH DESCRIPTION -The \fBscr_dump\fR routine dumps the current contents of the virtual screen -to the file \fIfilename\fR. - -The \fBscr_restore\fR routine sets the virtual screen to the contents -of \fIfilename\fR, which must have been written using \fBscr_dump\fR. The next -call to \fBdoupdate\fR restores the screen to the way it looked in the dump -file. - -The \fBscr_init\fR routine reads in the contents of \fIfilename\fR and uses -them to initialize the \fBcurses\fR data structures about what the terminal -currently has on its screen. If the data is determined to be valid, -\fBcurses\fR bases its next update of the screen on this information rather -than clearing the screen and starting from scratch. \fBscr_init\fR is used -after \fBinitscr\fR or a \fBsystem\fR call to share -the screen with another process which has done a \fBscr_dump\fR after its -\fBendwin\fR call. The data is declared invalid if the terminfo capabilities -\fBrmcup\fR and \fBnrrmc\fR exist; also if the terminal has been written to -since the preceding \fBscr_dump\fR call. - -The \fBscr_set\fR routine is a combination of \fBscr_restore\fR and -\fBscr_init\fR. It tells the program that the information in \fIfilename\fR is +.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. +If the data is determined to be valid, +\fBcurses\fP bases its next update of the screen on this information rather +than clearing the screen and starting from scratch. +\fBscr_init\fP is used +after \fBinitscr\fP(3X) or a \fBsystem\fP(3) call to share +the screen with another process which has done a \fBscr_dump\fP after its +\fBendwin\fP(3X) call. +The data is declared invalid +.bP +if the terminfo capabilities \fBrmcup\fP and \fBnrrmc\fP exist, also +.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. This can be thought of as a screen inheritance function. - -To read (write) a window from (to) a file, use the \fBgetwin\fR and -\fBputwin\fR routines [see \fBcurs_util\fR(3X)]. +.PP +To read (write) a window from (to) a file, use the \fBgetwin\fP and +\fBputwin\fP routines [see \fBcurs_util\fP(3X)]. .SH RETURN VALUE -All routines return the integer \fBERR\fR upon failure and \fBOK\fR +All routines return the integer \fBERR\fP upon failure and \fBOK\fP upon success. +.PP +X/Open defines no error conditions. +In this implementation, +each will return an error if the file cannot be opened. .SH NOTES -Note that \fBscr_init\fR, \fBscr_set\fR, and \fBscr_restore\fR may be macros. +Note that \fBscr_init\fP, \fBscr_set\fP, and \fBscr_restore\fP may be macros. .SH PORTABILITY The XSI Curses standard, Issue 4, describes these functions (adding the const qualifiers). - -The SVr4 docs merely say under \fBscr_init\fR that the dump data is also -considered invalid "if the time-stamp of the tty is old" but don't define -"old". +.PP +The SVr4 docs merely say under \fBscr_init\fP that the dump data is also +considered invalid "if the time-stamp of the tty is old" but do not define +\*(``old\*(''. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_refresh\fR(3X), -\fBcurs_util\fR(3X), \fBsystem\fR(3S) -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fBcurses\fP(3X), +\fBcurs_initscr\fP(3X), +\fBcurs_refresh\fP(3X), +\fBcurs_util\fP(3X), +\fBscr_dump\fP(5), +\fBsystem\fP(3)