App-Greple
view release on metacpan or search on metacpan
Option **--nocolor** is alias for **--color**=_never_.
When color output is disabled, ANSI terminal sequence is not produced,
but functional colormap, such as `--cm sub{...}`, still works.
- **--colormap**=_spec_, **--cm**=...
Specify color map. Because this option is mostly implemented by
[Getopt::EX::Colormap](https://metacpan.org/pod/Getopt%3A%3AEX%3A%3AColormap) module, consult its document for detail and
up-to-date specification.
Color specification is combination of single uppercase character
representing basic colors, and (usually brighter) alternative colors in
lowercase:
R r Red
G g Green
B b Blue
C c Cyan
M m Magenta
Y y Yellow
K k Black
W w White
or RGB value and 24 grey levels if using ANSI 256 color terminal:
(255,255,255) : 24bit decimal RGB colors
#000000 .. #FFFFFF : 24bit hex RGB colors
#000 .. #FFF : 12bit hex RGB 4096 colors
000 .. 555 : 6x6x6 RGB 216 colors
L00 .. L25 : Black (L00), 24 grey levels, White (L25)
> Beginning # can be omitted in 24bit RGB notation.
>
> When values are all same in 24bit or 12bit RGB, it is converted to 24
> grey level, otherwise 6x6x6 216 color.
or color names enclosed by angle bracket:
<red> <blue> <green> <cyan> <magenta> <yellow>
<aliceblue> <honeydue> <hotpink> <mooccasin>
<medium_aqua_marine>
with other special effects:
N None
Z 0 Zero (reset)
D 1 Double strike (boldface)
P 2 Pale (dark)
I 3 Italic
U 4 Underline
F 5 Flash (blink: slow)
Q 6 Quick (blink: rapid)
S 7 Stand out (reverse video)
H 8 Hide (concealed)
X 9 Cross out
E Erase Line
; No effect
/ Toggle foreground/background
^ Reset to foreground
@ Reset index list
If the spec includes `/`, left side is considered as foreground color
and right side as background. If multiple colors are given in same
spec, all indicators are produced in the order of their presence. As
a result, the last one takes effect.
Effect characters are case insensitive, and can be found anywhere and
in any order in color spec string. Character `;` does nothing and
can be used just for readability, like `SD;K/544`.
If the special reset symbol `@` is encountered, the index list is
reset to empty at that point. The reset symbol must be used alone and
may not be combined with other characters.
Example:
RGB 6x6x6 12bit 24bit color name
=== ======= ========= ============= ==================
B 005 #00F (0,0,255) <blue>
/M /505 /#F0F /(255,0,255) /<magenta>
K/W 000/555 #000/#FFF 000000/FFFFFF <black>/<white>
R/G 500/050 #F00/#0F0 FF0000/00FF00 <red>/<green>
W/w L03/L20 #333/#ccc 303030/c6c6c6 <dimgrey>/<lightgrey>
Multiple colors can be specified separating by white space or comma,
or by repeating options. Those colors will be applied for each
pattern keywords. Next command will show word `foo` in red, `bar`
in green and `baz` in blue.
greple --colormap='R G B' 'foo bar baz'
greple --cm R -e foo --cm G -e bar --cm B -e baz
Coloring capability is implemented in [Getopt::EX::Colormap](https://metacpan.org/pod/Getopt%3A%3AEX%3A%3AColormap) module.
- **--colormap**=_field_=_spec_,...
Another form of colormap option to specify the color for fields:
FILE File name
LINE Line number
TEXT Unmatched normal text
BLOCKEND Block end mark
PROGRESS Progress status with -dnf option
The `BLOCKEND` mark is colored with `E` effect provided by
[Getopt::EX](https://metacpan.org/pod/Getopt%3A%3AEX) module, which allows to fill up the line with background
color. This effect uses irregular escape
sequence, and you may need to define `LESSANSIENDCHARS` environment
as "mK" to see the result with [less](https://metacpan.org/pod/less) command.
- **--colormap**=`&func`
- **--colormap**=`sub{...}`
You can also set the name of perl subroutine name or definition to be
called handling matched words. Target word is passed as variable
`$_`, and the return value of the subroutine will be displayed.
Next command convert all words in C comment to upper case.
greple --all '/\*(?s:.*?)\*/' --cm 'sub{uc}'
You can quote matched string instead of coloring (this emulates
deprecated option `--quote`):
greple --cm 'sub{"<".$_.">"}' ...
It is possible to use this definition with field names. Next example
print line numbers in seven digits.
greple -n --cm 'LINE=sub{s/(\d+)/sprintf("%07d",$1)/e;$_}'
Experimentally, function can be combined with other normal color
specifications. Also the form `&func;` can be repeated.
greple --cm 'BF/544;sub{uc}'
greple --cm 'R;&func1;&func2;&func3'
When color for 'TEXT' field is specified, whole text including matched
part is passed to the function, exceptionally. It is not recommended
to use user defined function for 'TEXT' field.
- **--colorsub**=`...`, **--cs**=`...`
`--colorsub` or `--cs` is a shortcut for subroutine colormap. It
simply enclose the argument by `sub{ ... }` expression. So
greple --cm 'sub{uc}'
can be written as simple as this.
greple --cs uc
You can not use this option for labeled color.
- **--\[no\]colorful**
Shortcut for `--colormap`='`RD GD BD CD MD YD`' in ANSI 16 colors
mode, and `--colormap`='`D/544 D/454 D/445 D/455 D/454 D/554`' and
other combination of 3, 4, 5 for 256 colors mode. Enabled by default.
When single pattern is specified, first color in colormap is used for
the pattern. If multiple patterns and multiple colors are specified,
each pattern is colored with corresponding color cyclically.
Option `--regioncolor` and `--colorindex` change this behavior.
( run in 0.990 second using v1.01-cache-2.11-cpan-f56aa216473 )