ncurses 6.3 - patch 20211021

[ncurses.git] / man / curs_scr_dump.3x

diff --git a/man/curs_scr_dump.3x b/man/curs_scr_dump.3x
index 867d09329d0d9d4bf1997d2a1bc88b5ce112a5b7..faa614466de2d4c6aa44b7271a6d1a7b984379c3 100644 (file)
--- a/man/curs_scr_dump.3x
+++ b/man/curs_scr_dump.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2003,2005 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,53 +27,72 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_scr_dump.3x,v 1.5 2005/05/15 16:18:55 tom Exp $
+.\" $Id: curs_scr_dump.3x,v 1.17 2021/10/20 22:37:48 tom Exp $

 .TH curs_scr_dump 3X ""
 .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,
 .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_set\fR \- read (write) a \fBcurses\fR screen from (to) a file

 .ad
 .hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
 .ad
 .hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR

-
-\fBint scr_dump(const char *filename);\fR
+.sp
+\fBint scr_dump(const char *\fP\fIfilename\fP\fB);\fR

 .br
 .br

-\fBint scr_restore(const char *filename);\fR
+\fBint scr_restore(const char *\fP\fIfilename\fP\fB);\fR

 .br
 .br

-\fBint scr_init(const char *filename);\fR
+\fBint scr_init(const char *\fP\fIfilename\fP\fB);\fR

 .br
 .br

-\fBint scr_set(const char *filename);\fR
+\fBint scr_set(const char *\fP\fIfilename\fP\fB);\fR

 .br
 .SH DESCRIPTION
 .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.
 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.
-
+.SS scr_restore
+.PP
+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
 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
 \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
 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
 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.
 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
 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.

-
+.PP

 To read (write) a window from (to) a file, use the \fBgetwin\fR and
 \fBputwin\fR routines [see \fBcurs_util\fR(3X)].
 .SH RETURN VALUE
 To read (write) a window from (to) a file, use the \fBgetwin\fR and
 \fBputwin\fR routines [see \fBcurs_util\fR(3X)].
 .SH RETURN VALUE


@@ -87,16 +107,14 @@ Note that \fBscr_init\fR, \fBscr_set\fR, and \fBscr_restore\fR may be macros.
 .SH PORTABILITY
 The XSI Curses standard, Issue 4, describes these functions (adding the const
 qualifiers).
 .SH PORTABILITY
 The XSI Curses standard, Issue 4, describes these functions (adding the const
 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
 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
 .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\fR(3X),
+\fBcurs_initscr\fR(3X),
+\fBcurs_refresh\fR(3X),
+\fBcurs_util\fR(3X),
+\fBscr_dump\fR(5),
+\fBsystem\fR(3)