README.md 1.28 KB
Newer Older
judah's avatar
judah committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
#Haskeline

The Haskeline library provides a user interface for line input in command-line programs.
This library is similar in purpose to readline, but since it is written in Haskell it is (hopefully)
more easily used in other Haskell programs.

##Links
The latest release, as well as the API documentation, may be obtained from [Hackage](http://hackage.haskell.org/package/haskeline).

The most recent development source code can be downloaded with:

    git clone https://github.com/judah/haskeline

Further documentation is also available at
judah's avatar
judah committed
15
[https://github.com/judah/haskeline/wiki](https://github.com/judah/haskeline/wiki)
judah's avatar
judah committed
16
17
18
19
20
21
22
23
24
25
26


##Features:

 - Provides a [rich line editing interface](http://trac.haskell.org/haskeline/wiki/KeyBindings).
 - A `~/.haskeline` file allows customization of [preferences](http://trac.haskell.org/haskeline/wiki/UserPrefs) and [custom key bindings](http://trac.haskell.org/haskeline/wiki/CustomKeyBindings).
 - Runs on POSIX-compatible systems, using the [terminfo](http://github.com/judah/terminfo) library to support non-ANSI terminals.
 - Runs on Windows using MinGW.
 - [Supports Unicode](http://trac.haskell.org/haskeline/wiki/UnicodeSupport) cross-platform.
 - History recall and incremental search.
 - Custom tab completion functions which may run in an arbitrary monad.