xref: /386bsd/usr/share/man/cat3/curses.0 (revision a2142627)
1CURSES(3)                 386BSD Programmer's Manual                 CURSES(3)
2
3NNAAMMEE
4     ccuurrsseess - screen functions with ``optimal'' cursor motion
5
6SSYYNNOOPPSSIISS
7     cccc [_f_l_a_g_s] _f_i_l_e_s --llccuurrsseess --lltteerrmmccaapp [_l_i_b_r_a_r_i_e_s]
8
9DDEESSCCRRIIPPTTIIOONN
10     These routines give the user a method of updating screens with reasonable
11     optimization.  They keep an image of the current screen, and the user
12     sets up an image of a new one.  Then the rreeffrreesshh() tells the routines to
13     make the current screen look like the new one.  In order to initialize
14     the routines, the routine iinniittssccrr() must be called before any of the
15     other routines that deal with windows and screens are used.  The routine
16     eennddwwiinn() should be called before exiting.
17
18SSEEEE AALLSSOO
19     ioctl(2),  getenv(3),  tty(4),  termcap(5)
20
21     Ken Arnold, _S_c_r_e_e_n _U_p_d_a_t_i_n_g _a_n_d _C_u_r_s_o_r _M_o_v_e_m_e_n_t _O_p_t_i_m_i_z_a_t_i_o_n: _A _L_i_b_r_a_r_y
22     _P_a_c_k_a_g_e.
23
24AAUUTTHHOORR
25     Ken Arnold
26
27FFUUNNCCTTIIOONNSS
28     addch(ch)                                    add a character to _s_t_d_s_c_r
29     addstr(str)                                  add a string to _s_t_d_s_c_r
30     box(win,vert,hor)                            draw a box around a window
31     cbreak()                                     set cbreak mode
32     clear()                                      clear _s_t_d_s_c_r
33     clearok(scr,boolf)                           set clear flag for _s_c_r
34     clrtobot()                                   clear to bottom on _s_t_d_s_c_r
35     clrtoeol()                                   clear to end of line on
36                                                  _s_t_d_s_c_r
37     delch()                                      delete a character
38     deleteln()                                   delete a line
39     delwin(win)                                  delete _s_t_d_s_c_r
40     echo()                                       set echo mode
41     endwin()                                     end window modes
42     erase()                                      erase _s_t_d_s_c_r
43     flusok(win,boolf)                            set flush-on-refresh flag
44                                                  for _w_i_n
45     getch()                                      get a char through _s_t_d_s_c_r
46     getcap(name)                                 get terminal capability _n_a_m_e
47     getstr(str)                                  get a string through _s_t_d_s_c_r
48     gettmode()                                   get tty modes
49     getyx(win,y,x)                               get (y,x) co-ordinates
50     inch()                                       get char at current (y,x)
51                                                  co-ordinates
52     initscr()                                    initialize screens
53     insch(c)                                     insert a char
54     insertln()                                   insert a line
55     leaveok(win,boolf)                           set leave flag for _s_t_d_s_c_r
56     longname(termbuf,name)                       get long name from _t_e_r_m_b_u_f
57     move(y,x)                                    move to (y,x) on _s_t_d_s_c_r
58     mvcur(lasty,lastx,newy,newx)                 actually move cursor
59     newwin(lines,cols,begin_y,begin_x)           create a new window
60     nl()                                         set newline mapping
61     nocbreak()                                   unset cbreak mode
62     noecho()                                     unset echo mode
63     nonl()                                       unset newline mapping
64
65
66     noraw()                                      unset raw mode
67     overlay(win1,win2)                           overlay win1 on win2
68     overwrite(win1,win2)                         overwrite win1 on top of
69                                                  win2
70     printw(fmt,arg1,arg2,...)                    printf on _s_t_d_s_c_r
71     raw()                                        set raw mode
72     refresh()                                    make current screen look
73                                                  like _s_t_d_s_c_r
74     resetty()                                    reset tty flags to stored
75                                                  value
76     savetty()                                    stored current tty flags
77     scanw(fmt,arg1,arg2,...)                     scanf through _s_t_d_s_c_r
78     scroll(win)                                  scroll _w_i_n one line
79     scrollok(win,boolf)                          set scroll flag
80     setterm(name)                                set term variables for name
81     standend()                                   end standout mode
82     standout()                                   start standout mode
83     subwin(win,lines,cols,begin_y,begin_x)       create a subwindow
84     touchline(win,y,sx,ex)                       mark line _y _s_x through _s_y as
85                                                  changed
86     touchoverlap(win1,win2)                      mark overlap of _w_i_n_1 on _w_i_n_2
87                                                  as changed
88     touchwin(win)                                change all of _w_i_n
89     unctrl(ch)                                   printable version of _c_h
90     waddch(win,ch)                               add char to _w_i_n
91     waddstr(win,str)                             add string to _w_i_n
92     wclear(win)                                  clear _w_i_n
93     wclrtobot(win)                               clear to bottom of _w_i_n
94     wclrtoeol(win)                               clear to end of line on _w_i_n
95     wdelch(win,c)                                delete char from _w_i_n
96     wdeleteln(win)                               delete line from _w_i_n
97     werase(win)                                  erase _w_i_n
98     wgetch(win)                                  get a char through _w_i_n
99     wgetstr(win,str)                             get a string through _w_i_n
100     winch(win)                                   get char at current (y,x) in
101                                                  _w_i_n
102     winsch(win,c)                                insert char into _w_i_n
103     winsertln(win)                               insert line into _w_i_n
104     wmove(win,y,x)                               set current (y,x) co-
105                                                  ordinates on _w_i_n
106     wprintw(win,fmt,arg1,arg2,...)               printf on _w_i_n
107     wrefresh(win)                                make screen look like _w_i_n
108     wscanw(win,fmt,arg1,arg2,...)                scanf through _w_i_n
109     wstandend(win)                               end standout mode on _w_i_n
110     wstandout(win)                               start standout mode on _w_i_n
111
112HHIISSTTOORRYY
113     The ccuurrsseess package appeared in 4.0BSD.
114
1154th Berkeley Distribution        June 4, 1993                                2
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133