The cl-ncurses Reference Manual

Table of Contents

The cl-ncurses Reference Manual

This is the cl-ncurses Reference Manual, version 0.1.4, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:24:47 2020 GMT+0.

1 Introduction

CL-Ncurses is a Ncurses interface for Common Lisp on Unix-platforms. It is 
licensed under a MIT-style license. CL-Ncurses uses UFFI for foreign bindings
and it is developed with SBCL on Debian GNU/Linux.

To use cl-ncurses:

 (require :uffi)
 (asdf:oos 'asdf:load-op 'cl-ncurses)

The organization of files corresponds to ncurses manual pages:
eg. functions described in initscr(3) are dealt with in initscr.lisp.

Types and convenience macros reside in package.lisp.
Ncurses's constants reside in constants.lisp.
Ncurses's variables reside in variables.lisp.

There are some tests in the "test" directory.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 cl-ncurses

Version

0.1.4

Dependency

uffi

Source

cl-ncurses.asd (file)

Components

• package.lisp (file)
• add_wch.lisp (file)
• add_wchstr.lisp (file)
• addch.lisp (file)
• addchstr.lisp (file)
• addstr.lisp (file)
• addwstr.lisp (file)
• attr.lisp (file)
• beep.lisp (file)
• bkgd.lisp (file)
• bkgrnd.lisp (file)
• border.lisp (file)
• border_set.lisp (file)
• clear.lisp (file)
• color.lisp (file)
• constants.lisp (file)
• default_colors.lisp (file)
• delch.lisp (file)
• deleteln.lisp (file)
• extensions.lisp (file)
• get_wch.lisp (file)
• get_wstr.lisp (file)
• getcchar.lisp (file)
• getch.lisp (file)
• getstr.lisp (file)
• getyx.lisp (file)
• in_wch.lisp (file)
• in_wchstr.lisp (file)
• inch.lisp (file)
• inchstr.lisp (file)
• initscr.lisp (file)
• inopts.lisp (file)
• ins_wch.lisp (file)
• ins_wstr.lisp (file)
• insch.lisp (file)
• insstr.lisp (file)
• instr.lisp (file)
• inwstr.lisp (file)
• kernel.lisp (file)
• keybound.lisp (file)
• keyok.lisp (file)
• key_defined.lisp (file)
• mouse.lisp (file)
• move.lisp (file)
• outopts.lisp (file)
• overlay.lisp (file)
• pad.lisp (file)
• print.lisp (file)
• printw.lisp (file)
• refresh.lisp (file)
• resizeterm.lisp (file)
• scanw.lisp (file)
• scr_dump.lisp (file)
• scroll.lisp (file)
• slk.lisp (file)
• termattrs.lisp (file)
• termcap.lisp (file)
• terminfo.lisp (file)
• touch.lisp (file)
• util.lisp (file)
• variables.lisp (file)
• window.lisp (file)
• wresize.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-ncurses.asd

Location

cl-ncurses.asd

Systems

cl-ncurses (system)

Packages

cl-ncurses-asd

3.1.2 cl-ncurses/package.lisp

Parent

cl-ncurses (system)

Location

package.lisp

Packages

cl-ncurses

Internal Definitions

• *ncurses-path* (special variable)
• *ncurses-search-paths* (special variable)
• *nullptr* (constant)
• def (macro)
• group (function)

3.1.3 cl-ncurses/add_wch.lisp

Dependencies

• package.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

add_wch.lisp

3.1.4 cl-ncurses/add_wchstr.lisp

Dependencies

• add_wch.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

add_wchstr.lisp

3.1.5 cl-ncurses/addch.lisp

Dependencies

• add_wchstr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

addch.lisp

Exported Definitions

• addch (function)
• echochar (function)
• mvaddch (function)
• mvwaddch (function)
• waddch (function)
• wechochar (function)

3.1.6 cl-ncurses/addchstr.lisp

Dependencies

• addch.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

addchstr.lisp

3.1.7 cl-ncurses/addstr.lisp

Dependencies

• addchstr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

addstr.lisp

Exported Definitions

• addnstr (function)
• addstr (function)
• mvaddnstr (function)
• mvaddstr (function)
• mvwaddnstr (function)
• mvwaddstr (function)
• waddnstr (function)
• waddstr (function)

3.1.8 cl-ncurses/addwstr.lisp

Dependencies

