git.iko.soy/vty
on 6fd33eb help sign in
vty/README
48 lines 1.4 kB history raw
1vty is a terminal interface library.
3Vty currently provides:
5* Automatic handling of window resizes.
7* Supports Unicode characters on output, automatically setting and
8 resetting UTF-8 mode for xterm. Other terminals are assumed to support
10* Efficient output.
12* Minimizes repaint area, thus virtually eliminating the flicker
13 problem that plagues ncurses programs.
15* A pure, compositional interface for efficiently constructing display
16 images.
18* Automatically decodes keyboard keys into (key,[modifier]) tuples.
20* Automatically supports refresh on Ctrl-L.
22* Automatically supports timeout after 50ms for lone ESC (a barely
23 noticable delay)
25* Interface is designed for relatively easy compatible extension.
27* Supports all ANSI SGR-modes (defined in console_codes(4)) with
28 a type-safe interface.
30* Properly handles cleanup.
32Current disadvantages:
34* The character encoding of the output terminal is assumed to be UTF-8.
36* Minimal support for special keys on terminals other than the
37 linux-console. (F1-5 and arrow keys should work, but anything
38 shifted isn't likely to.)
40* Uses the TIOCGWINSZ ioctl to find the current window size, which
41 appears to be limited to Linux and *BSD.
43darcs get --tag=vty-4.0.0.1 http://code.haskell.org/vty/
45To compile the demonstration program: ghc --make test/Test.hs gwinsz.c
47The main documentation consists of the haddock-comments and the demonstration
48program