]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/new_pair.3x
ncurses 6.4 - patch 20230617
[ncurses.git] / man / new_pair.3x
index c22523887ac63b046960eb36824d09a9d6618b7d..bb49dea44307e3f1ec0532eeb2bd8151f7f3e3dd 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018,2020 Thomas E. Dickey                                     *
+.\" Copyright 2018-2021,2022 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.15 2020/10/17 23:54:50 tom Exp $
-.TH new_pair 3X ""
+.\" $Id: new_pair.3x,v 1.21 2023/06/17 17:50:37 tom Exp $
+.TH new_pair 3X 2023-06-17 "ncurses 6.4" "Library calls"
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .ie \n(.g .ds '' \(rq
@@ -45,7 +45,7 @@
 .ie n  .in +4
 .el    .in +2
 .nf
-.ft C                  \" Courier
+.ft CR                 \" Courier
 ..
 .de NE
 .fi
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .sp
-\fBint alloc_pair(int \fP\fIfg\fP\fB, int \fP\fIbg\fP\fB);\fP
+\fBint alloc_pair(int \fIfg\fB, int \fIbg\fB);\fR
 .br
-\fBint find_pair(int \fP\fIfg\fP\fB, int \fP\fIbg\fP\fB);\fP
+\fBint find_pair(int \fIfg\fB, int \fIbg\fB);\fR
 .br
-\fBint free_pair(int \fP\fIpair\fP\fB);\fP
+\fBint free_pair(int \fIpair\fB);\fR
 .SH DESCRIPTION
 These functions are an extension to the curses library.
 They permit an application to dynamically allocate a color pair using
@@ -82,7 +82,7 @@ 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
 on a terminal.
-If the library does not keep track of the \fIcombinations\fP of 
+If the library does not keep track of the \fIcombinations\fP of
 colors which are displayed, it will be inefficient.
 .bP
 For simple terminal emulators
@@ -90,21 +90,21 @@ 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\*('' 
+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
 implement a predefined color scheme.
 .IP
 Beyond that lies in the realm of programs using the foreground
-and background colors for \*(``ASCII art\*('' 
+and background colors for \*(``ASCII art\*(''
 (or some other non-textual application).
 .IP
 Also beyond those few dozen pairs, the required size for a table
@@ -127,7 +127,7 @@ 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.
@@ -161,6 +161,6 @@ 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).
+\fBcurs_color\fP(3X).
 .SH AUTHOR
 Thomas Dickey.