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