1.\" $NetBSD: curses_underscore.3,v 1.5 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_UNDERSCORE 3 30.Os 31.Sh NAME 32.Nm curses_underscore , 33.Nm underscore , 34.Nm underend , 35.Nm wunderscore , 36.Nm wunderend 37.Nd curses underscore attribute manipulation routines 38.Sh LIBRARY 39.Lb libcurses 40.Sh SYNOPSIS 41.In curses.h 42.Ft int 43.Fn underscore void 44.Ft int 45.Fn underend void 46.Ft int 47.Fn wunderscore void 48.Ft int 49.Fn wunderend void 50.Sh DESCRIPTION 51These functions manipulate the underscore attribute on 52.Dv stdscr 53or on the specified window. 54.Pp 55The 56.Fn underscore 57function turns on the underscore attribute 58on 59.Dv stdscr . 60The 61.Fn underend 62function turns off the underscore attribute on 63.Dv stdscr . 64.Pp 65The 66.Fn wunderscore 67and 68.Fn wunderend 69functions 70are equivalent to 71.Fn underscore 72and 73.Fn underend , 74respectively, excepting that the attribute is manipulated on the 75window specified by 76.Fa win . 77.Pp 78The 79.Fn underscore 80and 81.Fn underend 82functions 83are equivalent to 84.Fn wattron A_UNDERLINE 85and 86.Fn wattroff A_UNDERLINE , 87respectively. 88.Sh RETURN VALUES 89These functions always return 1. 90.Sh SEE ALSO 91.Xr curses_attributes 3 , 92.Xr curses_standout 3 93.Sh STANDARDS 94The 95.Nx 96Curses library complies with the X/Open Curses specification, part of the 97Single Unix Specification. 98.Sh HISTORY 99These functions first appeared in 100.Nx 1.5 . 101