xref: /minix3/lib/libcurses/curses_underscore.3 (revision 51ffecc181005cb45a40108612ee28d1daaeeb86)
1 *51ffecc1SBen Gras.\"	$NetBSD: curses_underscore.3,v 1.5 2008/04/30 13:10:51 martin Exp $
2 *51ffecc1SBen Gras.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
3 *51ffecc1SBen Gras.\" All rights reserved.
4 *51ffecc1SBen Gras.\"
5 *51ffecc1SBen Gras.\" This code is derived from software contributed to The NetBSD Foundation
6 *51ffecc1SBen Gras.\" by Julian Coleman.
7 *51ffecc1SBen Gras.\"
8 *51ffecc1SBen Gras.\" Redistribution and use in source and binary forms, with or without
9 *51ffecc1SBen Gras.\" modification, are permitted provided that the following conditions
10 *51ffecc1SBen Gras.\" are met:
11 *51ffecc1SBen Gras.\" 1. Redistributions of source code must retain the above copyright
12 *51ffecc1SBen Gras.\"    notice, this list of conditions and the following disclaimer.
13 *51ffecc1SBen Gras.\" 2. Redistributions in binary form must reproduce the above copyright
14 *51ffecc1SBen Gras.\"    notice, this list of conditions and the following disclaimer in the
15 *51ffecc1SBen Gras.\"    documentation and/or other materials provided with the distribution.
16 *51ffecc1SBen Gras.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
17 *51ffecc1SBen Gras.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
18 *51ffecc1SBen Gras.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
19 *51ffecc1SBen Gras.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
20 *51ffecc1SBen Gras.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21 *51ffecc1SBen Gras.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22 *51ffecc1SBen Gras.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23 *51ffecc1SBen Gras.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24 *51ffecc1SBen Gras.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25 *51ffecc1SBen Gras.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26 *51ffecc1SBen Gras.\" POSSIBILITY OF SUCH DAMAGE.
27 *51ffecc1SBen Gras.\"
28 *51ffecc1SBen Gras.Dd October 13, 2002
29 *51ffecc1SBen Gras.Dt CURSES_UNDERSCORE 3
30 *51ffecc1SBen Gras.Os
31 *51ffecc1SBen Gras.Sh NAME
32 *51ffecc1SBen Gras.Nm curses_underscore ,
33 *51ffecc1SBen Gras.Nm underscore ,
34 *51ffecc1SBen Gras.Nm underend ,
35 *51ffecc1SBen Gras.Nm wunderscore ,
36 *51ffecc1SBen Gras.Nm wunderend
37 *51ffecc1SBen Gras.Nd curses underscore attribute manipulation routines
38 *51ffecc1SBen Gras.Sh LIBRARY
39 *51ffecc1SBen Gras.Lb libcurses
40 *51ffecc1SBen Gras.Sh SYNOPSIS
41 *51ffecc1SBen Gras.In curses.h
42 *51ffecc1SBen Gras.Ft int
43 *51ffecc1SBen Gras.Fn underscore void
44 *51ffecc1SBen Gras.Ft int
45 *51ffecc1SBen Gras.Fn underend void
46 *51ffecc1SBen Gras.Ft int
47 *51ffecc1SBen Gras.Fn wunderscore void
48 *51ffecc1SBen Gras.Ft int
49 *51ffecc1SBen Gras.Fn wunderend void
50 *51ffecc1SBen Gras.Sh DESCRIPTION
51 *51ffecc1SBen GrasThese functions manipulate the underscore attribute on
52 *51ffecc1SBen Gras.Dv stdscr
53 *51ffecc1SBen Grasor on the specified window.
54 *51ffecc1SBen Gras.Pp
55 *51ffecc1SBen GrasThe
56 *51ffecc1SBen Gras.Fn underscore
57 *51ffecc1SBen Grasfunction turns on the underscore attribute
58 *51ffecc1SBen Grason
59 *51ffecc1SBen Gras.Dv stdscr .
60 *51ffecc1SBen GrasThe
61 *51ffecc1SBen Gras.Fn underend
62 *51ffecc1SBen Grasfunction turns off the underscore attribute on
63 *51ffecc1SBen Gras.Dv stdscr .
64 *51ffecc1SBen Gras.Pp
65 *51ffecc1SBen GrasThe
66 *51ffecc1SBen Gras.Fn wunderscore
67 *51ffecc1SBen Grasand
68 *51ffecc1SBen Gras.Fn wunderend
69 *51ffecc1SBen Grasfunctions
70 *51ffecc1SBen Grasare equivalent to
71 *51ffecc1SBen Gras.Fn underscore
72 *51ffecc1SBen Grasand
73 *51ffecc1SBen Gras.Fn underend ,
74 *51ffecc1SBen Grasrespectively, excepting that the attribute is manipulated on the
75 *51ffecc1SBen Graswindow specified by
76 *51ffecc1SBen Gras.Fa win .
77 *51ffecc1SBen Gras.Pp
78 *51ffecc1SBen GrasThe
79 *51ffecc1SBen Gras.Fn underscore
80 *51ffecc1SBen Grasand
81 *51ffecc1SBen Gras.Fn underend
82 *51ffecc1SBen Grasfunctions
83 *51ffecc1SBen Grasare equivalent to
84 *51ffecc1SBen Gras.Fn wattron A_UNDERLINE
85 *51ffecc1SBen Grasand
86 *51ffecc1SBen Gras.Fn wattroff A_UNDERLINE ,
87 *51ffecc1SBen Grasrespectively.
88 *51ffecc1SBen Gras.Sh RETURN VALUES
89 *51ffecc1SBen GrasThese functions always return 1.
90 *51ffecc1SBen Gras.Sh SEE ALSO
91 *51ffecc1SBen Gras.Xr curses_attributes 3 ,
92 *51ffecc1SBen Gras.Xr curses_standout 3
93 *51ffecc1SBen Gras.Sh STANDARDS
94 *51ffecc1SBen GrasThe
95 *51ffecc1SBen Gras.Nx
96 *51ffecc1SBen GrasCurses library complies with the X/Open Curses specification, part of the
97 *51ffecc1SBen GrasSingle Unix Specification.
98 *51ffecc1SBen Gras.Sh HISTORY
99 *51ffecc1SBen GrasThese functions first appeared in
100 *51ffecc1SBen Gras.Nx 1.5 .
101