ncurses 6.4 - patch 20231001

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

diff --git a/man/new_pair.3x b/man/new_pair.3x
index 98166a9f81c15cd74860f8973dde6bf43805dcd2..6fd7bef28b09f81b0404befdca288973fe2e3f26 100644 (file)
--- a/man/new_pair.3x
+++ b/man/new_pair.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018-2020,2021 Thomas E. Dickey                                *
+.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
 .\" Copyright 2017 Free Software Foundation, Inc.                            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -29,8 +29,8 @@
 .\"
 .\" Author: Thomas E. Dickey
 .\"
-.\" $Id: new_pair.3x,v 1.16 2021/06/17 21:26:02 tom Exp $
-.TH new_pair 3X ""
+.\" $Id: new_pair.3x,v 1.39 2023/09/30 21:38:11 tom Exp $
+.TH new_pair 3X 2023-09-30 "ncurses 6.4" "Library calls"
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
@@ -39,13 +39,18 @@
 .ie n  .IP \(bu 4
 .el    .IP \(bu 2
 ..
+.ie n .ds CW R
+.el   \{
+.ie \n(.g .ds CW CR
+.el       .ds CW CW
+.\}
 .de NS
 .ie n  .sp
 .el    .sp .5
 .ie n  .in +4
 .el    .in +2
 .nf
-.ft C                  \" Courier
+.ft \*(CW
 ..
 .de NE
 .fi
@@ -54,19 +59,20 @@
 .el    .in -2
 ..
 .SH NAME
-\fBalloc_pair\fP,
-\fBfind_pair\fP,
-\fBfree_pair\fP \- new curses color-pair functions
+\fB\%alloc_pair\fP,
+\fB\%find_pair\fP,
+\fB\%free_pair\fP \-
+dynamically allocate \fIcurses\fR color pairs
 .SH SYNOPSIS
+.nf
 \fB#include <curses.h>\fP
-.sp
-\fBint alloc_pair(int \fP\fIfg\fP\fB, int \fP\fIbg\fP\fB);\fP
-.br
-\fBint find_pair(int \fP\fIfg\fP\fB, int \fP\fIbg\fP\fB);\fP
-.br
-\fBint free_pair(int \fP\fIpair\fP\fB);\fP
+.PP
+\fBint alloc_pair(int \fIfg\fB, int \fIbg\fB);\fR
+\fBint find_pair(int \fIfg\fB, int \fIbg\fB);\fR
+\fBint free_pair(int \fIpair\fB);\fR
+.fi
 .SH DESCRIPTION
-These functions are an extension to the curses library.
+These functions are an extension to the \fIcurses\fP library.
 They permit an application to dynamically allocate a color pair using
 the foreground/background colors rather than assign a fixed color pair number,
 and return an unused pair to the pool.
@@ -80,7 +86,7 @@ it is unlikely that your terminal allows you to modify the attributes
 of a given character cell without rewriting it.
 That is, the foreground and background colors are applied as a pair.
 .bP
-Color pairs are the curses library's way of managing a color palette
+Color pairs are the \fIcurses\fP library's way of managing a color palette
 on a terminal.
 If the library does not keep track of the \fIcombinations\fP of
 colors which are displayed, it will be inefficient.
@@ -90,14 +96,14 @@ with only a few dozen color combinations,
 it is convenient to use the maximum number of combinations
 as the limit on color pairs:
 .NS
-\fBCOLORS\fP\fI * \fP\fBCOLORS\fP
+\fBCOLORS\fI * \fBCOLORS\fR
 .NE
 .bP
 Terminals which support \fIdefault colors\fP distinct
 from \*(``ANSI colors\*(''
 add to the possible combinations, producing this total:
 .NS
-\fI( \fP\fBCOLORS\fP\fI + 1 ) * ( \fP\fBCOLORS\fP\fI + 1 )\fP
+\fI( \fBCOLORS\fI + 1 ) * ( \fBCOLORS\fI + 1 )\fR
 .NE
 .bP
 An application might use up to a few dozen color pairs to
@@ -127,10 +133,10 @@ If the table fills up, \fBalloc_pair\fP discards the least-recently
 allocated entry using \fBfree_pair\fP and allocates a new color pair.
 .PP
 All of the color pairs are allocated from a table of possible color pairs.
-The size of the table is determined by the terminfo \fIpairs\fP capability.
+The size of the table is determined by the terminfo \fBpairs\fP capability.
 The table is shared with \fBinit_pair\fP;
 in fact \fBalloc_pair\fP calls \fBinit_pair\fP after
-updating the ncurses library's fast index to the colors versus color pairs.
+updating the \fIncurses\fP library's fast index to the colors versus color pairs.
 .SS find_pair
 The \fBfind_pair\fP function accepts parameters for
 foreground and background color, and
@@ -141,7 +147,6 @@ Otherwise it returns \-1.
 Marks the given color pair as unused,
 i.e., like color pair 0.
 .SH RETURN VALUE
-.PP
 The \fBalloc_pair\fP function returns a color pair number in the range
 1 through \fBCOLOR_PAIRS\fP\-1, unless it encounters an error updating
 its fast index to the color pair values, preventing it from allocating
@@ -155,12 +160,12 @@ or \-1 if not.
 Likewise, \fBfree_pair\fP returns \fBOK\fP unless it encounters an
 error updating the fast index or if no such color pair is in use.
 .SH PORTABILITY
-These routines are specific to ncurses.
+These routines are specific to \fIncurses\fP.
 They were not supported on
 Version 7, BSD or System V implementations.
 It is recommended that
-any code depending on them be conditioned using NCURSES_VERSION.
-.SH SEE ALSO
-\fBcurs_color\fR(3X).
+any code depending on them be conditioned using \fB\%NCURSES_VERSION\fP.
 .SH AUTHOR
-Thomas Dickey.
+Thomas Dickey
+.SH SEE ALSO
+\fB\%curs_color\fP(3X)