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