The vty package

[ Tags: bsd3, library, program, user-interfaces ] [ Propose Tags ]

vty is a *very* simplistic library in the niche of ncurses. It is intended to be easy to use, have no confusing corner cases, and good support for common terminal types.

If you want to use it, currently the best reference is the test module (Test.hs).

Notable infelicities: requires an ANSI-type terminal, poor efficiency, requires Linux/xterm style UTF8 support.

You can 'darcs get' it from © 2006-2007 Stefan O'Rear; BSD3 license.

[Skip to Readme]


Versions 3.0.0, 3.0.1, 3.0.2, 3.0.4, 3.1.0, 3.1.2, 3.1.4, 3.1.6, 3.1.8,,, 4.0.0,,,,,,,,,,,,,,,,,, 4.7.1, 4.7.2, 4.7.3, 4.7.4, 4.7.5, 5.0.0, 5.0.1, 5.0.2, 5.1.0, 5.1.1, 5.1.3, 5.1.4, 5.2.0, 5.2.1, 5.2.2, 5.2.3, 5.2.4, 5.2.5, 5.2.6, 5.2.7, 5.2.8, 5.2.9, 5.2.10, 5.2.11, 5.3, 5.3.1, 5.4.0, 5.5.0, 5.6, 5.7, 5.7.1, 5.8, 5.8.1, 5.9, 5.9.1, 5.10, 5.11, 5.11.1, 5.11.2, 5.11.3, 5.12, 5.13, 5.14, 5.15, 5.15.1, 5.16, 5.17, 5.17.1, 5.18, 5.18.1, 5.19 (info)
Dependencies base (>3), bytestring, containers, unix [details]
License BSD3
Author Stefan O'Rear
Maintainer Corey O'Connor (
Category User Interfaces
Uploaded Mon Jun 23 08:15:42 UTC 2008 by CoreyOConnor
Distributions Arch:5.18.1, Debian:5.4.0, LTSHaskell:5.16, NixOS:5.19, Stackage:5.18.1, Tumbleweed:5.15.1
Downloads 27986 total (1662 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]
Hackage Matrix CI




Maintainer's Corner

For package maintainers and hackage trustees

Readme for vty-3.0.2

[back to package description]
vty is a very simple terminal interface library.

Vty currently provides:

* Automatic handling of suspend/resume (SIGTSTP+SIGCONT).

* Automatic handling of window resizes.

* Supports Unicode characters on output, automatically setting and
  resetting UTF-8 mode (beware double width and combining characters!)

* Automatic computation of minimal differences.

* Minimizes repaint area, thus virtually eliminating the flicker
  problem that plagues ncurses programs.

* A pure, compositional interface for efficiently constructing display

* Automatically decodes keyboard keys into (key,[modifier]) tuples.

* Automatically supports refresh on Ctrl-L.

* Automatically supports timeout after 50ms for lone ESC (a barely
  noticable delay)

* Interface is designed for relatively easy compatible extension.

* Supports all ANSI SGR-modes (defined in console_codes(4)) with
  a simple type-safe interface.

* Properly handles cleanup, leaving the cursor at the bottom of
  the screen and erasing the last line.

Current disadvantages:

* No current support for non-ANSI terminals.

* UTF-8 support only works properly on the linux console/xterm,
  and even then only if it is not the system default.

* Minimal support for special keys on terminals other than the
  linux-console.  (F1-5 and arrow keys should work, but anything
  shifted isn't likely to.)

* Uses the TIOCGWINSZ ioctl to find the current window size, which
  appears to be limited to Linux and *BSD.

darcs get --tag=rel-3.0.0

To compile the demonstration program: ghc --make Test.hs gwinsz.c

The main documentation consists of the haddock-comments and the
demonstration program