/ 
Data-Unixish-ansi-0.04
/ Data::Unixish::ansi::highlight

NAME

Data::Unixish::ansi::highlight - Highlight string/pattern with color

VERSION

version 0.04

SYNOPSIS

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

FUNCTIONS

highlight(%args) -> [status, msg, result, meta]

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.

    You can also supply raw ANSI code.

  • in => any

    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 => str

    String to search.

    Either this or pattern is required.

Return value:

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.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Data-Unixish-ansi.

SOURCE

Source repository is at https://github.com/sharyanto/perl-Data-Unixish-ansi.

BUGS

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.

AUTHOR

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2014 by Steven Haryanto.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.