libcurses - man pages section 3: Curses Library Functions

Language:

libcurses(3XCURSES)

Name

libcurses - X/Open Curses library

Synopsis

cc [ flag... ] file... –I /usr/xpg4/include –L /usr/xpg4/lib \
–R /usr/xpg4/lib –lcurses [ library... ]

c89 [ flag... ] file... –lcurses [ library... ]

#include <curses.h>

Description

Functions in this library provide a terminal-independent method of updating character screens with reasonable optimization, conforming to X/Open Curses, Issue 4, Version 2.

INTERFACES

The shared object libcurses.so.2 provides the public interfaces defined below. See Intro(3) for additional information on shared object interfaces.

`COLORS`	`COLOR_PAIR`
`COLOR_PAIRS`	`COLS`
`LINES`	`PAIR_NUMBER`
`add_wch`	`add_wchnstr`
`add_wchstr`	`addch`
`addchnstr`	`addchstr`
`addnstr`	`addnwstr`
`addstr`	`addwstr`
`attr_get`	`attr_off`
`attr_on`	`attr_set`
`attroff`	`attron`
`attrset`	`baudrate`
`beep`	`bkgd`
`bkgdset`	`bkgrnd`
`bkgrndset`	`border`
`border_set`	`box`
`box_set`	`can_change_color`
`cbreak`	`chgat`
`clear`	`clearok`
`clrtobot`	`clrtoeol`
`color_content`	`color_set`
`copywin`	`cur_term`
`curs_set`	`curscr`
`def_prog_mode`	`def_shell_mode`
`del_curterm`	`delay_output`
`delch`	`deleteln`
`delscreen`	`delwin`
`derwin`	`doupdate`
`dupwin`	`echo`
`echo_wchar`	`echochar`
`endwin`	`erase`
`erasechar`	`erasewchar`
`filter`	`flash`
`flushinp`	`get_wch`
`get_wstr`	`getbkgd`
`getbkgrnd`	`getcchar`
`getch`	`getn_wstr`
`getnstr`	`getstr`
`getwin`	`halfdelay`
`has_colors`	`has_ic`
`has_il`	`hline`
`hline_set`	`idcok`
`idlok`	`immedok`
`in_wch`	`in_wchnstr`
`in_wchstr`	`inch`
`inchnstr`	`inchstr`
`init_color`	`init_pair`
`initscr`	`innstr`
`innwstr`	`ins_nwstr`
`ins_wch`	`ins_wstr`
`insch`	`insdelln`
`insertln`	`insnstr`
`insstr`	`instr`
`intrflush`	`inwstr`
`is_linetouched`	`is_wintouched`
`isendwin`	`key_name`
`keyname`	`keypad`
`killchar`	`killwchar`
`leaveok`	`longname`
`meta`	`move`
`mvadd_wch`	`mvadd_wchnstr`
`mvadd_wchstr`	`mvaddch`
`mvaddchnstr`	`mvaddchstr`
`mvaddnstr`	`mvaddnwstr`
`mvaddstr`	`mvaddwstr`
`mvchgat`	`mvcur`
`mvdelch`	`mvderwin`
`mvget_wch`	`mvget_wstr`
`mvgetch`	`mvgetn_wstr`
`mvgetnstr`	`mvgetstr`
`mvhline`	`mvhline_set`
`mvin_wch`	`mvin_wchnstr`
`mvin_wchstr`	`mvinch`
`mvinchnstr`	`mvinchstr`
`mvinnstr`	`mvinnwstr`
`mvins_nwstr`	`mvins_wch`
`mvins_wstr`	`mvinsch`
`mvinsnstr`	`mvinsstr`
`mvinstr`	`mvinwstr`
`mvprintw`	`mvscanw`
`mvvline`	`mvvline_set`
`mvwadd_wch`	`mvwadd_wchnstr`
`mvwadd_wchstr`	`mvwaddch`
`mvwaddchnstr`	`mvwaddchstr`
`mvwaddnstr`	`mvwaddnwstr`
`mvwaddstr`	`mvwaddwstr`
`mvwchgat`	`mvwdelch`
`mvwget_wch`	`mvwget_wstr`
`mvwgetch`	`mvwgetn_wstr`
`mvwgetnstr`	`mvwgetstr`
`mvwhline`	`mvwhline_set`
`mvwin`	`mvwin_wch`
`mvwin_wchnstr`	`mvwin_wchstr`
`mvwinch`	`mvwinchnstr`
`mvwinchstr`	`mvwinnstr`
`mvwinnwstr`	`mvwins_nwstr`
`mvwins_wch`	`mvwins_wstr`
`mvwinsch`	`mvwinsnstr`
`mvwinsstr`	`mvwinstr`
`mvwinwstr`	`mvwprintw`
`mvwscanw`	`mvwvline`
`mvwvline_set`	`napms`
`newpad`	`newterm`
`newwin`	`nl`
`nocbreak`	`nodelay`
`noecho`	`nonl`
`noqiflush`	`noraw`
`notimeout`	`overlay`
`overwrite`	`pair_content`
`pecho_wchar`	`pechochar`
`pnoutrefresh`	`prefresh`
`printw`	`putp`
`putwin`	`qiflush`
`raw`	`redrawwin`
`refresh`	`reset_prog_mode`
`reset_shell_mode`	`resetty`
`restartterm`	`ripoffline`
`savetty`	`scanw`
`scr_dump`	`scr_init`
`scr_restore`	`scr_set`
`scrl`	`scroll`
`scrollok`	`set_curterm`
`set_term`	`setcchar`
`setscrreg`	`setupterm`
`slk_attr_off`	`slk_attr_on`
`slk_attr_set`	`slk_attroff`
`slk_attron`	`slk_attrset`
`slk_clear`	`slk_color`
`slk_init`	`slk_label`
`slk_noutrefresh`	`slk_refresh`
`slk_restore`	`slk_set`
`slk_touch`	`slk_wset`
`standend`	`standout`
`start_color`	`stdscr`
`subpad`	`subwin`
`syncok`	`term_attrs`
`termattrs`	`termname`
`tgetent`	`tgetflag`
`tgetnum`	`tgetstr`
`tgoto`	`tigetflag`
`tigetnum`	`tigetstr`
`timeout`	`touchline`
`touchwin`	`tparm`
`tputs`	`typeahead`
`unctrl`	`unget_wch`
`ungetch`	`untouchwin`
`use_env`	`vid_attr`
`vid_puts`	`vidattr`
`vidputs`	`vline`
`vline_set`	`vw_printw`
`vw_scanw`	`vwprintw`
`vwscanw`	`wadd_wch`
`wadd_wchnstr`	`wadd_wchstr`
`waddch`	`waddchnstr`
`waddchstr`	`waddnstr`
`waddnwstr`	`waddstr`
`waddwstr`	`wattr_get`
`wattr_off`	`wattr_on`
`wattr_set`	`wattroff`
`wattron`	`wattrset`
`wbkgd`	`wbkgdset`
`wbkgrnd`	`wbkgrndset`
`wborder`	`wborder_set`
`wchgat`	`wclear`
`wclrtobot`	`wclrtoeol`
`wcolor_set`	`wcursyncup`
`wdelch`	`wdeleteln`
`wecho_wchar`	`wechochar`
`werase`	`wget_wch`
`wget_wstr`	`wgetbkgrnd`
`wgetch`	`wgetn_wstr`
`wgetnstr`	`wgetstr`
`whline`	`whline_set`
`win_wch`	`win_wchnstr`
`win_wchstr`	`winch`
`winchnstr`	`winchstr`
`winnstr`	`winnwstr`
`wins_nwstr`	`wins_wch`
`wins_wstr`	`winsch`
`winsdelln`	`winsertln`
`winsnstr`	`winsstr`
`winstr`	`winwstr`
`wmove`	`wnoutrefresh`
`wprintw`	`wredrawln`
`wrefresh`	`wscanw`
`wscrl`	`wsetscrreg`
`wstandend`	`wstandout`
`wsyncdown`	`wsyncup`
`wtimeout`	`wtouchln`
`wunctrl`	`wvline`
`wvline_set`

Files

/usr/xpg4/lib/libcurses.so.1: shared object for backward compatibility
/usr/xpg4/lib/libcurses.so.2: shared object
/usr/xpg4/lib/64/libcurses.so.1: 64-bit shared object for backward compatibility
/usr/xpg4/lib/64/libcurses.so.2: 64-bit shared object

Notes

The libcurses.so.1 listed above is an earlier shared object that provides the previous version of the X/Open Curses library (Issue 4). There is no binary compatiblity between libcurses.so.1 and libcurses.so.2. This file is provided for backwards compatiblity and will be removed in a future Solaris release. There is no plan to fix any of its defects.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	system/library
Interface Stability	Committed
MT-Level	Unsafe
Standard	See `standards`(5).