ncurses 6.2 - patch 20210619
[ncurses.git] / man / scr_dump.5
1 .\"***************************************************************************
2 .\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
3 .\" Copyright 2017 Free Software Foundation, Inc.                            *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: scr_dump.5,v 1.17 2021/06/17 21:26:02 tom Exp $
31 .TH scr_dump 5
32 .ie \n(.g .ds `` \(lq
33 .el       .ds `` ``
34 .ie \n(.g .ds '' \(rq
35 .el       .ds '' ''
36 .de NS
37 .ie n  .sp
38 .el    .sp .5
39 .ie n  .in +4
40 .el    .in +2
41 .nf
42 .ft C                   \" Courier
43 ..
44 .de NE
45 .fi
46 .ft R
47 .ie n  .in -4
48 .el    .in -2
49 ..
50 .de bP
51 .ie n  .IP \(bu 4
52 .el    .IP \(bu 2
53 ..
54 .SH NAME
55 scr_dump \- format of curses screen-dumps.
56 .SH SYNOPSIS
57 .B scr_dump
58 .SH DESCRIPTION
59 .PP
60 The curses library provides applications with the ability to write the
61 contents of a window to an external file using \fBscr_dump\fP or \fBputwin\fP,
62 and read it back using \fBscr_restore\fP or \fBgetwin\fP.
63 .PP
64 The \fBputwin\fP and \fBgetwin\fP functions do the work;
65 while \fBscr_dump\fP and \fBscr_restore\fP conveniently save and restore
66 the whole screen, i.e., \fBstdscr\fP.
67 .SS ncurses6
68 .PP
69 A longstanding implementation of screen-dump was
70 revised with ncurses6 to remedy problems with the earlier approach:
71 .bP
72 A \*(``magic number\*('' is written to the beginning of the dump file,
73 allowing applications (such as \fBfile\fP(1)) to recognize curses dump files.
74 .IP
75 Because ncurses6 uses a new format,
76 that requires a new magic number
77 was unused by other applications.
78 This 16-bit number was unused:
79 .NS
80 0x8888 (octal \*(``\\210\\210\*('')
81 .NE
82 .IP
83 but to be more certain, this 32-bit number was chosen:
84 .NS
85 0x88888888 (octal \*(``\\210\\210\\210\\210\*('')
86 .NE
87 .IP
88 This is the pattern submitted to the maintainers of the \fBfile\fP program:
89 .NS
90 #
91 # ncurses5 (and before) did not use a magic number,
92 # making screen dumps "data".
93 #
94 # ncurses6 (2015) uses this format, ignoring byte-order
95 0    string    \\210\\210\\210\\210ncurses    ncurses6 screen image
96 #
97 .NE
98 .bP
99 The screen dumps are written in textual form,
100 so that internal data sizes are not directly related to the dump-format, and
101 enabling the library to read dumps from either narrow- or wide-character-
102 configurations.
103 .IP
104 The \fInarrow\fP library configuration holds characters and video attributes
105 in a 32-bit \fBchtype\fP, while the \fIwide-character\fP library stores
106 this information in the \fBcchar_t\fP structure, which is much larger than
107 32-bits.
108 .bP
109 It is possible to read a screen dump into a terminal with a different
110 screen-size,
111 because the library truncates or fills the screen as necessary.
112 .bP
113 The ncurses6 \fBgetwin\fP reads the legacy screen dumps from ncurses5.
114 .SS ncurses5 (legacy)
115 .PP
116 The screen-dump feature was added to ncurses in June 1995.
117 While there were fixes and improvements in succeeding years,
118 the basic scheme was unchanged:
119 .bP
120 The \fBWINDOW\fP structure was written in binary form.
121 .bP
122 The \fBWINDOW\fP structure refers to lines of data,
123 which were written as an array of binary data following the \fBWINDOW\fP.
124 .bP
125 When \fBgetwin\fP restored the window,
126 it would keep track of offsets into the array of line-data
127 and adjust the \fBWINDOW\fP structure which was read back into memory.
128 .PP
129 This is similar to Unix SystemV,
130 but does not write a \*(``magic number\*('' to identify the file format.
131 .SH PORTABILITY
132 .PP
133 There is no standard format for \fBputwin\fP.
134 This section gives a brief description of the existing formats.
135 .SS X/Open Curses
136 .PP
137 Refer to \fIX/Open Curses, Issue 7\fP (2009).
138 .PP
139 X/Open's documentation for \fIenhanced curses\fP says only:
140 .RS 3
141 .PP
142 The \fIgetwin(\ ) \fPfunction reads window-related data
143 stored in the file by \fIputwin(\ )\fP.
144 The function
145 then creates and initializes a new window using that data.
146 .PP
147 The \fIputwin(\ )\fP function writes all data associated
148 with \fIwin\fP into the \fIstdio\fP stream to which \fIfilep\fP
149 points, using an \fBunspecified format\fP.
150 This information can be retrieved later using \fIgetwin(\ )\fP.
151 .RE
152 .PP
153 In the mid-1990s when the X/Open Curses document was written,
154 there were still systems using older, less capable curses libraries
155 (aside from the BSD curses library which was not relevant to X/Open
156 because it did not meet the criteria for \fIbase curses\fP).
157 The document explained the term \*(``enhanced\*('' as follows:
158 .RS 3
159 .bP
160 Shading is used to identify \fIX/Open Enhanced Curses\fP material,
161 relating to interfaces included to provide enhanced capabilities
162 for applications originally written to be compiled on systems
163 based on the UNIX operating system.
164 Therefore, the features described may not be present on systems
165 that conform to \fBXPG4 or to earlier XPG releases\fP.
166 The relevant reference pages may provide additional
167 or more specific portability warnings about use of the material.
168 .RE
169 .PP
170 In the foregoing, emphasis was added to \fBunspecified format\fP
171 and to \fBXPG4 or to earlier XPG releases\fP,
172 for clarity.
173 .SS Unix SystemV
174 .PP
175 Unix SystemV curses identified the file format by writing a
176 \*(``magic number\*('' at the beginning of the dump.
177 The \fBWINDOW\fP data and the lines of text follow, all in binary form.
178 .PP
179 The Solaris curses source has these definitions:
180 .NS
181 /* terminfo magic number */
182 #define MAGNUM  0432
183
184 /* curses screen dump magic number */
185 #define SVR2_DUMP_MAGIC_NUMBER  0433
186 #define SVR3_DUMP_MAGIC_NUMBER  0434
187 .NE
188 .PP
189 That is, the feature was likely introduced in SVr2 (1984),
190 and improved in SVr3 (1987).
191 The Solaris curses source has no magic number for SVr4 (1989).
192 Other operating systems (AIX and HPUX) use a magic number which would
193 correspond to this definition:
194 .NS
195 /* curses screen dump magic number */
196 #define SVR4_DUMP_MAGIC_NUMBER  0435
197 .NE
198 .PP
199 That octal number in bytes is 001, 035.
200 Because most Unix vendors use big-endian hardware,
201 the magic number is written with the high-order byte first, e.g.,
202 .NS
203 \001\035
204 .NE
205 .PP
206 After the magic number, the \fBWINDOW\fP structure and line-data are
207 written in binary format.
208 While the magic number used by the Unix systems can be seen using \fBod\fP(1),
209 none of the Unix systems documents the format used for screen-dumps.
210 .PP
211 The Unix systems do not use identical formats.
212 While collecting information for for this manual page,
213 the \fIsavescreen\fP test-program
214 produced dumps of different size
215 (all on 64-bit hardware, on 40x80 screens):
216 .bP
217 AIX (51817 bytes)
218 .bP
219 HPUX (90093 bytes)
220 .bP
221 Solaris 10 (13273 bytes)
222 .bP
223 ncurses5 (12888 bytes)
224 .SS Solaris
225 .PP
226 As noted above, Solaris curses has no magic number corresponding
227 to SVr4 curses.
228 This is odd since Solaris was the first operating system
229 to pass the SVr4 guidelines.
230 Solaris has two versions of curses:
231 .bP
232 The default curses library uses the SVr3 magic number.
233 .bP
234 There is an alternate curses library in \fB/usr/xpg4\fP.
235 This uses a textual format with no magic number.
236 .IP
237 According to the copyright notice, the \fIxpg4\fP Solaris curses library was
238 developed by MKS (Mortice Kern Systems) from 1990 to 1995.
239 .IP
240 Like ncurses6, there is a file-header with parameters.
241 Unlike ncurses6, the contents of the window are written piecemeal,
242 with coordinates and attributes for each chunk of text rather
243 than writing the whole window from top to bottom.
244 .SS PDCurses
245 .PP
246 PDCurses added support for screen dumps in version 2.7 (2005).
247 Like Unix SystemV and ncurses5,
248 it writes the \fBWINDOW\fP structure in binary,
249 but begins the file with its three-byte identifier \*(``PDC\*('',
250 followed by a one-byte version,
251 e.g.,
252 .NS
253         \*(``PDC\\001\*(''
254 .NE
255 .SS NetBSD
256 .PP
257 As of April 2017, NetBSD curses does
258 not support \fBscr_dump\fP and \fBscr_restore\fP
259 (or \fBscr_init\fP, \fBscr_set\fP),
260 although it has \fBputwin\fP and \fBgetwin\fP.
261 .PP
262 Like ncurses5, NetBSD \fBputwin\fP does not identify its dumps with a
263 useful magic number.
264 It writes
265 .bP
266 the curses shared library major and minor versions
267 as the first two bytes (e.g., 7 and 1),
268 .bP
269 followed by a binary dump of the \fBWINDOW\fP,
270 .bP
271 some data for wide-characters referenced by the \fBWINDOW\fP structure, and
272 .bP
273 finally, lines as done by other implementations.
274 .SH EXAMPLE
275 .PP
276 Given a simple program which writes text to the screen
277 (and for the sake of example, limiting the screen-size to 10x20):
278 .NS
279 #include <curses.h>
280
281 int
282 main(void)
283 {
284     putenv("LINES=10");
285     putenv("COLUMNS=20");
286     initscr();
287     start_color();
288     init_pair(1, COLOR_WHITE, COLOR_BLUE);
289     init_pair(2, COLOR_RED, COLOR_BLACK);
290     bkgd(COLOR_PAIR(1));
291     move(4, 5);
292     attron(A_BOLD);
293     addstr("Hello");
294     move(5, 5);
295     attroff(A_BOLD);
296     attrset(A_REVERSE | COLOR_PAIR(2));
297     addstr("World!");
298     refresh();
299     scr_dump("foo.out");
300     endwin();
301     return 0;
302 }
303 .NE
304 .PP
305 When run using ncurses6, the output looks like this:
306 .NS
307 \\210\\210\\210\\210ncurses 6.0.20170415
308 _cury=5
309 _curx=11
310 _maxy=9
311 _maxx=19
312 _flags=14
313 _attrs=\\{REVERSE|C2}
314 flag=_idcok
315 _delay=-1
316 _regbottom=9
317 _bkgrnd=\\{NORMAL|C1}\\s
318 rows:
319 1:\\{NORMAL|C1}\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s
320 2:\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s
321 3:\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s
322 4:\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s
323 5:\\s\\s\\s\\s\\s\\{BOLD}Hello\\{NORMAL}\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s
324 6:\\s\\s\\s\\s\\s\\{REVERSE|C2}World!\\{NORMAL|C1}\\s\\s\\s\\s\\s\\s\\s\\s\\s
325 7:\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s
326 8:\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s
327 9:\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s
328 10:\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s\\s
329 .NE
330 .PP
331 The first four octal escapes are actually nonprinting characters,
332 while the remainder of the file is printable text.
333 You may notice:
334 .bP
335 The actual color pair values are not written to the file.
336 .bP
337 All characters are shown in printable form; spaces are \*(``\\s\*('' to
338 ensure they are not overlooked.
339 .bP
340 Attributes are written in escaped curly braces, e.g., \*(``\\{BOLD}\*('',
341 and may include a color-pair (C1 or C2 in this example).
342 .bP
343 The parameters in the header are written out only if they are nonzero.
344 When reading back, order does not matter.
345 .ne 10
346 .PP
347 Running the same program with Solaris \fIxpg4\fP curses gives this dump:
348 .NS
349 MAX=10,20
350 BEG=0,0
351 SCROLL=0,10
352 VMIN=1
353 VTIME=0
354 FLAGS=0x1000
355 FG=0,0
356 BG=0,0,
357 0,0,0,1,
358 0,19,0,0,
359 1,0,0,1,
360 1,19,0,0,
361 2,0,0,1,
362 2,19,0,0,
363 3,0,0,1,
364 3,19,0,0,
365 4,0,0,1,
366 4,5,0x20,0,Hello
367 4,10,0,1,
368 4,19,0,0,
369 5,0,0,1,
370 5,5,0x4,2,World!
371 5,11,0,1,
372 5,19,0,0,
373 6,0,0,1,
374 6,19,0,0,
375 7,0,0,1,
376 7,19,0,0,
377 8,0,0,1,
378 8,19,0,0,
379 9,0,0,1,
380 9,19,0,0,
381 CUR=11,5
382 .NE
383 .PP
384 Solaris \fBgetwin\fP requires that all parameters are present, and
385 in the same order.
386 The \fIxpg4\fP curses library does not know about the \fBbce\fP
387 (back color erase) capability, and does not color the window background.
388 .ne 10
389 .PP
390 On the other hand, the SVr4 curses library does know about the background color.
391 However, its screen dumps are in binary.
392 Here is the corresponding dump (using \*(``od -t x1\*(''):
393 .NS
394 0000000 1c 01 c3 d6 f3 58 05 00 0b 00 0a 00 14 00 00 00
395 0000020 00 00 02 00 00 00 00 00 00 00 00 00 00 00 00 00
396 0000040 00 00 b8 1a 06 08 cc 1a 06 08 00 00 09 00 10 00
397 0000060 00 00 00 80 00 00 20 00 00 00 ff ff ff ff 00 00
398 0000100 ff ff ff ff 00 00 00 00 20 80 00 00 20 80 00 00
399 0000120 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
400 *
401 0000620 20 80 00 00 20 80 00 00 20 80 00 00 48 80 00 04
402 0000640 65 80 00 04 6c 80 00 04 6c 80 00 04 6f 80 00 04
403 0000660 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
404 *
405 0000740 20 80 00 00 20 80 00 00 20 80 00 00 57 00 81 00
406 0000760 6f 00 81 00 72 00 81 00 6c 00 81 00 64 00 81 00
407 0001000 21 00 81 00 20 80 00 00 20 80 00 00 20 80 00 00
408 0001020 20 80 00 00 20 80 00 00 20 80 00 00 20 80 00 00
409 *
410 0001540 20 80 00 00 20 80 00 00 00 00 f6 d1 01 00 f6 d1
411 0001560 08 00 00 00 40 00 00 00 00 00 00 00 00 00 00 07
412 0001600 00 04 00 01 00 01 00 00 00 01 00 00 00 00 00 00
413 0001620 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
414 *
415 0002371
416 .NE
417 .SH SEE ALSO
418 .PP
419 \fBcurs_scr_dump\fR(3X),
420 \fBcurs_util\fR(3X).
421 .SH AUTHORS
422 .PP
423 Thomas E. Dickey
424 .br
425 extended screen-dump format for ncurses 6.0 (2015)
426 .sp
427 Eric S. Raymond
428 .br
429 screen dump feature in ncurses 1.9.2d (1995)