Added separate man pages for curses functions to provide better
documentation of the curses functions.
This commit is contained in:
blymn
parent
9c7cf018ff
commit
0741e5c935
@ -1,4 +1,4 @@
|
||||
.\" $NetBSD: curses.3,v 1.40 2002/10/01 19:06:39 wiz Exp $
|
||||
.\" $NetBSD: curses.3,v 1.41 2002/10/21 13:55:07 blymn Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 1985, 1991, 1993
|
||||
.\" The Regents of the University of California. All rights reserved.
|
||||
@ -47,7 +47,7 @@ cursor motion
|
||||
.Nm cc
|
||||
.Op Ar flags
|
||||
.Ar files
|
||||
.Fl lcurses ltermcap
|
||||
.Fl lcurses
|
||||
.Op Ar libraries
|
||||
.Sh DESCRIPTION
|
||||
These routines give the user a method of updating screens with reasonable
|
||||
@ -80,389 +80,197 @@ must be called before any of the other routines that deal with color are used.
|
||||
.An Ken Arnold
|
||||
.Sh FUNCTIONS
|
||||
.Bl -column "subwin(win,lines,cols,begin_y,begin_x)"
|
||||
.It addch(ch) add a character to
|
||||
.Em stdscr
|
||||
.It addstr(str) add a string to
|
||||
.Em stdscr
|
||||
.It addnstr(str,len) add no more than len chars of string to
|
||||
.Em stdscr
|
||||
.It assume_default_colors(f, b) set default foreground and background colors
|
||||
.It attron(attribute) turn on attribute modes
|
||||
.It attroff(attribute) turn off attribute modes
|
||||
.It attrset(attribute) set attribute modes
|
||||
.It beep() sound the terminal bell
|
||||
.It bkgd(ch) set background rendition for
|
||||
.Em stdscr
|
||||
and applies this rendition to
|
||||
.Em stdscr
|
||||
.It bkgdset(ch) set background rendition for
|
||||
.Em stdscr
|
||||
.It border(ls,rs,ts,bs,tl,tr,bl,br) draw a border around
|
||||
.Em stdscr
|
||||
.It box(win,vert,hor) draw a box around a window
|
||||
.It can_change_colors() check if terminal can change colors
|
||||
.It cbreak() set cbreak mode
|
||||
.It clear() clear
|
||||
.Em stdscr
|
||||
.It clearok(win,boolf) set clear flag for
|
||||
.Em win
|
||||
.It clrtobot() clear to bottom on
|
||||
.Em stdscr
|
||||
.It clrtoeol() clear to end of line on
|
||||
.Em stdscr
|
||||
.It color_content(c, r, g, b) get rgb values of color
|
||||
.It copywin(srcwin, dstwin, sminrow, smincol, dminrow, dmincol, dmaxrow, dmaxcol, overlay)
|
||||
Copy rectangle from
|
||||
.Em srcwin
|
||||
to
|
||||
.Em dstwin .
|
||||
If overlay is true then copy is nondestructive.
|
||||
.It curs_set(vis) change cursor visibility, 0 is invisible, 1 is
|
||||
normal, 2 is high visibility.
|
||||
Returns previous value on success.
|
||||
.It delay_output(ms) pause output for
|
||||
.Em ms
|
||||
milliseconds using terminal pad character.
|
||||
.It def_prog_mode() define program (in curses) terminal modes
|
||||
.It def_shell_mode() define shell (not in curses) terminal modes
|
||||
.It delch() delete a character
|
||||
.It deleteln() delete a line
|
||||
.It delscreen(screen) free all associated storage and destroy
|
||||
.Em screen .
|
||||
.It delwin(win) delete
|
||||
.Em win
|
||||
.It derwin(win,lines,cols,begin_y,begin_x)\ create a subwindow
|
||||
relative to
|
||||
.Em win .
|
||||
.It doupdate() make current screen look like virtual screen
|
||||
.It dupwin(win) duplicate
|
||||
.Em win
|
||||
.It echo() set echo mode
|
||||
.It endwin() end window modes
|
||||
.It erase() erase
|
||||
.Em stdscr
|
||||
.It erasechar() Return the terminal erase character
|
||||
.It flash() flash the terminal screen
|
||||
.It flushinp() flush terminal input
|
||||
.It flushok(win,boolf) set flush-on-refresh flag for
|
||||
.Em win
|
||||
.It fullname(termbuf,name) get full name from
|
||||
.Em termbuf
|
||||
.It getattrs(win) get attributes for
|
||||
.Em win
|
||||
.It getbkgd(win) get background rendition for
|
||||
.Em win
|
||||
.It getcap(name) get terminal capability
|
||||
.Em name
|
||||
.It getch() get a char through
|
||||
.Em stdscr
|
||||
.It getcury(win) get current y position on
|
||||
.Em win
|
||||
.It getcurx(win) get current x position on
|
||||
.Em win
|
||||
.It getbegy(win) get start y position of
|
||||
.Em win
|
||||
.It getbegx(win) get start x position of
|
||||
.Em win
|
||||
.It getmaxy(win) get maximum y position on
|
||||
.Em win
|
||||
.It getmaxx(win) get maximum x position on
|
||||
.Em win
|
||||
.It getnstr(str, len) get a string of maximun len characters through
|
||||
.Em stdscr
|
||||
.It getpary(win) get start y position of subwindow
|
||||
.Em win
|
||||
relative to parent.
|
||||
.It getparx(win) get start x position of subwindow
|
||||
.Em win
|
||||
relative to parent.
|
||||
.It getparyx(win, y, x) set y and x to position of subwindow
|
||||
.Em win
|
||||
relative to parent.
|
||||
.It getstr(str) get a string through
|
||||
.Em stdscr
|
||||
.It gettmode() get tty modes
|
||||
.It getyx(win,y,x) get (y,x) co-ordinates
|
||||
.It has_colors() check if terminal has colors
|
||||
.It has_ic() check if terminal has insert/delete character
|
||||
.It has_il() check if terminal has insert/delete line
|
||||
.It hline(ch, count) draw a horizontal line of character ch.
|
||||
.It idcok(win,boolf) set insert/delete char flags for
|
||||
.Em win
|
||||
.It idlok(win,boolf) set insert/deleteln flags for
|
||||
.Em win
|
||||
.It inch() get char at current (y,x) co-ordinates
|
||||
.It inchnstr(chstr, n) get an array of characters from
|
||||
.Em stdscr
|
||||
.It inchstr(chstr) get an array of characters from
|
||||
.Em stdscr
|
||||
.It innstr(str, n) get a string of characters from
|
||||
.Em stdscr
|
||||
.It init_color(c, r, g, b) set rgb values of color
|
||||
.It init_pair(p, f, b) set foreground and background colors of pair
|
||||
.It initscr() initialize screens
|
||||
.It insch(c) insert a char
|
||||
.It insdelln(n) insert/delete n lines on
|
||||
.Em stdstr
|
||||
.It insertln() insert a line
|
||||
.It instr(str) get a string of characters from
|
||||
.Em stdscr
|
||||
.It intrflush(win,boolf) set flush on interrupt terminal mode
|
||||
.It is_linetouched(win, line) check if line has been modified since
|
||||
last refresh.
|
||||
.It is_wintouched(win) Check if window has been modified since last
|
||||
refresh.
|
||||
.It isendwin() check if endwin() or wrefresh() was called latest
|
||||
.It keypad(win,boolf) set keypad flag for
|
||||
.Em win
|
||||
.It killchar() Return the terminal kill character.
|
||||
.It leaveok(win,boolf) set leave flag for
|
||||
.Em win
|
||||
.It longname(termbuf,name) get long name from
|
||||
.Em termbuf
|
||||
.It meta(win,boolf) turn terminal meta mode on and off. Note
|
||||
.Em win
|
||||
is always ignored.
|
||||
.It move(y,x) move to (y,x) on
|
||||
.Em stdscr
|
||||
.It mvcur(lasty,lastx,newy,newx) actually move cursor
|
||||
.It mvderwin(win, y, x) move window to (y,x) within parent window.
|
||||
.It mvgetnstr(str, len) move to
|
||||
.Em y ,
|
||||
.Em x
|
||||
and get a string of maximun n characters through
|
||||
.Em stdscr
|
||||
.It mvgetstr(str, n) move to
|
||||
.Em y ,
|
||||
.Em x
|
||||
and get a string through
|
||||
.Em stdscr
|
||||
.It mvhline(y, x, ch, count) move to
|
||||
.Em y ,
|
||||
.Em x
|
||||
and draw a horizontal line of character
|
||||
.Em ch
|
||||
for
|
||||
.Em count
|
||||
characters.
|
||||
.It mvvline(y, x, ch, count) move to
|
||||
.Em y ,
|
||||
.Em x
|
||||
and draw a vertical line of character
|
||||
.Em ch
|
||||
for
|
||||
.Em count
|
||||
characters.
|
||||
.It mvwgetnstr(str, len) move to
|
||||
.Em y ,
|
||||
.Em x
|
||||
and get a string of maximun n characters through
|
||||
.Em win
|
||||
.It mvwgetstr(str, n) move to
|
||||
.Em y ,
|
||||
.Em x
|
||||
and get a string through
|
||||
.Em win
|
||||
.It mvwhline(win, y, x, ch, count) move to
|
||||
.Em y ,
|
||||
.Em x
|
||||
and draw a horizontal line of character
|
||||
.Em ch
|
||||
for
|
||||
.Em count
|
||||
characters on window
|
||||
.Em win .
|
||||
.It mvwvline(win, y, x, ch, count) move to
|
||||
.Em y ,
|
||||
.Em x
|
||||
and draw a vertical line of character
|
||||
.Em ch
|
||||
for
|
||||
.Em count
|
||||
characters on window
|
||||
.Em win .
|
||||
.It napms(ms) sleep for
|
||||
.Em ms
|
||||
milliseconds.
|
||||
.It newterm(type, outfd, infd) Initialises the curses subsystem
|
||||
for a multi-terminal application.
|
||||
Type is the type of terminal, if this is NULL then $TERM is used.
|
||||
The infd and outfd are the input and output file streams.
|
||||
.It newwin(lines,cols,begin_y,begin_x)\ create a new window
|
||||
.It nl() set newline mapping
|
||||
.It nocbreak() unset cbreak mode
|
||||
.It nodelay(win,boolf) unset blocking reads for
|
||||
.Em win
|
||||
.It noecho() unset echo mode
|
||||
.It nonl() unset newline mapping
|
||||
.It noraw() unset raw mode
|
||||
.It notimeout(win, boolf) unset infinite timeout on keypad assembly for
|
||||
.Em win
|
||||
.It overlay(win1,win2) overlay win1 on win2
|
||||
.It overwrite(win1,win2) overwrite win1 on top of win2
|
||||
.It pair_content(p, r, g, b) get foreground and
|
||||
background colors of pair
|
||||
.It printw(fmt,arg1,arg2,...) printf on
|
||||
.Em stdscr
|
||||
.It raw() set raw mode
|
||||
.It refresh() make current screen look like
|
||||
.Em stdscr
|
||||
.It reset_prog_mode() restore program (in curses) terminal modes
|
||||
.It reset_shell_mode() restore shell (not in curses) terminal modes
|
||||
.It resetty() reset tty flags to stored value
|
||||
.It resizeterm(lines,cols) resize the curses terminal, application must
|
||||
redraw the screen contents after this call
|
||||
.It savetty() stored current tty flags
|
||||
.It scanw(fmt,arg1,arg2,...) scanf through
|
||||
.Em stdscr
|
||||
.It scrl(n) scroll
|
||||
.Em stdscr
|
||||
n lines
|
||||
.It scroll(win) scroll
|
||||
.Em win
|
||||
one line
|
||||
.It scrollok(win,boolf) set scroll flag for
|
||||
.Em win
|
||||
.It setscrreg(top, bottom) set scrolling region on
|
||||
.Em stdscr
|
||||
.It set_term(screen) sets the curses screen to the given one.
|
||||
Returns the previous screen.
|
||||
.It setterm(name) set term variables for name
|
||||
.It standend() end standout mode
|
||||
.It standout() start standout mode
|
||||
.It start_color() initialise color
|
||||
.It subwin(win,lines,cols,begin_y,begin_x)\ create a subwindow
|
||||
.It timeout(delay) set blocking or non-blocking read for
|
||||
.Em stdscr
|
||||
.It touchline(win,y,sx,ex) mark line
|
||||
.Em y
|
||||
.Em sx
|
||||
through
|
||||
.Em sy
|
||||
as changed
|
||||
.It touchoverlap(win1,win2) mark overlap of
|
||||
.Em win1
|
||||
on
|
||||
.Em win2
|
||||
as changed
|
||||
.It touchwin(win) \*(lqchange\*(rq all of
|
||||
.Em win
|
||||
.It unctrl(ch) printable version of
|
||||
.Em ch
|
||||
.It underend() end underscore mode
|
||||
.It underscore() start underscore mode
|
||||
.It ungetch(ch) Put character back onto input queue.
|
||||
.It untouchwin(win) Make window appear not to have been modified.
|
||||
.It use_default_colors use terminal's default foreground and background colors
|
||||
.It vline(ch, count) Draw a vertical line of character
|
||||
.Em ch .
|
||||
.It waddch(win,ch) add char to
|
||||
.Em win
|
||||
.It waddstr(win,str) add string to
|
||||
.Em win
|
||||
.It wattron(win,attribute) turn on attribute modes for
|
||||
.Em win
|
||||
.It wattroff(win,attribute) turn off attribute modes for
|
||||
.Em win
|
||||
.It wattrset(win,attribute) set attribute modes for
|
||||
.Em win
|
||||
.It wbkgd(win, ch) set background rendition for
|
||||
.Em win
|
||||
and apply this rendition to
|
||||
.Em win
|
||||
.It wbkgdset(win, ch) set background rendition for
|
||||
.Em win
|
||||
.It wborder(win,ls,rs,ts,bs,tl,tr,bl,br) draw a border around
|
||||
.Em win
|
||||
.It wclear(win) clear
|
||||
.Em win
|
||||
.It wclrtobot(win) clear to bottom of
|
||||
.Em win
|
||||
.It wclrtoeol(win) clear to end of line on
|
||||
.Em win
|
||||
.It wdelch(win) delete char from
|
||||
.Em win
|
||||
.It wdeleteln(win) delete line from
|
||||
.Em win
|
||||
.It werase(win) erase
|
||||
.Em win
|
||||
.It wgetch(win) get a char through
|
||||
.Em win
|
||||
.It wgetnstr(win, str, len) get a string of maximun n characters through
|
||||
.Em win
|
||||
.It wgetstr(win, str) get a string through
|
||||
.Em win
|
||||
.It whline(win, ch, count) Draw a horizontal line of character
|
||||
.Em ch
|
||||
on window
|
||||
.Em win .
|
||||
.It winch(win) get char at current (y,x) in
|
||||
.Em win
|
||||
.It winchnstr(win, chstr, n) get an array of characters from
|
||||
.Em win
|
||||
.It winchstr(win, chstr) get an array of characters from
|
||||
.Em win
|
||||
.It winnstr(win, str, n) get a string of characters from
|
||||
.Em win
|
||||
.It winsch(win,c) insert char into
|
||||
.Em win
|
||||
.It winsdelln(win,n) insert/delete n lines on
|
||||
.Em win
|
||||
.It winsertln(win) insert line into
|
||||
.Em win
|
||||
.It winstr(win,str) get a string of characters from
|
||||
.Em win
|
||||
.It wmove(win,y,x) set current (y,x) co-ordinates on
|
||||
.Em win
|
||||
.It wnoutrefresh(win) add
|
||||
.Em win
|
||||
to virtual screen
|
||||
.It wprintw(win,fmt,arg1,arg2,...)\ printf on
|
||||
.Em win
|
||||
.It wrefresh(win) make screen look like
|
||||
.Em win
|
||||
.It wresize(win,lines,cols) resize
|
||||
.Em win
|
||||
.It wscanw(win,fmt,arg1,arg2,...)\ scanf through
|
||||
.Em win
|
||||
.It wscrl(win,n) scroll
|
||||
.Em win
|
||||
n lines
|
||||
.It wsetscrreg(win, top, bottom) set scrolling region on
|
||||
.Em win
|
||||
.It wstandend(win) end standout mode on
|
||||
.Em win
|
||||
.It wstandout(win) start standout mode on
|
||||
.Em win
|
||||
.It wtimeout(win,delay) set blocking or non-blocking read for
|
||||
.Em win
|
||||
.It wtouchln(win, line, n, changed) If
|
||||
.Em changed
|
||||
is 1 then touch
|
||||
.Em n
|
||||
lines starting at
|
||||
.Em line
|
||||
in window
|
||||
.Em win .
|
||||
If
|
||||
.Em changed
|
||||
is 0 then untouch
|
||||
.Em n
|
||||
lines starting at
|
||||
.Em line
|
||||
in window
|
||||
.Em win
|
||||
.It wunderend(win) end underscore mode on
|
||||
.Em win
|
||||
.It wunderscore(win) start underscore mode on
|
||||
.Em win
|
||||
.It wvline(win, ch, count) Draw a vertical line of character
|
||||
.Em ch
|
||||
on window
|
||||
.Em win .
|
||||
.It Sy "Function Name" Ta Sy "Manual Page Name"
|
||||
.It addch Ta Xr curses_addch 3
|
||||
.It addstr Ta Xr curses_addstr 3
|
||||
.It addnstr Ta Xr curses_addstr 3
|
||||
.It assume_default_colors Ta Xr curses_default_colors 3
|
||||
.It attron Ta Xr curses_attributes 3
|
||||
.It attroff Ta Xr curses_attributes 3
|
||||
.It attrset Ta Xr curses_attributes 3
|
||||
.It beep Ta Xr curses_tty 3
|
||||
.It bkgd Ta Xr curses_background 3
|
||||
.It bkgdset Ta Xr curses_background 3
|
||||
.It border Ta Xr curses_border 3
|
||||
.It box Ta Xr curses_border 3
|
||||
.It can_change_colors Ta Xr curses_color 3
|
||||
.It cbreak Ta Xr curses_tty 3
|
||||
.It clear Ta Xr curses_clear 3
|
||||
.It clearok Ta Xr curses_clear 3
|
||||
.It clrtobot Ta Xr curses_clear 3
|
||||
.It clrtoeol Ta Xr curses_clear 3
|
||||
.It color_content Ta Xr curses_color 3
|
||||
.It copywin Ta Xr curses_window 3
|
||||
.It curs_set Ta Xr curses_tty 3
|
||||
.It delay_output Ta Xr curses_tty 3
|
||||
.It def_prog_mode Ta Xr curses_tty 3
|
||||
.It def_shell_mode Ta Xr curses_tty 3
|
||||
.It delch Ta Xr curses_delch 3
|
||||
.It deleteln Ta Xr curses_deleteln 3
|
||||
.It delscreen Ta Xr curses_screen 3
|
||||
.It delwin Ta Xr curses_window 3
|
||||
.It derwin Ta Xr curses_window 3
|
||||
.It doupdate Ta Xr curses_refresh 3
|
||||
.It dupwin Ta Xr curses_window 3
|
||||
.It echo Ta Xr curses_tty 3
|
||||
.It endwin Ta Xr curses_screen 3
|
||||
.It erase Ta Xr curses_clear 3
|
||||
.It erasechar Ta Xr curses_tty 3
|
||||
.It flash Ta Xr curses_tty 3
|
||||
.It flushinp Ta Xr curses_tty 3
|
||||
.It flushok Ta Xr curses_refresh 3
|
||||
.It fullname Ta Xr curses_termcap 3
|
||||
.It getattrs Ta Xr curses_attributes 3
|
||||
.It getbkgd Ta Xr curses_background 3
|
||||
.It getcap Ta Xr curses_termcap 3
|
||||
.It getch Ta Xr curses_input 3
|
||||
.It getcury Ta Xr curses_cursor 3
|
||||
.It getcurx Ta Xr curses_cursor 3
|
||||
.It getbegy Ta Xr curses_cursor 3
|
||||
.It getbegx Ta Xr curses_cursor 3
|
||||
.It getmaxy Ta Xr curses_cursor 3
|
||||
.It getmaxx Ta Xr curses_cursor 3
|
||||
.It getnstr Ta Xr curses_input 3
|
||||
.It getpary Ta Xr curses_cursor 3
|
||||
.It getparx Ta Xr curses_cursor 3
|
||||
.It getparyx Ta Xr curses_cursor 3
|
||||
.It getstr Ta Xr curses_input 3
|
||||
.It gettmode Ta Xr curses_tty 3
|
||||
.It getyx Ta Xr curses_cursor 3
|
||||
.It has_colors Ta Xr curses_color 3
|
||||
.It has_ic Ta Xr curses_tty 3
|
||||
.It has_il Ta Xr curses_tty 3
|
||||
.It hline Ta Xr curses_line 3
|
||||
.It idcok Ta Xr curses_tty 3
|
||||
.It idlok Ta Xr curses_tty 3
|
||||
.It inch Ta Xr curses_inch 3
|
||||
.It inchnstr Ta Xr curses_inch 3
|
||||
.It inchstr Ta Xr curses_inch 3
|
||||
.It innstr Ta Xr curses_inch 3
|
||||
.It init_color Ta Xr curses_color 3
|
||||
.It init_pair Ta Xr curses_color 3
|
||||
.It initscr Ta Xr curses_screen 3
|
||||
.It insch Ta Xr curses_insertch 3
|
||||
.It insdelln Ta Xr curses_insdelln 3
|
||||
.It insertln Ta Xr curses_insertln 3
|
||||
.It instr Ta Xr curses_inch 3
|
||||
.It intrflush Ta Xr curses_tty 3
|
||||
.It is_linetouched Ta Xr curses_touch 3
|
||||
.It is_wintouched Ta Xr curses_touch 3
|
||||
.It isendwin Ta Xr curses_screen 3
|
||||
.It keypad Ta Xr curses_input 3
|
||||
.It killchar Ta Xr curses_tty 3
|
||||
.It leaveok Ta Xr curses_tty 3
|
||||
.It longname Ta Xr curses_termcap 3
|
||||
.It meta Ta Xr curses_tty 3
|
||||
.It move Ta Xr curses_cursor 3
|
||||
.It mvaddch Ta Xr curses_addch 3
|
||||
.It mvaddstr Ta Xr curses_addstr 3
|
||||
.It mvaddnstr Ta Xr curses_addstr 3
|
||||
.It mvcur Ta Xr curses_cursor 3
|
||||
.It mvderwin Ta Xr curses_window 3
|
||||
.It mvgetnstr Ta Xr curses_input 3
|
||||
.It mvgetstr Ta Xr curses_input 3
|
||||
.It mvhline Ta Xr curses_line 3
|
||||
.It mvvline Ta Xr curses_line 3
|
||||
.It mvwaddch Ta Xr curses_addch 3
|
||||
.It mvwaddstr Ta Xr curses_addstr 3
|
||||
.It mvwaddnstr Ta Xr curses_addstr 3
|
||||
.It mvwgetnstr Ta Xr curses_input 3
|
||||
.It mvwgetstr Ta Xr curses_input 3
|
||||
.It mvwhline Ta Xr curses_line 3
|
||||
.It mvwvline Ta Xr curses_line 3
|
||||
.It napms Ta Xr curses_tty 3
|
||||
.It newterm Ta Xr curses_screen 3
|
||||
.It newwin Ta Xr curses_window 3
|
||||
.It \&nl Ta Xr curses_tty 3
|
||||
.It nocbreak Ta Xr curses_tty 3
|
||||
.It nodelay Ta Xr curses_input 3
|
||||
.It noecho Ta Xr curses_tty 3
|
||||
.It nonl Ta Xr curses_tty 3
|
||||
.It noraw Ta Xr curses_tty 3
|
||||
.It notimeout Ta Xr curses_input 3
|
||||
.It overlay Ta Xr curses_window 3
|
||||
.It overwrite Ta Xr curses_window 3
|
||||
.It pair_content Ta Xr curses_color 3
|
||||
.It printw Ta Xr curses_print 3
|
||||
.It raw Ta Xr curses_tty 3
|
||||
.It refresh Ta Xr curses_refresh 3
|
||||
.It reset_prog_mode Ta Xr curses_tty 3
|
||||
.It reset_shell_mode Ta Xr curses_tty 3
|
||||
.It resetty Ta Xr curses_tty 3
|
||||
.It resizeterm Ta Xr curses_screen 3
|
||||
.It savetty Ta Xr curses_tty 3
|
||||
.It scanw Ta Xr curses_scanw 3
|
||||
.It scrl Ta Xr curses_scroll 3
|
||||
.It scroll Ta Xr curses_scroll 3
|
||||
.It scrollok Ta Xr curses_scroll 3
|
||||
.It setscrreg Ta Xr curses_scroll 3
|
||||
.It set_term Ta Xr curses_screen 3
|
||||
.It setterm Ta Xr curses_screen 3
|
||||
.It standend Ta Xr curses_standout 3
|
||||
.It standout Ta Xr curses_standout 3
|
||||
.It start_color Ta Xr curses_color 3
|
||||
.It subwin Ta Xr curses_window 3
|
||||
.It timeout Ta Xr curses_input 3
|
||||
.It touchline Ta Xr curses_touch 3
|
||||
.It touchoverlap Ta Xr curses_touch 3
|
||||
.It touchwin Ta Xr curses_touch 3
|
||||
.It unctrl Ta Xr curses_print 3
|
||||
.It underend Ta Xr curses_underscore 3
|
||||
.It underscore Ta Xr curses_underscore 3
|
||||
.It ungetch Ta Xr curses_input 3
|
||||
.It untouchwin Ta Xr curses_touch 3
|
||||
.It use_default_colors Ta Xr curses_default_colors 3
|
||||
.It vline Ta Xr curses_line 3
|
||||
.It waddch Ta Xr curses_addch 3
|
||||
.It waddstr Ta Xr curses_addstr 3
|
||||
.It waddnstr Ta Xr curses_addstr 3
|
||||
.It wattron Ta Xr curses_attributes 3
|
||||
.It wattroff Ta Xr curses_attributes 3
|
||||
.It wattrset Ta Xr curses_attributes 3
|
||||
.It wbkgd Ta Xr curses_background 3
|
||||
.It wbkgdset Ta Xr curses_background 3
|
||||
.It wborder Ta Xr curses_border 3
|
||||
.It wclear Ta Xr curses_clear 3
|
||||
.It wclrtobot Ta Xr curses_clear 3
|
||||
.It wclrtoeol Ta Xr curses_clear 3
|
||||
.It wdelch Ta Xr curses_delch 3
|
||||
.It wdeleteln Ta Xr curses_deleteln 3
|
||||
.It werase Ta Xr curses_clear 3
|
||||
.It wgetch Ta Xr curses_input 3
|
||||
.It wgetnstr Ta Xr curses_input 3
|
||||
.It wgetstr Ta Xr curses_input 3
|
||||
.It whline Ta Xr curses_line 3
|
||||
.It winch Ta Xr curses_inch 3
|
||||
.It winchnstr Ta Xr curses_inch 3
|
||||
.It winchstr Ta Xr curses_inch 3
|
||||
.It winnstr Ta Xr curses_inch 3
|
||||
.It winsch Ta Xr curses_insertch 3
|
||||
.It winsdelln Ta Xr curses_insdelln 3
|
||||
.It winsertln Ta Xr curses_insertln 3
|
||||
.It winstr Ta Xr curses_inch 3
|
||||
.It wmove Ta Xr curses_cursor 3
|
||||
.It wnoutrefresh Ta Xr curses_refresh 3
|
||||
.It wprintw Ta Xr curses_print 3
|
||||
.It wrefresh Ta Xr curses_refresh 3
|
||||
.It wresize Ta Xr curses_window 3
|
||||
.It wscanw Ta Xr curses_scanw 3
|
||||
.It wscrl Ta Xr curses_scroll 3
|
||||
.It wsetscrreg Ta Xr curses_scroll 3
|
||||
.It wstandend Ta Xr curses_standout 3
|
||||
.It wstandout Ta Xr curses_standout 3
|
||||
.It wtimeout Ta Xr curses_input 3
|
||||
.It wtouchln Ta Xr curses_touch 3
|
||||
.It wunderend Ta Xr curses_underscore 3
|
||||
.It wunderscore Ta Xr curses_underscore 3
|
||||
.It wvline Ta Xr curses_line 3
|
||||
.El
|
||||
.Sh HISTORY
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nm
|
||||
package appeared in
|
||||
.Nx
|
||||
Curses library complies with the X/Open Curses specification, part of the
|
||||
Single Unix Specification.
|
||||
.Sh HISTORY
|
||||
The Curses package appeared in
|
||||
.Bx 4.0 .
|
||||
|
||||
113
lib/libcurses/curses_add.3
Normal file
113
lib/libcurses/curses_add.3
Normal file
@ -0,0 +1,113 @@
|
||||
.\" $NetBSD: curses_add.3,v 1.1 2002/10/21 13:55:08 blymn Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2002
|
||||
.\" Brett Lymn (blymn@netbsd.org, brett_lymn@yahoo.com.au)
|
||||
.\"
|
||||
.\" This code is donated to the NetBSD Foundation by the Author.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\" 3. The name of the Author may not be used to endorse or promote
|
||||
.\" products derived from this software without specific prior written
|
||||
.\" permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\"
|
||||
.Dd August 12, 2002
|
||||
.Dt CURSES 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm addch ,
|
||||
.Nm addstr ,
|
||||
.Nm addnstr ,
|
||||
.Nm waddch ,
|
||||
.Nm waddstr
|
||||
.Nd add characters
|
||||
.Sh LIBRARY
|
||||
.Lb libcurses
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include \*[Lt]curses.h\*[Gt]
|
||||
.Ft int
|
||||
.Fn addch "chtype c"
|
||||
.Ft int
|
||||
.Fn waddch "WINDOW *win" "chtype c"
|
||||
.Ft int
|
||||
.Fn addstr "const char *string"
|
||||
.Ft int
|
||||
.Fn waddstr "WINDOW *win" "const char *string"
|
||||
.Ft int
|
||||
.Fn addnstr "const char *string" "int len"
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Fn addch
|
||||
function adds the character given in
|
||||
.Fa c
|
||||
to
|
||||
.Dv stdscr
|
||||
at the current cursor position and advances the current cursor
|
||||
position by one. Any character attributes currently set will be
|
||||
applied to the added character. The
|
||||
.Fn waddch
|
||||
function is the same as the
|
||||
.Fn addch
|
||||
function excepting that the character is added to the window specified.
|
||||
.Pp
|
||||
.Fn addstr
|
||||
will add the string passed in
|
||||
.Fa string
|
||||
to
|
||||
.Dv stdscr
|
||||
starting at the current cursor location, any character attributes in
|
||||
effect at the time will be applied to the added string,
|
||||
.Fn waddstr
|
||||
does the same thing but adds the string to the specified window.
|
||||
Similarly,
|
||||
.Fn addnstr
|
||||
will add the contents of
|
||||
.Fa string
|
||||
to
|
||||
.Dv stdscr
|
||||
but will limit the number of characters added to be, at most,
|
||||
.Fa len .
|
||||
If
|
||||
.Fa len
|
||||
is -1 then
|
||||
.Fa addnstr
|
||||
will add the number of bytes contained in the null terminated string
|
||||
.Fa string .
|
||||
.Sh RETURN VALUES
|
||||
Functions returning pointers will return NULL if an error is detected.
|
||||
The functions that return an int will return one of the following
|
||||
values:
|
||||
.Pp
|
||||
.Bl -tag -width ERR -compact
|
||||
.It Er OK
|
||||
The function completed successfully.
|
||||
.It Er ERR
|
||||
An error occurred in the function.
|
||||
.El
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nx
|
||||
Curses library complies with the X/Open Curses specification, part of the
|
||||
Single Unix Specification.
|
||||
.Sh HISTORY
|
||||
The Curses package appeared in
|
||||
.Bx 4.0 .
|
||||
56
lib/libcurses/curses_add.cat3
Normal file
56
lib/libcurses/curses_add.cat3
Normal file
@ -0,0 +1,56 @@
|
||||
CURSES(3) NetBSD Programmer's Manual CURSES(3)
|
||||
|
||||
NNAAMMEE
|
||||
aaddddcchh, aaddddssttrr, aaddddnnssttrr, wwaaddddcchh, wwaaddddssttrr - add characters
|
||||
|
||||
LLIIBBRRAARRYY
|
||||
Curses Library (libcurses, -lcurses)
|
||||
|
||||
SSYYNNOOPPSSIISS
|
||||
##iinncclluuddee <<ccuurrsseess..hh>>
|
||||
|
||||
_i_n_t
|
||||
aaddddcchh(_c_h_t_y_p_e _c);
|
||||
|
||||
_i_n_t
|
||||
wwaaddddcchh(_W_I_N_D_O_W _*_w_i_n, _c_h_t_y_p_e _c);
|
||||
|
||||
_i_n_t
|
||||
aaddddssttrr(_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g);
|
||||
|
||||
_i_n_t
|
||||
wwaaddddssttrr(_W_I_N_D_O_W _*_w_i_n, _c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g);
|
||||
|
||||
_i_n_t
|
||||
aaddddnnssttrr(_c_o_n_s_t _c_h_a_r _*_s_t_r_i_n_g, _i_n_t _l_e_n);
|
||||
|
||||
DDEESSCCRRIIPPTTIIOONN
|
||||
The aaddddcchh() function adds the character given in _c to stdscr at the cur-
|
||||
rent cursor position and advances the current cursor position by one.
|
||||
Any character attributes currently set will be applied to the added char-
|
||||
acter. The wwaaddddcchh() function is the same as the aaddddcchh() function except-
|
||||
ing that the character is added to the window specified.
|
||||
|
||||
aaddddssttrr() will add the string passed in _s_t_r_i_n_g to stdscr starting at the
|
||||
current cursor location, any character attributes in effect at the time
|
||||
will be applied to the added string, wwaaddddssttrr() does the same thing but
|
||||
adds the string to the specified window. Similarly, aaddddnnssttrr() will add
|
||||
the contents of _s_t_r_i_n_g to stdscr but will limit the number of characters
|
||||
added to be, at most, _l_e_n. If _l_e_n is -1 then _a_d_d_n_s_t_r will add the number
|
||||
of bytes contained in the null terminated string _s_t_r_i_n_g.
|
||||
|
||||
RREETTUURRNN VVAALLUUEESS
|
||||
Functions returning pointers will return NULL if an error is detected.
|
||||
The functions that return an int will return one of the following values:
|
||||
|
||||
OK The function completed successfully.
|
||||
ERR An error occurred in the function.
|
||||
|
||||
SSTTAANNDDAARRDDSS
|
||||
The NetBSD Curses library complies with the X/Open Curses specification,
|
||||
part of the Single Unix Specification.
|
||||
|
||||
HHIISSTTOORRYY
|
||||
The Curses package appeared in 4.0BSD.
|
||||
|
||||
NetBSD 1.6 August 12, 2002 1
|
||||
120
lib/libcurses/curses_addch.3
Normal file
120
lib/libcurses/curses_addch.3
Normal file
@ -0,0 +1,120 @@
|
||||
.\" $NetBSD: curses_addch.3,v 1.1 2002/10/21 13:55:09 blymn Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2002
|
||||
.\" Brett Lymn (blymn@netbsd.org, brett_lymn@yahoo.com.au)
|
||||
.\"
|
||||
.\" This code is donated to the NetBSD Foundation by the Author.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\" 3. The name of the Author may not be used to endorse or promote
|
||||
.\" products derived from this software without specific prior written
|
||||
.\" permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\"
|
||||
.Dd August 12, 2002
|
||||
.Dt CURSES_ADDCH 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm curses_addch ,
|
||||
.Nm addch ,
|
||||
.Nm waddch ,
|
||||
.Nm mvaddch ,
|
||||
.Nm mvwaddch
|
||||
.Nd curses add characters to windows routines
|
||||
.Sh LIBRARY
|
||||
.Lb libcurses
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include \*[Lt]curses.h\*[Gt]
|
||||
.Ft int
|
||||
.Fn addch "chtype ch"
|
||||
.Ft int
|
||||
.Fn waddch "WINDOW *win" "chtype ch"
|
||||
.Ft int
|
||||
.Fn mvaddch "int y" "int x" "chtype ch"
|
||||
.Ft int
|
||||
.Fn mvwaddch "WINDOW *win" "int y" "int x" "chtype ch"
|
||||
.Sh DESCRIPTION
|
||||
These functions add characters to
|
||||
.Dv stdscr
|
||||
or to the specified window.
|
||||
.Pp
|
||||
The
|
||||
.Fn addch
|
||||
function adds the character given in
|
||||
.Fa ch
|
||||
to
|
||||
.Dv stdscr
|
||||
at the current cursor position and advances the current cursor position by one.
|
||||
Any character attributes set in
|
||||
.Fa ch
|
||||
will be merged with the background attributes currently set on
|
||||
.Dv stdscr .
|
||||
.Pp
|
||||
The
|
||||
.Fn waddch
|
||||
function is the same as the
|
||||
.Fn addch
|
||||
function, excepting that the character is added to the window specified by
|
||||
.Fa win .
|
||||
.Pp
|
||||
The
|
||||
.Fn mvaddch
|
||||
and
|
||||
.Fn mvwaddch
|
||||
functions are the same as the
|
||||
.Fn addch
|
||||
and
|
||||
.Fn waddch
|
||||
functions, respectively, excepting that
|
||||
.Fn wmove
|
||||
is called to move the cursor to the position specified by
|
||||
.Fa y ,
|
||||
.Fa x
|
||||
before the character is added to the window.
|
||||
.Sh RETURN VALUES
|
||||
Functions returning pointers will return
|
||||
.Dv NULL
|
||||
if an error is detected.
|
||||
The functions that return an int will return one of the following
|
||||
values:
|
||||
.Pp
|
||||
.Bl -tag -width ERR -compact
|
||||
.It Er OK
|
||||
The function completed successfully.
|
||||
.It Er ERR
|
||||
An error occurred in the function.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr curses_addstr 3 ,
|
||||
.Xr curses_attributes 3 ,
|
||||
.Xr curses_cursor 3 ,
|
||||
.Xr curses_deletech 3 ,
|
||||
.Xr curses_inch 3 ,
|
||||
.Xr curses_insertch 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nx
|
||||
Curses library complies with the X/Open Curses specification, part of the
|
||||
Single Unix Specification.
|
||||
.Sh HISTORY
|
||||
The Curses package appeared in
|
||||
.Bx 4.0 .
|
||||
158
lib/libcurses/curses_addstr.3
Normal file
158
lib/libcurses/curses_addstr.3
Normal file
@ -0,0 +1,158 @@
|
||||
.\" $NetBSD: curses_addstr.3,v 1.1 2002/10/21 13:55:09 blymn Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2002
|
||||
.\" Brett Lymn (blymn@netbsd.org, brett_lymn@yahoo.com.au)
|
||||
.\"
|
||||
.\" This code is donated to the NetBSD Foundation by the Author.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\" 3. The name of the Author may not be used to endorse or promote
|
||||
.\" products derived from this software without specific prior written
|
||||
.\" permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\"
|
||||
.Dd August 12, 2002
|
||||
.Dt CURSES_ADDSTR 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm curses_addstr ,
|
||||
.Nm addstr ,
|
||||
.Nm waddstr ,
|
||||
.Nm addnstr ,
|
||||
.Nm waddnstr ,
|
||||
.Nm mvaddstr ,
|
||||
.Nm mvwaddstr ,
|
||||
.Nm mvaddnstr ,
|
||||
.Nm mvwaddnstr
|
||||
.Nd curses add character strings to windows routines
|
||||
.Sh LIBRARY
|
||||
.Lb libcurses
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include \*[Lt]curses.h\*[Gt]
|
||||
.Ft int
|
||||
.Fn addstr "const char *string"
|
||||
.Ft int
|
||||
.Fn waddstr "WINDOW *win" "const char *string"
|
||||
.Ft int
|
||||
.Fn mvaddstr "int y" "int x" "const char *string"
|
||||
.Ft int
|
||||
.Fn mvwaddstr "WINDOW *win" "int y" "int x" "const char *string"
|
||||
.Ft int
|
||||
.Fn addnstr "const char *string" "int len"
|
||||
.Ft int
|
||||
.Fn waddnstr "WINDOW *win" "const char *string" "int len"
|
||||
.Ft int
|
||||
.Fn mvaddnstr "int y" "int x" "const char *string" "int len"
|
||||
.Ft int
|
||||
.Fn mvwaddnstr "WINDOW *win" "int y" "int x" "const char *string" "int len"
|
||||
.Sh DESCRIPTION
|
||||
These functions add character strings to
|
||||
.Dv stdscr
|
||||
or to the specified window.
|
||||
.Pp
|
||||
The
|
||||
.Fn addstr
|
||||
function
|
||||
will add the characters passed in
|
||||
.Fa string
|
||||
to
|
||||
.Dv stdscr
|
||||
starting at the current cursor position.
|
||||
Any background attributes currently set on
|
||||
.Dv stdscr
|
||||
will be applied to the added character.
|
||||
The
|
||||
.Fn waddstr
|
||||
function does the same as
|
||||
.Fn addstr
|
||||
but adds the string to the window specified by
|
||||
.Fn win .
|
||||
.Pp
|
||||
The
|
||||
.Fn addnstr
|
||||
function will add the contents of
|
||||
.Fa string
|
||||
to
|
||||
.Dv stdscr
|
||||
but will limit the number of characters added to be, at most,
|
||||
.Fa len .
|
||||
If
|
||||
.Fa len
|
||||
is \-1 then
|
||||
.Fa addnstr
|
||||
will add the number of characters contained in the null terminated string
|
||||
.Fa string .
|
||||
Any background attributes currently set on
|
||||
.Dv stdscr
|
||||
will be applied to the added character.
|
||||
The
|
||||
.Fn waddnstr
|
||||
function
|
||||
does the same as
|
||||
.Fa addnstr
|
||||
but adds the string to the window specified by
|
||||
.Fa win .
|
||||
.Pp
|
||||
The functions
|
||||
.Fn mvaddstr ,
|
||||
.Fn mwaddnstr ,
|
||||
.Fn mvwaddstr
|
||||
and
|
||||
.Fn mvwaddnstr
|
||||
are the same as the functions
|
||||
.Fn addstr ,
|
||||
.Fn waddstr ,
|
||||
.Fn waddstr
|
||||
and
|
||||
.Fn waddnstr ,
|
||||
respectively, excepting that
|
||||
.Fn wmove
|
||||
is called to move the cursor to the position specified by
|
||||
.Fa y ,
|
||||
.Fa x
|
||||
before the string is added to the window.
|
||||
.Sh RETURN VALUES
|
||||
Functions returning pointers will return
|
||||
.Dv NULL
|
||||
if an error is detected.
|
||||
The functions that return an int will return one of the following
|
||||
values:
|
||||
.Pp
|
||||
.Bl -tag -width ERR -compact
|
||||
.It Er OK
|
||||
The function completed successfully.
|
||||
.It Er ERR
|
||||
An error occurred in the function.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr curses_addch 3 ,
|
||||
.Xr curses_attributes 3 ,
|
||||
.Xr curses_cursor 3 ,
|
||||
.Xr curses_inch 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nx
|
||||
Curses library complies with the X/Open Curses specification, part of the
|
||||
Single Unix Specification.
|
||||
.Sh HISTORY
|
||||
The Curses package appeared in
|
||||
.Bx 4.0 .
|
||||
162
lib/libcurses/curses_attributes.3
Normal file
162
lib/libcurses/curses_attributes.3
Normal file
@ -0,0 +1,162 @@
|
||||
.\" $NetBSD: curses_attributes.3,v 1.1 2002/10/21 13:55:10 blymn Exp $
|
||||
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" This code is derived from software contributed to The NetBSD Foundation
|
||||
.\" by Julian Coleman.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\" 3. Neither the name of The NetBSD Foundation nor the names of its
|
||||
.\" contributors may be used to endorse or promote products derived
|
||||
.\" from this software without specific prior written permission.
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
||||
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
||||
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
||||
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
.\" POSSIBILITY OF SUCH DAMAGE.
|
||||
.\"
|
||||
.Dd October 13, 2002
|
||||
.Dt CURSES_ATTRIBUTES 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm curses_attributes ,
|
||||
.Nm attron ,
|
||||
.Nm attroff ,
|
||||
.Nm attrset ,
|
||||
.Nm wattron ,
|
||||
.Nm wattroff ,
|
||||
.Nm wattrset ,
|
||||
.Nm getattrs
|
||||
.Nd curses general attribute manipulation routines
|
||||
.Sh LIBRARY
|
||||
.Lb libcurses
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include \*[Lt]curses.h\*[Gt]
|
||||
.Ft int
|
||||
.Fn attron int
|
||||
.Ft int
|
||||
.Fn attroff int
|
||||
.Ft int
|
||||
.Fn attrset int
|
||||
.Ft int
|
||||
.Fn wattron int
|
||||
.Ft int
|
||||
.Fn wattroff int
|
||||
.Ft int
|
||||
.Fn wattrset int
|
||||
.Ft chtype
|
||||
.Fn getattrs "WINDOW *win"
|
||||
.Sh DESCRIPTION
|
||||
These functions manipulate attributes on
|
||||
.Dv stdscr
|
||||
or on the specified window.
|
||||
The attributes that can be manipulated are:
|
||||
.Pp
|
||||
.Bl -tag -width "A_ALTCHARSET" -compact -offset indent
|
||||
.It A_NORMAL
|
||||
no special attributes are applied
|
||||
.It A_STANDOUT
|
||||
characters are displayed in standout mode
|
||||
.It A_UNDERLINE
|
||||
characters are displayed underlined
|
||||
.It A_REVERSE
|
||||
characters are displayed in inverse video
|
||||
.It A_BLINK
|
||||
characters blink
|
||||
.It A_DIM
|
||||
characters are displayed at a lower intensity
|
||||
.It A_BOLD
|
||||
characters are displayed at a higher intensity
|
||||
.It A_BLANK
|
||||
characters are added as blanks
|
||||
.It A_PROTECT
|
||||
characters are protected from modification
|
||||
.It A_ALTCHARSET
|
||||
characters are displayed using the alternate character set (ACS)
|
||||
.El
|
||||
along with color.
|
||||
.Pp
|
||||
The function
|
||||
.Fn attron
|
||||
turns on the attributes specified in
|
||||
.Fa attr
|
||||
on
|
||||
.Dv stdscr .
|
||||
.Pp
|
||||
The function
|
||||
.Fn attroff
|
||||
turns off the attributes specified in
|
||||
.Fa attr
|
||||
on
|
||||
.Dv stdscr .
|
||||
.Pp
|
||||
The function
|
||||
.Fn attrset
|
||||
sets the attributes of
|
||||
.Dv stdscr
|
||||
to those specified in
|
||||
.Fa attr ,
|
||||
turning off any others.
|
||||
To turn off all the attributes (including color and alternate character set),
|
||||
use
|
||||
.Fn attrset A_NORMAL \.
|
||||
.Pp
|
||||
Multiple attributes can be manipulated by combining the attributes
|
||||
using a logical
|
||||
.Em OR .
|
||||
For example,
|
||||
.Fn attron "A_REVERSE | A_BOLD"
|
||||
will turn on both inverse video and higher intensity.
|
||||
.Pp
|
||||
The functions
|
||||
.Fn wattron ,
|
||||
.Fn wattroff
|
||||
and
|
||||
.Fn wattrset
|
||||
are equivalent to
|
||||
.Fn attron ,
|
||||
.Fn attroff
|
||||
and
|
||||
.Fn attrset ,
|
||||
respectively, excepting that the character is added to the window specified by
|
||||
.Fa win .
|
||||
.Pp
|
||||
The function
|
||||
.Fn getattrs
|
||||
returns the attributes that are currently applied to window specified by
|
||||
.Fa win .
|
||||
.Sh RETURN VALUES
|
||||
These functions return OK on success and ERR on failure.
|
||||
.Sh SEE ALSO
|
||||
.Xr curses_addch 3 ,
|
||||
.Xr curses_addstr 3 ,
|
||||
.Xr curses_background 3 ,
|
||||
.Xr curses_color 3 ,
|
||||
.Xr curses_insertch 3 ,
|
||||
.Xr curses_standout 3 ,
|
||||
.Xr curses_underscore 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nx
|
||||
Curses library complies with the X/Open Curses specification, part of the
|
||||
Single Unix Specification.
|
||||
.Sh HISTORY
|
||||
These functions first appeared in
|
||||
.Nx 1.5 .
|
||||
.Sh BUGS
|
||||
Some terminals do not support characters with both color and other attributes
|
||||
set.
|
||||
In this case, the other attribute is displayed instead of the color attribute.
|
||||
116
lib/libcurses/curses_background.3
Normal file
116
lib/libcurses/curses_background.3
Normal file
@ -0,0 +1,116 @@
|
||||
.\" $NetBSD: curses_background.3,v 1.1 2002/10/21 13:55:10 blymn Exp $
|
||||
.\" Copyright (c) 2002 The NetBSD Foundation, Inc.
|
||||
.\" All rights reserved.
|
||||
.\"
|
||||
.\" This code is derived from software contributed to The NetBSD Foundation
|
||||
.\" by Julian Coleman.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\" 3. Neither the name of The NetBSD Foundation nor the names of its
|
||||
.\" contributors may be used to endorse or promote products derived
|
||||
.\" from this software without specific prior written permission.
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
|
||||
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
|
||||
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
|
||||
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
|
||||
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
|
||||
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
||||
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
|
||||
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
.\" POSSIBILITY OF SUCH DAMAGE.
|
||||
.\"
|
||||
.Dd October 13, 2002
|
||||
.Dt CURSES_BACKGROUND 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm curses_background ,
|
||||
.Nm bkgd ,
|
||||
.Nm bkgdset ,
|
||||
.Nm getbkgd ,
|
||||
.Nm wbkgd ,
|
||||
.Nm wbkgdset
|
||||
.Nd curses attribute manipulation routines
|
||||
.Sh LIBRARY
|
||||
.Lb libcurses
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include \*[Lt]curses.h\*[Gt]
|
||||
.Ft int
|
||||
.Fn bkgd chtype
|
||||
.Ft int
|
||||
.Fn bkgdset chtype
|
||||
.Ft chtype
|
||||
.Fn getbkgd "WINDOW *"
|
||||
.Ft int
|
||||
.Fn wbkgd chtype
|
||||
.Ft int
|
||||
.Fn wbkgdset chtype
|
||||
.Sh DESCRIPTION
|
||||
These functions manipulate the background attributes on
|
||||
.Dv stdscr
|
||||
or on the specified window.
|
||||
.Pp
|
||||
The function
|
||||
.Fn wbkgdset win ch
|
||||
sets the background attributes of the specified window
|
||||
.Fa win
|
||||
to
|
||||
.Fa ch .
|
||||
.Pp
|
||||
The function
|
||||
.Fn wbkgd win ch
|
||||
sets the background attributes of the specified window
|
||||
.Fa win
|
||||
to
|
||||
.Fa ch
|
||||
and also sets the background attribute of every character position on that
|
||||
window.
|
||||
.Pp
|
||||
The functions
|
||||
.Fn bkgdset ch
|
||||
and
|
||||
.Fn bkgd ch
|
||||
are equivalent to
|
||||
.Fn wbkgdset stdscr ch
|
||||
and
|
||||
.Fn wbkgd stdscr ch ,
|
||||
respectively.
|
||||
.Pp
|
||||
When the background attributes are set on a window, characters are rendered
|
||||
with the logical
|
||||
.Em OR
|
||||
of the background attributes and the character's attributes.
|
||||
If both the background attribute and the character attribute contain color,
|
||||
the color of the character attribute is displayed.
|
||||
If the background attribute contains a non-space character, then this
|
||||
character is rendered where the foreground character is a space character.
|
||||
.Pp
|
||||
The function
|
||||
.Fn getbkgd win
|
||||
returns the background attributes for the window
|
||||
.Fa win .
|
||||
.Sh RETURN VALUES
|
||||
The functions
|
||||
.Fn wbkgdset
|
||||
and
|
||||
.Fn wbkgd
|
||||
return OK on success and ERR on failure.
|
||||
.Sh SEE ALSO
|
||||
.Xr curses_attributes 3 ,
|
||||
.Xr curses_color 3 ,
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nx
|
||||
Curses library complies with the X/Open Curses specification, part of the
|
||||
Single Unix Specification.
|
||||
.Sh HISTORY
|
||||
These functions first appeared in
|
||||
.Nx 1.6 .
|
||||
159
lib/libcurses/curses_border.3
Normal file
159
lib/libcurses/curses_border.3
Normal file
@ -0,0 +1,159 @@
|
||||
.\" $NetBSD: curses_border.3,v 1.1 2002/10/21 13:55:10 blymn Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2002
|
||||
.\" Brett Lymn (blymn@netbsd.org, brett_lymn@yahoo.com.au)
|
||||
.\"
|
||||
.\" This code is donated to the NetBSD Foundation by the Author.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\" 3. The name of the Author may not be used to endorse or promote
|
||||
.\" products derived from this software without specific prior written
|
||||
.\" permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\"
|
||||
.Dd August 12, 2002
|
||||
.Dt CURSES_BORDER 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm curses_border ,
|
||||
.Nm border ,
|
||||
.Nm box ,
|
||||
.Nm wborder
|
||||
.Nd curses border drawing routines
|
||||
.Sh LIBRARY
|
||||
.Lb libcurses
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include \*[Lt]curses.h\*[Gt]
|
||||
.Ft int
|
||||
.Fo border
|
||||
.Fa "chtype ls"
|
||||
.Fa "chtype rs"
|
||||
.Fa "chtype ts"
|
||||
.Fa "chtype bs"
|
||||
.Fa "chtype tl"
|
||||
.Fa "chtype tr"
|
||||
.Fa "chtype bl"
|
||||
.Fa "chtype br"
|
||||
.Fc
|
||||
.Ft int
|
||||
.Fn box "WINDOW *win" "chtype vertical" "chtype horizontal"
|
||||
.Ft int
|
||||
.Fo wborder
|
||||
.Fa "WINDOW *win"
|
||||
.Fa "chtype ls"
|
||||
.Fa "chtype rs"
|
||||
.Fa "chtype ts"
|
||||
.Fa "chtype bs"
|
||||
.Fa "chtype tl"
|
||||
.Fa "chtype tr"
|
||||
.Fa "chtype bl"
|
||||
.Fa "chtype br"
|
||||
.Fc
|
||||
.Sh DESCRIPTION
|
||||
These functions draw borders around
|
||||
.Dv stdscr
|
||||
or around the specified window.
|
||||
.Pp
|
||||
The
|
||||
.Fn border
|
||||
function draws a border around
|
||||
.Dv stdscr
|
||||
using the characters given as arguments to the function.
|
||||
The
|
||||
.Fa ls ,
|
||||
.Fa rs ,
|
||||
.Fa ts
|
||||
and
|
||||
.Fa bs
|
||||
are the characters used to draw the left, right, top and bottom sides,
|
||||
respectively.
|
||||
The
|
||||
.Fa tl ,
|
||||
.Fa tr ,
|
||||
.Fa bl
|
||||
and
|
||||
.Fa br
|
||||
are the characters used to draw the top-left, top-right, bottom-left
|
||||
and bottom-right corners, respectively.
|
||||
If any of the characters have a text portion that is 0 then a default
|
||||
alternate character set character is used for that character.
|
||||
Note that even though the text portion of the argument is 0, the argument
|
||||
can still be used to specify the attributes for that portion of the border.
|
||||
The following table shows the default characters for each argument:
|
||||
.Pp
|
||||
.Bl -column "ls" -offset indent
|
||||
.It ls ACS_VLINE
|
||||
.It rs ACS_VLINE
|
||||
.It ts ACS_HLINE
|
||||
.It bs ACS_HLINE
|
||||
.It tl ACS_ULCORNER
|
||||
.It tr ACS_URCORNER
|
||||
.It bl ACS_LLCORNER
|
||||
.It br ACS_LRCORNER
|
||||
.El
|
||||
.Pp
|
||||
.Fn wborder
|
||||
is the same as
|
||||
.Fn border
|
||||
excepting that the border is drawn around the specified window.
|
||||
.Pp
|
||||
The
|
||||
.Fn box
|
||||
command draws a box around the window given in
|
||||
.Fa win
|
||||
using the
|
||||
.Fa vertical
|
||||
character for the vertical lines and the
|
||||
.Fa horiztonal
|
||||
character for the horizontal lines.
|
||||
The corner characters of this box will be the defaults as described for
|
||||
.Fn border
|
||||
above.
|
||||
Passing characters with text portion that is 0 to
|
||||
.Fn box
|
||||
will result in the same defaults as those for
|
||||
.Fn border
|
||||
as described above.
|
||||
.Sh RETURN VALUES
|
||||
Functions returning pointers will return
|
||||
.Dv NULL
|
||||
if an error is detected.
|
||||
The functions that return an int will return one of the following
|
||||
values:
|
||||
.Pp
|
||||
.Bl -tag -width ERR -compact
|
||||
.It Er OK
|
||||
The function completed successfully.
|
||||
.It Er ERR
|
||||
An error occurred in the function.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr curses_attributes 3 ,
|
||||
.Xr curses_line 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nx
|
||||
Curses library complies with the X/Open Curses specification, part of the
|
||||
Single Unix Specification.
|
||||
.Sh HISTORY
|
||||
The Curses package appeared in
|
||||
.Bx 4.0 .
|
||||
141
lib/libcurses/curses_clear.3
Normal file
141
lib/libcurses/curses_clear.3
Normal file
@ -0,0 +1,141 @@
|
||||
.\" $NetBSD: curses_clear.3,v 1.1 2002/10/21 13:55:11 blymn Exp $
|
||||
.\"
|
||||
.\" Copyright (c) 2002
|
||||
.\" Brett Lymn (blymn@netbsd.org, brett_lymn@yahoo.com.au)
|
||||
.\"
|
||||
.\" This code is donated to the NetBSD Foundation by the Author.
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
.\" are met:
|
||||
.\" 1. Redistributions of source code must retain the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer.
|
||||
.\" 2. Redistributions in binary form must reproduce the above copyright
|
||||
.\" notice, this list of conditions and the following disclaimer in the
|
||||
.\" documentation and/or other materials provided with the distribution.
|
||||
.\" 3. The name of the Author may not be used to endorse or promote
|
||||
.\" products derived from this software without specific prior written
|
||||
.\" permission.
|
||||
.\"
|
||||
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
|
||||
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
||||
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
|
||||
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
||||
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
||||
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
||||
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
||||
.\" SUCH DAMAGE.
|
||||
.\"
|
||||
.\"
|
||||
.Dd August 12, 2002
|
||||
.Dt CURSES_CLEAR 3
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm curses_clear ,
|
||||
.Nm clear ,
|
||||
.Nm wclear ,
|
||||
.Nm clearok ,
|
||||
.Nm clrtobot ,
|
||||
.Nm clrtoeol ,
|
||||
.Nm erase ,
|
||||
.Nm werase ,
|
||||
.Nm wclrtobot ,
|
||||
.Nm wclrtoeol
|
||||
.Nd curses clear window routines
|
||||
.Sh LIBRARY
|
||||
.Lb libcurses
|
||||
.Sh SYNOPSIS
|
||||
.Fd #include \*[Lt]curses.h\*[Gt]
|
||||
.Ft int
|
||||
.Fn clear "void"
|
||||
.Ft int
|
||||
.Fn clearok "WINDOW *win" "bool flag"
|
||||
.Ft int
|
||||
.Fn clrtobot "void"
|
||||
.Ft int
|
||||
.Fn clrtoeol "void"
|
||||
.Ft int
|
||||
.Fn erase "void"
|
||||
.Ft int
|
||||
.Fn wclear "WINDOW *win"
|
||||
.Ft int
|
||||
.Fn werase "WINDOW *win"
|
||||
.Ft int
|
||||
.Fn wclrtobot "WINDOW *win"
|
||||
.Ft int
|
||||
.Fn wclrtoeol "WINDOW *win"
|
||||
.Sh DESCRIPTION
|
||||
These functions clear all or part of
|
||||
.Dv stdscr
|
||||
or of the specified window.
|
||||
.Pp
|
||||
The
|
||||
.Fn clear
|
||||
and
|
||||
.Fn erase
|
||||
functions erase all characters on
|
||||
.Dv stdscr .
|
||||
.Fn wclear
|
||||
and
|
||||
.Fn werase
|
||||
perform the same function as
|
||||
.Fn clear
|
||||
and
|
||||
.Fn erase ,
|
||||
respectively, excepting that the specified window is cleared.
|
||||
.Pp
|
||||
By setting
|
||||
.Fa flag
|
||||
to
|
||||
.Dv TRUE ,
|
||||
the
|
||||
.Fn clearok
|
||||
function is used to force the next call to
|
||||
.Fn wrefresh
|
||||
to clear and completely redraw the window given in
|
||||
.Fa win .
|
||||
.Pp
|
||||
The function
|
||||
.Fn clrtobot
|
||||
will clear
|
||||
.Dv stdscr
|
||||
from the current row to the bottom of the screen.
|
||||
.Fn clrtoeol
|
||||
will clear
|
||||
.Dv stdscr
|
||||
from the current column position to the end of the line.
|
||||
.Fn wclrtobot
|
||||
and
|
||||
.Fn wclrtoeol
|
||||
are the same as
|
||||
.Fn clrtobot
|
||||
and
|
||||
.Fn clrtoeol ,
|
||||
respectively, excepting the window specified is operated on instead of
|
||||
.Dv stdscr .
|
||||
.Sh RETURN VALUES
|
||||
Functions returning pointers will return
|
||||
.Dv NULL
|
||||
if an error is detected.
|
||||
The functions that return an int will return one of the following
|
||||
values:
|
||||
.Pp
|
||||
.Bl -tag -width ERR -compact
|
||||
.It Er OK
|
||||
The function completed successfully.
|
||||
.It Er ERR
|
||||
An error occurred in the function.
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr curses_refresh 3
|
||||
.Sh STANDARDS
|
||||
The
|
||||
.Nx
|
||||
Curses library complies with the X/Open Curses specification, part of the
|
||||
Single Unix Specification.
|
||||
.Sh HISTORY
|
||||
The Curses package appeared in
|
||||
.Bx 4.0 .
|
||||
Loading…
Reference in New Issue
Block a user