ncurses 6.1 - patch 20180728
[ncurses.git] / doc / html / man / curs_scr_dump.3x.html
index 6003cdc14bb3d7b520f019a1cce02e04e9fdd728..4ed7ac7112d4e140dc0aa06407c43faf15fcd3b7 100644 (file)
@@ -1,6 +1,6 @@
 <!-- 
   ****************************************************************************
-  * Copyright (c) 1998-2010,2017 Free Software Foundation, Inc.              *
+  * Copyright (c) 1998-2017,2018 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,7 +26,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: curs_scr_dump.3x,v 1.11 2017/04/17 00:41:24 tom Exp @
+  * @Id: curs_scr_dump.3x,v 1.13 2018/07/28 22:50:26 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
-       The <STRONG>scr_dump</STRONG> routine dumps the current contents of the  virtual  screen
+       The <STRONG>scr_dump</STRONG> routine dumps the current contents of the  <EM>virtual</EM>  <EM>screen</EM>
        to the file <EM>filename</EM>.
 
-       The  <STRONG>scr_restore</STRONG>  routine  sets  the  virtual screen to the contents of
+       The  <STRONG>scr_restore</STRONG>  routine  sets  the  <EM>virtual</EM> <EM>screen</EM> to the contents of
        <EM>filename</EM>, which must have been written using <STRONG>scr_dump</STRONG>.  The  next  call
-       to <STRONG>doupdate</STRONG> restores the screen to the way it looked in the dump file.
+       to  <STRONG>doupdate</STRONG>  restores  the <EM>physical</EM> <EM>screen</EM> to the way it looked in the
+       dump 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> call to share the screen with  another  process  which  has
-       done  a  <STRONG>scr_dump</STRONG>  after its <STRONG><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG> call.  The data is declared in-
-       valid 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
+       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><A HREF="curs_initscr.3x.html">endwin(3x)</A></STRONG> call.  The data  is  declared  in-
+       valid
+
+       <STRONG>o</STRONG>   if the terminfo capabilities <STRONG>rmcup</STRONG> and <STRONG>nrrmc</STRONG> exist, also
+
+       <STRONG>o</STRONG>   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 <EM>filename</EM> 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  <STRONG>getwin</STRONG>  and  <STRONG>putwin</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><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
        All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> upon success.
 
-       X/Open  defines no error conditions.  In this implementation, each will
+       X/Open defines no error conditions.  In this implementation, each  will
        return an error if the file cannot be opened.