on fe55cd4 help sign in
vty/README
54 lines 1.7 kB history raw
1vty is a very simple terminal interface library.
3Vty currently provides:
5* Automatic handling of suspend/resume (SIGTSTP+SIGCONT).
7* Automatic handling of window resizes.
9* Supports Unicode characters on output, automatically setting and
10 resetting UTF-8 mode (beware double width and combining characters!)
12* Automatic computation of minimal differences.
14* Minimizes repaint area, thus virtually eliminating the flicker
15 problem that plagues ncurses programs.
17* A pure, compositional interface for efficiently constructing display
18 images.
20* Automatically decodes keyboard keys into (key,[modifier]) tuples.
22* Automatically supports refresh on Ctrl-L.
24* Automatically supports timeout after 50ms for lone ESC (a barely
25 noticable delay)
27* Interface is designed for relatively easy compatible extension.
29* Supports all ANSI SGR-modes (defined in console_codes(4)) with
30 a simple type-safe interface.
32* Properly handles cleanup, leaving the cursor at the bottom of
33 the screen and erasing the last line.
35Current disadvantages:
37* No current support for non-ANSI terminals.
39* UTF-8 support only works properly on the linux console/xterm,
40 and even then only if it is not the system default.
42* Minimal support for special keys on terminals other than the
43 linux-console. (F1-5 and arrow keys should work, but anything
44 shifted isn't likely to.)
46* Uses the TIOCGWINSZ ioctl to find the current window size, which
47 appears to be limited to Linux and *BSD.
49darcs get --tag=rel-3.0.0 http://code.haskell.org/vty/
51To compile the demonstration program: ghc --make Test.hs gwinsz.c
53The main documentation consists of the haddock-comments and the
54demonstration program