• addstr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

addwstr.lisp

3.1.9 cl-ncurses/attr.lisp

Dependencies

• addwstr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

attr.lisp

Exported Definitions

• attroff (function)
• attron (function)
• attrset (function)
• color-set (function)
• standend (function)
• standout (function)
• wattroff (function)
• wattron (function)
• wattrset (function)
• wcolor-set (function)
• wstandend (function)
• wstandout (function)

3.1.10 cl-ncurses/beep.lisp

Dependencies

• attr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

beep.lisp

Exported Definitions

• beep (function)
• flash (function)

3.1.11 cl-ncurses/bkgd.lisp

Dependencies

• beep.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

bkgd.lisp

Exported Definitions

• bkgd (function)
• bkgdset (function)
• getbkgd (function)
• wbkgd (function)
• wbkgdset (function)

3.1.12 cl-ncurses/bkgrnd.lisp

Dependencies

• bkgd.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

bkgrnd.lisp

3.1.13 cl-ncurses/border.lisp

Dependencies

• bkgrnd.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

border.lisp

Exported Definitions

• border (function)
• box (function)
• hline (function)
• mvhline (function)
• mvvline (function)
• mvwhline (function)
• mvwvline (function)
• vline (function)
• wborder (function)
• whline (function)
• wvline (function)

3.1.14 cl-ncurses/border_set.lisp

Dependencies

• border.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

border_set.lisp

3.1.15 cl-ncurses/clear.lisp

Dependencies

• border_set.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

clear.lisp

Exported Definitions

• clear (function)
• clrtobot (function)
• clrtoeol (function)
• erase (function)
• wclear (function)
• wclrtobot (function)
• wclrtoeol (function)
• werase (function)

3.1.16 cl-ncurses/color.lisp

Dependencies

• clear.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

color.lisp

Exported Definitions

• can-change-color (function)
• color-content (function)
• color-pair (function)
• has-colors (function)
• init-color (function)
• init-pair (function)
• pair-content (function)
• start-color (function)

3.1.17 cl-ncurses/constants.lisp

Dependencies

• color.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

constants.lisp

Exported Definitions

• a_altcharset (constant)
• a_attributes (constant)
• a_blink (constant)
• a_bold (constant)
• a_dim (constant)
• a_horizontal (constant)
• a_invis (constant)
• a_left (constant)
• a_low (constant)
• a_normal (constant)
• a_protect (constant)
• a_reverse (constant)
• a_right (constant)
• a_standout (constant)
• a_top (constant)
• a_underline (constant)
• a_vertical (constant)
• color_black (constant)
• color_blue (constant)
• color_cyan (constant)
• color_green (constant)
• color_magenta (constant)
• color_red (constant)
• color_white (constant)
• color_yellow (constant)
• err (constant)
• false (constant)
• key_resize (constant)
• ok (constant)
• true (constant)
• wa_altcharset (constant)
• wa_attributes (constant)
• wa_blink (constant)
• wa_bold (constant)
• wa_dim (constant)
• wa_horizontal (constant)
• wa_invis (constant)
• wa_left (constant)
• wa_low (constant)
• wa_normal (constant)
• wa_protect (constant)
• wa_reverse (constant)
• wa_right (constant)
• wa_standout (constant)
• wa_top (constant)
• wa_underline (constant)
• wa_vertical (constant)

Internal Definitions

• acs_btee (constant)
• acs_bullet (constant)
• acs_ckboard (constant)
• acs_degree (constant)
• acs_diamond (constant)
• acs_hline (constant)
• acs_llcorner (constant)
• acs_lrcorner (constant)
• acs_ltee (constant)
• acs_plminus (constant)
• acs_plus (constant)
• acs_rtee (constant)
• acs_s1 (constant)
• acs_s9 (constant)
• acs_ttee (constant)
• acs_ulcorner (constant)
• acs_urcorner (constant)
• acs_vline (constant)

3.1.18 cl-ncurses/default_colors.lisp

Dependencies

• constants.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

default_colors.lisp

Exported Definitions

• assume-default-colors (function)
• use-default-colors (function)

3.1.19 cl-ncurses/delch.lisp

Dependencies

• default_colors.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

delch.lisp

Exported Definitions

• delch (function)
• mvdelch (function)
• mvwdelch (function)
• wdelch (function)

3.1.20 cl-ncurses/deleteln.lisp

