ncurses
ncurses(s)                                           ncurses(s)



NAME
       ncurses - CRT screen handling and optimization package

SYNOPSIS
       #include <curses.h>

DESCRIPTION
       The  ncurses  library  routines  give the user a terminal-
       independent method of updating character screens with rea-
       sonable   optimization.    This  implementation  is  ``new
       curses'' (ncurses) and is  the  approved  replacement  for
       4.4BSD classic curses, which has been discontinued.

       The  ncurses  routines  emulate  the curses(s) library of
       System V Release 4 UNIX, and the XPG4 curses standard (XSI
       curses)  but the ncurses library is freely redistributable
       in source form.  Differences from the SVr4 curses are sum-
       marized  under  the EXTENSIONS and BUGS sections below and
       described in detail in the EXTENSIONS and BUGS sections of
       individual man pages.

       A  program  using  these  routines must be linked with the
       -lncurses option, or (if it has been generated)  with  the
       debugging  library  -lncurses_g.   (Your system integrator
       may also have installed these libraries  under  the  names
       -lcurses and -lcurses_g.)  The ncurses_g library generates
       trace logs (in a file called 'trace' in the current direc-
       tory) that describe curses actions.

       The  ncurses  package supports: overall screen, window and
       pad manipulation; output to windows and pads; reading ter-
       minal  input;  control  over terminal and curses input and
       output options; environment query routines; color  manipu-
       lation; use of soft label keys; terminfo capabilities; and
       access to low-level terminal-manipulation routines.

       To initialize the routines, the routine initscr or newterm
       must  be called before any of the other routines that deal
       with windows and screens are  used.   The  routine  endwin
       must be called before exiting.  To get character-at-a-time
       input without echoing (most interactive,  screen  oriented
       programs  want  this),  the  following  sequence should be
       used:

             initscr(); cbreak(); noecho();

       Most programs would additionally use the sequence:

             nonl();
             intrflush(stdscr, FALSE);
             keypad(stdscr, TRUE);

       Before a curses program is run, the tab stops of the  ter-
       minal  should  be  set  and its initialization strings, if
       defined, must be output.  This can be  done  by  executing
       the tput init command after the shell environment variable
       TERM has been exported.  tset(t)  is  usually  responsible
       for doing this.  [See terminfo(o) for further details.]

       The  ncurses  library  permits manipulation of data struc-
       tures, called windows, which can be  thought  of  as  two-
       dimensional  arrays of characters representing all or part
       of a CRT screen.  A default window called stdscr, which is
       the  size of the terminal screen, is supplied.  Others may
       be created with newwin.

       Note that curses  does  not  handle  overlapping  windows,
       that's  done by the panel(l) library. This means that you
       can either use stdscr or divide the screen into tiled win-
       dows  and  not  using  stdscr  at all. Mixing the two will
       result in unpredictable, and undesired, effects.

       Windows are referred to by variables declared as WINDOW *.
       These   data  structures  are  manipulated  with  routines
       described here and elsewhere in the ncurses manual  pages.
       Among  which  the  most basic routines are move and addch.
       More general versions of these routines are included  with
       names  beginning  with  w,  allowing the user to specify a
       window.  The routines not beginning with w affect stdscr.)

       After  using  routines  to manipulate a window, refresh is
       called, telling curses to make the user's CRT screen  look
       like  stdscr.   The characters in a window are actually of
       type chtype, (character and attribute data) so that  other
       information  about  the  character may also be stored with
       each character.

       Special windows  called  pads  may  also  be  manipulated.
       These are windows which are not constrained to the size of
       the screen and whose contents need not be completely  dis-
       played.  See curs_pad(d) for more information.

       In  addition  to  drawing  characters on the screen, video
       attributes and colors may be supported, causing the  char-
       acters  to show up in such modes as underlined, in reverse
       video, or in color on terminals that support such  display
       enhancements.  Line drawing characters may be specified to
       be output.  On input, curses is  also  able  to  translate
       arrow  and  function  keys  that transmit escape sequences
       into single values.  The video  attributes,  line  drawing
       characters,   and  input  values  use  names,  defined  in
       <curses.h>, such as A_REVERSE, ACS_HLINE, and KEY_LEFT.

       If the environment variables LINES and COLUMNS are set, or
       if  the program is executing in a window environment, line
       and column information in the  environment  will  override
       information read by terminfo.  This would effect a program
       running in an AT&T 630 layer, for example, where the  size
       of a screen is changeable (see ENVIRONMENT).

       If  the environment variable TERMINFO is defined, any pro-
       gram using curses checks for a local  terminal  definition
       before  checking  in  the standard place.  For example, if
       TERM is set to att4424, then the compiled terminal defini-
       tion is found in

             /usr/share/terminfo/a/att4424.

       (The a is copied from the first letter of att4424 to avoid
       creation of huge directories.)  However,  if  TERMINFO  is
       set to $HOME/myterms, curses first checks

             $HOME/myterms/a/att4424,

       and if that fails, it then checks

             /usr/share/terminfo/a/att4424.

       This  is useful for developing experimental definitions or
       when write permission in /usr/share/terminfo is not avail-
       able.

       The  integer  variables  LINES  and  COLS  are  defined in
       <curses.h> and will be filled in by initscr with the  size
       of the screen.  The constants TRUE and FALSE have the val-
       ues 1 and 0, respectively.

       The curses routines also  define  the  WINDOW  *  variable
       curscr which is used for certain low-level operations like
       clearing and redrawing a screen containing  garbage.   The
       curscr can be used in only a few routines.


   Routine and Argument Names
       Many  curses routines have two or more versions.  The rou-
       tines prefixed with w require a window argument.  The rou-
       tines prefixed with p require a pad argument.  Those with-
       out a prefix generally use stdscr.

       The routines prefixed with mv require a y and x coordinate
       to  move to before performing the appropriate action.  The
       mv routines imply a call to move before the  call  to  the
       other  routine.  The coordinate y always refers to the row
       (of the window), and x always refers to the  column.   The
       upper left-hand corner is always (0,0), not (1,1).

       The routines prefixed with mvw take both a window argument
       and x and y coordinates.  The window  argument  is  always
       specified before the coordinates.

       In  each  case, win is the window affected, and pad is the
       pad affected; win and pad are always pointers to type WIN-
       DOW.

       Option setting routines require a Boolean flag bf with the
       value TRUE or FALSE; bf is always of type bool.  The vari-
       ables  ch  and attrs below are always of type chtype.  The
       types WINDOW, SCREEN, bool,  and  chtype  are  defined  in
       <curses.h>.   The  type  TERMINAL  is defined in <term.h>.
       All other arguments are integers.


   Routine Name Index
       The following table lists each curses routine and the name
       of  the  manual  page  on which it is described.  Routines
       flagged with `*' are ncurses-specific,  not  described  by
       XPG4 or present in SVr4.

       center  tab(/); l l l l .  curses Routine Name/Manual Page
       Name = COLOR_PAIR/curs_color(r) PAIR_NUMBER/curs_attr(r)
       _nc_tracebits/curs_trace(e)*   _traceattr/curs_trace(e)*
       _traceattr2/curs_trace(e)*     _tracechar/curs_trace(e)*
       _tracechtype/curs_trace(e)* _tracechtype2/curs_trace(e)*
       _tracedump/curs_trace(e)* _tracef/curs_trace(e)* _trace-
       mouse/curs_trace(e)*             add_wch/curs_add_wch(h)
       addch/curs_addch(h)  addchnstr/curs_addchstr(r)   addch-
       str/curs_addchstr(r)              addnstr/curs_addstr(r)
       addstr/curs_addstr(r)  assume_default_colors/default_col-
       ors(s)*   attr_get/curs_attr(r)   attr_off/curs_attr(r)
       attr_on/curs_attr(r)               attr_set/curs_attr(r)
       attroff/curs_attr(r)                 attron/curs_attr(r)
       attrset/curs_attr(r)          baudrate/curs_termattrs(s)
       beep/curs_beep(p)                      bkgd/curs_bkgd(d)
       bkgdset/curs_bkgd(d)               border/curs_border(r)
       box/curs_border(r)        can_change_color/curs_color(r)
       cbreak/curs_inopts(s)                 chgat/curs_attr(r)
       clear/curs_clear(r)    clearok/curs_outopts(s)    clrto-
       bot/curs_clear(r)   clrtoeol/curs_clear(r)    color_con-
       tent/curs_color(r)      color_set/curs_attr(r)     copy-
       win/curs_overlay(y) curs_set/curs_kernel(l)  curses_ver-
       sion/curs_extend(d)*        def_prog_mode/curs_kernel(l)
       def_shell_mode/curs_kernel(l)  define_key/define_key(y)*
       del_curterm/curs_terminfo(o)   delay_output/curs_util(l)
       delch/curs_delch(h)            deleteln/curs_deleteln(n)
       delscreen/curs_initscr(r)   delwin/curs_window(w)   der-
       win/curs_window(w)     doupdate/curs_refresh(h)     dup-
       win/curs_window(w)                   echo/curs_inopts(s)
       echo_wchar/curs_add_wch(h)  echochar/curs_addch(h)  end-
       win/curs_initscr(r)                  erase/curs_clear(r)
       erasechar/curs_termattrs(s)          filter/curs_util(l)
       flash/curs_beep(p)      flushinp/curs_util(l)     getbe-
       gyx/curs_getyx(x)       getbkgd/curs_bkgd(d)       getc-
       char/curs_getcchar(r)      getch/curs_getch(h)      get-
       maxyx/curs_getyx(x)              getmouse/curs_mouse(e)*
       getnstr/curs_getstr(r)    getparyx/curs_getyx(x)    get-
       str/curs_getstr(r)                 getsyx/curs_kernel(l)
       getwin/curs_util(l)      getyx/curs_getyx(x)     halfde-
       lay/curs_inopts(s)              has_colors/curs_color(r)
       has_ic/curs_termattrs(s)        has_il/curs_termattrs(s)
       has_key/curs_getch(h)*              hline/curs_border(r)
       idcok/curs_outopts(s)     idlok/curs_outopts(s)    imme-
       dok/curs_outopts(s)       inch/curs_inch(h)       inchn-
       str/curs_inchstr(r)              inchstr/curs_inchstr(r)
       init_color/curs_color(r)         init_pair/curs_color(r)
       initscr/curs_initscr(r)             innstr/curs_instr(r)
       insch/curs_insch(h)            insdelln/curs_deleteln(n)
       insertln/curs_deleteln(n)         insnstr/curs_insstr(r)
       insstr/curs_insstr(r)     instr/curs_instr(r)      intr-
       flush/curs_inopts(s)        is_linetouched/curs_touch(h)
       is_wintouched/curs_touch(h)     isendwin/curs_initscr(r)
       keybound/keybound(d)*               keyname/curs_util(l)
       keyok/keyok(k)* keypad/curs_inopts(s) killchar/curs_ter-
       mattrs(s)  leaveok/curs_outopts(s) longname/curs_termat-
       trs(s)    mcprint/curs_print(t)*    meta/curs_inopts(s)
       mouse_trafo/curs_mouse(e)*  mouseinterval/curs_mouse(e)*
       mousemask/curs_mouse(e)*               move/curs_move(e)
       mvadd_wch/curs_add_wch(h)  mvaddch/curs_addch(h)  mvadd-
       chnstr/curs_addchstr(r)      mvaddchstr/curs_addchstr(r)
       mvaddnstr/curs_addstr(r)  mvaddstr/curs_addstr(r)  mvch-
       gat/curs_attr(r)                  mvcur/curs_terminfo(o)
       mvdelch/curs_delch(h)            mvderwin/curs_window(w)
       mvgetch/curs_getch(h)  mvgetnstr/curs_getstr(r)   mvget-
       str/curs_getstr(r)                mvhline/curs_border(r)
       mvinch/curs_inch(h)  mvinchnstr/curs_inchstr(r)  mvinch-
       str/curs_inchstr(r)     mvinnstr/curs_instr(r)     mvin-
       sch/curs_insch(h)               mvinsnstr/curs_insstr(r)
       mvinsstr/curs_insstr(r)            mvinstr/curs_instr(r)
       mvprintw/curs_printw(w)            mvscanw/curs_scanw(w)
       mvvline/curs_border(r) mvwadd_wch/curs_add_wch(h) mvwad-
       dch/curs_addch(h) mvwaddchnstr/curs_addchstr(r)  mvwadd-
       chstr/curs_addchstr(r)         mvwaddnstr/curs_addstr(r)
       mvwaddstr/curs_addstr(r)           mvwchgat/curs_attr(r)
       mvwdelch/curs_delch(h)            mvwgetch/curs_getch(h)
       mvwgetnstr/curs_getstr(r) mvwgetstr/curs_getstr(r) mvwh-
       line/curs_border(r)                 mvwin/curs_window(w)
       mvwinch/curs_inch(h)         mvwinchnstr/curs_inchstr(r)
       mvwinchstr/curs_inchstr(r)       mvwinnstr/curs_instr(r)
       mvwinsch/curs_insch(h)         mvwinsnstr/curs_insstr(r)
       mvwinsstr/curs_insstr(r)   mvwinstr/curs_instr(r)   mvw-
       printw/curs_printw(w)             mvwscanw/curs_scanw(w)
       mvwvline/curs_border(r)     napms/curs_kernel(l)    new-
       pad/curs_pad(d) newterm/curs_initscr(r) newwin/curs_win-
       dow(w) nl/curs_outopts(s) nocbreak/curs_inopts(s) node-
       lay/curs_inopts(s) noecho/curs_inopts(s)  nonl/curs_out-
       opts(s)  noqiflush/curs_inopts(s)  noraw/curs_inopts(s)
       notimeout/curs_inopts(s)  overlay/curs_overlay(y)  over-
       write/curs_overlay(y)         pair_content/curs_color(r)
       pechochar/curs_pad(d)   pnoutrefresh/curs_pad(d)    pre-
       fresh/curs_pad(d)  printw/curs_printw(w)  putp/curs_ter-
       minfo(o)   putwin/curs_util(l)   qiflush/curs_inopts(s)
       raw/curs_inopts(s)             redrawwin/curs_refresh(h)
       refresh/curs_refresh(h)   reset_prog_mode/curs_kernel(l)
       reset_shell_mode/curs_kernel(l)   resetty/curs_kernel(l)
       resizeterm/resizeterm(m)*   restartterm/curs_terminfo(o)
       ripoffline/curs_kernel(l)         savetty/curs_kernel(l)
       scanw/curs_scanw(w)            scr_dump/curs_scr_dump(p)
       scr_init/curs_scr_dump(p)   scr_restore/curs_scr_dump(p)
       scr_set/curs_scr_dump(p)             scrl/curs_scroll(l)
       scroll/curs_scroll(l)           scrollok/curs_outopts(s)
       set_curterm/curs_terminfo(o)    set_term/curs_initscr(r)
       setcchar/curs_getcchar(r) setscrreg/curs_outopts(s) set-
       syx/curs_kernel(l)              setterm/curs_terminfo(o)
       setupterm/curs_terminfo(o)         slk_attr/curs_slk(k)*
       slk_attr_off/curs_slk(k)         slk_attr_on/curs_slk(k)
       slk_attr_set/curs_slk(k)         slk_attroff/curs_slk(k)
       slk_attron/curs_slk(k)           slk_attrset/curs_slk(k)
       slk_clear/curs_slk(k)              slk_color/curs_slk(k)
       slk_init/curs_slk(k)  slk_label/curs_slk(k)  slk_noutre-
       fresh/curs_slk(k)                slk_refresh/curs_slk(k)
       slk_restore/curs_slk(k)              slk_set/curs_slk(k)
       slk_touch/curs_slk(k)    standend/curs_attr(r)    stand-
       out/curs_attr(r)     start_color/curs_color(r)      sub-
       pad/curs_pad(d)  subwin/curs_window(w)  syncok/curs_win-
       dow(w) termattrs/curs_termattrs(s) termname/curs_termat-
       trs(s) tgetent/curs_termcap(p) tgetflag/curs_termcap(p)
       tgetnum/curs_termcap(p)          tgetstr/curs_termcap(p)
       tgoto/curs_termcap(p)  tigetflag/curs_terminfo(o) tiget-
       num/curs_terminfo(o)   tigetstr/curs_terminfo(o)   time-
       out/curs_inopts(s)     touchline/curs_touch(h)    touch-
       win/curs_touch(h)                 tparm/curs_terminfo(o)
       tputs/curs_termcap(p)             tputs/curs_terminfo(o)
       trace/curs_trace(e)*    typeahead/curs_inopts(s)    unc-
       trl/curs_util(l)       ungetch/curs_getch(h)      unget-
       mouse/curs_mouse(e)*            untouchwin/curs_touch(h)
       use_default_colors/default_colors(s)*
       use_env/curs_util(l)  use_extended_names/curs_extend(d)*
       vidattr/curs_terminfo(o)        vidputs/curs_terminfo(o)
       vline/curs_border(r)            vw_printw/curs_printw(w)
       vw_scanw/curs_scanw(w)    vwprintw/curs_printw(w)   vws-
       canw/curs_scanw(w)     wadd_wch/curs_add_wch(h)     wad-
       dch/curs_addch(h)   waddchnstr/curs_addchstr(r)  waddch-
       str/curs_addchstr(r)             waddnstr/curs_addstr(r)
       waddstr/curs_addstr(r)            wattr_get/curs_attr(r)
       wattr_off/curs_attr(r)             wattr_on/curs_attr(r)
       wattr_set/curs_attr(r)     wattroff/curs_attr(r)    wat-
       tron/curs_attr(r)                  wattrset/curs_attr(r)
       wbkgd/curs_bkgd(d)      wbkgdset/curs_bkgd(d)      wbor-
       der/curs_border(r)                   wchgat/curs_attr(r)
       wclear/curs_clear(r)    wclrtobot/curs_clear(r)    wclr-
       toeol/curs_clear(r)   wcolor_set/curs_attr(r)   wcursyn-
       cup/curs_window(w)                  wdelch/curs_delch(h)
       wdeleteln/curs_deleteln(n)   wecho_wchar/curs_add_wch(h)
       wechochar/curs_addch(h)          wenclose/curs_mouse(e)*
       werase/curs_clear(r)                wgetch/curs_getch(h)
       wgetnstr/curs_getstr(r)           wgetstr/curs_getstr(r)
       whline/curs_border(r)                 winch/curs_inch(h)
       winchnstr/curs_inchstr(r)       winchstr/curs_inchstr(r)
       winnstr/curs_instr(r)     winsch/curs_insch(h)     wins-
       delln/curs_deleteln(n)  winsertln/curs_deleteln(n)  win-
       snstr/curs_insstr(r)     winsstr/curs_insstr(r)     win-
       str/curs_instr(r)            wmouse_trafo/curs_mouse(e)*
       wmove/curs_move(e)          wnoutrefresh/curs_refresh(h)
       wprintw/curs_printw(w)   wredrawln/curs_refresh(h)  wre-
       fresh/curs_refresh(h)                wresize/wresize(e)*
       wscanw/curs_scanw(w)    wscrl/curs_scroll(l)    wsetscr-
       reg/curs_outopts(s)    wstandend/curs_attr(r)    wstand-
       out/curs_attr(r)      wsyncdown/curs_window(w)     wsyn-
       cup/curs_window(w)               wtimeout/curs_inopts(s)
       wtouchln/curs_touch(h) wvline/curs_border(r)

RETURN VALUE
       Routines  that  return  an integer return ERR upon failure
       and an integer value other than ERR upon  successful  com-
       pletion,  unless  otherwise  noted in the routine descrip-
       tions.

       All macros return the  value  of  the  w  version,  except
       setscrreg,  wsetscrreg,  getyx,  getbegyx,  getmaxyx.  The
       return values of setscrreg, wsetscrreg,  getyx,  getbegyx,
       and getmaxyx are undefined (i.e., these should not be used
       as the right-hand side of assignment statements).

       Routines that return pointers return NULL on error.

ENVIRONMENT
       The following environment symbols are useful for customiz-
       ing the runtime behavior of the ncurses library.  The most
       important ones have been already discussed in detail.

       BAUDRATE
            The debugging library checks this environment  symbol
            when the application has redirected output to a file.
            The symbol's numeric value is used for the  baudrate.
            If  no value is found ncurses uses 9600.  This allows
            testers to construct repeatable test-cases that  take
            into account costs that depend on baudrate.

       CC   When set, change occurrences of the command_character
            (i.e., the cmdch capability) of the  loaded  terminfo
            entries  to  the value of this symbol.  Very few ter-
            minfo entries provide this feature.

       COLUMNS
            Specify  the  width  of  the  screen  in  characters.
            Applications  running in a windowing environment usu-
            ally are able to obtain the width of  the  window  in
            which  they  are  executing.  If neither the $COLUMNS
            value nor the terminal's screen  size  is  available,
            ncurses  uses  the size which may be specified in the
            terminfo database (i.e., the cols capability).

            It is important that your application use  a  correct
            size  for  the  screen.   However, this is not always
            possible because your application may be running on a
            host  which  does  not honor NAWS (Negotiations About
            Window Size), or because you are temporarily  running
            as another user.

            Either  COLUMNS  or  LINES  symbols  may be specified
            independently.  This is mainly useful  to  circumvent
            legacy  misfeatures  of  terminal descriptions, e.g.,
            xterm which commonly specifies a 65 line screen.  For
            best  results, lines and cols should not be specified
            in a terminal description for terminals which are run
            as emulations.

            Use the use_env function to disable this feature.

       ESCDELAY
            Specifies  the total time, in milliseconds, for which
            ncurses will await  a  character  sequence,  e.g.,  a
            function  key.  The default value, 1000 milliseconds,
            is enough for most uses.  However, it is made a vari-
            able to accommodate unusual applications.

            The most common instance where you may wish to change
            this value is to work with slow hosts, e.g.,  running
            on  a  network.   If  the host cannot read characters
            rapidly enough, it will have the same  effect  as  if
            the  terminal did not send characters rapidly enough.
            The library will still see a timeout.

            Note that xterm mouse events are built up from  char-
            acter  sequences  received  from  the xterm.  If your
            application makes heavy use of multiple-clicking, you
            may  wish  to lengthen this default value because the
            timeout applies to the composed multi-click event  as
            well as the individual clicks.

       HOME Tells  ncurses where your home directory is.  That is
            where  it  may  read  and  write  auxiliary  terminal
            descriptions:

            $HOME/.termcap
            $HOME/.terminfo

       LINES
            Like  COLUMNS,  specify  the  height of the screen in
            characters.  See COLUMNS for a detailed  description.

       MOUSE_BUTTONS_123
            This applies only to the OS/2 EMX port.  It specifies
            the order of buttons on the mouse.   OS/2  numbers  a
            3-button mouse inconsistently from other platforms:

            1 = left
            2 = right
            3 = middle.

            This symbol lets you customize the mouse.  The symbol
            must be three numeric digits 1-3 in any order,  e.g.,
            123  or  321.   If  it is not specified, ncurses uses
            132.

       NCURSES_NO_PADDING
            Most of the terminal  descriptions  in  the  terminfo
            database  are  written for real "hardware" terminals.
            Many people use terminal emulators  which  run  in  a
            windowing  environment  and use curses-based applica-
            tions.  Terminal emulators can duplicate all  of  the
            important aspects of a hardware terminal, but they do
            not have the same limitations.  The chief  limitation
            of  a  hardware  terminal from the standpoint of your
            application is the management of dataflow, i.e., tim-
            ing.  Unless a hardware terminal is interfaced into a
            terminal concentrator (which does flow  control),  it
            (or  your application) must manage dataflow, prevent-
            ing overruns.  The  cheapest  solution  (no  hardware
            cost) is for your program to do this by pausing after
            operations that the terminal  does  slowly,  such  as
            clearing the display.

            As  a  result,  many terminal descriptions (including
            the vt100) have delay times embedded.  You  may  wish
            to  use  these  descriptions, but not want to pay the
            performance penalty.

            Set the NCURSES_NO_PADDING symbol to disable all  but
            mandatory  padding.   Mandatory  padding is used as a
            part of special control sequences such as flash.

       NCURSES_NO_SETBUF
            Normally ncurses enables buffered output during  ter-
            minal  initialization.   This  is  done  (as  in SVr4
            curses) for performance reasons.   For  testing  pur-
            poses, both of ncurses and certain applications, this
            feature    is    made    optional.     Setting    the
            NCURSES_NO_SETBUF variable disables output buffering,
            leaving the output  in  the  original  (usually  line
            buffered) mode.

       NCURSES_TRACE
            During  initialization, the ncurses debugging library
            checks the NCURSES_TRACE symbol.  If it  is  defined,
            to a numeric value, ncurses calls the trace function,
            using that value as the argument.

            The argument values, which are defined  in  curses.h,
            provide  several  types of information.  When running
            with traces enabled, your application will write  the
            file trace to the current directory.

       TERM Denotes  your  terminal  type.  Each terminal type is
            distinct, though many are similar.

       TERMCAP
            If the ncurses library has been configured with term-
            cap  support,  ncurses  will  check  for a terminal's
            description in termcap form if it is not available in
            the terminfo database.

            The   TERMCAP   symbol  contains  either  a  terminal
            description (with newlines stripped out), or  a  file
            name  telling  where  the  information denoted by the
            TERM symbol  exists.   In  either  case,  setting  it
            directs  ncurses  to  ignore the usual place for this
            information, e.g., /etc/termcap.

       TERMINFO
            Overrides the directory in which ncurses searches for
            your terminal description.  This is the simplest, but
            not the only way to change the list  of  directories.
            The complete list of directories in order follows:

            -  the last directory to which ncurses wrote, if any,
               is searched first.

            -  the directory specified by the TERMINFO symbol

            -  $HOME/.terminfo

            -  directories listed in the TERMINFO_DIRS symbol

            -  one or more directories whose names are configured
               and  compiled  into  the  ncurses  library,  e.g.,
               /usr/share/terminfo

       TERMINFO_DIRS
            Specifies a list of directories to search for  termi-
            nal  descriptions.   The  list is separated by colons
            (i.e., ":") on Unix, semicolons on OS/2 EMX.  All  of
            the terminal descriptions are in terminfo form, which
            makes a subdirectory named for the  first  letter  of
            the terminal names therein.

       TERMPATH
            If  TERMCAP  does  not  hold a file name then ncurses
            checks the TERMPATH symbol.  This is a list of  file-
            names  separated  by  spaces or colons (i.e., ":") on
            Unix, semicolons on OS/2 EMX.  If the TERMPATH symbol
            is  not set, ncurses looks in the files /etc/termcap,
            /usr/share/misc/termcap and $HOME/.termcap,  in  that
            order.

       The  library  may be configured to disregard the following
       variables when the current user is the  superuser  (root),
       or  if  the application uses setuid or setgid permissions:
       $TERMINFO, $TERMINFO_DIRS, $TERMPATH, as well as $HOME.

FILES
       /usr/share/tabset
            directory containing  initialization  files  for  the
            terminal capability database /usr/share/terminfo ter-
            minal capability database

SEE ALSO
       terminfo(o) and 3X pages whose  names  begin  "curs_"  for
       detailed routine descriptions.

EXTENSIONS
       The  ncurses  library  can  be  compiled  with  an  option
       (-DUSE_GETCAP) that falls back to the old-style /etc/term-
       cap file if the terminal setup code cannot find a terminfo
       entry corresponding to TERM.  Use of this feature  is  not
       recommended,  as it essentially includes an entire termcap
       compiler in the ncurses startup code, at significant  cost
       in core and startup cycles.

       The  ncurses  library  includes  facilities  for capturing
       mouse events on certain terminals (including  xterm).  See
       the curs_mouse(e) manual page for details.

       The  ncurses library includes facilities for responding to
       window resizing events, e.g., when running  in  an  xterm.
       See  the  resizeterm(m)  and wresize(e) manual pages for
       details.  In addition, the library may be configured  with
       a SIGWINCH handler.

       The  ncurses library extends the fixed set of function key
       capabilities of  terminals  by  allowing  the  application
       designer  to  define  additional key sequences at runtime.
       See the define_key(y)  and  keyok(k)  manual  pages  for
       details.

       The ncurses library can exploit the capabilities of termi-
       nals which implement the ISO-6429 SGR 39 and SGR  49  con-
       trols, which allow an application to reset the terminal to
       its original foreground and background colors.   From  the
       users'  perspective,  the application is able to draw col-
       ored  text  on   a   background   whose   color   is   set
       independently,  providing  better  control over color con-
       trasts.   See  the  default_colors(s)  manual  page   for
       details.

       The  ncurses  library  includes  a  function for directing
       application output to a printer attached to  the  terminal
       device.  See the curs_print(t) manual page for details.

PORTABILITY
       The  ncurses  library is intended to be BASE-level confor-
       mant with the XSI Curses standard.   Certain  portions  of
       the  EXTENDED  XSI  Curses  functionality (including color
       support) are supported.  The following EXTENDED XSI Curses
       calls  in  support  of wide (multibyte) characters are not
       yet implemented: add_wchnstr, add_wchstr, addnwstr,  addw-
       str,  bkgrnd,  bkgrndset, border_set, box_set, erasewchar,
       get_wch,  get_wstr,  getbkgrnd,   getn_wstr,   getwchtype,
       hline_set,   in_wch,   in_wchnstr,   in_wchstr,   innwstr,
       ins_nwstr, ins_wch, ins_wstr, inwchnstr, inwchstr, inwstr,
       key_name, killwchar, mvadd_wchnstr, mvadd_wchstr, mvaddnw-
       str, mvaddwstr, mvget_wch, mvget_wstr,  mvgetn_wstr,  mvh-
       line_set,  mvin_wch,  mvinnwstr,  mvins_nwstr,  mvins_wch,
       mvins_wstr, mvinwchnstr, mvinwchstr, mvinwchstr, mvinwstr,
       mvvline_set,  mvwadd_wchnstr,  mvwadd_wchstr, mvwaddnwstr,
       mvwaddwstr,    mvwget_ch,     mvwget_wch,     mvwget_wstr,
       mvwgetn_wstr,   mvwhline_set,   mvwin_wch,  mvwin_wchnstr,
       mvwin_wchstr,   mvwinnwstr,   mvwins_nwstr,    mvwins_wch,
       mvwins_wstr,   mvwinwchnstr.    mvwinwstr,   mvwvline_set,
       pecho_wchar, slk_wset, term_attrs, unget_wch,  vhline_set,
       vid_attr,  vid_puts, vline_set, wadd_wchnstr, wadd_wchstr,
       waddnwstr,  waddwstr,   waddwstr,   wbkgrnd,   wbkgrndset,
       wbkgrndset,  wborder_set, wget_wch, wget_wstr, wgetbkgrnd,
       wgetn_wstr, whline_set, win_wch, win_wchnstr,  win_wchstr,
       winnwstr,  wins_nwstr,  wins_wch,  wins_wstr,  winwchnstr,
       winwchstr, winwstr, wunctrl, wvline_set,

       A small number of local differences (that  is,  individual
       differences  between the XSI Curses and ncurses calls) are
       described in  PORTABILITY  sections  of  the  library  man
       pages.

       The routine has_key is not part of XPG4, nor is it present
       in SVr4.  See the curs_getch(h) manual page for  details.

       The  routine  slk_attr is not part of XPG4, nor is it pre-
       sent in  SVr4.   See  the  curs_slk(k)  manual  page  for
       details.

       The  routines getmouse, mousemask, ungetmouse, mouseinter-
       val, and wenclose relating to mouse  interfacing  are  not
       part  of  XPG4,  nor  are  they  present in SVr4.  See the
       curs_mouse(e) manual page for details.

       The routine mcprint was not present in any previous curses
       implementation.   See  the  curs_print(t) manual page for
       details.

       The routine wresize is not part of XPG4, nor is it present
       in SVr4.  See the wresize(e) manual page for details.

       In  historic curses versions, delays embedded in the capa-
       bilities cr, ind, cub1, ff and tab activated corresponding
       delay  bits  in  the UNIX tty driver.  In this implementa-
       tion, all padding is done by NUL sends.   This  method  is
       slightly  more expensive, but narrows the interface to the
       UNIX kernel  significantly  and  increases  the  package's
       portability correspondingly.

       In  the  XSI  standard  and  SVr4 manual pages, many entry
       points have prototype arguments of the for char *const (or
       cchar_t  *const,  or  wchar_t  *const,  or  void  *const).
       Depending on one's interpretation of the ANSI  C  standard
       (see  section  3.5.4.1), these declarations are either (a)
       meaningless, or (b) meaningless and illegal.  The declara-
       tion const char *x is a modifiable pointer to unmodifiable
       data, but char *const x' is  an  unmodifiable  pointer  to
       modifiable  data.  Given that C passes arguments by value,
       <type> *const as a formal type is at best  dubious.   Some
       compilers  choke  on  the  prototypes.  Therefore, in this
       implementation, they have been changed to const  <type>  *
       globally.

NOTES
       The  header  file  <curses.h>  automatically  includes the
       header files <stdio.h> and <unctrl.h>.

       If standard output from a ncurses program  is  re-directed
       to  something  which  is not a tty, screen updates will be
       directed to standard error.  This was an undocumented fea-
       ture of AT&T System V Release 3 curses.

AUTHORS
       Zeyd  M.  Ben-Halim,  Eric  S.  Raymond, Thomas E. Dickey.
       Based on pcurses by Pavel Curtis.



                                                      ncurses(s)