
             Lightweight Terminal User Interface library
             -------------------------------------------


Description
===========

libtermui is a terminal driver library.

 * It is fully standalone and lightweight, it does not rely on termcap
   or curses libraries.

 * It can drive terminals on TTY or through telnet connection directly
   on TCP socket.

 * It is fully reentrant, can be used to drive multiple terminals from
   different threads.

The API is split in 3 layers:

 * The low level terminal access can be used to play with cursor and
   to register key events.

   - Terminal specific drivers are included for xterm, vt100, vt102
     and similar terminals. More can be implemented easily.

 * Behaviors are implemeted on top of the terminal access layer:

   - The getline module offer a readline like feature. Other behaviors
     can be implemented as well.

 * User interfaces are implemented on top of the behavior layer:

   - The console user interface modules use the getline feature and
     offer an easy way for developpers to add terminal interfaces to
     applications. This module can be used to register commands in a
     hierarchic manner; it comed with argument parsing and completion
     feature.


Package directories
===================

src/                 library source files
src/termui           library public header files

examples/            library usage examples

extra/lua/           lua shell with completion handler example code


Installation
============

$ ./configure
$ make
$ make install

Some modules can be enabled/disabled with the following configure switches:

 * --enable-getline
 * --enable-console

