.\" Automatically generated by Pandoc 3.9
.\"
.TH "rgrc" "1" "" ""
.SS NAME
\f[B]rgrc\f[R] \- Rusty Generic Colouriser
.SS SYNOPSIS
\f[B]rgrc\f[R] [\f[I]options\f[R]] \f[I]COMMAND\f[R] [\f[I]args\f[R]]
\&...
.SS DESCRIPTION
\f[B]rgrc\f[R] runs any command and colourises its output according to a
set of rules.
Rules are imported from \f[B]grc\f[R] and \f[B]grcat\f[R] configuration
files.
.SS OPTIONS
.IP \(bu 2
\f[B]\f[CB]\-\-help\f[B]\f[R]
.PD 0
.P
.PD
Show summary of options.
.IP \(bu 2
\f[B]\f[CB]\-\-aliases\f[B]\f[R]
.PD 0
.P
.PD
Output a list of shell commands to generate aliases for supported and
installed binaries.
.IP \(bu 2
\f[B]\f[CB]\-\-all\-aliases\f[B]\f[R]
.PD 0
.P
.PD
Output a list of shell commands with aliases for all supported binaries.
.IP \(bu 2
\f[B]\f[CB]\-\-except\f[B]\f[R]=\f[I]alias\f[R][,\f[I]alias\f[R][,\&...]]
.PD 0
.P
.PD
List of aliases to exclude from list of shell commands generated by
\f[B]\(enaliases\f[R] or \f[B]\(enall\-aliases\f[R].
.IP \(bu 2
\f[B]\f[CB]\-\-color\f[B]\f[R]=[on,off,auto]
.PD 0
.P
.PD
Enable/disable color output (default auto).
.IP \(bu 2
\f[B]\f[CB]\-\-completions\f[B]\f[R]=\f[I]SHELL\f[R]
.PD 0
.P
.PD
Print a shell completion script for \f[CR]SHELL\f[R] (supported:
\f[CR]bash\f[R], \f[CR]zsh\f[R], \f[CR]fish\f[R], \f[CR]ash\f[R]).
.IP \(bu 2
\f[B]\f[CB]\-\-flush\-cache\f[B]\f[R]
.PD 0
.P
.PD
Flush and rebuild the embedded configuration cache (only available when
built with \f[CR]embed\-configs\f[R]).
.IP \(bu 2
\f[B]\f[CB]\-\-config\f[B]\f[R], \f[B]\-c\f[R] \f[I]NAME\f[R]
.PD 0
.P
.PD
Explicit config file name (e.g., \f[CR]df\f[R] to load
\f[CR]conf.df\f[R]).
.IP \(bu 2
\f[B]\f[CB]\-\-version\f[B]\f[R], \f[B]\-V\f[R]
.PD 0
.P
.PD
Print the installed \f[CR]rgrc\f[R] version and exit.
.IP \(bu 2
\f[B]\f[CB]\-\-verbose\f[B]\f[R]\f[CR][=\f[R]\f[I]LEVEL\f[R]\f[CR]]\f[R],
\f[B]\-v\f[R], \f[B]\-vv\f[R]
.PD 0
.P
.PD
Enable rule\-level debug output (only available when the binary is built
with the \f[CR]debug\f[R] feature).
If provided without a value, behaves like \f[CR]\-\-verbose=1\f[R].
\f[B]Debug Levels:\f[R]
.RS 2
.IP \(bu 2
\f[B]\f[CB]\-\-verbose[=1]\f[B]\f[R] or \f[B]\-v\f[R] (Basic): Show
matched rules count and style count for each line.
.RS 2
.IP \(bu 2
Format: \f[CR][Line N] ✓ Matched M rule(s): #R (S style(s)), ...\f[R]
.RE
.IP \(bu 2
\f[B]\f[CB]\-\-verbose=2\f[B]\f[R] or \f[B]\-vv\f[R] (Verbose): Show
detailed matching information including:
.RS 2
.IP \(bu 2
Rule regex patterns
.IP \(bu 2
Matched text with capture groups (space\-separated)
.IP \(bu 2
Applied styles for each capture group
.RE
.RE
.SS CONFIGURATION FILES
\f[B]rgrc\f[R] reads its configuration from all of the following
locations (same format as \f[B]rgrc.conf\f[R]), if available.
All matching rules are read and used.
.IP
.EX
\(ti/.rgrc
\(ti/.config/rgrc/rgrc.conf
/usr/local/etc/rgrc.conf
/etc/rgrc.conf
\(ti/.grc
\(ti/.config/grc/grc.conf
/usr/local/etc/grc.conf
/etc/grc.conf
.EE
.PP
Any \f[B]grcat\f[R] configuration (e.g.\ \f[B]conf.\f[R]_xyz_) are
searched for in all of these locations.
Only the first found file is read and used.
.IP
.EX
\(ti/.config/rgrc
\(ti/.local/share/rgrc
/usr/local/share/rgrc
/usr/share/rgrc
\(ti/.config/grc
\(ti/.local/share/grc
/usr/local/share/grc
/usr/share/grc
.EE
.PP
To extend the existing configuration for a command that is already
configured, simply add a new rule in \f[B]\(ti/.rgrc\f[R] and have a
unique \f[B]conf.\f[R]_command_.
To replace existing rules for a known command, create
\f[B]\(ti/.config/rgrc/conf.\f[R]_command_ and it will be used instead
of the one from \f[B]/usr/share/grc\f[R].
.SS SEE ALSO
\f[B]grc\f[R](1), \f[B]grcat\f[R](1)
.SS AUTHOR
Written by Lazy Walker \c
.MT l4zywalk3r@gmail.com
.ME \c