Dependencies

• delch.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

deleteln.lisp

Exported Definitions

• deleteln (function)
• insdelln (function)
• insertln (function)
• wdeleteln (function)
• winsdelln (function)
• winsertln (function)

3.1.21 cl-ncurses/extensions.lisp

Dependencies

• deleteln.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

extensions.lisp

Exported Definitions

• curses-version (function)
• use-extended-names (function)

3.1.22 cl-ncurses/get_wch.lisp

Dependencies

• extensions.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

get_wch.lisp

3.1.23 cl-ncurses/get_wstr.lisp

Dependencies

• get_wch.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

get_wstr.lisp

3.1.24 cl-ncurses/getcchar.lisp

Dependencies

• get_wstr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

getcchar.lisp

3.1.25 cl-ncurses/getch.lisp

Dependencies

• getcchar.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

getch.lisp

Exported Definitions

• getch (function)
• has-key (function)
• mvgetch (function)
• mvwgetch (function)
• ungetch (function)
• wgetch (function)

3.1.26 cl-ncurses/getstr.lisp

Dependencies

• getch.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

getstr.lisp

Exported Definitions

• getnstr (function)
• getstr (function)
• mvgetnstr (function)
• mvgetstr (function)
• mvwgetnstr (function)
• mvwgetstr (function)
• wgetnstr (function)
• wgetstr (function)

3.1.27 cl-ncurses/getyx.lisp

Dependencies

• getstr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

getyx.lisp

Exported Definitions

• get-begyx (function)
• get-maxyx (function)
• get-paryx (function)
• get-yx (function)
• getbegx (function)
• getbegy (function)
• getbegyx (macro)
• getcurx (function)
• getcury (function)
• getmaxx (function)
• getmaxy (function)
• getmaxyx (macro)
• getparx (function)
• getpary (function)
• getparyx (macro)
• getyx (macro)

Internal Definitions

• generate-getyx-macro (macro)
• generate-getyx-macros (macro)

3.1.28 cl-ncurses/in_wch.lisp

Dependencies

• getyx.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

in_wch.lisp

3.1.29 cl-ncurses/in_wchstr.lisp

Dependencies

• in_wch.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

in_wchstr.lisp

3.1.30 cl-ncurses/inch.lisp

Dependencies

• in_wchstr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

inch.lisp

Exported Definitions

• inch (function)
• mvinch (function)
• mvwinch (function)
• winch (function)

3.1.31 cl-ncurses/inchstr.lisp

Dependencies

• inch.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

inchstr.lisp

Exported Definitions

• inchnstr (function)
• inchstr (function)
• mvinchnstr (function)
• mvinchstr (function)
• mvwinchnstr (function)
• mvwinchstr (function)
• winchnstr (function)
• winchstr (function)

3.1.32 cl-ncurses/initscr.lisp

Dependencies

• inchstr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

initscr.lisp

Exported Definitions

• delscreen (function)
• endwin (function)
• initscr (function)
• isendwin (function)
• newterm (function)
• set-term (function)

3.1.33 cl-ncurses/inopts.lisp

Dependencies

• initscr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

inopts.lisp

Exported Definitions

• cbreak (function)
• echo (function)
• halfdelay (function)
• intrflush (function)
• keypad (function)
• meta (function)
• nocbreak (function)
• nodelay (function)
• noecho (function)
• noqiflush (function)
• noraw (function)
• notimeout (function)
• qiflush (function)
• raw (function)
• timeout (function)
• typeahead (function)
• wtimeout (function)

3.1.34 cl-ncurses/ins_wch.lisp

Dependencies

• inopts.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

ins_wch.lisp

3.1.35 cl-ncurses/ins_wstr.lisp

Dependencies

• ins_wch.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

ins_wstr.lisp

3.1.36 cl-ncurses/insch.lisp

Dependencies

• ins_wstr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

insch.lisp

Exported Definitions

• insch (function)
• mvinsch (function)
• mvwinsch (function)
• winsch (function)

3.1.37 cl-ncurses/insstr.lisp

Dependencies

• insch.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

insstr.lisp

Exported Definitions

• insnstr (function)
• insstr (function)
• mvinsnstr (function)
• mvinsstr (function)
• mvwinsnstr (function)
• mvwinsstr (function)
• winsnstr (function)
• winsstr (function)

