1.\" $NetBSD: curses_underscore.3,v 1.3 2002/10/21 14:17: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_UNDERSCORE 3 33.Os 34.Sh NAME 35.Nm curses_underscore , 36.Nm underscore , 37.Nm underend , 38.Nm wunderscore , 39.Nm wunderend 40.Nd curses underscore attribute manipulation routines 41.Sh LIBRARY 42.Lb libcurses 43.Sh SYNOPSIS 44.Fd #include \*[Lt]curses.h\*[Gt] 45.Ft int 46.Fn underscore void 47.Ft int 48.Fn underend void 49.Ft int 50.Fn wunderscore void 51.Ft int 52.Fn wunderend void 53.Sh DESCRIPTION 54These functions manipulate the underscore attribute on 55.Dv stdscr 56or on the specified window. 57.Pp 58The 59.Fn underscore 60function turns on the underscore attribute 61on 62.Dv stdscr . 63The 64.Fn underend 65function turns off the underscore attribute on 66.Dv stdscr . 67.Pp 68The 69.Fn wunderscore 70and 71.Fn wunderend 72functions 73are equivalent to 74.Fn underscore 75and 76.Fn underend , 77respectively, excepting that the attribute is manipulated on the 78window specified by 79.Fa win . 80.Pp 81The 82.Fn underscore 83and 84.Fn underend 85functions 86are equivalent to 87.Fn wattron A_UNDERLINE 88and 89.Fn wattroff A_UNDERLINE , 90respectively. 91.Sh RETURN VALUES 92These functions always return 1. 93.Sh SEE ALSO 94.Xr curses_attributes 3 , 95.Xr curses_standout 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 102These functions first appeared in 103.Nx 1.5 . 104