xref: /netbsd/lib/libcurses/curses.3 (revision c4a72b64) 
1.\"	$NetBSD: curses.3,v 1.42 2002/10/22 12:07:20 blymn Exp $
2.\"
3.\" Copyright (c) 1985, 1991, 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)curses.3	8.1 (Berkeley) 6/4/93
35.\"
36.Dd March 11, 1999
37.Dt CURSES 3
38.Os
39.Sh NAME
40.Nm curses
41.Nd screen functions with
42.Dq optimal
43cursor motion
44.Sh LIBRARY
45.Lb libcurses
46.Sh SYNOPSIS
47.Nm cc
48.Op Ar flags
49.Ar files
50.Fl lcurses
51.Op Ar libraries
52.Sh DESCRIPTION
53These routines give the user a method of updating screens with reasonable
54optimization.
55They keep an image of the current screen,
56and the user sets up an image of a new one.
57Then the
58.Fn refresh
59tells the routines to make the current screen look like the new one.
60In order to initialize the routines, the routine
61.Fn initscr
62must be called before any of the other routines that deal with windows and
63screens are used.
64The routine
65.Fn endwin
66should be called before exiting.
67The routine
68.Fn start_color
69must be called before any of the other routines that deal with color are used.
70.Sh SEE ALSO
71.Xr ioctl 2 ,
72.Xr getenv 3 ,
73.Xr tty 4 ,
74.Xr termcap 5
75.Rs
76.%T Screen Updating and Cursor Movement Optimization: A Library Package
77.%A Ken Arnold
78.Re
79.Sh AUTHORS
80.An Ken Arnold
81.Sh FUNCTIONS
82.Bl -column "subwin(win,lines,cols,begin_y,begin_x)"
83.It Sy "Function Name" Ta Sy "Manual Page Name"
84.It addch Ta Xr curses_addch 3
85.It addstr Ta Xr curses_addstr 3
86.It addnstr Ta Xr curses_addstr 3
87.It assume_default_colors Ta Xr curses_default_colors 3
88.It attron Ta Xr curses_attributes 3
89.It attroff Ta Xr curses_attributes 3
90.It attrset Ta Xr curses_attributes 3
91.It beep Ta Xr curses_tty 3
92.It bkgd Ta Xr curses_background 3
93.It bkgdset Ta Xr curses_background 3
94.It border Ta Xr curses_border 3
95.It box Ta Xr curses_border 3
96.It can_change_colors Ta Xr curses_color 3
97.It cbreak Ta Xr curses_tty 3
98.It clear Ta Xr curses_clear 3
99.It clearok Ta Xr curses_clear 3
100.It clrtobot Ta Xr curses_clear 3
101.It clrtoeol Ta Xr curses_clear 3
102.It color_content Ta Xr curses_color 3
103.It copywin Ta Xr curses_window 3
104.It curs_set Ta Xr curses_tty 3
105.It delay_output Ta Xr curses_tty 3
106.It def_prog_mode Ta Xr curses_tty 3
107.It def_shell_mode Ta Xr curses_tty 3
108.It define_key Ta Xr curses_input 3
109.It delch Ta Xr curses_delch 3
110.It deleteln Ta Xr curses_deleteln 3
111.It delscreen Ta Xr curses_screen 3
112.It delwin Ta Xr curses_window 3
113.It derwin Ta Xr curses_window 3
114.It doupdate Ta Xr curses_refresh 3
115.It dupwin Ta Xr curses_window 3
116.It echo Ta Xr curses_tty 3
117.It endwin Ta Xr curses_screen 3
118.It erase Ta Xr curses_clear 3
119.It erasechar Ta Xr curses_tty 3
120.It flash Ta Xr curses_tty 3
121.It flushinp Ta Xr curses_tty 3
122.It flushok Ta Xr curses_refresh 3
123.It fullname Ta Xr curses_termcap 3
124.It getattrs Ta Xr curses_attributes 3
125.It getbkgd Ta Xr curses_background 3
126.It getcap Ta Xr curses_termcap 3
127.It getch Ta Xr curses_input 3
128.It getcury Ta Xr curses_cursor 3
129.It getcurx Ta Xr curses_cursor 3
130.It getbegy Ta Xr curses_cursor 3
131.It getbegx Ta Xr curses_cursor 3
132.It getmaxy Ta Xr curses_cursor 3
133.It getmaxx Ta Xr curses_cursor 3
134.It getnstr Ta Xr curses_input 3
135.It getpary Ta Xr curses_cursor 3
136.It getparx Ta Xr curses_cursor 3
137.It getparyx Ta Xr curses_cursor 3
138.It getstr Ta Xr curses_input 3
139.It gettmode Ta Xr curses_tty 3
140.It getyx Ta Xr curses_cursor 3
141.It has_colors Ta Xr curses_color 3
142.It has_ic Ta Xr curses_tty 3
143.It has_il Ta Xr curses_tty 3
144.It hline Ta Xr curses_line 3
145.It idcok Ta Xr curses_tty 3
146.It idlok Ta Xr curses_tty 3
147.It inch Ta Xr curses_inch 3
148.It inchnstr Ta Xr curses_inch 3
149.It inchstr Ta Xr curses_inch 3
150.It innstr Ta Xr curses_inch 3
151.It init_color Ta Xr curses_color 3
152.It init_pair Ta Xr curses_color 3
153.It initscr Ta Xr curses_screen 3
154.It insch Ta Xr curses_insertch 3
155.It insdelln Ta Xr curses_insdelln 3
156.It insertln Ta Xr curses_insertln 3
157.It instr Ta Xr curses_inch 3
158.It intrflush Ta Xr curses_tty 3
159.It is_linetouched Ta Xr curses_touch 3
160.It is_wintouched Ta Xr curses_touch 3
161.It isendwin Ta Xr curses_screen 3
162.It keypad Ta Xr curses_input 3
163.It keyok Ta Xr curses_input 3
164.It killchar Ta Xr curses_tty 3
165.It leaveok Ta Xr curses_tty 3
166.It longname Ta Xr curses_termcap 3
167.It meta Ta Xr curses_tty 3
168.It move Ta Xr curses_cursor 3
169.It mvaddch Ta Xr curses_addch 3
170.It mvaddstr Ta Xr curses_addstr 3
171.It mvaddnstr Ta Xr curses_addstr 3
172.It mvcur Ta Xr curses_cursor 3
173.It mvderwin Ta Xr curses_window 3
174.It mvgetnstr Ta Xr curses_input 3
175.It mvgetstr Ta Xr curses_input 3
176.It mvhline Ta Xr curses_line 3
177.It mvvline Ta Xr curses_line 3
178.It mvwaddch Ta Xr curses_addch 3
179.It mvwaddstr Ta Xr curses_addstr 3
180.It mvwaddnstr Ta Xr curses_addstr 3
181.It mvwgetnstr Ta Xr curses_input 3
182.It mvwgetstr Ta Xr curses_input 3
183.It mvwhline Ta Xr curses_line 3
184.It mvwvline Ta Xr curses_line 3
185.It napms Ta Xr curses_tty 3
186.It newterm Ta Xr curses_screen 3
187.It newwin Ta Xr curses_window 3
188.It \&nl Ta Xr curses_tty 3
189.It nocbreak Ta Xr curses_tty 3
190.It nodelay Ta Xr curses_input 3
191.It noecho Ta Xr curses_tty 3
192.It nonl Ta Xr curses_tty 3
193.It noraw Ta Xr curses_tty 3
194.It notimeout Ta Xr curses_input 3
195.It overlay Ta Xr curses_window 3
196.It overwrite Ta Xr curses_window 3
197.It pair_content Ta Xr curses_color 3
198.It printw Ta Xr curses_print 3
199.It raw Ta Xr curses_tty 3
200.It refresh Ta Xr curses_refresh 3
201.It reset_prog_mode Ta Xr curses_tty 3
202.It reset_shell_mode Ta Xr curses_tty 3
203.It resetty Ta Xr curses_tty 3
204.It resizeterm Ta Xr curses_screen 3
205.It savetty Ta Xr curses_tty 3
206.It scanw Ta Xr curses_scanw 3
207.It scrl Ta Xr curses_scroll 3
208.It scroll Ta Xr curses_scroll 3
209.It scrollok Ta Xr curses_scroll 3
210.It setscrreg Ta Xr curses_scroll 3
211.It set_term Ta Xr curses_screen 3
212.It setterm Ta Xr curses_screen 3
213.It standend Ta Xr curses_standout 3
214.It standout Ta Xr curses_standout 3
215.It start_color Ta Xr curses_color 3
216.It subwin Ta Xr curses_window 3
217.It timeout Ta Xr curses_input 3
218.It touchline Ta Xr curses_touch 3
219.It touchoverlap Ta Xr curses_touch 3
220.It touchwin Ta Xr curses_touch 3
221.It unctrl Ta Xr curses_print 3
222.It underend Ta Xr curses_underscore 3
223.It underscore Ta Xr curses_underscore 3
224.It ungetch Ta Xr curses_input 3
225.It untouchwin Ta Xr curses_touch 3
226.It use_default_colors Ta Xr curses_default_colors 3
227.It vline Ta Xr curses_line 3
228.It waddch Ta Xr curses_addch 3
229.It waddstr Ta Xr curses_addstr 3
230.It waddnstr Ta Xr curses_addstr 3
231.It wattron Ta Xr curses_attributes 3
232.It wattroff Ta Xr curses_attributes 3
233.It wattrset Ta Xr curses_attributes 3
234.It wbkgd Ta Xr curses_background 3
235.It wbkgdset Ta Xr curses_background 3
236.It wborder Ta Xr curses_border 3
237.It wclear Ta Xr curses_clear 3
238.It wclrtobot Ta Xr curses_clear 3
239.It wclrtoeol Ta Xr curses_clear 3
240.It wdelch Ta Xr curses_delch 3
241.It wdeleteln Ta Xr curses_deleteln 3
242.It werase Ta Xr curses_clear 3
243.It wgetch Ta Xr curses_input 3
244.It wgetnstr Ta Xr curses_input 3
245.It wgetstr Ta Xr curses_input 3
246.It whline Ta Xr curses_line 3
247.It winch Ta Xr curses_inch 3
248.It winchnstr Ta Xr curses_inch 3
249.It winchstr Ta Xr curses_inch 3
250.It winnstr Ta Xr curses_inch 3
251.It winsch Ta Xr curses_insertch 3
252.It winsdelln Ta Xr curses_insdelln 3
253.It winsertln Ta Xr curses_insertln 3
254.It winstr Ta Xr curses_inch 3
255.It wmove Ta Xr curses_cursor 3
256.It wnoutrefresh Ta Xr curses_refresh 3
257.It wprintw Ta Xr curses_print 3
258.It wrefresh Ta Xr curses_refresh 3
259.It wresize Ta Xr curses_window 3
260.It wscanw Ta Xr curses_scanw 3
261.It wscrl Ta Xr curses_scroll 3
262.It wsetscrreg Ta Xr curses_scroll 3
263.It wstandend Ta Xr curses_standout 3
264.It wstandout Ta Xr curses_standout 3
265.It wtimeout Ta Xr curses_input 3
266.It wtouchln Ta Xr curses_touch 3
267.It wunderend Ta Xr curses_underscore 3
268.It wunderscore Ta Xr curses_underscore 3
269.It wvline Ta Xr curses_line 3
270.El
271.Sh STANDARDS
272The
273.Nx
274Curses library complies with the X/Open Curses specification, part of the
275Single Unix Specification.
276.Sh HISTORY
277The Curses package appeared in
278.Bx 4.0 .
279