summaryrefslogtreecommitdiffstats
path: root/scripts/external_libs/ansi2html/README.rst
diff options
context:
space:
mode:
authorYaroslav Brustinov <ybrustin@cisco.com>2016-03-09 14:05:08 +0200
committerYaroslav Brustinov <ybrustin@cisco.com>2016-03-09 14:05:08 +0200
commit2258ea303c6c3573998dea7b9d347d46873018db (patch)
treeff446df4df551ec8efce7ace69f8ea029fd0996d /scripts/external_libs/ansi2html/README.rst
parentbcf08b4e5715029ccfa54d22b0d5875b4c7cda78 (diff)
regression: stl updates
Diffstat (limited to 'scripts/external_libs/ansi2html/README.rst')
-rwxr-xr-xscripts/external_libs/ansi2html/README.rst71
1 files changed, 71 insertions, 0 deletions
diff --git a/scripts/external_libs/ansi2html/README.rst b/scripts/external_libs/ansi2html/README.rst
new file mode 100755
index 00000000..eab11608
--- /dev/null
+++ b/scripts/external_libs/ansi2html/README.rst
@@ -0,0 +1,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+.