X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fcurs_scr_dump.3x.html;h=2c3efab46df75075e352d1d8b26c7c4e3734f876;hp=6003cdc14bb3d7b520f019a1cce02e04e9fdd728;hb=HEAD;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b diff --git a/doc/html/man/curs_scr_dump.3x.html b/doc/html/man/curs_scr_dump.3x.html index 6003cdc1..f1759cb3 100644 --- a/doc/html/man/curs_scr_dump.3x.html +++ b/doc/html/man/curs_scr_dump.3x.html @@ -1,6 +1,7 @@ - -curs_scr_dump 3x - - +curs_scr_dump 3x 2024-04-20 ncurses 6.5 Library calls + + -

curs_scr_dump 3x

curs_scr_dump 3x 2024-04-20 ncurses 6.5 Library calls

-curs_scr_dump(3x)                                            curs_scr_dump(3x)
+curs_scr_dump(3x)                Library calls               curs_scr_dump(3x)

NAME

-       scr_dump, scr_restore, scr_init, scr_set - read (write) a curses screen
-       from (to) a file
+       scr_dump,  scr_restore,  scr_init, scr_set - read/write a curses screen
+       from/to a file

SYNOPSIS

        #include <curses.h>
 
-       int scr_dump(const char *filename);
-       int scr_restore(const char *filename);
-       int scr_init(const char *filename);
-       int scr_set(const char *filename);
+       int scr_dump(const char *filename);
+       int scr_restore(const char *filename);
+       int scr_init(const char *filename);
+       int scr_set(const char *filename);

DESCRIPTION

-       The scr_dump routine dumps the current contents of the  virtual  screen
-       to the file filename.
-
-       The  scr_restore  routine  sets  the  virtual screen to the contents of
-       filename, which must have been written using scr_dump.  The  next  call
-       to doupdate restores the screen to the way it looked in the dump file.
-
-       The scr_init routine reads in the contents of filename and uses them to
-       initialize the curses data structures about what the terminal currently
-       has on its screen.  If the data is determined to be valid, curses bases
-       its next update of the screen on this information rather than  clearing
-       the  screen  and starting from scratch.  scr_init is used after initscr
-       or a system call to share the screen with  another  process  which  has
-       done  a  scr_dump  after its endwin(3x) call.  The data is declared in-
-       valid if the terminfo capabilities rmcup and nrrmc exist; also  if  the
-       terminal has been written to since the preceding scr_dump call.
+       curses provides applications the ability to write the contents  of  the
+       screen  to  a  file and read them back.  To read/write a window (rather
+       than the whole screen) from/to a file, use getwin(3x)  and  putwin(3x),
+       respectively.
+
+
+

scr_dump

+       scr_dump  writes  to  filename  the contents of the virtual screen; see
+       curscr(3x).
+
+
+

scr_restore

+       scr_restore updates the virtual  screen  to  contain  the  contents  of
+       filename  (if  it  was  validly  written with scr_dump).  No refresh is
+       performed;  after  performing  any  further   desired   updates,   call
+       doupdate(3x) or similar.
+
+
+

scr_init

+       scr_init  reads filename, using it to initialize curses data structures
+       describing the state of the terminal screen.  If these data are  valid,
+       curses  bases  its next update of the screen on this information rather
+       than clearing it and starting from scratch.
+
+       The data fail the validity check
 
+       o   if the terminal employs terminfo capabilities exit_ca_mode  (rmcup)
+           or non_rev_rmcup (nrrmc) are defined, or
+
+       o   if  curses  knows  that  the terminal has been written to since the
+           preceding scr_dump call.
+
+       scr_init could be used after initscr(3x)  or  system(3)  to  share  the
+       screen with another process that has done a scr_dump after endwin(3x).
+
+
+

scr_set

        The  scr_set  routine is a combination of scr_restore and scr_init.  It
        tells the program that the information in filename 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  getwin  and  putwin
-       routines [see curs_util(3x)].
-

RETURN VALUE

-       All routines return the integer ERR upon failure and OK upon success.
+       These functions return OK on success and ERR on failure.
 
-       X/Open  defines no error conditions.  In this implementation, each will
-       return an error if the file cannot be opened.
+       X/Open defines no failure conditions.   In  this  implementation,  each
+       function fails if it cannot open filename.

NOTES

-       Note that scr_init, scr_set, and scr_restore may be macros.
+       scr_init, scr_set, and scr_restore may be macros.

PORTABILITY

-       The XSI Curses standard, Issue 4, describes these functions (adding the
-       const qualifiers).
+       X/Open Curses, Issue 4 describes these functions.
+
+       SVr4 omitted the const qualifiers.
 
-       The SVr4 docs merely say under scr_init that the dump data is also con-
-       sidered invalid "if the time-stamp of the tty is old" but do not define
-       "old".
+       SVr4  documentation  describes scr_init such that the dump data is also
+       considered invalid "if the time-stamp of the tty is old" but  does  not
+       define "old".