ncurses 6.2 - patch 20201212
[ncurses.git] / man / term_variables.3x
index 49a22938cf3003ce396633306aafd323f6509160..0abaf0968bde50dcfcee54664e1f35c432151726 100644 (file)
@@ -1,5 +1,6 @@
 .\"***************************************************************************
-.\" Copyright (c) 2011-2013,2015 Free Software Foundation, Inc.              *
+.\" Copyright 2019,2020 Thomas E. Dickey                                     *
+.\" Copyright 2010-2015,2017 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            *
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: term_variables.3x,v 1.7 2015/12/05 18:43:25 tom Exp $
+.\" $Id: term_variables.3x,v 1.12 2020/02/02 23:34:34 tom Exp $
 .TH term_variables 3X ""
 .ds n 5
+.ie \n(.g .ds `` \(lq
+.el       .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el       .ds '' ''
 .na
 .hy 0
 .SH NAME
 .sp
 \fBchar ttytype[];\fR
 .sp
-\fBNCURSES_CONST char * const * boolcodes;\fR
+\fBNCURSES_CONST char * const boolcodes[];\fR
 .br
-\fBNCURSES_CONST char * const * boolfnames;\fR
+\fBNCURSES_CONST char * const boolfnames[];\fR
 .br
-\fBNCURSES_CONST char * const * boolnames;\fR
+\fBNCURSES_CONST char * const boolnames[];\fR
 .sp
-\fBNCURSES_CONST char * const * numcodes;\fR
+\fBNCURSES_CONST char * const numcodes[];\fR
 .br
-\fBNCURSES_CONST char * const * numfnames;\fR
+\fBNCURSES_CONST char * const numfnames[];\fR
 .br
-\fBNCURSES_CONST char * const * numnames;\fR
+\fBNCURSES_CONST char * const numnames[];\fR
 .sp
-\fBNCURSES_CONST char * const * strcodes;\fR
+\fBNCURSES_CONST char * const strcodes[];\fR
 .br
-\fBNCURSES_CONST char * const * strfnames;\fR
+\fBNCURSES_CONST char * const strfnames[];\fR
 .br
-\fBNCURSES_CONST char * const * strnames;\fR
+\fBNCURSES_CONST char * const strnames[];\fR
 .br
 .fi
 .SH DESCRIPTION
@@ -97,7 +102,7 @@ the \fBacs_map\fP array holds information used to translate cells
 with the \fBA_ALTCHARSET\fP video attribute into line-drawing characters.
 .PP
 The encoding of the information in this array has changed periodically.
-Application developers need only know that it is used for the "ACS_"
+Application developers need only know that it is used for the \*(``ACS_\*(''
 constants in <curses.h>.
 .PP
 The comparable data for the wide-character library is a private variable.
@@ -110,7 +115,7 @@ and \fBdelscreen\fP(3X).
 It is possible to save a value of \fBcur_term\fP for subsequent
 use as a parameter to \fBset_term\fP, for switching between screens.
 Alternatively, one can save the return value from \fBnewterm\fP
-or \fBsetupterm\fP to reuse in \fBset_term\fP.
+or \fBsetupterm\fP(3X) to reuse in \fBset_term\fP.
 .SS Terminfo Names
 The \fB@TIC@\fP(1) and \fB@INFOCMP@\fP(1) programs use lookup tables for
 the long and short names of terminfo capabilities,
@@ -119,7 +124,7 @@ These are available to other applications,
 although the hash-tables used by
 the terminfo and termcap functions are not available.
 .PP
-The long terminfo capability names use a "l" (ell) in their names:
+The long terminfo capability names use a \*(``l\*('' (ell) in their names:
 \fBboolfnames\fP,
 \fBnumfnames\fP, and
 \fBstrfnames\fP.
@@ -135,8 +140,10 @@ These are the corresponding names used for termcap descriptions:
 \fBstrcodes\fP.
 .\"
 .SS Terminal Type
+A terminal description begins with one or more terminal names
+separated by \*(``|\*('' (vertical bars).
 On initialization of the curses or terminfo interfaces,
-\fBsetupterm\fP copies the terminal name to the array \fBttytype\fP.
+\fBsetupterm\fP(3X) copies the terminal names to the array \fBttytype\fP.
 .\"
 .SS Terminfo Names
 .PP
@@ -147,12 +154,16 @@ which is defined
 .PP
 .nf
 .ft CW
-#define CUR cur_term->type.
+#define CUR ((TERMTYPE *)(cur_term))->
 .fi
 .ft R
 .PP
 These symbols provide a faster method of accessing terminfo capabilities
 than using \fBtigetstr\fR(3X), etc.
+.PP
+The actual definition of \fBCUR\fP depends upon the implementation,
+but each terminfo library provides these long names defined to point
+into the current terminal description loaded into memory.
 .\"
 .SH NOTES
 The low-level terminfo interface is initialized using