bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 13/52] Document `COLORS` and `COLOR_PAIRS` globals only in curs_c


From: G. Branden Robinson
Subject: [PATCH 13/52] Document `COLORS` and `COLOR_PAIRS` globals only in curs_color.3x.
Date: Fri, 22 Dec 2023 17:02:38 -0600

Drop documentation of color-related features from curs_variables.3x,
except for the more elaborate description of `COLOR_PAIRS`--migrate that
to curs_color.3x, replacing the more terse information there.

* man/curs_color.3x:
* man/curs_variables.3x: Do it.
---
 man/curs_color.3x     | 18 ++++++++++++++++--
 man/curs_variables.3x | 22 ----------------------
 2 files changed, 16 insertions(+), 24 deletions(-)

diff --git a/man/curs_color.3x b/man/curs_color.3x
index 9cf9165e5..d56419613 100644
--- a/man/curs_color.3x
+++ b/man/curs_color.3x
@@ -75,6 +75,10 @@ .SH SYNOPSIS
 .nf
 \fB#include <curses.h>
 .PP
+\fI/* variables */
+\fBint COLOR_PAIRS;
+\fBint COLORS;
+.PP
 \fBint start_color(void);
 .PP
 \fBbool has_colors(void);
@@ -189,8 +193,18 @@ .SS COLORS
 is initialized by \fB\%start_color\fP to the maximum number of colors
 the terminal can support.
 .SS COLOR_PAIRS
-is initialized by \fB\%start_color\fP to the maximum number of color pairs
-the terminal can support.
+is initialized by \fB\%start_color\fP to the maximum number of color
+pairs the terminal can support.
+Often,
+its value is the product \fB\%COLORS\fP \(mu \fB\%COLORS\fP,
+but this is not always true.
+.bP
+A few terminals use HLS colors,
+ignoring this rule;
+and
+.bP
+terminals supporting a large number of colors are limited by the number
+of color pairs that a \fIsigned short\fP value can represent.
 .SH FUNCTIONS
 .SS start_color
 The \fB\%start_color\fP routine requires no arguments.
diff --git a/man/curs_variables.3x b/man/curs_variables.3x
index eceb87488..938c39981 100644
--- a/man/curs_variables.3x
+++ b/man/curs_variables.3x
@@ -58,8 +58,6 @@ .SH NAME
 \fB\%FALSE\fP,
 \fB\%ERR\fP,
 \fB\%OK\fP,
-\fB\%COLORS\fP,
-\fB\%COLOR_PAIRS\fP,
 \fB\%COLS\fP,
 \fB\%ESCDELAY\fP,
 \fB\%LINES\fP,
@@ -87,8 +85,6 @@ .SH SYNOPSIS
 \fBconst \fI/*\fP .\|.\|. \fI*/\fP OK;
 .PP
 \fI/* variables */
-\fBint COLOR_PAIRS;
-\fBint COLORS;
 \fBint COLS;
 \fBint LINES;
 \fBWINDOW * curscr;
@@ -151,24 +147,6 @@ .SS \fIcchar_t\fP, \fIattr_t\fP
 \fB\%attr_on\fP(3X),
 and
 \fB\%in_wch\fP(3X).
-.SS COLOR_PAIRS
-Once \fIcurses\fP is initialized,
-\fB\%COLOR_PAIRS\fP
-contains the number of color pairs supported by the terminal.
-Often,
-its value is the product \fB\%COLORS\fP \(mu \fB\%COLORS\fP,
-but this is not always true.
-.bP
-A few terminals use HLS colors,
-ignoring this rule;
-and
-.bP
-terminals supporting a large number of colors are limited by the number
-of color pairs that a \fIsigned short\fP value can represent.
-.SS COLORS
-Once \fIcurses\fP is initialized,
-\fB\%COLORS\fP
-contains the number of colors supported by the terminal.
 .SS COLS
 Once \fIcurses\fP is initialized,
 \fB\%COLS\fP
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]