1.\" $NetBSD: curses_standout.3,v 1.4 2008/04/30 13:10:51 martin 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 October 13, 2002 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.Fn wstandout void 48.Ft int 49.Fn wstandend void 50.Sh DESCRIPTION 51These functions manipulate the standout attribute on 52.Dv stdscr 53or on the specified window. 54.Pp 55The 56.Fn standout 57function turns on the standout attribute 58on 59.Dv stdscr . 60The 61.Fn standend 62function turns off the standout attribute 63on 64.Dv stdscr . 65.Pp 66The 67.Fn wstandout 68and 69.Fn wstandend 70functions are equivalent to 71.Fn standout 72and 73.Fn standend , 74respectively, excepting that the attribute is manipulated on the 75window specified by 76.Fa win . 77.Pp 78The 79.Fn standout 80and 81.Fn standend 82functions are equivalent to 83.Fn attron A_STANDOUT 84and 85.Fn attroff A_STANDOUT , 86respectively. 87.Sh RETURN VALUES 88These functions always return 1. 89.Sh SEE ALSO 90.Xr curses_attributes 3 , 91.Xr curses_underscore 3 92.Sh STANDARDS 93The 94.Nx 95Curses library complies with the X/Open Curses specification, part of the 96Single Unix Specification. 97.Sh HISTORY 98The Curses package appeared in 99.Bx 4.0 . 100.Sh BUGS 101On modern terminals that support other attributes, there is no difference 102between characters displayed with the standout attribute set and those 103displayed with one of the other attributes set (usually bold). 104It is best to avoid using standout if the terminal supports other attributes. 105