<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
<!--
****************************************************************************
- * Copyright (c) 1998,2000 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2006,2010 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: curs_scr_dump.3x,v 1.2 2000/07/01 20:06:53 tom Exp @
+ * @Id: curs_scr_dump.3x,v 1.9 2010/12/04 18:40:45 tom Exp @
-->
<HTML>
<HEAD>
<HR>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->
+<STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG> <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
+
+
+
</PRE>
<H2>NAME</H2><PRE>
- <STRONG>scr_dump</STRONG>, <STRONG>scr_restore</STRONG>, <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG> - read (write) a
+ <STRONG>scr_dump</STRONG>, <STRONG>scr_restore</STRONG>, <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG> - read (write) a
<STRONG>curses</STRONG> screen from (to) a file
The <STRONG>scr_init</STRONG> routine reads in the contents of <EM>filename</EM> and
uses them to initialize the <STRONG>curses</STRONG> data structures about
- what the terminal currently has on its screen. If the
- data is determined to be valid, <STRONG>curses</STRONG> bases its next
- update of the screen on this information rather than
- clearing the screen and starting from scratch. <STRONG>scr_init</STRONG>
- is used after <STRONG>initscr</STRONG> or a <STRONG>system</STRONG> [see <STRONG>system</STRONG>(BA_LIB)]
- call to share the screen with another process which has
- done a <STRONG>scr_dump</STRONG> after its <STRONG>endwin</STRONG> call. The data is
- declared invalid if the terminfo capabilities <STRONG>rmcup</STRONG> and
- <STRONG>nrrmc</STRONG> exist; also if the terminal has been written to
- since the preceding <STRONG>scr_dump</STRONG> call.
-
- The <STRONG>scr_set</STRONG> routine is a combination of <STRONG>scr_restore</STRONG> and
- <STRONG>scr_init</STRONG>. It tells the program that the information in
+ what the terminal currently has on its screen. If the da-
+ ta is determined to be valid, <STRONG>curses</STRONG> bases its next update
+ of the screen on this information rather than clearing the
+ screen and starting from scratch. <STRONG>scr_init</STRONG> is used after
+ <STRONG>initscr</STRONG> or a <STRONG>system</STRONG> call to share the screen with another
+ process which has done a <STRONG>scr_dump</STRONG> after its <STRONG>endwin</STRONG> call.
+ The data is declared invalid if the terminfo capabilities
+ <STRONG>rmcup</STRONG> and <STRONG>nrrmc</STRONG> exist; also if the terminal has been writ-
+ ten to since the preceding <STRONG>scr_dump</STRONG> call.
+
+ The <STRONG>scr_set</STRONG> routine is a combination of <STRONG>scr_restore</STRONG> and
+ <STRONG>scr_init</STRONG>. It tells the program that the information in
<EM>filename</EM> is what is currently on the screen, and also what
- the program wants on the screen. This can be thought of
+ 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 <STRONG>getwin</STRONG>
+ To read (write) a window from (to) a file, use the <STRONG>getwin</STRONG>
and <STRONG>putwin</STRONG> routines [see <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>].
</PRE>
<H2>RETURN VALUE</H2><PRE>
- All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
+ All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG>
upon success.
+ X/Open defines no error conditions. In this implementa-
+ tion, each will return an error if the file cannot be
+ opened.
+
</PRE>
<H2>NOTES</H2><PRE>
</PRE>
<H2>PORTABILITY</H2><PRE>
- The XSI Curses standard, Issue 4, describes these func-
+ The XSI Curses standard, Issue 4, describes these func-
tions (adding the const qualifiers).
+
The SVr4 docs merely say under <STRONG>scr_init</STRONG> that the dump data
- is also considered invalid "if the time-stamp of the tty
- is old" but don't define "old".
+ is also considered invalid "if the time-stamp of the tty
+ is old" but do not define "old".
</PRE>
<H2>SEE ALSO</H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>,
- <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="system.3S.html">system(3S)</A></STRONG>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_initscr.3x.html">curs_initscr(3x)</A></STRONG>, <STRONG><A HREF="curs_refresh.3x.html">curs_refresh(3x)</A></STRONG>,
+ <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>, <STRONG><A HREF="system.3.html">system(3)</A></STRONG>
+ <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
</PRE>
<HR>
<ADDRESS>