Module Name: src
Committed By: nia
Date: Mon Aug 2 11:11:20 UTC 2021
Modified Files:
src/lib/libcurses: curses_attributes.3 curses_standout.3
Log Message:
curses: clarify documentation regarding the standout attribute
To generate a diff of this commit:
cvs rdiff -u -r1.9 -r1.10 src/lib/libcurses/curses_attributes.3
cvs rdiff -u -r1.8 -r1.9 src/lib/libcurses/curses_standout.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libcurses/curses_attributes.3
diff -u src/lib/libcurses/curses_attributes.3:1.9 src/lib/libcurses/curses_attributes.3:1.10
--- src/lib/libcurses/curses_attributes.3:1.9 Thu Oct 25 10:36:56 2018
+++ src/lib/libcurses/curses_attributes.3 Mon Aug 2 11:11:20 2021
@@ -1,4 +1,4 @@
-.\" $NetBSD: curses_attributes.3,v 1.9 2018/10/25 10:36:56 uwe Exp $
+.\" $NetBSD: curses_attributes.3,v 1.10 2021/08/02 11:11:20 nia Exp $
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
@@ -25,7 +25,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd October 25, 2018
+.Dd July 27, 2021
.Dt CURSES_ATTRIBUTES 3
.Os
.Sh NAME
@@ -102,7 +102,7 @@ The attributes that can be manipulated a
.It A_NORMAL
no special attributes are applied
.It A_STANDOUT
-characters are displayed in standout mode
+characters are displayed in the "best" highlighting mode of the terminal
.It A_UNDERLINE
characters are displayed underlined
.It A_REVERSE
@@ -193,7 +193,7 @@ The additional wide attributes that can
.Pp
.Bl -tag -width "COLOR_PAIR(n)" -compact -offset indent
.It WA_STANDOUT
-characters are displayed in standout mode
+characters are displayed in the "best" highlighting mode of the terminal
.It WA_UNDERLINE
characters are displayed underlined
.It WA_REVERSE
@@ -336,7 +336,10 @@ extension.
.Sh HISTORY
These functions first appeared in
.Nx 1.5 .
-.Sh BUGS
+.Sh CAVEATS
Some terminals do not support characters with both color and other attributes
set.
In this case, the other attribute is displayed instead of the color attribute.
+.Pp
+The standout attribute is a higher level alias and should not be mixed with
+other attributes.
Index: src/lib/libcurses/curses_standout.3
diff -u src/lib/libcurses/curses_standout.3:1.8 src/lib/libcurses/curses_standout.3:1.9
--- src/lib/libcurses/curses_standout.3:1.8 Mon Jul 26 20:17:09 2021
+++ src/lib/libcurses/curses_standout.3 Mon Aug 2 11:11:20 2021
@@ -1,4 +1,4 @@
-.\" $NetBSD: curses_standout.3,v 1.8 2021/07/26 20:17:09 nia Exp $
+.\" $NetBSD: curses_standout.3,v 1.9 2021/08/02 11:11:20 nia Exp $
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
@@ -25,7 +25,7 @@
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
-.Dd July 26, 2021
+.Dd July 27, 2021
.Dt CURSES_STANDOUT 3
.Os
.Sh NAME
@@ -55,6 +55,9 @@
These functions manipulate the standout attribute on
.Dv stdscr
or on the specified window.
+The standout attribute applies the "best highlighting mode"
+supported by the current terminal, which may be an alias of
+other attributes.
.Pp
The
.Fn standout
@@ -101,3 +104,9 @@ Single Unix Specification.
.Sh HISTORY
The Curses package appeared in
.Bx 4.0 .
+.Sh CAVEATS
+On some terminals, characters with standout set may have the same appearance
+as characters with the reverse video or bold attribute set.
+However, on legacy terminals, standout may be the only attribute that can be
+used to emphasize characters.
+The standout attribute should not be mixed with other attributes.
