diff options
author | Dan Klein <danklei@cisco.com> | 2015-08-24 18:44:56 +0300 |
---|---|---|
committer | Dan Klein <danklei@cisco.com> | 2015-08-24 18:44:56 +0300 |
commit | 98bc71b1c21452c3d868c4a4d418a8aeaa5a43af (patch) | |
tree | 2e66b9a775f0a5c545caa76f62890f5a5546e231 /scripts/automation/trex_control_plane/python_lib/termstyle/README.rst | |
parent | 20eb7d362f9bce1951bd61ad3f78cf8f4267d1d5 (diff) | |
parent | 36c6c87fe4380b214f8ff8a45dc0213fa109821c (diff) |
Merge branch 'master' into dan_stateless
Diffstat (limited to 'scripts/automation/trex_control_plane/python_lib/termstyle/README.rst')
-rwxr-xr-x | scripts/automation/trex_control_plane/python_lib/termstyle/README.rst | 82 |
1 files changed, 0 insertions, 82 deletions
diff --git a/scripts/automation/trex_control_plane/python_lib/termstyle/README.rst b/scripts/automation/trex_control_plane/python_lib/termstyle/README.rst deleted file mode 100755 index f3dfa0ab..00000000 --- a/scripts/automation/trex_control_plane/python_lib/termstyle/README.rst +++ /dev/null @@ -1,82 +0,0 @@ -========= -termstyle -========= - -termstyle is a simple python library for adding coloured output to -terminal (console) programs. The definitions come from ECMA-048_, the -"Control Functions for Coded Character Sets" standard. - -Installation: -------------- - -I thoroughly recommend using the zero-install feed (see the project homepage) to manage your dependencies if at all possible. zero-install_ provides a much better system than pip or easy_install, and works with absolutely any language and allows decentralised package management that requires no special privileges to install. - -Example Usage: --------------- -:: - - from termstyle import * - print "%s:%s" % (red('Hey'), green('how are you?')) - print blue('How ', bold('you'), ' doin?') - -or, you can use a colour just as a string:: - - print "%sBlue!%s" % (blue, reset) - -Styles: -------- -:: - - reset or default (no colour / style) - -colour:: - - black - red - green - yellow - blue - magenta - cyan - white - -background colour:: - - bg_black - bg_red - bg_green - bg_yellow - bg_blue - bg_magenta - bg_cyan - bg_white - bg_default - -In terminals supporting transparency ``bg_default`` is often used to set -the background to transparent [#]_. - -weight:: - - bold - inverted - -style:: - - italic - underscore - -Controls: ---------- -:: - - auto() - sets colouring on only if sys.stdout is a terminal - disabe() - disable colours - enable() - enable colours - -.. [#] Supporting terminals include rxvt-unicode_, and Eterm_. - -.. _ECMA-048: http://www.ecma-international.org/publications/files/ECMA-ST/Ecma-048.pdf -.. _rxvt-unicode: http://software.schmorp.de/ -.. _Eterm: http://www.eterm.org/ -.. _zero-install: http://0install.net/ - |