diff options
Diffstat (limited to 'misc/grc/README')
| -rw-r--r-- | misc/grc/README | 49 |
1 files changed, 41 insertions, 8 deletions
diff --git a/misc/grc/README b/misc/grc/README index 08d4689320..c95ff92d76 100644 --- a/misc/grc/README +++ b/misc/grc/README @@ -1,13 +1,46 @@ 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 +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. -NOTE: to use, add following lines into your ~/.bashrc, ~/.zshrc or in -~/.config/fish/config.fish: +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. -[[ -s "/etc/profile.d/grc.bashrc" ]] && source /etc/profile.d/grc.bashrc -[[ -s "/etc/profile.d/grc.zsh" ]] && source /etc/profile.d/grc.zsh -[[ -s "/etc/profile.d/grc.fish" ]] && source /etc/profile.d/grc.fish +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 |