X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fscr_dump.5.html;h=f1527c8b353e11605aac4f7e5424ca9ca95a3095;hp=e73ebc08f05effff5da2768b0ff30602af87e479;hb=a6eb34d7fec8170a8715f9e53ca2f96452dd30dd;hpb=5925150381bb42a4d8c7116d62c348a7b84309f3 diff --git a/doc/html/man/scr_dump.5.html b/doc/html/man/scr_dump.5.html index e73ebc08..f1527c8b 100644 --- a/doc/html/man/scr_dump.5.html +++ b/doc/html/man/scr_dump.5.html @@ -60,8 +60,8 @@ read it back using scr_restore or getwin. The putwin and getwin functions do the work; while scr_dump and - scr_restore conveniently save and restore the whole screen, i.e., std- - scr. + scr_restore conveniently save and restore the whole screen, i.e., + stdscr.
@@ -72,8 +72,8 @@ allowing applications (such as file(1)) to recognize curses dump files. - Because ncurses6 uses a new format, that requires a new magic num- - ber was unused by other applications. This 16-bit number was + Because ncurses6 uses a new format, that requires a new magic + number was unused by other applications. This 16-bit number was unused: 0x8888 (octal "\210\210") @@ -82,8 +82,8 @@ 0x88888888 (octal "\210\210\210\210") - This is the pattern submitted to the maintainers of the file pro- - gram: + This is the pattern submitted to the maintainers of the file + program: # # ncurses5 (and before) did not use a magic number, @@ -95,17 +95,17 @@ o The screen dumps are written in textual form, so that internal data sizes are not directly related to the dump-format, and enabling the - library to read dumps from either narrow- or wide-character- con- - figurations. + library to read dumps from either narrow- or wide-character- + configurations. The narrow library configuration holds characters and video attributes in a 32-bit chtype, while the wide-character library stores this information in the cchar_t structure, which is much larger than 32-bits. - o It is possible to read a screen dump into a terminal with a differ- - ent screen-size, because the library truncates or fills the screen - as necessary. + o It is possible to read a screen dump into a terminal with a + different screen-size, because the library truncates or fills the + screen as necessary. o The ncurses6 getwin reads the legacy screen dumps from ncurses5. @@ -139,8 +139,8 @@ X/Open's documentation for enhanced curses says only: The getwin( ) function reads window-related data stored in the file - by putwin( ). The function then creates and initializes a new win- - dow using that data. + by putwin( ). The function then creates and initializes a new + window using that data. The putwin( ) function writes all data associated with win into the stdio stream to which filep points, using an unspecified format. @@ -157,17 +157,17 @@ for applications originally written to be compiled on systems based on the UNIX operating system. Therefore, the features described may not be present on systems that conform to XPG4 or - to earlier XPG releases. The relevant reference pages may pro- - vide additional or more specific portability warnings about use - of the material. + to earlier XPG releases. The relevant reference pages may + provide additional or more specific portability warnings about + use of the material. In the foregoing, emphasis was added to unspecified format and to XPG4 or to earlier XPG releases, for clarity.
- Unix SystemV curses identified the file format by writing a "magic num- - ber" at the beginning of the dump. The WINDOW data and the lines of + Unix SystemV curses identified the file format by writing a "magic + number" at the beginning of the dump. The WINDOW data and the lines of text follow, all in binary form. The Solaris curses source has these definitions: @@ -198,9 +198,10 @@ be seen using od(1), none of the Unix systems documents the format used for screen-dumps. - The Unix systems do not use identical formats. While collecting infor- - mation for for this manual page, the savescreen test-program produced - dumps of different size (all on 64-bit hardware, on 40x80 screens): + The Unix systems do not use identical formats. While collecting + information for for this manual page, the savescreen test-program + produced dumps of different size (all on 64-bit hardware, on 40x80 + screens): o AIX (51817 bytes) @@ -212,27 +213,27 @@
- As noted above, Solaris curses has no magic number corresponding to - SVr4 curses. This is odd since Solaris was the first operating system + As noted above, Solaris curses has no magic number corresponding to + SVr4 curses. This is odd since Solaris was the first operating system to pass the SVr4 guidelines. Solaris has two versions of curses: o The default curses library uses the SVr3 magic number. - o There is an alternate curses library in /usr/xpg4. This uses a + o There is an alternate curses library in /usr/xpg4. This uses a textual format with no magic number. - According to the copyright notice, the xpg4 Solaris curses library + According to the copyright notice, the xpg4 Solaris curses library was developed by MKS (Mortice Kern Systems) from 1990 to 1995. - Like ncurses6, there is a file-header with parameters. Unlike - ncurses6, the contents of the window are written piecemeal, with - coordinates and attributes for each chunk of text rather than writ- - ing the whole window from top to bottom. + Like ncurses6, there is a file-header with parameters. Unlike + ncurses6, the contents of the window are written piecemeal, with + coordinates and attributes for each chunk of text rather than + writing the whole window from top to bottom.
- PDCurses added support for screen dumps in version 2.7 (2005). Like - Unix SystemV and ncurses5, it writes the WINDOW structure in binary, + PDCurses added support for screen dumps in version 2.7 (2005). Like + Unix SystemV and ncurses5, it writes the WINDOW structure in binary, but begins the file with its three-byte identifier "PDC", followed by a one-byte version, e.g., @@ -243,7 +244,7 @@ As of April 2017, NetBSD curses does not support scr_dump and scr_restore (or scr_init, scr_set), although it has putwin and getwin. - Like ncurses5, NetBSD putwin does not identify its dumps with a useful + Like ncurses5, NetBSD putwin does not identify its dumps with a useful magic number. It writes o the curses shared library major and minor versions as the first two @@ -251,14 +252,14 @@ o followed by a binary dump of the WINDOW, - o some data for wide-characters referenced by the WINDOW structure, + o some data for wide-characters referenced by the WINDOW structure, and o finally, lines as done by other implementations.
- Given a simple program which writes text to the screen (and for the + Given a simple program which writes text to the screen (and for the sake of example, limiting the screen-size to 10x20): #include <curses.h> @@ -316,13 +317,13 @@ o The actual color pair values are not written to the file. - o All characters are shown in printable form; spaces are "\s" to + o All characters are shown in printable form; spaces are "\s" to ensure they are not overlooked. - o Attributes are written in escaped curly braces, e.g., "\{BOLD}", + o Attributes are written in escaped curly braces, e.g., "\{BOLD}", and may include a color-pair (C1 or C2 in this example). - o The parameters in the header are written out only if they are + o The parameters in the header are written out only if they are nonzero. When reading back, order does not matter. Running the same program with Solaris xpg4 curses gives this dump: @@ -361,13 +362,13 @@ 9,19,0,0, CUR=11,5 - Solaris getwin requires that all parameters are present, and in the - same order. The xpg4 curses library does not know about the bce (back + Solaris getwin requires that all parameters are present, and in the + same order. The xpg4 curses library does not know about the bce (back color erase) capability, and does not color the window background. - On the other hand, the SVr4 curses library does know about the back- - ground color. However, its screen dumps are in binary. Here is the - corresponding dump (using "od -t x1"): + On the other hand, the SVr4 curses library does know about the + background 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