vty: A simple terminal UI library

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

Warnings:

'ghc-options: -O2' is rarely needed. Check that it is giving a real benefit and not just imposing longer compile times on your users.
'ghc-options: -threaded' has no effect for libraries. It should only be used for executables.
'cc-options: -O[n]' is generally not needed. When building with optimisations Cabal automatically adds '-O2' for C code. Setting it yourself interferes with the --disable-optimization flag.

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.

Project is hosted on github.com: https://github.com/coreyoconnor/vty

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

[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.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, 6.3, 6.4
Change log	CHANGELOG
Dependencies	base (>=4 && <5), blaze-builder (>=0.3.3.2 && <0.4), bytestring, containers, data-default (>=0.5.3), deepseq (>=1.1 && <1.4), directory, filepath (>=1.0 && <2.0), hashable (>=1.2), lens (>=3.9.0.2 && <4.2), mtl (>=1.1.1.0 && <2.2), parallel (>=2.2 && <3.3), parsec (>=2 && <4), terminfo (>=0.3 && <0.5), text (>=0.11.3), transformers (>=0.3.0.0), unix, utf8-string (>=0.3 && <0.4), vector (>=0.7), vty [details]
License	BSD-3-Clause
Author	AUTHORS
Maintainer	Corey O'Connor (coreyoconnor@gmail.com)
Category	User Interfaces
Home page	https://github.com/coreyoconnor/vty
Uploaded	by CoreyOConnor at 2014-06-05T07:48:10Z

Modules

[Index]

Downloads

vty-5.0.0.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

CoreyOConnor, JonathanDaugherty

For package maintainers and hackage trustees

edit package information

Readme for vty-5.0.0

[back to package description]

vty is a terminal interface library.

Project is hosted on github.com: https://github.com/coreyoconnor/vty

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

Features

Automatic handling of window resizes.
Supports Unicode characters on output, automatically setting and resetting UTF-8 mode for xterm. Other terminals are assumed to support
Efficient output.
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 type-safe interface.
Properly handles cleanup, but not due to signals.

Known Issues

Signal handling of STOP, TERM and INT are non existent.
The character encoding of the terminal is assumed to be UTF-8.
Terminfo is assumed to be correct unless the terminal (as declared by TERM) starts with xterm or ansi. This means that some terminals will not have correct special key support (shifted F10 etc)
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. Some special rules for Mac terminal applications. The special rules might be invalid on newer Mac OS.

Windows

None!

Development Notes

Coverage

Profiling appears to cause 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