ncurses 6.0 - patch 20180106
[ncurses.git] / doc / html / man / scr_dump.5.html
index ed7a18f84fc8b1c35c03ffbea61b237805cd8515..081c90edd48e504fd3a4576b5c19f2498326d5eb 100644 (file)
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: scr_dump.5,v 1.10 2017/04/29 20:53:55 tom Exp @
+  * @Id: scr_dump.5,v 1.12 2017/11/25 20:12:55 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 http://invisible-island.net/scripts/readme.html#others_scripts">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
 <TITLE>scr_dump 5</TITLE>
 <link rev=made href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
@@ -40,7 +40,7 @@
 <BODY>
 <H1 class="no-header">scr_dump 5</H1>
 <PRE>
-<STRONG><A HREF="scr_dump.5.html">scr_dump(5)</A></STRONG>                                                        <STRONG><A HREF="scr_dump.5.html">scr_dump(5)</A></STRONG>
+<STRONG><A HREF="scr_dump.5.html">scr_dump(5)</A></STRONG>                   File Formats Manual                  <STRONG><A HREF="scr_dump.5.html">scr_dump(5)</A></STRONG>
 
 
 
            ber  was  unused  by  other  applications.   This 16-bit number was
            unused:
 
-             0x8888 (octal "\210\210")
+               0x8888 (octal "\210\210")
 
            but to be more certain, this 32-bit number was chosen:
 
-             0x88888888 (octal "\210\210\210\210")
+               0x88888888 (octal "\210\210\210\210")
 
            This is the pattern submitted to the maintainers of the  <STRONG>file</STRONG>  pro-
            gram:
 
-             #
-             # ncurses5 (and before) did not use a magic number,
-             # making screen dumps "data".
-             #
-             # ncurses6 (2015) uses this format, ignoring byte-order
-             0    string    \210\210\210\210ncurses    ncurses6 screen image
-             #
+               #
+               # ncurses5 (and before) did not use a magic number,
+               # making screen dumps "data".
+               #
+               # ncurses6 (2015) uses this format, ignoring byte-order
+               0    string    \210\210\210\210ncurses    ncurses6 screen image
+               #
 
        <STRONG>o</STRONG>   The screen dumps are written in textual form, so that internal data
            sizes are not directly related to the dump-format, and enabling the
 
        The Solaris curses source has these definitions:
 
-         /* terminfo magic number */
-         #define MAGNUM  0432
+           /* terminfo magic number */
+           #define MAGNUM  0432
 
-         /* curses screen dump magic number */
-         #define SVR2_DUMP_MAGIC_NUMBER  0433
-         #define SVR3_DUMP_MAGIC_NUMBER  0434
+           /* curses screen dump magic number */
+           #define SVR2_DUMP_MAGIC_NUMBER  0433
+           #define SVR3_DUMP_MAGIC_NUMBER  0434
 
        That is, the feature was likely introduced in SVr2 (1984), and improved
        in SVr3 (1987).  The Solaris curses source has no magic number for SVr4
        (1989).  Other operating systems (AIX and  HPUX)  use  a  magic  number
        which would correspond to this definition:
 
-         /* curses screen dump magic number */
-         #define SVR4_DUMP_MAGIC_NUMBER  0435
+           /* curses screen dump magic number */
+           #define SVR4_DUMP_MAGIC_NUMBER  0435
 
        That  octal number in bytes is 001, 035.  Because most Unix vendors use
        big-endian hardware, the magic number is written  with  the  high-order
        byte first, e.g.,
 
-          01 35
+            01 35
 
        After  the magic number, the <STRONG>WINDOW</STRONG> structure and line-data are written
        in binary format.  While the magic number used by the Unix systems  can
        but begins the file with its three-byte identifier "PDC", followed by a
        one-byte version, e.g.,
 
-              "PDC\001"
+                "PDC\001"
 
 
 </PRE><H3><a name="h3-NetBSD">NetBSD</a></H3><PRE>
        Given a simple program which writes text to the  screen  (and  for  the
        sake of example, limiting the screen-size to 10x20):
 
