search

jdjakub / ansi-parse

Parse ANSI terminal escape codes into usable abstract representation.
ISC License
4 stars 4 forks source link

readme

Ansiparse - Escape sequences to HTML

%%1.0.2%%

Ansiparse is a library for converting raw terminal output, replete with escape codes, into formatted HTML.

Ansiparse is distributed under the ISC license.

Homepage: https://github.com/jdjakub/ansi-parse Contact: Joel Jakubovic <jdj27@cam.ac.uk>

Installation

ansi-parse can be installed with opam:

opam install ansi-parse

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation and API reference is automatically generated by ocamldoc from the interfaces. It can be consulted online and there is a generated version in the doc directory of the distribution.

Sample programs

If you installed ansi-parse with opam sample programs are located in the directory opam config var ansi-parse:doc.

In the distribution sample programs and tests are located in the test directory of the distribution. They can be built with:

ocamlbuild -use-ocamlfind test/tests.otarget

The resulting binaries are in _build/test.