ncurses 6.4 - patch 20240420

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

diff --git a/man/new_pair.3x b/man/new_pair.3x
index 66d2c0062466c22513a07ae0257556a83fece467..5e844bf8fc25c7c437bbae4cc0871efb89e5c1fe 100644 (file)
--- a/man/new_pair.3x
+++ b/man/new_pair.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
 .\" Copyright 2017 Free Software Foundation, Inc.                            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -29,35 +29,23 @@
 .\"
 .\" Author: Thomas E. Dickey
 .\"
-.\" $Id: new_pair.3x,v 1.36 2023/09/23 22:37:46 tom Exp $
-.TH new_pair 3X 2023-09-23 "ncurses 6.4" "Library calls"
-.ie \n(.g .ds `` \(lq
-.el       .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el       .ds '' ''
+.\" $Id: new_pair.3x,v 1.46 2024/03/16 15:35:01 tom Exp $
+.TH new_pair 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
+.
 .de bP
 .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 \*(CW
-..
-.de NE
-.fi
-.ft R
-.ie n  .in -4
-.el    .in -2
-..
 .SH NAME
 \fB\%alloc_pair\fP,
 \fB\%find_pair\fP,
@@ -65,11 +53,11 @@
 dynamically allocate \fIcurses\fR color pairs
 .SH SYNOPSIS
 .nf
-\fB#include <curses.h>\fP
+\fB#include <curses.h>
 .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
+\fBint alloc_pair(int \fIfg\fP, int \fIbg\fP);
+\fBint find_pair(int \fIfg\fP, int \fIbg\fP);
+\fBint free_pair(int \fIpair\fP);
 .fi
 .SH DESCRIPTION
 These functions are an extension to the \fIcurses\fP library.
@@ -90,21 +78,27 @@ 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.
-.bP
+.IP \(bu 4
 For simple terminal emulators
 with only a few dozen color combinations,
 it is convenient to use the maximum number of combinations
 as the limit on color pairs:
-.NS
+.PP
+.RS 8
+.EX
 \fBCOLORS\fI * \fBCOLORS\fR
-.NE
-.bP
+.EE
+.RE
+.IP \(bu 4
 Terminals which support \fIdefault colors\fP distinct
 from \*(``ANSI colors\*(''
 add to the possible combinations, producing this total:
-.NS
+.PP
+.RS 8
+.EX
 \fI( \fBCOLORS\fI + 1 ) * ( \fBCOLORS\fI + 1 )\fR
-.NE
+.EE
+.RE
 .bP
 An application might use up to a few dozen color pairs to
 implement a predefined color scheme.
@@ -136,7 +130,8 @@ All of the color pairs are allocated from a table of possible color pairs.
 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 \fIncurses\fP library's fast index to the colors versus color pairs.
+updating the \fI\%ncurses\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
@@ -160,12 +155,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 \fIncurses\fP.
+These routines are specific to \fI\%ncurses\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 \fB\%NCURSES_VERSION\fP.
-.SH SEE ALSO
-\fBcurs_color\fP(3X)
-.SH AUTHOR
+.SH AUTHORS
 Thomas Dickey
+.SH SEE ALSO
+\fB\%curs_color\fP(3X)