3.1.38 cl-ncurses/instr.lisp

Dependencies

• insstr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

instr.lisp

Exported Definitions

• innstr (function)
• instr (function)
• mvinnstr (function)
• mvinstr (function)
• mvwinnstr (function)
• mvwinstr (function)
• winnstr (function)
• winstr (function)

3.1.39 cl-ncurses/inwstr.lisp

Dependencies

• instr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

inwstr.lisp

3.1.40 cl-ncurses/kernel.lisp

Dependencies

• inwstr.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

kernel.lisp

Exported Definitions

• curs-set (function)
• def-prog-mode (function)
• def-shell-mode (function)
• napms (function)
• reset-prog-mode (function)
• reset-shell-mode (function)
• resetty (function)
• savetty (function)

3.1.41 cl-ncurses/keybound.lisp

Dependencies

• kernel.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

keybound.lisp

Exported Definitions

keybound (function)

3.1.42 cl-ncurses/keyok.lisp

Dependencies

• keybound.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

keyok.lisp

Exported Definitions

keyok (function)

3.1.43 cl-ncurses/key_defined.lisp

Dependencies

• keyok.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

key_defined.lisp

3.1.44 cl-ncurses/mouse.lisp

Dependencies

• key_defined.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

mouse.lisp

3.1.45 cl-ncurses/move.lisp

Dependencies

• mouse.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

move.lisp

Exported Definitions

• move (function)
• wmove (function)

3.1.46 cl-ncurses/outopts.lisp

Dependencies

• move.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

outopts.lisp

Exported Definitions

• clearok (function)
• idcok (function)
• idlok (function)
• immedok (function)
• leaveok (function)
• nl (function)
• nonl (function)
• scrollok (function)
• setscrreg (function)
• wsetscrreg (function)

3.1.47 cl-ncurses/overlay.lisp

Dependencies

• outopts.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

overlay.lisp

Exported Definitions

• overlay (function)
• overwrite (function)

3.1.48 cl-ncurses/pad.lisp

Dependencies

• overlay.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

pad.lisp

Exported Definitions

• newpad (function)
• pechochar (function)
• pnoutrefresh (function)
• prefresh (function)
• subpad (function)

3.1.49 cl-ncurses/print.lisp

Dependencies

• pad.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

print.lisp

Exported Definitions

mcprint (function)

3.1.50 cl-ncurses/printw.lisp

Dependencies

• print.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

printw.lisp

Exported Definitions

• mvprintw (function)
• mvwprintw (function)
• printw (function)
• wprintw (function)

3.1.51 cl-ncurses/refresh.lisp

Dependencies

• printw.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

refresh.lisp

Exported Definitions

• doupdate (function)
• redrawwin (function)
• refresh (function)
• wnoutrefresh (function)
• wredrawln (function)
• wrefresh (function)

3.1.52 cl-ncurses/resizeterm.lisp

Dependencies

• refresh.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

resizeterm.lisp

Exported Definitions

• is-term-resized (function)
• resize-term (function)
• resizeterm (function)

3.1.53 cl-ncurses/scanw.lisp

Dependencies

• resizeterm.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

scanw.lisp

3.1.54 cl-ncurses/scr_dump.lisp

Dependencies

• scanw.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

scr_dump.lisp

Exported Definitions

• scr-dump (function)
• scr-init (function)
• scr-restore (function)
• scr-set (function)

3.1.55 cl-ncurses/scroll.lisp

Dependencies

• scr_dump.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

scroll.lisp

Exported Definitions

• scrl (function)
• scroll (function)
• wscrl (function)

3.1.56 cl-ncurses/slk.lisp

Dependencies

• scroll.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

slk.lisp

Exported Definitions

• slk-attroff (function)
• slk-attron (function)
• slk-attrset (function)
• slk-clear (function)
• slk-color (function)
• slk-init (function)
• slk-label (function)
• slk-noutrefresh (function)
• slk-refresh (function)
• slk-restore (function)
• slk-set (function)
• slk-touch (function)

3.1.57 cl-ncurses/termattrs.lisp

Dependencies

• slk.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

termattrs.lisp

Exported Definitions

• baudrate (function)
• erasechar (function)
• has-ic (function)
• has-il (function)
• killchar (function)
• longname (function)
• termattrs (function)
• termname (function)

3.1.58 cl-ncurses/termcap.lisp

Dependencies

