diff options
Diffstat (limited to 'doc/html/man/curs_scr_dump.3x.html')
-rw-r--r-- | doc/html/man/curs_scr_dump.3x.html | 139 |
1 files changed, 70 insertions, 69 deletions
diff --git a/doc/html/man/curs_scr_dump.3x.html b/doc/html/man/curs_scr_dump.3x.html index 9e696c1..f07d40a 100644 --- a/doc/html/man/curs_scr_dump.3x.html +++ b/doc/html/man/curs_scr_dump.3x.html @@ -1,7 +1,7 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright 2018-2019,2020 Thomas E. Dickey * + * Copyright 1998-2010,2017 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 * @@ -27,32 +27,31 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: curs_scr_dump.3x,v 1.9 2010/12/04 18:40:45 tom Exp @ + * @Id: curs_scr_dump.3x,v 1.15 2020/02/02 23:34:34 tom Exp @ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> <TITLE>curs_scr_dump 3x</TITLE> -<link rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>curs_scr_dump 3x</H1> -<HR> +<H1 class="no-header">curs_scr_dump 3x</H1> <PRE> -<!-- Manpage converted by man2html 3.0.1 --> -<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> +<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> -</PRE> -<H2>NAME</H2><PRE> - <STRONG>scr_dump</STRONG>, <STRONG>scr_restore</STRONG>, <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG> - read (write) a - <STRONG>curses</STRONG> screen from (to) a file +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> + <STRONG>scr_dump</STRONG>, <STRONG>scr_restore</STRONG>, <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG> - read (write) a <STRONG>curses</STRONG> screen + from (to) a file -</PRE> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><curses.h></STRONG> <STRONG>int</STRONG> <STRONG>scr_dump(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG> @@ -61,74 +60,76 @@ <STRONG>int</STRONG> <STRONG>scr_set(const</STRONG> <STRONG>char</STRONG> <STRONG>*filename);</STRONG> -</PRE> -<H2>DESCRIPTION</H2><PRE> - The <STRONG>scr_dump</STRONG> routine dumps the current contents of the - virtual screen to the file <EM>filename</EM>. - - The <STRONG>scr_restore</STRONG> routine sets the virtual screen 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. - - 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 da- - ta 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>endwin</STRONG> call. - The data is declared invalid if the terminfo capabilities - <STRONG>rmcup</STRONG> and <STRONG>nrrmc</STRONG> exist; also if the terminal has been writ- - ten 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> routines [see <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>]. +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + 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 <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 <EM>physical</EM> <EM>screen</EM> to the way it looked in the + dump file. -</PRE> -<H2>RETURN VALUE</H2><PRE> - All routines return the integer <STRONG>ERR</STRONG> upon failure and <STRONG>OK</STRONG> - upon success. + 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 - X/Open defines no error conditions. In this implementa- - tion, each will return an error if the file cannot be - opened. + <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. -</PRE> -<H2>NOTES</H2><PRE> - Note that <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG>, and <STRONG>scr_restore</STRONG> may be - macros. + 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> + routines [see <STRONG><A HREF="curs_util.3x.html">curs_util(3x)</A></STRONG>]. -</PRE> -<H2>PORTABILITY</H2><PRE> - The XSI Curses standard, Issue 4, describes these func- - tions (adding the const qualifiers). - The SVr4 docs merely say under <STRONG>scr_init</STRONG> that the dump data - is also considered invalid "if the time-stamp of the tty - is old" but do not define "old". +</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 + return an error if the file cannot be opened. -</PRE> -<H2>SEE ALSO</H2><PRE> - <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>, <STRONG>system(3)</STRONG> + +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + Note that <STRONG>scr_init</STRONG>, <STRONG>scr_set</STRONG>, and <STRONG>scr_restore</STRONG> may be macros. + + +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + The XSI Curses standard, Issue 4, describes these functions (adding the + const qualifiers). + + The SVr4 docs merely say under <STRONG>scr_init</STRONG> that the dump data is also con- + sidered invalid "if the time-stamp of the tty is old" but do not define + "old". + + +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> + <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>, + <STRONG><A HREF="scr_dump.5.html">scr_dump(5)</A></STRONG>, <STRONG>system(3)</STRONG> - <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> </PRE> -<HR> -Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> +<div class="nav"> +<ul> +<li><a href="#h2-NAME">NAME</a></li> +<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> +<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> +<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> +<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> +</ul> +</div> </BODY> </HTML> |