|
|
1.1 root 1: .\" Copyright (c) 1980 Regents of the University of California.
2: .\" All rights reserved. The Berkeley software License Agreement
3: .\" specifies the terms and conditions for redistribution.
4: .\"
5: .\" @(#)curses.3x 6.3 (Berkeley) 4/23/86
6: .\"
7: .TH CURSES 3X "April 23, 1986"
8: .UC 4
9: .SH NAME
10: curses \- screen functions with ``optimal'' cursor motion
11: .SH SYNOPSIS
12: .B cc
13: [ flags ] files
14: .B \-lcurses \-ltermcap
15: [ libraries ]
16: .SH DESCRIPTION
17: These routines give the user a method of updating screens with reasonable
18: optimization. They keep an image of the current screen,
19: and the user sets up an image of a new one. Then the
20: .I refresh()
21: tells the routines to make the current screen look like the new one.
22: In order to initialize the routines, the routine
23: .I initscr()
24: must be called before any of the other routines that deal with windows and
25: screens are used. The routine
26: .I endwin()
27: should be called before exiting.
28: .SH SEE ALSO
29: .I "Screen Updating and Cursor Movement Optimization: A Library Package,"
30: Ken Arnold,
31: .br
32: ioctl(2),
33: getenv(3),
34: tty(4),
35: termcap(5)
36: .SH AUTHOR
37: Ken Arnold
38: .SH FUNCTIONS
39: .nf
40: .ds w \fIwin\fP
41: .ds s \fIstdscr\fP
42: .ta 3i
43: addch(ch) add a character to \*s
44: addstr(str) add a string to \*s
45: box(win,vert,hor) draw a box around a window
46: cbreak() set cbreak mode
47: clear() clear \*s
48: clearok(scr,boolf) set clear flag for \fIscr\fP
49: clrtobot() clear to bottom on \*s
50: clrtoeol() clear to end of line on \*s
51: delch() delete a character
52: deleteln() delete a line
53: delwin(win) delete \*w
54: echo() set echo mode
55: endwin() end window modes
56: erase() erase \*s
57: flusok(win,boolf) set flush-on-refresh flag for \fIwin\fP
58: getch() get a char through \*s
59: getcap(name) get terminal capability \fIname\fP
60: getstr(str) get a string through \*s
61: gettmode() get tty modes
62: getyx(win,y,x) get (y,x) co-ordinates
63: inch() get char at current (y,x) co-ordinates
64: initscr() initialize screens
65: insch(c) insert a char
66: insertln() insert a line
67: leaveok(win,boolf) set leave flag for \*w
68: longname(termbuf,name) get long name from \fItermbuf\fP
69: move(y,x) move to (y,x) on \*s
70: mvcur(lasty,lastx,newy,newx) actually move cursor
71: newwin(lines,cols,begin_y,begin_x)\ create a new window
72: nl() set newline mapping
73: nocbreak() unset cbreak mode
74: noecho() unset echo mode
75: nonl() unset newline mapping
76: noraw() unset raw mode
77: overlay(win1,win2) overlay win1 on win2
78: overwrite(win1,win2) overwrite win1 on top of win2
79: printw(fmt,arg1,arg2,...) printf on \*s
80: raw() set raw mode
81: refresh() make current screen look like \*s
82: resetty() reset tty flags to stored value
83: savetty() stored current tty flags
84: scanw(fmt,arg1,arg2,...) scanf through \*s
85: scroll(win) scroll \*w one line
86: scrollok(win,boolf) set scroll flag
87: setterm(name) set term variables for name
88: standend() end standout mode
89: standout() start standout mode
90: subwin(win,lines,cols,begin_y,begin_x)\ create a subwindow
91: touchline(win,y,sx,ex) mark line \fIy\fP \fIsx\fP through \fIsy\fP as changed
92: touchoverlap(win1,win2) mark overlap of \fIwin1\fP on \fIwin2\fP as changed
93: touchwin(win) \*(lqchange\*(rq all of \*w
94: unctrl(ch) printable version of \fIch\fP
95: waddch(win,ch) add char to \*w
96: waddstr(win,str) add string to \*w
97: wclear(win) clear \*w
98: wclrtobot(win) clear to bottom of \*w
99: wclrtoeol(win) clear to end of line on \*w
100: wdelch(win,c) delete char from \*w
101: wdeleteln(win) delete line from \*w
102: werase(win) erase \*w
103: wgetch(win) get a char through \*w
104: wgetstr(win,str) get a string through \*w
105: winch(win) get char at current (y,x) in \*w
106: winsch(win,c) insert char into \*w
107: winsertln(win) insert line into \*w
108: wmove(win,y,x) set current (y,x) co-ordinates on \*w
109: wprintw(win,fmt,arg1,arg2,...)\ printf on \*w
110: wrefresh(win) make screen look like \*w
111: wscanw(win,fmt,arg1,arg2,...)\ scanf through \*w
112: wstandend(win) end standout mode on \*w
113: wstandout(win) start standout mode on \*w
114: .SH BUGS
This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.