Data::Unixish::ANSI::highlight - Highlight string/pattern with color
This document describes version 0.07 of Data::Unixish::ANSI::highlight (from Perl distribution Data-Unixish-ANSI), released on 2015-09-03.
In Perl:
use Data::Unixish qw(lduxl); $hilited = lduxl(['ANSI::highlight' => {string=>"er"}], "merah"); # "m\e[31m\e[1mer\e[0mah"
In command line:
% echo -e "merah" | dux ANSI::highlight -s er; # 'er' will be highlighted merah
Highlight string/pattern with color.
Arguments ('*' denotes required arguments):
ci => bool (default: 0)
Whether to search case-insensitively.
color => str (default: "bold red")
The color to use for each item.
Example: red, bold blue, yellow on_magenta, black on_bright_yellow. See Perl module Term::ANSIColor for more details.
red
bold blue
yellow on_magenta
black on_bright_yellow
You can also supply raw ANSI code.
in => array
Input stream (e.g. array or filehandle).
out => any
Output stream (e.g. array or filehandle).
pattern => str
Regex pattern to search.
Either this or string is required.
string
string => str
String to search.
Either this or pattern is required.
pattern
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
Please visit the project's homepage at https://metacpan.org/release/Data-Unixish-ANSI.
Source repository is at https://github.com/perlancar/perl-Data-Unixish-ansi.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Unixish-ANSI
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2015 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Data::Unixish::ANSI, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Data::Unixish::ANSI
CPAN shell
perl -MCPAN -e shell install Data::Unixish::ANSI
For more information on module installation, please visit the detailed CPAN module installation guide.