xref: /illumos-gate/usr/src/man/man3lib/libcurses.3lib (revision bbf215553c7233fbab8a0afdf1fac74c44781867)
te
Copyright 2011 Nexenta Systems, Inc. All rights reserved.
Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]

LIBCURSES 3LIB "May 13, 2017"
NAME
libcurses, libtermcap, libtermlib - screen handling and optimization library
SYNOPSIS

cc [ flag... ] file... -lcurses [ library... ]
DESCRIPTION

Functions in the libcurses library provide a terminal-independent method of updating character screens with reasonable optimization.

The libtermcap library is a "filter" on libcurses that provides the traditional BSD-style termcap functions, and does so in a way that allows the consuming library or application to link with an alternate curses library.

The libtermlib library is identical to libcurses and is maintained for backward compatibility.

See libcurses(3XCURSES) for information about the curses library that conforms to X/Open Curses, Issue 4, Version 2.

INTERFACES

The shared objects libcurses.so.1 and libtermlib.so.1 provide the public interfaces defined below. See Intro(3) for additional information on shared object interfaces.

_getsyx _meta
_ring _setecho
_setnonl _setqiflush
addch addchnstr
addchstr addnstr
addnwstr addstr
addwch addwchnstr
addwchstr addwstr
attroff attron
attrset baudrate
beep bkgd
bkgdset border
box can_change_color
cbreak clear
clearok clrtobot
clrtoeol color_content
copywin crmode
curs_set curserr
def_prog_mode def_shell_mode
del_curterm delay_output
delch deleteln
delkeymap delscreen
delwin derwin
doupdate dupwin
echo echochar
echowchar endwin
erase erasechar
filter flash
flushinp getbmap
getch getmouse
getnwstr getstr
getwch getwin
getwstr halfdelay
has_colors has_ic
has_il idcok
idlok immedok
inch inchnstr
inchstr init_color
init_pair initscr
innstr innwstr
insch insdelln
insertln insnstr
insnwstr insstr
instr inswch
inswstr intrflush
inwch inwchnstr
inwchstr inwstr
is_linetouched is_wintouched
isendwin keyname
keypad killchar
leaveok longname
m_addch m_addstr
m_clear m_erase
m_initscr m_move
m_newterm m_refresh
map_button meta
mouse_off mouse_on
mouse_set move
mvaddch mvaddchnstr
mvaddchstr mvaddnstr
mvaddnwstr mvaddstr
mvaddwch mvaddwchnstr
mvaddwchstr mvaddwstr
mvcur mvdelch
mvderwin mvgetch
mvgetnwstr mvgetstr
mvgetwch mvgetwstr
mvinch mvinchnstr
mvinchstr mvinnstr
mvinnwstr mvinsch
mvinsnstr mvinsnwstr
mvinsstr mvinstr
mvinswch mvinswstr
mvinwch mvinwchnstr
mvinwchstr mvinwstr
mvprintw mvscanw
mvwaddch mvwaddchnstr
mvwaddchstr mvwaddnstr
mvwaddnwstr mvwaddstr
mvwaddwch mvwaddwchnstr
mvwaddwchstr mvwaddwstr
mvwdelch mvwgetch
mvwgetnwstr mvwgetstr
mvwgetwch mvwgetwstr
mvwin mvwinch
mvwinchnstr mvwinchstr
mvwinnstr mvwinnwstr
mvwinsch mvwinsnstr
mvwinsnwstr mvwinsstr
mvwinstr mvwinswch
mvwinswstr mvwinwch
mvwinwchnstr mvwinwchstr
mvwinwstr mvwprintw
mvwscanw napms
newkey newpad
newscreen newterm
newwin nl
nocbreak nocrmode
nodelay noecho
nonl noqiflush
noraw notimeout
overlay overwrite
pair_content pechochar
pechowchar pnoutrefresh
prefresh printw
putp putwin
qiflush raw
redrawwin refresh
request_mouse_pos reset_prog_mode
reset_shell_mode resetty
restartterm ripoffline
savetty scanw
scr_dump scr_init
scr_restore scr_set
scrl scroll
scrollok set_term
setcurscreen setscrreg
setsyx setterm
setupterm slk_attroff
slk_attron slk_attrset
slk_clear slk_init
slk_label slk_noutrefresh
slk_refresh slk_restore
slk_set slk_start
slk_touch standend
standout start_color
subpad subwin
syncok termattrs
termname tgetent
tgetflag tgetnum
tgetstr tgoto
tigetflag tigetnum
tigetstr timeout
touchline touchwin
tparm tputs
traceoff traceon
typeahead unctrl
ungetch ungetwch
untouchwin vidattr
vidputs vidupdate
vwprintw vwscanw
waddch waddchnstr
waddchstr waddnstr
waddnwstr waddstr
waddwch waddwchnstr
waddwchstr waddwstr
wadjcurspos wattroff
wattron wattrset
wbkgd wbkgdset
wborder wclear
wclrtobot wclrtoeol
wcursyncup wdelch
wdeleteln wechochar
wechowchar werase
wgetch wgetnstr
wgetnwstr wgetstr
wgetwch wgetwstr
whline winch
winchnstr winchstr
winnstr winnwstr
winsch winsdelln
winsertln winsnstr
winsnwstr winsstr
winstr winswch
winswstr winwch
winwchnstr winwchstr
winwstr wmouse_position
wmove wmovenextch
wmoveprevch wnoutrefresh
wprintw wredrawln
wrefresh wscanw
wscrl wsetscrreg
wstandend wstandout
wsyncdown wsyncup
wtimeout wtouchln
wvline

The shared object libtermcap.so.1 provides the traditional BSD-style interfaces defined below:

tgetent
tgetflag
tgetnum
tgetstr
tgoto
tputs
FILES
/lib/libcurses.so.1

shared object

/lib/64/libcurses.so.1

64-bit shared object

/lib/libtermcap.so.1

shared object (symbolic link to /lib/libcurses.so.1)

/lib/64/libtermcap.so.1

64-bit shared object (symbolic link to /lib/64/libcurses.so.1)

/lib/libtermlib.so.1

shared object (symbolic link to /lib/libcurses.so.1)

/lib/64/libtermlib.so.1

64-bit shared object (symbolic link to /lib/64/libcurses.so.1)

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

Intro (3), curses (3CURSES), libcurses (3XCURSES), attributes (7)