vty: A simple terminal access library

[ bsd3, library, 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.

The latest code is in a darcs repo at http://code.haskell.org/vty/. This is only compatible with GHC 6.10+.

The 3.1.8.* line of vty which is compatable with GHC 6.8 and GHC 6.10 is currently in the darcs repo at http://www.tothepowerofdisco.com/repo/vty-compat. ' © 2006-2007 Stefan O'Rear; BSD3 license.


[Skip to Readme]

Modules

[Index]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 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, 3.1.8.2, 3.1.8.4, 4.0.0, 4.0.0.1, 4.2.1.0, 4.4.0.0, 4.4.0.0.1, 4.6.0.1, 4.6.0.2, 4.6.0.4, 4.6.0.6, 4.7.0.0, 4.7.0.4, 4.7.0.6, 4.7.0.8, 4.7.0.10, 4.7.0.12, 4.7.0.14, 4.7.0.18, 4.7.0.20, 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, 5.19.1, 5.19.2, 5.20, 5.21, 5.22, 5.23, 5.23.1, 5.24, 5.24.1, 5.25, 5.25.1, 5.26, 5.27, 5.28, 5.28.1, 5.28.2, 5.29, 5.30, 5.31, 5.32, 5.33, 5.34, 5.35, 5.35.1, 5.36, 5.37, 5.38, 5.39, 6.0, 6.1, 6.2 (info)
Dependencies base (<4.6), bytestring, containers, extensible-exceptions, terminfo (>=0.2 && <0.3), unix, utf8-string (>=0.3 && <0.4) [details]
License BSD-3-Clause
Author Stefan O'Rear
Maintainer Corey O'Connor (coreyoconnor@gmail.com)
Revised Revision 1 made by HerbertValerioRiedel at 2019-04-24T20:43:31Z
Category User Interfaces
Home page http://trac.haskell.org/vty/
Uploaded by CoreyOConnor at 2009-01-17T22:27:05Z
Distributions Arch:5.38, Debian:5.28.2, Fedora:5.38, LTSHaskell:6.1, NixOS:6.1, Stackage:6.2, openSUSE:6.1
Reverse Dependencies 67 direct, 19 indirect [details]
Downloads 110268 total (447 in the last 30 days)
Rating 2.5 (votes: 3) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for vty-3.1.8.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
  images.

* 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 http://code.haskell.org/vty/

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

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