1.\" $NetBSD: curses_standout.3,v 1.2 2002/10/21 13:59:54 wiz 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.\" 3. Neither the name of The NetBSD Foundation nor the names of its 17.\" contributors may be used to endorse or promote products derived 18.\" from this software without specific prior written permission. 19.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 21.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 22.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 23.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 24.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 27.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 29.\" POSSIBILITY OF SUCH DAMAGE. 30.\" 31.Dd October 13, 2002 32.Dt CURSES_STANDOUT 3 33.Os 34.Sh NAME 35.Nm curses_standout , 36.Nm standout , 37.Nm standend , 38.Nm wstandout , 39.Nm wstandend 40.Nd curses standout attribute manipulation routines 41.Sh LIBRARY 42.Lb libcurses 43.Sh SYNOPSIS 44.Fd #include \*[Lt]curses.h\*[Gt] 45.Ft int 46.Fn standout void 47.Ft int 48.Fn standend void 49.Ft int 50.Fn wstandout void 51.Ft int 52.Fn wstandend void 53.Sh DESCRIPTION 54These functions manipulate the standout attribute on 55.Dv stdscr 56or on the specified window. 57.Pp 58The 59.Fn standout 60function turns on the standout attribute 61on 62.Dv stdscr . 63The 64.Fn standend 65function turns off the standout attribute 66on 67.Dv stdscr . 68.Pp 69The 70.Fn wstandout 71and 72.Fn wstandend 73functions are equivalent to 74.Fn standout 75and 76.Fn standend , 77respectively, excepting that the attribute is manipulated on the 78window specified by 79.Fa win . 80.Pp 81The 82.Fn standout 83and 84.Fn standend 85functions are equivalent to 86.Fn attron A_STANDOUT 87and 88.Fn attroff A_STANDOUT , 89respectively. 90.Sh RETURN VALUES 91These functions always return 1. 92.Sh SEE ALSO 93.Xr curses_attributes 3 , 94.Xr curses_underscore 3 95.Sh STANDARDS 96The 97.Nx 98Curses library complies with the X/Open Curses specification, part of the 99Single Unix Specification. 100.Sh HISTORY 101The Curses package appeared in 102.Bx 4.0 . 103.Sh BUGS 104On modern terminals that support other attributes, there is no difference 105between characters displayed with the standout attribute set and those 106displayed with one of the other attributes set (usually bold). 107It is best to avoid using standout if the terminal supports other attributes. 108