summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/mgutz/ansi/doc.go
diff options
context:
space:
mode:
authorWim <wim@42.be>2018-02-20 23:41:09 +0100
committerWim <wim@42.be>2018-02-20 23:41:09 +0100
commit6ea368c383ccc19678623c51d8e4ecbbdb0a64ac (patch)
tree0ccce9d453a743c59abf58eb510ccab99128e381 /vendor/github.com/mgutz/ansi/doc.go
parente92b6de09fd9d983deea17113b28aaba14863735 (diff)
downloadmatterbridge-msglm-6ea368c383ccc19678623c51d8e4ecbbdb0a64ac.tar.gz
matterbridge-msglm-6ea368c383ccc19678623c51d8e4ecbbdb0a64ac.tar.bz2
matterbridge-msglm-6ea368c383ccc19678623c51d8e4ecbbdb0a64ac.zip
Move Sirupsen => sirupsen
Diffstat (limited to 'vendor/github.com/mgutz/ansi/doc.go')
-rw-r--r--vendor/github.com/mgutz/ansi/doc.go65
1 files changed, 65 insertions, 0 deletions
diff --git a/vendor/github.com/mgutz/ansi/doc.go b/vendor/github.com/mgutz/ansi/doc.go
new file mode 100644
index 00000000..43c217e1
--- /dev/null
+++ b/vendor/github.com/mgutz/ansi/doc.go
@@ -0,0 +1,65 @@
+/*
+Package ansi is a small, fast library to create ANSI colored strings and codes.
+
+Installation
+
+ # this installs the color viewer and the package
+ go get -u github.com/mgutz/ansi/cmd/ansi-mgutz
+
+Example
+
+ // colorize a string, SLOW
+ msg := ansi.Color("foo", "red+b:white")
+
+ // create a closure to avoid recalculating ANSI code compilation
+ phosphorize := ansi.ColorFunc("green+h:black")
+ msg = phosphorize("Bring back the 80s!")
+ msg2 := phospohorize("Look, I'm a CRT!")
+
+ // cache escape codes and build strings manually
+ lime := ansi.ColorCode("green+h:black")
+ reset := ansi.ColorCode("reset")
+
+ fmt.Println(lime, "Bring back the 80s!", reset)
+
+Other examples
+
+ Color(s, "red") // red
+ Color(s, "red+b") // red bold
+ Color(s, "red+B") // red blinking
+ Color(s, "red+u") // red underline
+ Color(s, "red+bh") // red bold bright
+ Color(s, "red:white") // red on white
+ Color(s, "red+b:white+h") // red bold on white bright
+ Color(s, "red+B:white+h") // red blink on white bright
+
+To view color combinations, from terminal
+
+ ansi-mgutz
+
+Style format
+
+ "foregroundColor+attributes:backgroundColor+attributes"
+
+Colors
+
+ black
+ red
+ green
+ yellow
+ blue
+ magenta
+ cyan
+ white
+
+Attributes
+
+ b = bold foreground
+ B = Blink foreground
+ u = underline foreground
+ h = high intensity (bright) foreground, background
+ i = inverse
+
+Wikipedia ANSI escape codes [Colors](http://en.wikipedia.org/wiki/ANSI_escape_code#Colors)
+*/
+package ansi