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

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