colout(1) -- Color Up Arbitrary Command Output

SYNOPSIS

colout [-h] [-r RESOURCE]

colout [-g] [-c] [-l min,max] [-a] [-t] [-T DIR] [-P DIR] [-d COLORMAP] [-s] [--debug] PATTERN [COLOR(S) [STYLE(S)]]

DESCRIPTION

colout read lines of text stream on the standard input and output characters matching a given regular expression PATTERN in given COLOR and STYLE.

If groups are specified in the regular expression pattern, only them are taken into account, else the whole matching pattern is colored.

You can specify several colors or styles when using groups by separating them with commas. If you indicate more colors than groups, the last ones will be ignored. If you ask for fewer colors, the last one will be duplicated across remaining groups.

Available colors are: blue, black, yellow, cyan, green, magenta, white, red, rainbow, random, Random, Spectrum, spectrum, scale, Scale, hash, Hash, none, an RGB hexadecimal triplet (#11aaff, for example) or any number between 0 and 255.

Available styles are: normal, bold, faint, italic, underline, blink, rapid_blink, reverse, conceal or random (some styles may have no effect, depending on your terminal).

rainbow will cycle over a the default colormap at each matching pattern. Rainbow will do the same over the default colormap for the 256-colors mode (this requires a terminal that supports the 256 color escape sequences).

Random will color each matching pattern with a random color among the default colormap (the 255 available in the ANSI table, by default). random will do the same in 8 colors mode.

spectrum and Spectrum are like rainbows, but with more colors (8 and 36 colors).

scale (8 colors) and Scale (256 colors) will parse the numbers characters in the matching text as a decimal number and apply the default colormap according to its position on the scale defined by the -l option (see below, "0,100" by default).

hash (8 colors) and Hash (256 colors) will take a fingerprint of the matching text and apply the default colormap according to it. This ensure that matching texts appearing several times will always get the same color.

Before interpreting the matched string as a number, colout will remove any character not supposed to be used to write down numbers. This permits to apply this special color on a large group, while interpreting only its numerical part.

If the python3-pygments library is installed, you can use the name of a syntax-coloring "lexer" as a color (for example: "Cpp", "ruby", "xml+django", etc.).

If GIMP palettes files (*.gpl) are available, you can also use their names as a colormap (see the -P switch below).

Note that the RGB colors (either the hex triplets or the palettes's colors) will be converted to their nearest ANSI 256 color mode equivalents.

When not specified, a COLOR defaults to red and a STYLE defaults to bold.

colout comes with some predefined themes to rapidly color well-known outputs (see the -t switch below).

If the python3-pygments library is available, colout can be used as an interface to it (see also the -s switch below).

To have a list of all colors, styles, special colormaps, themes, palettes and lexers, use the -r switch (see below).

colout is released under the GNU Public License v3.

INSTALLATION

sudo python3 setup.py install

and then soft link /usr/local/bin/colout to your colout.py under your installation directory, which is usually something like

/usr/local/lib/python3/dist-packages/colout-0.1-py3.egg/colout/colout.py

OTHER INSTALLATION METHOD

Pypi (the Python Package Index)

sudo pip install colout

sudo easy_install colout

Ubuntu 13.04's ppa

sudo add-apt-repository ppa:ciici123/colout
sudo apt-get update
sudo apt-get/aptitude install colout

Gentoo

sudo emerge colout

OPTIONS

-h, --help: Show a help message and exit
-g, --groups: For color maps (like "rainbow"), iterate over matching groups in the pattern instead of over patterns.
-c, --colormap: Use the given list of comma-separated colors as a colormap (cycle the colors at each match).
-l min,max, --scale min,max: When using the 'scale' colormap, parse matches as decimal numbers (taking your locale into account) or as arithmetic expression (like "1+2/0.9*3") and apply the rainbow colormap linearly between the given min,max (0,100, by default).
-a, --all: Color the whole input at once instead of line per line (really useful for coloring a source code file with strings on multiple lines).
-t, --theme: Interpret PATTERN as a predefined theme (perm, cmake, g++, etc.).
-T DIR, --themes-dir DIR: Search for additional themes (colout_*.py files) in this directory.
-P DIR, --palettes-dir DIR: Search for additional palettes (*.gpl files) in this directory.
-d COLORMAP, --default COLORMAP: When using special colormaps (random, scale or hash), use this COLORMAP instead of the default one. This can be either one of the available colormaps or a comma-separated list of colors. WARNING: be sure to specify a default colormap that is compatible with the special colormap's mode, or else the colors may not appear the same. Also, external palettes are converted from RGB to 256-ANSI and will thus not work if you use them as default colormaps for a 8-colors mode special color.
-r TYPE(S), --resources TYPE(S): Print the names of available resources. Use a comma-separated list of resources names (styles, colors, special, themes, palettes, colormaps or lexers), use 'all' to print everything.
-s, --source: Interpret PATTERN as source code readable by the Pygments library. If the first letter of PATTERN is upper case, use the 256 color mode, if it is lower case, use the 8 colors mode. In 256 color mode, interpret COLOR as a Pygments style (e.g. "default").
--debug: Debug mode: print what's going on internally, if you want to check what features are available.

REGULAR EXPRESSIONS

A regular expression (or regex) is a pattern that describes a set of strings that matches it.

colout understands regex as specified in the re python module. Given that colout is generally called by the command line, you may have to escape special characters that would be recognize by your shell.

DEPENDENCIES

Recommended packages:

argparse for a usable arguments parsing
pygments for the source code syntax coloring
babel for a locale-aware number parsing

LIMITATIONS

Don't use nested groups or colout will duplicate the corresponding input text with each matching colors.

Using a default colormap that is incompatible with the special colormap's mode will end badly.

EXAMPLES

Simple

Color in bold red every occurrence of the word color in colout sources: cat colout.py | colout color red bold
Color in bold violet home directories in /etc/passwd: colout '/home/[a-z]+' 135 < /etc/passwd
Color in yellow user/groups id, in bold green name and in bold red home directories in /etc/passwd: colout ':x:([0-9]+:[0-9]+):([^:]+).*(/home/[a-z]+)' yellow,green,red normal,bold < /etc/passwd
Color in yellow file permissions with read rights for everyone: ls -l | colout '.(r.-){3}' yellow normal
Color in green read permission, in bold red write and execution ones: ls -l | colout '(r)(w*)(x*)' green,red normal,bold
Color in green comments in colout sources: colout '.*(#.*)$' green normal < colout.py
Color in bold green every numbers and in bold red the words error in make output: make 2>&1 | colout '[0-9]+' green normal | colout error

Somewhat useful

Use a different color for each line of the auth log grep user /var/log/auth.log | colout "^.*$" rainbow
Color each line of a file with a different color among a 256 color gradient from cyan to green: head /var/log/auth.log | colout -c "^.*$" 39,38,37,36,35,34
Color permissions with a predefined template: ls -l | colout -t perm
Color in light green comments in non-empty colout sources, with the sharp in bold green: grep -v '^\s*$' colout.py | colout '.*(#)(.*)$' green,119 bold,normal
Color a make output, line numbers in yellow, errors in bold red, warning in magenta, pragma in green and C++ file base names in cyan: make 2>&1 | colout ':([0-9]+):[0-9]*' yellow normal | colout error | colout warning magenta | colout pragma green normal | colout '/(\w+)*\.(h|cpp)' cyan normal Or using themes: make 2>&1 | colout -t cmake | colout -t g++
Color each word in the head of auth.log with a rainbow color map, starting a new colormap at each new line (the beginning of the command is just bash magic to repeat the string "(\w+)\W+": L=$(seq 10) ; P=${L//??/(\\w+)\\W+} ; head /var/log/auth.log | colout -g "^${P}(.*)$" rainbow
Color source code in 8 colors mode, without seeing comments: cat colout.py | grep -v "#" | colout -s python
Color source code in 256 color mode: cat colout.py | colout -s Python monokai
Color a JSON stream: echo '{"foo": "lorem", "bar":"ipsum"}' | python -mjson.tool | colout -t json
Color a source code substring: echo "There is an error in 'static void Functor::operator()( EOT& indiv ) { return indiv; }' you should fix it" | colout "'(.*)'" Cpp monokai
Color the percent of progress part of a CMake's makefile output, with a color related to the value of the progress (from 0%=blue to 100%=red): cmake .. && make | colout "^(\[\s*[0-9]+%\])" Scale
Color hosts and users in auth.log, with consistent colors: cat /var/log/auth.log | colout "^(\S+\s+){3}(\S+)\s(\S+\s+){3}(\S+)\s+(\S+\s+){2}(\S+)\s*" none,hash,none,hash,none,hash

Bash alias

The following bash function color the output of any command with the cmake and g++ themes:

function cm()
{
    set -o pipefail
    $@ 2>&1  | colout -t cmake | colout -t g++
}

You then can use the cm alias as a prefix to your build command, for example: cm make test

Themes

You can easily add your own theme to colout. A theme is basically a module with a function named theme that take the configuration context as an argument and return back the (modified) context and a list of triplets. Each triplet figures the same arguments than those of the command line interface.

def theme(context):
    return context,[ [regexp, colors, styles] ]

With the context dictionary at hand, you have access to the internal configuration of colout, you can thus change colormaps for special keywords, the scale, even the available colors, styles or themes.

See the cmake theme for how to modify an existing colormap if (and only if) the user didn't ask for an alternative one. See the ninja theme for how to extend an existing theme with more regexps and a different configuration. See the gcc theme for an example of how to use the localization of existing softwares to build translated regexp.

Buffering

Note that when you use colout within real time streams (like tail -f X | qrep Y | colout Y) of commands, you may observe that the lines are printed by large chunks and not one by one, in real time. This is not due to colout but to the buffering behavior of your shell. To fix that, use stdbuf, for example: tail -f X | stdbuf -o0 grep Y | colout Y.

bradparks / colout__simple_colorize_with_themes Goto Github PK

colout__simple_colorize_with_themes's Introduction