summaryrefslogtreecommitdiffstats
path: root/scripts/external_libs/ansi2html/README.rst
blob: eab116081aa0711759018f9fb666199601d8d62f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
ansi2html
=========

:Author: Ralph Bean <rbean@redhat.com>
:Contributor: Robin Schneider <ypid23@aol.de>

.. comment: split here

Convert text with ANSI color codes to HTML or to LaTeX.

.. _pixelbeat: http://www.pixelbeat.org/docs/terminal_colours/
.. _blackjack: http://www.koders.com/python/fid5D57DD37184B558819D0EE22FCFD67F53078B2A3.aspx

Inspired by and developed off of the work of `pixelbeat`_ and `blackjack`_.

Build Status
------------

.. |master| image:: https://secure.travis-ci.org/ralphbean/ansi2html.png?branch=master
   :alt: Build Status - master branch
   :target: http://travis-ci.org/#!/ralphbean/ansi2html

.. |develop| image:: https://secure.travis-ci.org/ralphbean/ansi2html.png?branch=develop
   :alt: Build Status - develop branch
   :target: http://travis-ci.org/#!/ralphbean/ansi2html

+----------+-----------+
| Branch   | Status    |
+==========+===========+
| master   | |master|  |
+----------+-----------+
| develop  | |develop| |
+----------+-----------+


Example - Python API
--------------------

>>> from ansi2html import Ansi2HTMLConverter
>>> conv = Ansi2HTMLConverter()
>>> ansi = "".join(sys.stdin.readlines())
>>> html = conv.convert(ansi)

Example - Shell Usage
---------------------

::

 $ ls --color=always | ansi2html > directories.html
 $ sudo tail /var/log/messages | ccze -A | ansi2html > logs.html
 $ task burndown | ansi2html > burndown.html

See the list of full options with::

 $ ansi2html --help

Get this project:
-----------------

::

 $ sudo yum install python-ansi2html

Source:  http://github.com/ralphbean/ansi2html/

pypi:    http://pypi.python.org/pypi/ansi2html/

License
-------

``ansi2html`` is licensed GPLv3+.