• termattrs.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

termcap.lisp

Exported Definitions

• tgetflag (function)
• tgetnum (function)

3.1.59 cl-ncurses/terminfo.lisp

Dependencies

• termcap.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

terminfo.lisp

3.1.60 cl-ncurses/touch.lisp

Dependencies

• terminfo.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

touch.lisp

Exported Definitions

• is-linetouched (function)
• is-wintouched (function)
• touchline (function)
• touchwin (function)
• untouchwin (function)
• wtouchln (function)

3.1.61 cl-ncurses/util.lisp

Dependencies

• touch.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

util.lisp

Exported Definitions

• delay-output (function)
• filter (function)
• flushinp (function)
• keyname (function)
• unctrl (function)
• use-env (function)

3.1.62 cl-ncurses/variables.lisp

Dependencies

• util.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

variables.lisp

3.1.63 cl-ncurses/window.lisp

Dependencies

• variables.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

window.lisp

Exported Definitions

• delwin (function)
• derwin (function)
• dupwin (function)
• mvderwin (function)
• mvwin (function)
• newwin (function)
• subwin (function)
• syncok (function)
• wcursyncup (function)
• wsyncdown (function)
• wsyncup (function)

3.1.64 cl-ncurses/wresize.lisp

Dependencies

• window.lisp (file)
• package.lisp (file)

Parent

cl-ncurses (system)

Location

wresize.lisp

Exported Definitions

wresize (function)

4 Packages

Packages are listed by definition order.

4.1 cl-ncurses-asd

Source

cl-ncurses.asd

Use List

• asdf/interface
• common-lisp

4.2 cl-ncurses

Source

package.lisp (file)

Use List

• uffi
• common-lisp

Exported Definitions

