Annotation of researchv10dc/man/adm/man3/curses.3, revision 1.1.1.1

1.1       root        1: .TH CURSES 3X
                      2: .CT 2 comm_term
                      3: .SH NAME
                      4: curses \(mi screen functions with `optimal' cursor motion
                      5: .SH DESCRIPTION
                      6: These routines give the user a method
                      7: of updating screens with reasonable optimization.
                      8: They keep an image of the current screen,
                      9: and the user sets up an image of a new one.
                     10: Then
                     11: .I refresh()
                     12: tells the routines to make the current screen look
                     13: like the new one.
                     14: The initialization routine
                     15: .I initscr()
                     16: must be called before any other routines
                     17: that deal with windows and screens.
                     18: The routine
                     19: .I endwin()
                     20: should be called before exiting.
                     21: .PP
                     22: To load the functions use the
                     23: .IR ld (1)
                     24: options
                     25: .BR \-lcurses\ \-ltermcap .
                     26: .SH SEE ALSO
                     27: .IR ioctl (2),
                     28: .IR termcap (5)
                     29: .br
                     30: Ken Arnold,
                     31: `Screen Updating and Cursor Movement Optimization: A Library Package',
                     32: .I UNIX Programmer's Manual,
                     33: Seventh Edition, Virtual VAX-11 Version, 1980
                     34: (Berkeley)
                     35: .SH FUNCTIONS
                     36: .nf
                     37: .ds w \fIwin\fR
                     38: .ds s \fIstdscr\fR
                     39: .ta 3.3i
                     40: \fLaddch(ch)\fP        add a character to \*s
                     41: \fLaddstr(str)\fP      add a string to \*s
                     42: \fLbox(win,vert,hor)\fP        draw a box around a window
                     43: \fLcrmode()\fP set cbreak mode
                     44: \fLclear()\fP  clear \*s
                     45: \fLclearok(scr,boolf)\fP       set clear flag for \fIscr\fR
                     46: \fLclrtobot()\fP       clear to bottom on \*s
                     47: \fLclrtoeol()\fP       clear to end of line on \*s
                     48: \fLdelwin(win)\fP      delete \*w
                     49: \fLecho()\fP   set echo mode
                     50: \fLendwin()\fP end window modes
                     51: \fLerase()\fP  erase \*s
                     52: \fLgetch()\fP  get a char through \*s
                     53: \fLgetstr(str)\fP      get a string through \*s
                     54: \fLgettmode()\fP       get tty modes
                     55: \fLgetyx(win,y,x)\fP   get (y,x) co-ordinates
                     56: \fLinch()\fP   get char at current (y,x) co-ordinates
                     57: \fLinitscr()\fP        initialize screens
                     58: \fLleaveok(win,boolf)\fP       set leave flag for \*w
                     59: \fLlongname(termbuf,name)\fP   get long name from \fItermbuf\fR
                     60: \fLmove(y,x)\fP        move to (y,x) on \*s
                     61: \fLmvcur(lasty,lastx,newy,newx)\fP     actually move cursor
                     62: \fLnewwin(lines,cols,begin_y,begin_x)\ \fP     create a new window
                     63: \fLnl()\fP     set newline mapping
                     64: \fLnocrmode()\fP       unset cbreak mode
                     65: \fLnoecho()\fP unset echo mode
                     66: \fLnonl()\fP   unset newline mapping
                     67: \fLnoraw()\fP  unset raw mode
                     68: \fLoverlay(win1,win2)\fP       overlay win1 on win2
                     69: \fLoverwrite(win1,win2)\fP     overwrite win1 on top of win2
                     70: \fLprintw(fmt,arg1,arg2,...)\fP        printf on \*s
                     71: \fLraw()\fP    set raw mode
                     72: \fLrefresh()\fP        make current screen look like \*s
                     73: \fLresetty()\fP        reset tty flags to stored value
                     74: \fLsavetty()\fP        stored current tty flags
                     75: \fLscanw(fmt,arg1,arg2,...)\fP scanf through \*s
                     76: \fLscroll(win)\fP      scroll \*w one line
                     77: \fLscrollok(win,boolf)\fP      set scroll flag
                     78: \fLsetterm(name)\fP    set term variables for name
                     79: \fLstandend()\fP       end standout mode
                     80: \fLstandout()\fP       start standout mode
                     81: \fLsubwin(win,lines,cols,begin_y,begin_x)\ \fP create a subwindow
                     82: \fLtouchwin(win)\fP    `change' all of \*w
                     83: \fLunctrl(ch)\fP       printable version of \fIch\fR
                     84: \fLwaddch(win,ch)\fP   add char to \*w
                     85: \fLwaddstr(win,str)\fP add string to \*w
                     86: \fLwclear(win)\fP      clear \*w
                     87: \fLwclrtobot(win)\fP   clear to bottom of \*w
                     88: \fLwclrtoeol(win)\fP   clear to end of line on \*w
                     89: \fLwerase(win)\fP      erase \*w
                     90: \fLwgetch(win)\fP      get a char through \*w
                     91: \fLwgetstr(win,str)\fP get a string through \*w
                     92: \fLwinch(win)\fP       get char at current (y,x) in \*w
                     93: \fLwmove(win,y,x)\fP   set current (y,x) co-ordinates on \*w
                     94: \fLwprintw(win,fmt,arg1,arg2,...)\ \fP printf on \*w
                     95: \fLwrefresh(win)\fP    make screen look like \*w
                     96: \fLwscanw(win,fmt,arg1,arg2,...)\ \fP  scanf through \*w
                     97: \fLwstandend(win)\fP   end standout mode on \*w
                     98: \fLwstandout(win)\fP   start standout mode on \*w

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.