ncurses 6.1 - patch 20190209

[ncurses.git] / man / scr_dump.5

diff --git a/man/scr_dump.5 b/man/scr_dump.5
index aff1fb5783deb0e5687b57f726b6a45e1c07f373..81a95aa20b2da639233f21bd9c643abc26bd7fb3 100644 (file)
--- a/man/scr_dump.5
+++ b/man/scr_dump.5
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 2017 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 2017,2018 Free Software Foundation, Inc.                   *

 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,16 +26,16 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: scr_dump.5,v 1.9 2017/04/22 18:44:25 tom Exp $
+.\" $Id: scr_dump.5,v 1.15 2018/07/28 21:46:15 tom Exp $

 .TH scr_dump 5
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
 .el       .ds '' ''
 .de NS
 .TH scr_dump 5
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
 .el       .ds '' ''
 .de NS

-.ie \n(.sp
+.ie n  .sp

 .el    .sp .5
 .el    .sp .5

-.ie \n(.in +4
+.ie n  .in +4

 .el    .in +2
 .nf
 .ft C                  \" Courier
 .el    .in +2
 .nf
 .ft C                  \" Courier


@@ -43,13 +43,13 @@
 .de NE
 .fi
 .ft R
 .de NE
 .fi
 .ft R

-.in -4
+.ie n  .in -4
+.el    .in -2

 ..
 .de bP
 ..
 .de bP

-.IP \(bu 4
+.ie n  .IP \(bu 4
+.el    .IP \(bu 2

 ..
 ..

-.ds n 5
-.ds d @TERMINFO@

 .SH NAME
 scr_dump \- format of curses screen-dumps.
 .SH SYNOPSIS
 .SH NAME
 scr_dump \- format of curses screen-dumps.
 .SH SYNOPSIS


@@ -156,12 +156,14 @@ because it did not meet the criteria for \fIbase curses\fP).
 The document explained the term \*(``enhanced\*('' as follows:
 .RS 3
 .bP
 The document explained the term \*(``enhanced\*('' as follows:
 .RS 3
 .bP

-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. 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 or more specific portability warnings
-about use of the material.
+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.
+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
+or more specific portability warnings about use of the material.

 .RE
 .PP
 In the foregoing, emphasis was added to \fBunspecified format\fP
 .RE
 .PP
 In the foregoing, emphasis was added to \fBunspecified format\fP


@@ -251,7 +253,23 @@ e.g.,
 .NE
 .SS NetBSD
 .PP
 .NE
 .SS NetBSD
 .PP

-As of April 2017, NetBSD curses does not yet support screen dumps.
+As of April 2017, NetBSD curses does
+not support \fBscr_dump\fP and \fBscr_restore\fP
+(or \fBscr_init\fP, \fBscr_set\fP),
+although it has \fBputwin\fP and \fBgetwin\fP.
+.PP
+Like ncurses5, NetBSD \fBputwin\fP does not identify its dumps with a
+useful magic number.
+It writes
+.bP
+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,
+.bP
+some data for wide-characters referenced by the \fBWINDOW\fP structure, and
+.bP
+finally, lines as done by other implementations.

 .SH EXAMPLE
 .PP
 Given a simple program which writes text to the screen
 .SH EXAMPLE
 .PP
 Given a simple program which writes text to the screen


@@ -368,8 +386,8 @@ The \fIxpg4\fP curses library does not know about the \fBbce\fP
 (back color erase) capability, and does not color the window background.
 .ne 10
 .PP
 (back color erase) capability, and does not color the window background.
 .ne 10
 .PP

-On the other hand, the SVr4 curses library does know about the background
-color.  However, its screen dumps are in binary.
+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
 0000000 1c 01 c3 d6 f3 58 05 00 0b 00 0a 00 14 00 00 00
 Here is the corresponding dump (using \*(``od -t x1\*(''):
 .NS
 0000000 1c 01 c3 d6 f3 58 05 00 0b 00 0a 00 14 00 00 00