ncurses 6.1 - patch 20180728

[ncurses.git] / man / curs_variables.3x

diff --git a/man/curs_variables.3x b/man/curs_variables.3x
index 8cfee5290e5ccbe47ec9cc595d074d0173694932..6b9fb59a4db002af602625dddd5f877df678e3e9 100644 (file)
--- a/man/curs_variables.3x
+++ b/man/curs_variables.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright (c) 2010 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 2010-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            *
@@ -26,10 +26,15 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_variables.3x,v 1.4 2010/12/04 18:38:55 tom Exp $
+.\" $Id: curs_variables.3x,v 1.11 2018/07/28 22:37:10 tom Exp $
 .TH curs_variables 3X ""
+.ie \n(.g .ds `` \(lq
+.el       .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el       .ds '' ''
 .de bP
-.IP \(bu 4
+.ie n  .IP \(bu 4
+.el    .IP \(bu 2
 ..
 .ds n 5
 .na
@@ -74,7 +79,7 @@ This page summarizes variables provided by the \fBcurses\fP library.
 A more complete description is given in the \fBcurses\fP(3X) manual page.
 .PP
 Depending on the configuration, these may be actual variables,
-or macros (see \fBcurs_threads\fR(3X))
+or macros (see \fBcurs_threads\fR(3X) and \fBcurs_opaque\fR(3X))
 which provide read-only access to \fIcurses\fP's state.
 In either case, applications should treat them as read-only to avoid
 confusing the library.
@@ -99,7 +104,7 @@ This variable holds the number of milliseconds to wait after reading an
 escape character,
 to distinguish between an individual escape character entered on the
 keyboard from escape sequences sent by cursor- and function-keys
-(see curses(3X).
+(see curses(3X)).
 .SS LINES
 After initializing curses, this variable contains the height of the screen,
 i.e., the number of lines.
@@ -110,9 +115,18 @@ when converting a tab character to spaces as it adds the tab to a window
 .SS The Current Screen
 This implementation of curses uses a special window \fBcurscr\fP to
 record its updates to the terminal screen.
+.PP
+This is referred to as the \*(``physical screen\*('' in the
+\fBcurs_refresh\fR(3X) and
+\fBcurs_outopts\fR(3X) manual pages.
 .SS The New Screen
 This implementation of curses uses a special window \fBnewscr\fP to
 hold updates to the terminal screen before applying them to \fBcurscr\fP.
+.PP
+This is referred to as the \*(``virtual screen\*('' in the
+\fBcurs_kernel\fR(3X),
+\fBcurs_refresh\fR(3X) and
+\fBcurs_outopts\fR(3X) manual pages.
 .SS The Standard Screen
 Upon initializing curses,
 a default window called \fBstdscr\fP,
@@ -127,9 +141,24 @@ most of these variables reside in the curses library.
 .SH PORTABILITY
 ESCDELAY and TABSIZE are extensions,
 not provided in most other implementations of curses.
+.PP
+ESCDELAY is an extension in AIX curses:
+.bP
+In AIX, the units for ESCDELAY are \fIfifths\fP of a millisecond.
+.bP
+The default value for AIX's ESCDELAY is 0.1 seconds.
+.bP
+AIX also enforces a limit of 10,000 seconds for ESCDELAY;
+this implementation currently has no upper limit.
+.PP
+This implementation has long used ESCDELAY with units of milliseconds,
+making it impossible to be completely compatible with AIX.
+Likewise, most users have either decided to override the value,
+or rely upon its default value.
 .SH SEE ALSO
 \fBcurses\fR(3X),
+\fBcurs_opaque\fR(3X),
+\fBcurs_terminfo\fR(3X),
 \fBcurs_threads\fR(3X),
 \fBterm_variables\fR(3X),
-\fBterminfo\fR(3X),
 \fBterminfo\fR(\*n).