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