summaryrefslogtreecommitdiffstats
path: root/misc/grc/README
blob: c95ff92d76b637a01de9775f5d476909c748bb4a (plain)
grc (generic colouriser)

grc provides two programs: grc and grcat. The main one 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.

One major use of grc is to colorize the output of commonly-used shell
commands. For this to work, grc has to set up the environment of your
shell when it starts up. How you do this depends on which shell you
use.

bash, ksh, other POSIX-like shells
----------------------------------
To enable this globally for all users:

  chmod +x /etc/profile.d/grc.sh

Or, you can enable it for just your user by adding this line to one of
your shell startup scripts (.profile, .bashrc, .kshrc, etc):

  [ -e /etc/profile.d/grc.sh ] && . /etc/profile.d/grc.sh

csh, tcsh
---------
To enable this globally for all users:

  chmod +x /etc/profile.d/grc.csh

Or, for one user, add to your .cshrc:

  if ( -e /etc/profile.d/grc.csh ) then
    source /etc/profile.d/grc.csh
  endif

zsh
---
Add this line to your ~/.zshrc:

  [ -e /etc/grc.zsh ] && source /etc/grc.zsh

fish
----
Add this line to your ~/.config/fish/config.fish:

  [ -e /etc/grc.fish ] && source /etc/grc.fish