-         #include &lt;curses.h&gt;
-
-         int
-         main(void)
-         {
-             putenv("LINES=10");
-             putenv("COLUMNS=20");
-             initscr();
-             start_color();
-             init_pair(1, COLOR_WHITE, COLOR_BLUE);
-             init_pair(2, COLOR_RED, COLOR_BLACK);
-             bkgd(<STRONG>COLOR_PAIR(1)</STRONG>);
-             move(4, 5);
-             attron(A_BOLD);
-             addstr("Hello");
-             move(5, 5);
-             attroff(A_BOLD);
-             attrset(A_REVERSE | <STRONG>COLOR_PAIR(2)</STRONG>);
-             addstr("World!");
-             refresh();
-             scr_dump("foo.out");
-             endwin();
-             return 0;
-         }
+           #include &lt;curses.h&gt;
+
+           int
+           main(void)
+           {
+               putenv("LINES=10");
+               putenv("COLUMNS=20");
+               initscr();
+               start_color();
+               init_pair(1, COLOR_WHITE, COLOR_BLUE);
+               init_pair(2, COLOR_RED, COLOR_BLACK);
+               bkgd(<STRONG>COLOR_PAIR(1)</STRONG>);
+               move(4, 5);
+               attron(A_BOLD);
+               addstr("Hello");
+               move(5, 5);
+               attroff(A_BOLD);
+               attrset(A_REVERSE | <STRONG>COLOR_PAIR(2)</STRONG>);
+               addstr("World!");
+               refresh();
+               scr_dump("foo.out");
+               endwin();
+               return 0;
+           }
 
        When run using ncurses6, the output looks like this:
 
-         \210\210\210\210ncurses 6.0.20170415
-         _cury=5
-         _curx=11
-         _maxy=9
-         _maxx=19
-         _flags=14
-         _attrs=\{REVERSE|C2}
-         flag=_idcok
-         _delay=-1
-         _regbottom=9
-         _bkgrnd=\{NORMAL|C1}\s
-         rows:
-         1:\{NORMAL|C1}\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
-         2:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
-         3:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
-         4:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
-         5:\s\s\s\s\s\{BOLD}Hello\{NORMAL}\s\s\s\s\s\s\s\s\s\s
-         6:\s\s\s\s\s\{REVERSE|C2}World!\{NORMAL|C1}\s\s\s\s\s\s\s\s\s
-         7:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
-         8:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
-         9:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
-         10:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
+           \210\210\210\210ncurses 6.0.20170415
+           _cury=5
+           _curx=11
+           _maxy=9
+           _maxx=19
+           _flags=14
+           _attrs=\{REVERSE|C2}
+           flag=_idcok
+           _delay=-1
+           _regbottom=9
+           _bkgrnd=\{NORMAL|C1}\s
+           rows:
+           1:\{NORMAL|C1}\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
+           2:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
+           3:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
+           4:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
+           5:\s\s\s\s\s\{BOLD}Hello\{NORMAL}\s\s\s\s\s\s\s\s\s\s
+           6:\s\s\s\s\s\{REVERSE|C2}World!\{NORMAL|C1}\s\s\s\s\s\s\s\s\s
+           7:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
+           8:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
+           9:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
+           10:\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s\s
 
        The first four octal escapes are actually nonprinting characters, while
        the remainder of the file is printable text.  You may notice:
 
        Running the same program with Solaris <EM>xpg4</EM> curses gives this dump:
 