• a_altcharset (constant)
• a_attributes (constant)
• a_blink (constant)
• a_bold (constant)
• a_dim (constant)
• a_horizontal (constant)
• a_invis (constant)
• a_left (constant)
• a_low (constant)
• a_normal (constant)
• a_protect (constant)
• a_reverse (constant)
• a_right (constant)
• a_standout (constant)
• a_top (constant)
• a_underline (constant)
• a_vertical (constant)
• addch (function)
• addnstr (function)
• addstr (function)
• assume-default-colors (function)
• attroff (function)
• attron (function)
• attrset (function)
• baudrate (function)
• beep (function)
• bkgd (function)
• bkgdset (function)
• border (function)
• box (function)
• can-change-color (function)
• cbreak (function)
• clear (function)
• clearok (function)
• clrtobot (function)
• clrtoeol (function)
• color-content (function)
• color-pair (function)
• color-set (function)
• color_black (constant)
• color_blue (constant)
• color_cyan (constant)
• color_green (constant)
• color_magenta (constant)
• color_red (constant)
• color_white (constant)
• color_yellow (constant)
• curs-set (function)
• curses-version (function)
• def-prog-mode (function)
• def-shell-mode (function)
• delay-output (function)
• delch (function)
• deleteln (function)
• delscreen (function)
• delwin (function)
• derwin (function)
• doupdate (function)
• dupwin (function)
• echo (function)
• echochar (function)
• endwin (function)
• erase (function)
• erasechar (function)
• err (constant)
• false (constant)
• filter (function)
• flash (function)
• flushinp (function)
• get-begyx (function)
• get-maxyx (function)
• get-paryx (function)
• get-yx (function)
• getbegx (function)
• getbegy (function)
• getbegyx (macro)
• getbkgd (function)
• getch (function)
• getcurx (function)
• getcury (function)
• getmaxx (function)
• getmaxy (function)
• getmaxyx (macro)
• getnstr (function)
• getparx (function)
• getpary (function)
• getparyx (macro)
• getstr (function)
• getyx (macro)
• halfdelay (function)
• has-colors (function)
• has-ic (function)
• has-il (function)
• has-key (function)
• hline (function)
• idcok (function)
• idlok (function)
• immedok (function)
• inch (function)
• inchnstr (function)
• inchstr (function)
• init-color (function)
• init-pair (function)
• initscr (function)
• innstr (function)
• insch (function)
• insdelln (function)
• insertln (function)
• insnstr (function)
• insstr (function)
• instr (function)
• intrflush (function)
• is-linetouched (function)
• is-term-resized (function)
• is-wintouched (function)
• isendwin (function)
• key_resize (constant)
• keybound (function)
• keyname (function)
• keyok (function)
• keypad (function)
• killchar (function)
• leaveok (function)
• longname (function)
• mcprint (function)
• meta (function)
• move (function)
• mvaddch (function)
• mvaddnstr (function)
• mvaddstr (function)
• mvdelch (function)
• mvderwin (function)
• mvgetch (function)
• mvgetnstr (function)
• mvgetstr (function)
• mvhline (function)
• mvinch (function)
• mvinchnstr (function)
• mvinchstr (function)
• mvinnstr (function)
• mvinsch (function)
• mvinsnstr (function)
• mvinsstr (function)
• mvinstr (function)
• mvprintw (function)
• mvvline (function)
• mvwaddch (function)
• mvwaddnstr (function)
• mvwaddstr (function)
• mvwdelch (function)
• mvwgetch (function)
• mvwgetnstr (function)
• mvwgetstr (function)
• mvwhline (function)
• mvwin (function)
• mvwinch (function)
• mvwinchnstr (function)
• mvwinchstr (function)
• mvwinnstr (function)
• mvwinsch (function)
• mvwinsnstr (function)
• mvwinsstr (function)
• mvwinstr (function)
• mvwprintw (function)
• mvwvline (function)
• napms (function)
• newpad (function)
• newterm (function)
• newwin (function)
• nl (function)
• nocbreak (function)
• nodelay (function)
• noecho (function)
• nonl (function)
• noqiflush (function)
• noraw (function)
• notimeout (function)
• ok (constant)
• overlay (function)
• overwrite (function)
• pair-content (function)
• pechochar (function)
• pnoutrefresh (function)
• prefresh (function)
• printw (function)
• qiflush (function)
• raw (function)
• redrawwin (function)
• refresh (function)
• reset-prog-mode (function)
• reset-shell-mode (function)
• resetty (function)
• resize-term (function)
• resizeterm (function)
• savetty (function)
• scr-dump (function)
• scr-init (function)
• scr-restore (function)
• scr-set (function)
• scrl (function)
• scroll (function)
• scrollok (function)
• set-term (function)
• setscrreg (function)
• slk-attroff (function)
• slk-attron (function)
• slk-attrset (function)
• slk-clear (function)
• slk-color (function)
• slk-init (function)
• slk-label (function)
• slk-noutrefresh (function)
• slk-refresh (function)
• slk-restore (function)
• slk-set (function)
• slk-touch (function)
• standend (function)
• standout (function)
• start-color (function)
• subpad (function)
• subwin (function)
• syncok (function)
• termattrs (function)
• termname (function)
• tgetflag (function)
• tgetnum (function)
• timeout (function)
• touchline (function)
• touchwin (function)
• true (constant)
• typeahead (function)
• unctrl (function)
• ungetch (function)
• untouchwin (function)
• use-default-colors (function)
• use-env (function)
• use-extended-names (function)
• vline (function)
• wa_altcharset (constant)
• wa_attributes (constant)
• wa_blink (constant)
• wa_bold (constant)
• wa_dim (constant)
• wa_horizontal (constant)
• wa_invis (constant)
• wa_left (constant)
• wa_low (constant)
• wa_normal (constant)
• wa_protect (constant)
• wa_reverse (constant)
• wa_right (constant)
• wa_standout (constant)
• wa_top (constant)
• wa_underline (constant)
• wa_vertical (constant)
• waddch (function)
• waddnstr (function)
• waddstr (function)
• wattroff (function)
• wattron (function)
• wattrset (function)
• wbkgd (function)
• wbkgdset (function)
• wborder (function)
• wclear (function)
• wclrtobot (function)
• wclrtoeol (function)
• wcolor-set (function)
• wcursyncup (function)
• wdelch (function)
• wdeleteln (function)
• wechochar (function)
• werase (function)
• wgetch (function)
• wgetnstr (function)
• wgetstr (function)
• whline (function)
• winch (function)
• winchnstr (function)
• winchstr (function)
• winnstr (function)
• winsch (function)
• winsdelln (function)
• winsertln (function)
• winsnstr (function)
• winsstr (function)
• winstr (function)
• wmove (function)
• wnoutrefresh (function)
• wprintw (function)
• wredrawln (function)
• wrefresh (function)
• wresize (function)
• wscrl (function)
• wsetscrreg (function)
• wstandend (function)
• wstandout (function)
• wsyncdown (function)
• wsyncup (function)
• wtimeout (function)
• wtouchln (function)
• wvline (function)

