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