-         MAX=10,20
-         BEG=0,0
-         SCROLL=0,10
-         VMIN=1
-         VTIME=0
-         FLAGS=0x1000
-         FG=0,0
-         BG=0,0,
-         0,0,0,1,
-         0,19,0,0,
-         1,0,0,1,
-         1,19,0,0,
-         2,0,0,1,
-         2,19,0,0,
-         3,0,0,1,
-         3,19,0,0,
-         4,0,0,1,
-         4,5,0x20,0,Hello
-         4,10,0,1,
-         4,19,0,0,
-         5,0,0,1,
-         5,5,0x4,2,World!
-         5,11,0,1,
-         5,19,0,0,
-         6,0,0,1,
-         6,19,0,0,
-         7,0,0,1,
-         7,19,0,0,
-         8,0,0,1,
-         8,19,0,0,
-         9,0,0,1,
-         9,19,0,0,
-         CUR=11,5
+           MAX=10,20
+           BEG=0,0
+           SCROLL=0,10
+           VMIN=1
+           VTIME=0
+           FLAGS=0x1000
+           FG=0,0
+           BG=0,0,
+           0,0,0,1,
+           0,19,0,0,
+           1,0,0,1,
+           1,19,0,0,
+           2,0,0,1,
+           2,19,0,0,
+           3,0,0,1,
+           3,19,0,0,
+           4,0,0,1,
+           4,5,0x20,0,Hello
+           4,10,0,1,
+           4,19,0,0,
+           5,0,0,1,
+           5,5,0x4,2,World!
+           5,11,0,1,
+           5,19,0,0,
+           6,0,0,1,
+           6,19,0,0,
+           7,0,0,1,
+           7,19,0,0,
+           8,0,0,1,
+           8,19,0,0,
+           9,0,0,1,
+           9,19,0,0,
+           CUR=11,5
 
        Solaris  <STRONG>getwin</STRONG>  requires  that  all parameters are present, and in the
        same order.  The <EM>xpg4</EM> curses library does not know about the <STRONG>bce</STRONG>  (back
        ground color.  However, its screen dumps are in binary.   Here  is  the
        corresponding dump (using "od -t x1"):
 
-         0000000 1c 01 c3 d6 f3 58 05 00 0b 00 0a 00 14 00 00 00
-         0000020 00 00 02 00 00 00 00 00 00 00 00 00 00 00 00 00
-         0000040 00 00 b8 1a 06 08 cc 1a 06 08 00 00 09 00 10 00
-         0000060 00 00 00 80 00 00 20 00 00 00 ff ff ff ff 00 00
-         0000100 ff ff ff ff 00 00 00 00 20 80 00 00 20 80 00 00
-         0000120 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
-         *
-         0000620 20 80 00 00 20 80 00 00 20 80 00 00 48 80 00 04
-         0000640 65 80 00 04 6c 80 00 04 6c 80 00 04 6f 80 00 04
-         0000660 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
-         *
-         0000740 20 80 00 00 20 80 00 00 20 80 00 00 57 00 81 00
-         0000760 6f 00 81 00 72 00 81 00 6c 00 81 00 64 00 81 00
-         0001000 21 00 81 00 20 80 00 00 20 80 00 00 20 80 00 00
-         0001020 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
-         *
-         0001540 20 80 00 00 20 80 00 00 00 00 f6 d1 01 00 f6 d1
-         0001560 08 00 00 00 40 00 00 00 00 00 00 00 00 00 00 07
-         0001600 00 04 00 01 00 01 00 00 00 01 00 00 00 00 00 00
-         0001620 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
-         *
-         0002371
+           0000000 1c 01 c3 d6 f3 58 05 00 0b 00 0a 00 14 00 00 00
+           0000020 00 00 02 00 00 00 00 00 00 00 00 00 00 00 00 00
+           0000040 00 00 b8 1a 06 08 cc 1a 06 08 00 00 09 00 10 00
+           0000060 00 00 00 80 00 00 20 00 00 00 ff ff ff ff 00 00
+           0000100 ff ff ff ff 00 00 00 00 20 80 00 00 20 80 00 00
+           0000120 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
+           *
+           0000620 20 80 00 00 20 80 00 00 20 80 00 00 48 80 00 04
+           0000640 65 80 00 04 6c 80 00 04 6c 80 00 04 6f 80 00 04
+           0000660 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
+           *
+           0000740 20 80 00 00 20 80 00 00 20 80 00 00 57 00 81 00
+           0000760 6f 00 81 00 72 00 81 00 6c 00 81 00 64 00 81 00
+           0001000 21 00 81 00 20 80 00 00 20 80 00 00 20 80 00 00
+           0001020 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
+           *
+           0001540 20 80 00 00 20 80 00 00 00 00 f6 d1 01 00 f6 d1
+           0001560 08 00 00 00 40 00 00 00 00 00 00 00 00 00 00 07
+           0001600 00 04 00 01 00 01 00 00 00 01 00 00 00 00 00 00
+           0001620 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+           *
+           0002371
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>