Internal Definitions

• *ncurses-path* (special variable)
• *ncurses-search-paths* (special variable)
• *nullptr* (constant)
• acs_btee (constant)
• acs_bullet (constant)
• acs_ckboard (constant)
• acs_degree (constant)
• acs_diamond (constant)
• acs_hline (constant)
• acs_llcorner (constant)
• acs_lrcorner (constant)
• acs_ltee (constant)
• acs_plminus (constant)
• acs_plus (constant)
• acs_rtee (constant)
• acs_s1 (constant)
• acs_s9 (constant)
• acs_ttee (constant)
• acs_ulcorner (constant)
• acs_urcorner (constant)
• acs_vline (constant)
• def (macro)
• generate-getyx-macro (macro)
• generate-getyx-macros (macro)
• group (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Constants

Constant: a_altcharset

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_attributes

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_blink

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_bold

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_dim

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_horizontal

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_invis

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_left

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_low

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_normal

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_protect

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_reverse

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_right

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_standout

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_top

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_underline

Package

cl-ncurses

Source

constants.lisp (file)

Constant: a_vertical

Package

cl-ncurses

Source

constants.lisp (file)

Constant: color_black

Package

cl-ncurses

Source

constants.lisp (file)

Constant: color_blue

Package

cl-ncurses

Source

constants.lisp (file)

Constant: color_cyan

Package

cl-ncurses

Source

constants.lisp (file)

Constant: color_green

Package

cl-ncurses

Source

constants.lisp (file)

Constant: color_magenta

Package

cl-ncurses

Source

constants.lisp (file)

Constant: color_red

Package

cl-ncurses

Source

constants.lisp (file)

Constant: color_white

Package

cl-ncurses

Source

constants.lisp (file)

Constant: color_yellow

Package

cl-ncurses

Source

constants.lisp (file)

Constant: err

Package

cl-ncurses

Source

constants.lisp (file)

Constant: false

Package

cl-ncurses

Source

constants.lisp (file)

Constant: key_resize

Package

cl-ncurses

Source

constants.lisp (file)

Constant: ok

Package

cl-ncurses

Source

constants.lisp (file)

Constant: true

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_altcharset

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_attributes

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_blink

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_bold

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_dim

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_horizontal

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_invis

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_left

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_low

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_normal

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_protect

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_reverse

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_right

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_standout

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_top

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_underline

Package

cl-ncurses

Source

constants.lisp (file)

Constant: wa_vertical

Package

cl-ncurses

Source

constants.lisp (file)

5.1.2 Macros

Macro: getbegyx WIN Y X

Package

cl-ncurses

Source

getyx.lisp (file)

Macro: getmaxyx WIN Y X

Package

cl-ncurses

Source

getyx.lisp (file)

Macro: getparyx WIN Y X

Package

cl-ncurses

Source

getyx.lisp (file)

Macro: getyx WIN Y X

Package

cl-ncurses

Source

getyx.lisp (file)

5.1.3 Functions

Function: addch CH

Package

cl-ncurses

Source

addch.lisp (file)

Function: addnstr STR N

Package

cl-ncurses

Source

addstr.lisp (file)

Function: addstr STR

Package

cl-ncurses

Source

addstr.lisp (file)

Function: assume-default-colors FG BG

Package

cl-ncurses

Source

default_colors.lisp (file)

Function: attroff ATTRS

Package

cl-ncurses

Source

attr.lisp (file)

Function: attron ATTRS

Package

cl-ncurses

Source

attr.lisp (file)

Function: attrset ATTRS

Package

cl-ncurses

Source

attr.lisp (file)

Function: baudrate ()

Package

cl-ncurses

Source

termattrs.lisp (file)

Function: beep ()

Package

cl-ncurses

Source

beep.lisp (file)

Function: bkgd CH

Package

cl-ncurses

Source

bkgd.lisp (file)

Function: bkgdset CH

Package

cl-ncurses

Source

bkgd.lisp (file)

Function: border LS RS TS BS TL TR BL BR

Package

cl-ncurses

Source

border.lisp (file)

Function: box WIN VERCH HORCH

Package

cl-ncurses

Source

border.lisp (file)

Function: can-change-color ()

Package

cl-ncurses

Source

color.lisp (file)

Function: cbreak ()

Package

cl-ncurses

Source

inopts.lisp (file)

Function: clear ()

Package

cl-ncurses

Source

clear.lisp (file)

Function: clearok WIN BF

Package

cl-ncurses

Source

outopts.lisp (file)

Function: clrtobot ()

Package

cl-ncurses

Source

clear.lisp (file)

Function: clrtoeol ()

Package

cl-ncurses

Source

clear.lisp (file)

Function: color-content COLOR R G B

Package

cl-ncurses

Source

color.lisp (file)

Function: color-pair PAIR

Package

cl-ncurses

Source

color.lisp (file)

Function: color-set COLOR_PAIR_NUMBER OPTS

Package

cl-ncurses

Source

attr.lisp (file)

Function: curs-set VISIBILITY

Package

cl-ncurses

Source

kernel.lisp (file)

Function: curses-version ()

Package

cl-ncurses

Source

extensions.lisp (file)

Function: def-prog-mode ()

Package

cl-ncurses

Source

kernel.lisp (file)

Function: def-shell-mode ()

Package

cl-ncurses

Source

kernel.lisp (file)

Function: delay-output MS

Package

cl-ncurses

Source

util.lisp (file)

Function: delch ()

Package

cl-ncurses

Source

delch.lisp (file)

Function: deleteln ()

Package

cl-ncurses

Source

deleteln.lisp (file)

Function: delscreen SP

Package

cl-ncurses

Source

initscr.lisp (file)

Function: delwin WIN

Package

cl-ncurses

Source

window.lisp (file)

Function: derwin ORIG NLINES NCOLS BEGIN_Y BEGIN_X

Package

cl-ncurses

Source

window.lisp (file)

Function: doupdate ()

Package

cl-ncurses

Source

refresh.lisp (file)

Function: dupwin WIN

Package

cl-ncurses

Source

window.lisp (file)

Function: echo ()

Package

cl-ncurses

Source

inopts.lisp (file)

Function: echochar CH

Package

cl-ncurses

Source

addch.lisp (file)

Function: endwin ()

Package

cl-ncurses

Source

initscr.lisp (file)

Function: erase ()

Package

cl-ncurses

Source

clear.lisp (file)

Function: erasechar ()

Package

cl-ncurses

Source

termattrs.lisp (file)

Function: filter ()

Package

cl-ncurses

Source

util.lisp (file)

Function: flash ()

Package

cl-ncurses

Source

beep.lisp (file)

Function: flushinp ()

Package

cl-ncurses

Source

util.lisp (file)

Function: get-begyx WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: get-maxyx WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: get-paryx WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: get-yx WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: getbegx WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: getbegy WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: getbkgd WIN

Package

cl-ncurses

Source

bkgd.lisp (file)

Function: getch ()

Package

cl-ncurses

Source

getch.lisp (file)

Function: getcurx WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: getcury WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: getmaxx WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: getmaxy WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: getnstr STR N

Package

cl-ncurses

Source

getstr.lisp (file)

Function: getparx WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: getpary WIN

Package

cl-ncurses

Source

getyx.lisp (file)

Function: getstr STR

Package

cl-ncurses

Source

getstr.lisp (file)

Function: halfdelay TENTHS

Package

cl-ncurses

Source

inopts.lisp (file)

Function: has-colors ()

Package

cl-ncurses

Source

color.lisp (file)

Function: has-ic ()

Package

cl-ncurses

Source

termattrs.lisp (file)

Function: has-il ()

Package

cl-ncurses

Source

termattrs.lisp (file)

Function: has-key CH

Package

cl-ncurses

Source

getch.lisp (file)

Function: hline CH N

Package

cl-ncurses

Source

border.lisp (file)

Function: idcok WIN BF

Package

cl-ncurses

Source

outopts.lisp (file)

Function: idlok WIN BF

Package

cl-ncurses

Source

outopts.lisp (file)

Function: immedok WIN BF

Package

cl-ncurses

Source

outopts.lisp (file)

Function: inch ()

Package

cl-ncurses

Source

inch.lisp (file)

Function: inchnstr CHSTR N

Package

cl-ncurses

Source

inchstr.lisp (file)

Function: inchstr CHSTR

Package

cl-ncurses

Source

inchstr.lisp (file)