doc/html/man/curs_scr_dump.3x.html

   1 <!--
   2   ****************************************************************************
   3   * Copyright 2018-2021,2022 Thomas E. Dickey                                *
   4   * Copyright 1998-2010,2017 Free Software Foundation, Inc.                  *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: curs_scr_dump.3x,v 1.20 2022/02/12 20:05:11 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>curs_scr_dump 3x</TITLE>
  38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
  39
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">curs_scr_dump 3x</H1>
  43 <PRE>
  44 <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>
  45
  46
  47
  48
  49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  50        <STRONG>scr_dump</STRONG>, <STRONG>scr_restore</STRONG>, <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG> - read (write) a <STRONG>curses</STRONG> screen
  51        from (to) a file
  52
  53
  54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  55        <STRONG>#include</STRONG> <STRONG>&lt;curses.h&gt;</STRONG>
  56
  57        <STRONG>int</STRONG> <STRONG>scr_dump(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>filename</EM><STRONG>);</STRONG>
  58        <STRONG>int</STRONG> <STRONG>scr_restore(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>filename</EM><STRONG>);</STRONG>
  59        <STRONG>int</STRONG> <STRONG>scr_init(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>filename</EM><STRONG>);</STRONG>
  60        <STRONG>int</STRONG> <STRONG>scr_set(const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>filename</EM><STRONG>);</STRONG>
  61
  62
  63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  64
  65 </PRE><H3><a name="h3-scr_dump">scr_dump</a></H3><PRE>
  66        The <STRONG>scr_dump</STRONG> routine dumps the current contents of the  <EM>virtual</EM>  <EM>screen</EM>
  67        to the file <EM>filename</EM>.
  68
  69
  70 </PRE><H3><a name="h3-scr_restore">scr_restore</a></H3><PRE>
  71        The  <STRONG>scr_restore</STRONG>  routine  sets  the  <EM>virtual</EM> <EM>screen</EM> to the contents of
  72        <EM>filename</EM>, which must have been written using <STRONG>scr_dump</STRONG>.  The  next  call
  73        to  <STRONG>doupdate</STRONG>  restores  the <EM>physical</EM> <EM>screen</EM> to the way it looked in the
  74        dump file.
  75
  76
  77 </PRE><H3><a name="h3-scr_init">scr_init</a></H3><PRE>
  78        The <STRONG>scr_init</STRONG> routine reads in the contents of <EM>filename</EM> and uses them to
  79        initialize the <STRONG>curses</STRONG> data structures about what the terminal currently
  80        has on its screen.  If the data is determined to be valid, <STRONG>curses</STRONG> bases
  81        its  next update of the screen on this information rather than clearing
  82        the  screen  and  starting  from  scratch.   <STRONG>scr_init</STRONG>  is  used   after
  83        <STRONG><A HREF="curs_initscr.3x.html">initscr(3x)</A></STRONG>  or  a  <STRONG>system(3)</STRONG>  call  to  share  the screen with another
  84        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
  85        is declared invalid
  86
  87        <STRONG>o</STRONG>   if the terminfo capabilities <STRONG>rmcup</STRONG> and <STRONG>nrrmc</STRONG> exist, also
  88
  89        <STRONG>o</STRONG>   if  the  terminal  has been written to since the preceding <STRONG>scr_dump</STRONG>
  90            call.
  91
  92
  93 </PRE><H3><a name="h3-scr_set">scr_set</a></H3><PRE>
  94        The <STRONG>scr_set</STRONG> routine is a combination of <STRONG>scr_restore</STRONG> and  <STRONG>scr_init</STRONG>.   It
  95        tells the program that the information in <EM>filename</EM> is what is currently
  96        on the screen, and also what the program wants on the screen.  This can
  97        be thought of as a screen inheritance function.
  98
  99        To  read  (write)  a window from (to) a file, use the <STRONG>getwin</STRONG> and <STRONG>putwin</STRONG>
 100        routines [see <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>].
 101
 102
 103 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
 104        All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> upon success.
 105
 106        X/Open defines no error conditions.  In this implementation, each  will
 107        return an error if the file cannot be opened.
 108
 109
 110 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 111        Note that <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG>, and <STRONG>scr_restore</STRONG> may be macros.
 112
 113
 114 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 115        The XSI Curses standard, Issue 4, describes these functions (adding the
 116        const qualifiers).
 117
 118        The SVr4 docs merely say under <STRONG>scr_init</STRONG> that the dump data is also con-
 119        sidered invalid "if the time-stamp of the tty is old" but do not define
 120        "old".
 121
 122
 123 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 124        <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>,
 125        <STRONG><A HREF="scr_dump.5.html">scr_dump(5)</A></STRONG>, <STRONG>system(3)</STRONG>
 126
 127
 128
 129                                                              <STRONG><A HREF="curs_scr_dump.3x.html">curs_scr_dump(3x)</A></STRONG>
 130 </PRE>
 131 <div class="nav">
 132 <ul>
 133 <li><a href="#h2-NAME">NAME</a></li>
 134 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 135 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
 136 <ul>
 137 <li><a href="#h3-scr_dump">scr_dump</a></li>
 138 <li><a href="#h3-scr_restore">scr_restore</a></li>
 139 <li><a href="#h3-scr_init">scr_init</a></li>
 140 <li><a href="#h3-scr_set">scr_set</a></li>
 141 </ul>
 142 </li>
 143 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 144 <li><a href="#h2-NOTES">NOTES</a></li>
 145 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 146 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 147 </ul>
 148 </div>
 149 </BODY>
 150 </HTML>