ncurses 5.6 - patch 20070217
[ncurses.git] / man / curs_scr_dump.3x
index a925ea56d9414e01d1f260dd3d0ee1f77ec69207..7884f6aa0648faf4976e79defdef63d044f8e451 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 1998-2000,2003 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2005,2006 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_scr_dump.3x,v 1.3 2003/10/25 20:34:06 tom Exp $
+.\" $Id: curs_scr_dump.3x,v 1.7 2006/12/24 16:05:49 tom Exp $
 .TH curs_scr_dump 3X ""
+.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
+.ad
+.hy
 .SH SYNOPSIS
 \fB#include <curses.h>\fR
-
+.sp
 \fBint scr_dump(const char *filename);\fR
 .br
 \fBint scr_restore(const char *filename);\fR
 .SH DESCRIPTION
 The \fBscr_dump\fR routine dumps the current contents of the virtual screen
 to the file \fIfilename\fR.
-
+.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.
-
+.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,
@@ -63,29 +67,33 @@ 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.
-
+.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.
-
+.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
 All routines return the integer \fBERR\fR upon failure and \fBOK\fR
 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.
 .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 don't define
+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)
+\fBcurs_util\fR(3X), \fBsystem\fR(3)
 .\"#
 .\"# The following sets edit modes for GNU EMACS
 .\"# Local Variables: