xref: /titanic_50/usr/src/man/man3lib/libcurses.3lib (revision 6b817808e8a80c4e9c93850856065502cc48f7ad)
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 "24 Mar 2004" "SunOS 5.11" "Interface Libraries"
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
addchaddchnstr
addchstraddnstr
addnwstraddstr
addwchaddwchnstr
addwchstraddwstr
attroffattron
attrsetbaudrate
beepbkgd
bkgdsetborder
boxcan_change_color
cbreakclear
clearokclrtobot
clrtoeolcolor_content
copywincrmode
curs_setcurserr
def_prog_modedef_shell_mode
del_curtermdelay_output
delchdeleteln
delkeymapdelscreen
delwinderwin
doupdatedupwin
echoechochar
echowcharendwin
eraseerasechar
filterflash
flushinpgetbmap
getchgetmouse
getnwstrgetstr
getwchgetwin
getwstrhalfdelay
has_colorshas_ic
has_ilidcok
idlokimmedok
inchinchnstr
inchstrinit_color
init_pairinitscr
innstrinnwstr
inschinsdelln
insertlninsnstr
insnwstrinsstr
instrinswch
inswstrintrflush
inwchinwchnstr
inwchstrinwstr
is_linetouchedis_wintouched
isendwinkeyname
keypadkillchar
leaveoklongname
m_addchm_addstr
m_clearm_erase
m_initscrm_move
m_newtermm_refresh
map_buttonmeta
mouse_offmouse_on
mouse_setmove
mvaddchmvaddchnstr
mvaddchstrmvaddnstr
mvaddnwstrmvaddstr
mvaddwchmvaddwchnstr
mvaddwchstrmvaddwstr
mvcurmvdelch
mvderwinmvgetch
mvgetnwstrmvgetstr
mvgetwchmvgetwstr
mvinchmvinchnstr
mvinchstrmvinnstr
mvinnwstrmvinsch
mvinsnstrmvinsnwstr
mvinsstrmvinstr
mvinswchmvinswstr
mvinwchmvinwchnstr
mvinwchstrmvinwstr
mvprintwmvscanw
mvwaddchmvwaddchnstr
mvwaddchstrmvwaddnstr
mvwaddnwstrmvwaddstr
mvwaddwchmvwaddwchnstr
mvwaddwchstrmvwaddwstr
mvwdelchmvwgetch
mvwgetnwstrmvwgetstr
mvwgetwchmvwgetwstr
mvwinmvwinch
mvwinchnstrmvwinchstr
mvwinnstrmvwinnwstr
mvwinschmvwinsnstr
mvwinsnwstrmvwinsstr
mvwinstrmvwinswch
mvwinswstrmvwinwch
mvwinwchnstrmvwinwchstr
mvwinwstrmvwprintw
mvwscanwnapms
newkeynewpad
newscreennewterm
newwinnl
nocbreaknocrmode
nodelaynoecho
nonlnoqiflush
norawnotimeout
overlayoverwrite
pair_contentpechochar
pechowcharpnoutrefresh
prefreshprintw
putpputwin
qiflushraw
redrawwinrefresh
request_mouse_posreset_prog_mode
reset_shell_moderesetty
restarttermripoffline
savettyscanw
scr_dumpscr_init
scr_restorescr_set
scrlscroll
scrollokset_term
setcurscreensetscrreg
setsyxsetterm
setuptermslk_attroff
slk_attronslk_attrset
slk_clearslk_init
slk_labelslk_noutrefresh
slk_refreshslk_restore
slk_setslk_start
slk_touchstandend
standoutstart_color
subpadsubwin
syncoktermattrs
termnametgetent
tgetflagtgetnum
tgetstrtgoto
tigetflagtigetnum
tigetstrtimeout
touchlinetouchwin
tparmtputs
traceofftraceon
typeaheadunctrl
ungetchungetwch
untouchwinvidattr
vidputsvidupdate
vwprintwvwscanw
waddchwaddchnstr
waddchstrwaddnstr
waddnwstrwaddstr
waddwchwaddwchnstr
waddwchstrwaddwstr
wadjcursposwattroff
wattronwattrset
wbkgdwbkgdset
wborderwclear
wclrtobotwclrtoeol
wcursyncupwdelch
wdeletelnwechochar
wechowcharwerase
wgetchwgetnstr
wgetnwstrwgetstr
wgetwchwgetwstr
whlinewinch
winchnstrwinchstr
winnstrwinnwstr
winschwinsdelln
winsertlnwinsnstr
winsnwstrwinsstr
winstrwinswch
winswstrwinwch
winwchnstrwinwchstr
winwstrwmouse_position
wmovewmovenextch
wmoveprevchwnoutrefresh
wprintwwredrawln
wrefreshwscanw
wscrlwsetscrreg
wstandendwstandout
wsyncdownwsyncup
wtimeoutwtouchln
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(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelUnsafe
SEE ALSO

Intro(3), curses(3CURSES), libcurses(3LIBUCB), libcurses(3XCURSES), attributes(5)