usr/src/man/man3xcurses/scr_dump.3xcurses

   1 '\" te
   2 .\"  Copyright (c) 1990, 1995 by Mortice Kern Systems Inc.  All Rights Reserved  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH SCR_DUMP 3XCURSES "Jun 5, 2002"
   7 .SH NAME
   8 scr_dump, scr_init, scr_restore, scr_set \- write screen contents to/from a
   9 file
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e
  14 \fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ]
  15
  16 \fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ]
  17
  18 #include <curses.h>
  19
  20 \fBint\fR \fBscr_dump\fR(\fBconst char *\fR\fIfilename\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBint\fR \fBscr_init\fR(\fBconst char *\fR\fIfilename\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBscr_restore\fR(\fBconst char *\fR\fIfilename\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBint\fR \fBscr_set\fR(\fBconst char *\fR\fIfilename\fR);
  36 .fi
  37
  38 .SH PARAMETERS
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIfilename\fR\fR
  43 .ad
  44 .RS 12n
  45 Is a pointer to the file in which screen contents are written.
  46 .RE
  47
  48 .SH DESCRIPTION
  49 .sp
  50 .LP
  51 These function perform input/output functions on a screen basis.
  52 .sp
  53 .LP
  54 The \fBscr_dump()\fR function writes the contents of the virtual screen,
  55 \fBcurscr\fR, to \fIfilename\fR.
  56 .sp
  57 .LP
  58 The \fBscr_restore()\fR function reads the contents of \fIfilename\fR  from
  59 \fBcurscr\fR (which must have been written with \fBscr_dump()\fR).  The next
  60 refresh operation restores the screen to the way it looks in \fIfilename\fR.
  61 .sp
  62 .LP
  63 The \fBscr_init()\fR function reads the contents of \fIfilename\fR and uses
  64 those contents to initialize the X/Open Curses data structures to what is
  65 actually on screen. The next refresh operation bases its updates on this data,
  66 unless the  terminal has been written to since \fIfilename\fR was saved or the
  67 \fBterminfo\fR capabilities \fBrmcup\fR and \fBnrrmc\fR are defined for  the
  68 current terminal.
  69 .sp
  70 .LP
  71 The \fBscr_set()\fR function combines \fBscr_restore()\fR and
  72 \fBscr_init()\fR.   It informs the program that the contents of the file
  73 \fIfilename\fR are what is currently on the screen and that the program wants
  74 those contents on the screen.
  75 .SH RETURN VALUES
  76 .sp
  77 .LP
  78 On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR.
  79 .SH ERRORS
  80 .sp
  81 .LP
  82 None.
  83 .SH ATTRIBUTES
  84 .sp
  85 .LP
  86 See \fBattributes\fR(5) for descriptions of the following attributes:
  87 .sp
  88
  89 .sp
  90 .TS
  91 box;
  92 c | c
  93 l | l .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 Interface Stability     Standard
  97 _
  98 MT-Level        Unsafe
  99 .TE
 100
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBdelscreen\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), \fBendwin\fR(3XCURSES),
 105 \fBgetwin\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5),
 106 \fBstandards\fR(5)