1.\" $NetBSD: curses_standout.3,v 1.10 2021/08/03 07:58:50 nia Exp $ 2.\" Copyright (c) 2002 The NetBSD Foundation, Inc. 3.\" All rights reserved. 4.\" 5.\" This code is derived from software contributed to The NetBSD Foundation 6.\" by Julian Coleman. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 17.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 18.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 19.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 20.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 21.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 22.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 23.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 24.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 25.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 26.\" POSSIBILITY OF SUCH DAMAGE. 27.\" 28.Dd July 27, 2021 29.Dt CURSES_STANDOUT 3 30.Os 31.Sh NAME 32.Nm curses_standout , 33.Nm standout , 34.Nm standend , 35.Nm wstandout , 36.Nm wstandend 37.Nd curses standout attribute manipulation routines 38.Sh LIBRARY 39.Lb libcurses 40.Sh SYNOPSIS 41.In curses.h 42.Ft int 43.Fn standout void 44.Ft int 45.Fn standend void 46.Ft int 47.Fo wstandout 48.Fa "WINDOW *win" 49.Fc 50.Ft int 51.Fo wstandend 52.Fa "WINDOW *win" 53.Fc 54.Sh DESCRIPTION 55These functions manipulate the standout attribute on 56.Dv stdscr 57or on the specified window. 58The standout attribute applies the "best" supported highlighting mode 59supported by the current terminal, which may be an alias of 60other attributes. 61.Pp 62The 63.Fn standout 64function turns on the standout attribute 65on 66.Dv stdscr . 67The 68.Fn standend 69function turns off all attributes 70on 71.Dv stdscr . 72.Pp 73The 74.Fn wstandout 75and 76.Fn wstandend 77functions are equivalent to 78.Fn standout 79and 80.Fn standend , 81respectively, excepting that the attribute is manipulated on the 82window specified by 83.Fa win . 84.Pp 85The 86.Fn standout 87and 88.Fn standend 89functions are equivalent to 90.Fn attron A_STANDOUT 91and 92.Fn attroff A_STANDOUT , 93respectively. 94.Sh RETURN VALUES 95These functions always return 1. 96.Sh SEE ALSO 97.Xr curses_attributes 3 , 98.Xr curses_underscore 3 99.Sh STANDARDS 100The 101.Nx 102Curses library complies with the X/Open Curses specification, part of the 103Single Unix Specification. 104.Sh HISTORY 105The Curses package appeared in 106.Bx 4.0 . 107.Sh CAVEATS 108On some terminals, characters with standout set may have the same appearance 109as characters with the reverse video or bold attribute set. 110However, on legacy terminals, standout may be the only attribute that can be 111used to emphasize characters. 112The standout attribute should not be mixed with other attributes. 113