.\"***************************************************************************
-.\" Copyright 2018-2020,2021 Thomas E. Dickey *
+.\" Copyright 2018-2021,2023 Thomas E. Dickey *
.\" Copyright 2017 Free Software Foundation, Inc. *
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" authorization. *
.\"***************************************************************************
.\"
-.\" $Id: scr_dump.5,v 1.22 2023/06/17 17:50:37 tom Exp $
-.TH scr_dump 5 2023-06-17 "ncurses 6.4" "File formats"
-.ie \n(.g .ds `` \(lq
-.el .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el .ds '' ''
-.de NS
-.ie n .sp
-.el .sp .5
-.ie n .in +4
-.el .in +2
-.nf
-.ft CR \" Courier
-..
-.de NE
-.fi
-.ft R
-.ie n .in -4
-.el .in -2
-..
+.\" $Id: scr_dump.5,v 1.41 2023/12/23 16:27:25 tom Exp $
+.TH scr_dump 5 2023-12-23 "ncurses 6.4" "File formats"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el .ds `` ""
+.ie t .ds '' ''
+.el .ds '' ""
+.\}
+.
.de bP
.ie n .IP \(bu 4
.el .IP \(bu 2
..
.SH NAME
-scr_dump \- format of curses screen-dumps.
+scr_dump \-
+\fIcurses\fR screen dump
.SH SYNOPSIS
.B scr_dump
.SH DESCRIPTION
-.PP
The curses library provides applications with the ability to write the
contents of a window to an external file using \fBscr_dump\fP or \fBputwin\fP,
and read it back using \fBscr_restore\fP or \fBgetwin\fP.
while \fBscr_dump\fP and \fBscr_restore\fP conveniently save and restore
the whole screen, i.e., \fBstdscr\fP.
.SS ncurses6
-.PP
A longstanding implementation of screen-dump was
revised with ncurses6 to remedy problems with the earlier approach:
-.bP
+.IP \(bu 4
A \*(``magic number\*('' is written to the beginning of the dump file,
allowing applications (such as \fBfile\fP(1)) to recognize curses dump files.
.IP
that requires a new magic number
was unused by other applications.
This 16-bit number was unused:
-.NS
-0x8888 (octal \*(``\\210\\210\*('')
-.NE
-.IP
+.RS 4
+.PP
+.RS 4
+.EX
+0x8888 (octal \*(``\e210\e210\*('')
+.EE
+.RE
+.PP
but to be more certain, this 32-bit number was chosen:
-.NS
-0x88888888 (octal \*(``\\210\\210\\210\\210\*('')
-.NE
-.IP
+.PP
+.RS 4
+.EX
+0x88888888 (octal \*(``\e210\e210\e210\e210\*('')
+.EE
+.RE
+.PP
This is the pattern submitted to the maintainers of the \fBfile\fP program:
-.NS
+.PP
+.RS 4
+.EX
#
# 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
+0 string \e210\e210\e210\e210ncurses ncurses6 screen image
#
-.NE
+.EE
+.RE
+.RE
.bP
The screen dumps are written in textual form,
so that internal data sizes are not directly related to the dump-format, and
because the library truncates or fills the screen as necessary.
.bP
The ncurses6 \fBgetwin\fP reads the legacy screen dumps from ncurses5.
-.SS ncurses5 (legacy)
-.PP
-The screen-dump feature was added to ncurses in June 1995.
+.SS "ncurses5 (Legacy)"
+The screen-dump feature was added to \fI\%ncurses\fP in June 1995.
While there were fixes and improvements in succeeding years,
the basic scheme was unchanged:
.bP
-The \fBWINDOW\fP structure was written in binary form.
+The \fI\%WINDOW\fP structure was written in binary form.
.bP
-The \fBWINDOW\fP structure refers to lines of data,
-which were written as an array of binary data following the \fBWINDOW\fP.
+The \fI\%WINDOW\fP structure refers to lines of data,
+which were written as an array of binary data following the \fI\%WINDOW\fP.
.bP
When \fBgetwin\fP restored the window,
it would keep track of offsets into the array of line-data
-and adjust the \fBWINDOW\fP structure which was read back into memory.
+and adjust the \fI\%WINDOW\fP structure which was read back into memory.
.PP
-This is similar to Unix SystemV,
+This is similar to Unix System\ V,
but does not write a \*(``magic number\*('' to identify the file format.
.SH PORTABILITY
-.PP
There is no standard format for \fBputwin\fP.
This section gives a brief description of the existing formats.
-.SS X/Open Curses
-.PP
+.SS "X/Open Curses"
Refer to \fIX/Open Curses, Issue 7\fP (2009).
.PP
X/Open's documentation for \fIenhanced curses\fP says only:
then creates and initializes a new window using that data.
.PP
The \fBputwin(\ )\fP function writes all data associated
-with \fIwin\fP into the \fBstdio\fP(3) stream to which \fIfilep\fP
+with \fIwin\fP into the \fI\%stdio\fP(3) stream to which \fIfilep\fP
points, using an \fBunspecified format\fP.
This information can be retrieved later using \fBgetwin(\ )\fP.
.RE
Shading is used to identify \fIX/Open Enhanced Curses\fP material,
relating to interfaces included to provide enhanced capabilities
for applications originally written to be compiled on systems
-based on the UNIX operating system.
+based on the Unix operating system.
Therefore, the features described may not be present on systems
that conform to \fBXPG4 or to earlier XPG releases\fP.
The relevant reference pages may provide additional
In the foregoing, emphasis was added to \fBunspecified format\fP
and to \fBXPG4 or to earlier XPG releases\fP,
for clarity.
-.SS Unix SystemV
-.PP
-Unix SystemV curses identified the file format by writing a
+.SS "Unix System V"
+Unix System\ V curses identified the file format by writing a
\*(``magic number\*('' at the beginning of the dump.
-The \fBWINDOW\fP data and the lines of text follow, all in binary form.
+The \fI\%WINDOW\fP data and the lines of text follow, all in binary form.
.PP
The Solaris curses source has these definitions:
-.NS
+.PP
+.RS 4
+.EX
/* terminfo magic number */
#define MAGNUM 0432
/* curses screen dump magic number */
#define SVR2_DUMP_MAGIC_NUMBER 0433
#define SVR3_DUMP_MAGIC_NUMBER 0434
-.NE
+.EE
+.RE
.PP
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
+Other operating systems (AIX and HP-UX) use a magic number which would
correspond to this definition:
-.NS
+.PP
+.RS 4
+.EX
/* curses screen dump magic number */
#define SVR4_DUMP_MAGIC_NUMBER 0435
-.NE
+.EE
+.RE
.PP
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.,
-.NS
-\001\035
-.NE
.PP
-After the magic number, the \fBWINDOW\fP structure and line-data are
+.RS 4
+.EX
+\e001\e035
+.EE
+.RE
+.PP
+After the magic number, the \fI\%WINDOW\fP structure and line-data are
written in binary format.
While the magic number used by the Unix systems can be seen using \fBod\fP(1),
none of the Unix systems documents the format used for screen-dumps.
.bP
AIX (51817 bytes)
.bP
-HPUX (90093 bytes)
+HP-UX (90093 bytes)
.bP
Solaris 10 (13273 bytes)
.bP
-ncurses5 (12888 bytes)
+\fI\%ncurses\fP5 (12888 bytes)
.SS Solaris
-.PP
As noted above, Solaris curses has no magic number corresponding
to SVr4 curses.
This is odd since Solaris was the first operating system
with coordinates and attributes for each chunk of text rather
than writing the whole window from top to bottom.
.SS PDCurses
-.PP
PDCurses added support for screen dumps in version 2.7 (2005).
-Like Unix SystemV and ncurses5,
-it writes the \fBWINDOW\fP structure in binary,
+Like Unix System\ V and ncurses5,
+it writes the \fI\%WINDOW\fP structure in binary,
but begins the file with its three-byte identifier \*(``PDC\*('',
followed by a one-byte version,
e.g.,
-.NS
- \*(``PDC\\001\*(''
-.NE
-.SS NetBSD
.PP
+.RS 4
+.EX
+ \*(``PDC\e001\*(''
+.EE
+.RE
+.SS NetBSD
As of April 2017, NetBSD curses does
not support \fBscr_dump\fP and \fBscr_restore\fP
(or \fBscr_init\fP, \fBscr_set\fP),
the curses shared library major and minor versions
as the first two bytes (e.g., 7 and 1),
.bP
-followed by a binary dump of the \fBWINDOW\fP,
+followed by a binary dump of the \fI\%WINDOW\fP,
.bP
-some data for wide-characters referenced by the \fBWINDOW\fP structure, and
+some data for wide-characters referenced by the \fI\%WINDOW\fP structure, and
.bP
finally, lines as done by other implementations.
-.SH EXAMPLE
-.PP
+.SH EXAMPLES
Given a simple program which writes text to the screen
(and for the sake of example, limiting the screen-size to 10x20):
-.NS
+.PP
+.RS 4
+.EX
#include <curses.h>
int
endwin();
return 0;
}
-.NE
+.EE
+.RE
.PP
When run using ncurses6, the output looks like this:
-.NS
-\\210\\210\\210\\210ncurses 6.0.20170415
+.PP
+.RS 4
+.EX
+\e210\e210\e210\e210ncurses 6.0.20170415
_cury=5
_curx=11
_maxy=9
_maxx=19
_flags=14
-_attrs=\\{REVERSE|C2}
+_attrs=\e{REVERSE|C2}
flag=_idcok
_delay=-1
_regbottom=9
-_bkgrnd=\\{NORMAL|C1}\\s
+_bkgrnd=\e{NORMAL|C1}\es
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
-.NE
+1:\e{NORMAL|C1}\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es
+2:\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es
+3:\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es
+4:\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es
+5:\es\es\es\es\es\e{BOLD}Hello\e{NORMAL}\es\es\es\es\es\es\es\es\es\es
+6:\es\es\es\es\es\e{REVERSE|C2}World!\e{NORMAL|C1}\es\es\es\es\es\es\es\es\es
+7:\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es
+8:\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es
+9:\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es
+10:\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es\es
+.EE
+.RE
.PP
The first four octal escapes are actually nonprinting characters,
while the remainder of the file is printable text.
.bP
The actual color pair values are not written to the file.
.bP
-All characters are shown in printable form; spaces are \*(``\\s\*('' to
+All characters are shown in printable form; spaces are \*(``\es\*('' to
ensure they are not overlooked.
.bP
-Attributes are written in escaped curly braces, e.g., \*(``\\{BOLD}\*('',
-and may include a color-pair (C1 or C2 in this example).
+Attributes are written in escaped curly braces, e.g., \*(``\e{BOLD}\*('',
+and may include a color pair (C1 or C2 in this example).
.bP
The parameters in the header are written out only if they are nonzero.
When reading back, order does not matter.
.ne 10
.PP
Running the same program with Solaris \fIxpg4\fP curses gives this dump:
-.NS
+.PP
+.RS 4
+.EX
MAX=10,20
BEG=0,0
SCROLL=0,10
9,0,0,1,
9,19,0,0,
CUR=11,5
-.NE
+.EE
+.RE
.PP
Solaris \fBgetwin\fP requires that all parameters are present, and
in the same order.
.PP
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\*(''):
-.NS
+Here is the corresponding dump (using \*(``od \-t x1\*(''):
+.PP
+.RS 4
+.EX
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
0001620 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
*
0002371
-.NE
-.SH SEE ALSO
-.PP
-\fBcurs_scr_dump\fP(3X),
-\fBcurs_util\fP(3X).
+.EE
+.RE
.SH AUTHORS
-.PP
Thomas E. Dickey
.br
-extended screen-dump format for ncurses 6.0 (2015)
+extended screen-dump format for \fI\%ncurses\fP 6.0 (2015)
.sp
Eric S. Raymond
.br
-screen dump feature in ncurses 1.9.2d (1995)
+screen dump feature in \fI\%ncurses\fP 1.9.2d (1995)
+.SH SEE ALSO
+\fB\%curs_scr_dump\fP(3X),
+\fB\%curs_util\fP(3X)
projects / ncurses.git / blobdiff