The vty package

[Tags:bsd3, library, program]

vty is terminal GUI 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.

Included in the source distribution is a program test/interactive_terminal_test.hs that demonstrates the various features.

Developers: See the Graphics.Vty module.

Users: See the Graphics.Vty.Config module.

If your terminal is not behaving as expected the results of the vty-interactive-terminal-test executable should be sent to the Vty maintainter to aid in debugging the issue.

Notable infelicities: Assumes UTF-8 character encoding support by the terminal; Poor signal handling; Requires terminfo.

This project is hosted on github.com: https://github.com/coreyoconnor/vty

 git clone git://github.com/coreyoconnor/vty.git

© 2006-2007 Stefan O'Rear; BSD3 license.

© Corey O'Connor; BSD3 license.


[Skip to Readme]

Properties

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, 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
Change log CHANGELOG
Dependencies base (==4.*), blaze-builder (>=0.3.3.2 && <0.5), bytestring, containers, data-default (>=0.5.3), deepseq (>=1.1 && <1.5), directory, filepath (>=1.0 && <2.0), hashable (>=1.2), microlens, microlens-mtl, microlens-th, mtl (>=1.1.1.0 && <2.3), parallel (>=2.2 && <3.3), parsec (>=2 && <4), stm, terminfo (>=0.3 && <0.5), text (>=0.11.3), transformers (>=0.3.0.0), unix, utf8-string (>=0.3 && <1.1), vector (>=0.7), vty [details]
License BSD3
Author AUTHORS
Maintainer Corey O'Connor (coreyoconnor@gmail.com)
Stability Unknown
Category User Interfaces
Home page https://github.com/coreyoconnor/vty
Source repository head: git clone https://github.com/coreyoconnor/vty.git
Uploaded Wed May 11 01:27:33 UTC 2016 by CoreyOConnor
Distributions Debian:5.4.0, LTSHaskell:5.4.0, NixOS:5.5.0, Stackage:5.5.0
Downloads 19385 total (141 in the last 30 days)
Votes
0 []
Status Docs available [build log]
Last success reported on 2016-05-11 [all 1 reports]

Modules

[Index]

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for vty

Readme for vty-5.5.0

Build Status

vty is a terminal interface library.

This project is hosted on github.com: https://github.com/coreyoconnor/vty

Install via git with:

git clone git://github.com/coreyoconnor/vty.git

Install via cabal with:

cabal install vty

Features

  • Support for a large number of terminals. vt100, ansi, hurd, linux, screen etc etc. Anything with a sufficient terminfo entry.

  • Automatic handling of window resizes.

  • If the terminal support UTF-8 then vty supports Unicode output.

  • Handles multi-column glyphs. (Requires user to properly configure terminal.)

  • Efficient output. Output buffering and terminal state changes are minimized.

  • Minimizes repaint area. Virtually eliminating the flicker problems 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 for lone ESC. The timeout is customizable.

  • Interface is designed for easy compatible extension.

  • Supports ANSI graphics modes (SGR as defined in console_codes(4)) with a type-safe interface. Gracefull fallback for terminals that do not support, or partially support the standard ANSI graphics modes.

  • Properly handles cleanup, but not due to signals.

  • Comprehensive test suite.

Known Issues

  • Terminals have numerous quirks and bugs. vty picks what works best for the author in ambigious, or buggy situations.

  • Signal handling of STOP, TERM and INT are non existent.

  • The character encoding of the terminal is assumed to be UTF-8 if unicode is used.

  • Terminfo is assumed to be correct unless there is an override configured. Some terminals will not have correct special key support (shifted F10 etc). See Config for customizing vty's behavior for a particular terminal.

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

Platform Support

Posix Terminals

Uses terminfo to determine terminal protocol. With some special rules to handle some omissions from terminfo.

Windows

cygwin only.

Development Notes

Under NixOS

Using cabal

After installing ncurses to user env.

LIBRARY_PATH=$HOME/.nix-profile/lib/ cabal configure --enable-tests --extra-lib-dirs=$HOME/.nix-profile/lib
LIBRARY_PATH=$HOME/.nix-profile/lib/ cabal build
LIBRARY_PATH=$HOME/.nix-profile/lib/ cabal test

Using stack

stack build
stack test
stack install

Coverage

As of last testing, profiling causes issues with coverage when enabled. To evaluate coverage configure as follows:

rm -rf dist ; cabal configure --enable-tests --enable-library-coverage \
  --disable-library-profiling \
  --disable-executable-profiling

Profiling

rm -rf dist ; cabal configure --enable-tests --disable-library-coverage \
  --enable-library-profiling \
  --enable-executable-profiling