summaryrefslogtreecommitdiff
path: root/misc/grc/README
diff options
context:
space:
mode:
Diffstat (limited to 'misc/grc/README')
-rw-r--r--misc/grc/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/misc/grc/README b/misc/grc/README
new file mode 100644
index 0000000000..4a0ed4ba0e
--- /dev/null
+++ b/misc/grc/README
@@ -0,0 +1,14 @@
+grc (generic colouriser)
+
+grc provides two programs: grc and grcat. The main is grcat, which
+acts as a filter, i.e. taking standard input, colourising it and
+writing to standard output. grcat takes as a parameter the name of
+configuration file.
+
+To use, add following lines into your ~/.bashrc or ~/.zshrc:
+
+ [[ -s "/etc/grc.bashrc" ]] && source /etc/grc.bashrc
+ [[ -s "/etc/grc.zsh" ]] && source /etc/grc.zsh
+
+Or put the entire content of /usr/doc/grc-1.9/grc.bashrc-expanded
+example into these files.