ncurses 6.2 - patch 20201107
[ncurses.git] / man / curs_attr.3x
index 4b3948242e6ebbfd7f5c059d0df5f2e9a1748d95..8199977ab69058a4069685215d89c01458647754 100644 (file)
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998-2016,2017 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
+.\" Copyright 1998-2016,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            *
@@ -27,7 +28,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_attr.3x,v 1.62 2017/12/16 20:16:07 tom Exp $
+.\" $Id: curs_attr.3x,v 1.66 2020/02/02 23:34:34 tom Exp $
 .TH curs_attr 3X ""
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
@@ -44,7 +45,8 @@
 .de NE
 .fi
 .ft R
-.in -4
+.ie n  .in -4
+.el    .in -2
 ..
 .de bP
 .ie n  .IP \(bu 4
@@ -197,7 +199,7 @@ it is the same size as \fBchtype\fP (used by \fBaddch\fP(3X)).
 It holds the common video attributes (such as bold, reverse),
 as well as a few bits for color.
 Those bits correspond to the \fBA_COLOR\fP symbol.
-The \fBCOLOR_PAIR\fP macro provides a value which can be OR'd into 
+The \fBCOLOR_PAIR\fP macro provides a value which can be OR'd into
 the attribute parameter.
 For example,
 as long as that value fits into the \fBA_COLOR\fP mask,
@@ -210,7 +212,8 @@ attr_set(A_BOLD, \fIpair\fP, NULL);
 However, if the value does not fit, then the \fBCOLOR_PAIR\fP macro
 uses only the bits that fit.
 For example, because in ncurses \fBA_COLOR\fP has eight (8) bits,
-then \fBCOLOR_PAIR(259)\fP is 4 (259\-255).
+then \fBCOLOR_PAIR(\fP\fI259\fP\fB)\fP is 4
+(i.e., 259 is 4 more than the limit 255).
 .PP
 The \fBPAIR_NUMBER\fP macro extracts a pair number from an \fBint\fP
 (or \fBchtype\fP).
@@ -260,7 +263,7 @@ The routine \fBstandend\fR is the same
 as \fBattrset(A_NORMAL)\fR or \fBattrset(0)\fR, that is, it turns off all
 attributes.
 .PP
-X/Open does not mark these "restricted", because
+X/Open does not mark these \*(``restricted\*('', because
 .bP
 they have well established legacy use, and
 .bP
@@ -327,7 +330,8 @@ Color pair values can only be OR'd with attributes if the pair
 number is less than 256.
 The alternate functions such as \fBcolor_set\fP can pass a color pair
 value directly.
-However, ncurses ABI 4 and 5 simply OR this value within the alternate functions.
+However, ncurses ABI 4 and 5 simply OR this value
+within the alternate functions.
 You must use ncurses ABI 6 to support more than 256 color pairs.
 .\" ---------------------------------------------------------------------------
 .SH HISTORY
@@ -397,7 +401,7 @@ l l l l l l .
 1992   HPUX 9  32      no      8       SVr2 curses
 1992   AIX 3.2 32      no      23      SVr2 curses
 1994   OSF/1 r3        32      no      23      SVr2 curses
-1995   HP-UX 10.00     32      6       16      SVr3 \*(``curses_colr\*('' 
+1995   HP-UX 10.00     32      6       16      SVr3 \*(``curses_colr\*(''
 1995   HP-UX 10.00     32      6       8       SVr4, X/Open curses
 1995   Solaris 5.4     32/64   7       16      X/Open curses
 1996   AIX 4.2 32      7       16      X/Open curses
@@ -433,12 +437,13 @@ The initial release of Solaris was in 1992.
 The \fIxpg4\fP (X/Open) curses was developed by MKS from 1990 to 1995.
 Sun's copyright began in 1996.
 .bP
-Sun updated the X/Open curses interface after 64-bit support was introduced in 1997,
+Sun updated the X/Open curses interface
+after 64-bit support was introduced in 1997,
 but did not modify the SVr4 curses interface.
 .PP
 Regarding U/Win,
 .bP
-Development of the curses library began in 1991, stopped in 2000. 
+Development of the curses library began in 1991, stopped in 2000.
 .bP
 Color support was added in 1998.
 .bP
@@ -447,7 +452,8 @@ The library uses only \fBchtype\fP (no \fBcchar_t\fP).
 .PP
 Once X/Open curses was adopted in the mid-1990s, the constraint of
 a 32-bit interface with many colors and wide-characters for \fBchtype\fP
-became a moot point.  The \fBcchar_t\fP structure (whose size and
+became a moot point.
+The \fBcchar_t\fP structure (whose size and
 members are not specified in X/Open Curses) could be extended as needed.
 .PP
 Other interfaces are rarely used now:
@@ -507,7 +513,7 @@ Use \fBtouchwin\fR to force the screen to match the updated attributes.
 The XSI Curses standard states that whether the traditional functions
 \fBattron\fR/\fBattroff\fR/\fBattrset\fR can manipulate attributes other than
 \fBA_BLINK\fR, \fBA_BOLD\fR, \fBA_DIM\fR, \fBA_REVERSE\fR, \fBA_STANDOUT\fR, or
-\fBA_UNDERLINE\fR is "unspecified".
+\fBA_UNDERLINE\fR is \*(``unspecified\*(''.
 Under this implementation as well as
 SVr4 curses, these functions correctly manipulate all other highlights
 (specifically, \fBA_ALTCHARSET\fR, \fBA_PROTECT\fR, and \fBA_INVIS\fR).
@@ -585,7 +591,7 @@ for \fBwcolor_set\fP is outside the range 0..COLOR_PAIRS\-1.
 does not return an error if either of the parameters of \fBwattr_get\fP
 used for retrieving attribute or color-pair values is \fBNULL\fP.
 .PP
-Functions with a "mv" prefix first perform a cursor movement using
+Functions with a \*(``mv\*('' prefix first perform a cursor movement using
 \fBwmove\fP, and return an error if the position is outside the window,
 or if the window pointer is null.
 .\" ---------------------------------------------------------------------------