nojhan/colout
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update the README with recent features

Browse source
This commit is contained in:
Johann Dreo 2013-05-30 11:33:12 +02:00
commit 9b3e8e257c
1 changed files with 41 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

53
README.md
View file

@ -3,12 +3,12 @@ colout(1) -- Color Up Arbitrary Command Ouput
## SYNOPSIS ## SYNOPSIS
`colout` [-h] [-e] [-g] [-t] [-s] [-l] PATTERN [COLOR(S)] [STYLE(S)] `colout` [-h] [-g] [-c] [-l] [-a] [-t] [-T] [-s] PATTERN [COLOR(S)] [STYLE(S)]
## DESCRIPTION ## DESCRIPTION
`colout` read lines of text stream on the standard input and output characters `colout` read lines of text stream on the standard input and output characters
matching a given regular expression *PATTERN* in given <COLOR> and *STYLE*. matching a given regular expression *PATTERN* in given <COLOR> and *STYLE*.
If groups are specified in the regular expression pattern, only them are taken If groups are specified in the regular expression pattern, only them are taken
@ -23,7 +23,8 @@ Available colors are: blue, black, yellow, cyan, green, magenta, white, red,
rainbow, random, Random, scale, none or any number between 0 and 255. rainbow, random, Random, scale, none or any number between 0 and 255.
Available styles are: normal, bold, faint, italic, underline, blink, Available styles are: normal, bold, faint, italic, underline, blink,
rapid_blink, reverse, conceal or random. rapid_blink, reverse, conceal or random (some styles may have no effect, depending
on your terminal).
`Random` will color each matching pattern with a random color among the 255 `Random` will color each matching pattern with a random color among the 255
available in the ANSI table. `random` will do the same in 8 colors mode. available in the ANSI table. `random` will do the same in 8 colors mode.
@ -31,9 +32,16 @@ available in the ANSI table. `random` will do the same in 8 colors mode.
`rainbow` will cycle over a 8 colors rainbow at each matching pattern. `rainbow` will cycle over a 8 colors rainbow at each matching pattern.
`scale` will parse the matching text as a decimal number and apply the rainbow `scale` will parse the matching text as a decimal number and apply the rainbow
colormap according to its position on a scale defined by the `-l` option (see colormap according to its position on the scale defined by the `-l` option (see
below, [0-100] by default). below, [0-100] by default).
If the python-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. Note that the RGB colors will be converted to their nearest ANSI
256-colors mode equivalents (see the `-P` switch below).
When not specified, a *COLOR* defaults to _red_ and a *STYLE* defaults to _bold_. When not specified, a *COLOR* defaults to _red_ and a *STYLE* defaults to _bold_.
`colout` comes with some predefined themes to rapidely color well-known outputs `colout` comes with some predefined themes to rapidely color well-known outputs
@ -42,8 +50,12 @@ When not specified, a *COLOR* defaults to _red_ and a *STYLE* defaults to _bold_
If the python-pygments library is available, `colout` can be used as an interface If the python-pygments library is available, `colout` can be used as an interface
to it (see also the `-s` switch below). 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. `colout` is released under the GNU Public License v3.
## INSTALLATION ## INSTALLATION
sudo python setup.py install sudo python setup.py install
@ -52,12 +64,13 @@ and then soft link `/usr/local/bin/colout` to your colout.py under your installa
/usr/local/lib/python2.7/dist-packages/colout-0.1-py2.7.egg/colout/colout.py /usr/local/lib/python2.7/dist-packages/colout-0.1-py2.7.egg/colout/colout.py
## OTHER INSTALLATION METHOD ## OTHER INSTALLATION METHOD
Pypi(the Python Package Index) Pypi(the Python Package Index)
sudo pip install colout sudo pip install colout
or or
sudo easy_install colout sudo easy_install colout
@ -86,7 +99,7 @@ Gentoo overlay
3. Edit `$EPREFIX/var/lib/layman/my-list.xml`. The content of this file should be: 3. Edit `$EPREFIX/var/lib/layman/my-list.xml`. The content of this file should be:
<?xml version="1.0" ?> <?xml version="1.0" ?>
<repositories version="1.0"> <repositories version="1.0">
<repo priority="50" quality="experimental" status="unofficial"> <repo priority="50" quality="experimental" status="unofficial">
<name>dongwm-overlay</name> <name>dongwm-overlay</name>
@ -94,15 +107,15 @@ Gentoo overlay
<homepage>https://github.com/dongweiming/dongwm-overlay.git</homepage> <homepage>https://github.com/dongweiming/dongwm-overlay.git</homepage>
<owner> <owner>
<email>ciici1234@hotmail.com</email> <email>ciici1234@hotmail.com</email>
</owner> </owner>
<source type="git">git://github.com/dongweiming/dongwm-overlay.git</source> <source type="git">git://github.com/dongweiming/dongwm-overlay.git</source>
</repo> </repo>
</repositories> </repositories>
4. Add this overlay and installation 4. Add this overlay and installation
layman -a dongwm-overlay && sudo emerge colout layman -a dongwm-overlay && sudo emerge colout
## OPTIONS ## OPTIONS
@ -115,22 +128,38 @@ Gentoo overlay
* `-c`, `--colormap`: * `-c`, `--colormap`:
Use the given list of comma-separated colors as a colormap (cycle the colors at each match). Use the given list of comma-separated colors as a colormap (cycle the colors at each match).
* `-l`, `--scale`: * `-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).
* `-l min,max`, `--scale min,max`:
When using the 'scale' colormap, parse matches as decimal numbers (taking your locale into account) When using the 'scale' colormap, parse matches as decimal numbers (taking your locale into account)
and apply the rainbow colormap linearly between the given SCALE=min,max (SCALE=0,100, by default). and apply the rainbow colormap linearly between the given min,max (0,100, by default).
* `-a`, `--all`: * `-a`, `--all`:
Color the whole input at once instead of line per line Color the whole input at once instead of line per line
(really useful for coloring a source code file with strings on multiple lines). (really useful for coloring a source code file with strings on multiple lines).
* `-t`, `--theme`: * `-t`, `--theme`:
Interpret PATTERN as a predefined theme (perm, cmake, g++, etc.) 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.
* `-r`, `--resources`:
Print the names of all available colors, styles, themes and palettes.
* `-s`, `--source`: * `-s`, `--source`:
Interpret PATTERN as a source code readable by the Pygments library. If the first letter of PATTERN Interpret PATTERN as a source code readable by the Pygments library. If the first letter of PATTERN
is upper case, use the 256 colors mode, if it is lower case, use the 8 colors mode. is upper case, use the 256 colors mode, if it is lower case, use the 8 colors mode.
In 256 colors, interpret COLOR as a Pygments style (e.g. "default"). In 256 colors, 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 ## REGULAR EXPRESSIONS