X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_scr_dump.3x;h=faa614466de2d4c6aa44b7271a6d1a7b984379c3;hp=df3e79c1ffee19f058139d8f76a98eabdc0a3190;hb=a816c8dae437106bbf1661304240ff568ae3efef;hpb=96d6b16de0d487e5d3aed0302a179dbce11b5d96 diff --git a/man/curs_scr_dump.3x b/man/curs_scr_dump.3x index df3e79c1..faa61446 100644 --- a/man/curs_scr_dump.3x +++ b/man/curs_scr_dump.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright 2018-2020,2021 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,8 +27,16 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_scr_dump.3x,v 1.9 2010/12/04 18:40:45 tom Exp $ +.\" $Id: curs_scr_dump.3x,v 1.17 2021/10/20 22:37:48 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 @@ -40,33 +49,44 @@ .SH SYNOPSIS \fB#include \fR .sp -\fBint scr_dump(const char *filename);\fR +\fBint scr_dump(const char *\fP\fIfilename\fP\fB);\fR .br -\fBint scr_restore(const char *filename);\fR +\fBint scr_restore(const char *\fP\fIfilename\fP\fB);\fR .br -\fBint scr_init(const char *filename);\fR +\fBint scr_init(const char *\fP\fIfilename\fP\fB);\fR .br -\fBint scr_set(const char *filename);\fR +\fBint scr_set(const char *\fP\fIfilename\fP\fB);\fR .br .SH DESCRIPTION -The \fBscr_dump\fR routine dumps the current contents of the virtual screen +.SS scr_dump +.PP +The \fBscr_dump\fR routine dumps the current contents +of the \fIvirtual screen\fP to the file \fIfilename\fR. +.SS scr_restore .PP -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_restore\fR routine sets the \fIvirtual screen\fP to the contents +of \fIfilename\fR, which must have been written using \fBscr_dump\fR. +The next call to \fBdoupdate\fR restores +the \fIphysical screen\fP to the way it looked in the dump file. +.SS scr_init .PP 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, +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 +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. +\fBendwin\fR(3X) call. +The data is declared invalid +.bP +if the terminfo capabilities \fBrmcup\fR and \fBnrrmc\fR exist, also +.bP +if the terminal has been written to since the preceding \fBscr_dump\fR call. +.SS scr_set .PP 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 @@ -90,7 +110,11 @@ qualifiers). .PP 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 do not define -"old". +\*(``old\*(''. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_initscr\fR(3X), \fBcurs_refresh\fR(3X), -\fBcurs_util\fR(3X), \fBsystem\fR(3) +\fBcurses\fR(3X), +\fBcurs_initscr\fR(3X), +\fBcurs_refresh\fR(3X), +\fBcurs_util\fR(3X), +\fBscr_dump\fR(5), +\fBsystem\fR(3)