Color::ANSI::Util - Routines for dealing with ANSI colors
This document describes version 0.13 of Color::ANSI::Util (from Perl distribution Color-ANSI-Util), released on 2014-08-06.
use Color::ANSI::Util qw( ansifg ansibg ); say ansifg("f0c010"); # => "\e[33;1m" (on 16-color terminal) # => "\e[38;5;11m" (on 256-color terminal) # => "\e[38;2;240;192;16m" (on 24-bit-color terminal) say ansibg("ff5f87"); # => "\e[47m" (on 16-color terminal) # => "\e[48;5;7m" (on 256-color terminal) # => "\e[48;2;255;95;135m" (on 24-bit-color terminal)
There are a bunch of other exportable functions too, mostly for converting between RGB and ANSI color (16/256/24bit color depth).
This module provides routines for dealing with ANSI colors. The two main functions are ansifg and ansibg. With those functions, you can specify colors in RGB and let it output the correct ANSI color escape code according to the color depth support of the terminal (whether 16-color, 256-color, or 24bit). There are other functions to convert RGB to ANSI in specific color depths, or reverse functions to convert from ANSI to RGB codes.
ansifg
ansibg
Keywords: xterm, xterm-256color, terminal
Convert ANSI-16 color to RGB. $color is number from 0-15, or color names "black", "red", "green", "yellow", "blue", "magenta", "cyan", "white" with "bold" to indicate bold/bright. Return 6-hexdigit, e.g. "ff00cc".
$color
Die on invalid input.
Convert RGB to ANSI-16 color. $color is 6-hexdigit RGB color like "ff00cc". Will pick the closest color. Return number from 0-15.
Convert ANSI-256 color to RGB. $color is a number from 0-255. Return 6-hexdigit, e.g. "ff00cc".
Convert RGB to ANSI-256 color. $color is 6-hexdigit RGB color like "ff00cc". Will pick the closest color. Return number between 0-255.
Alias for rgb_to_ansi16_fg_code().
Alias for rgb_to_ansi16_bg_code().
Alias for rgb_to_ansi256_fg_code().
Alias for rgb_to_ansi256_bg_code().
Return ANSI escape code to set 24bit foreground color. Supported by Konsole and Yakuake.
Alias for rgb_to_ansi24b_fg_code().
Return ANSI escape code to set 24bit background color. Supported by Konsole and Yakuake.
Alias for rgb_to_ansi24b_bg_code().
Return ANSI escape code to set 24bit/256/16 foreground color (which color depth used is determined by COLOR_DEPTH environment setting or from Term::Detect::Software if that module is available). In other words, this function automatically chooses rgb_to_ansi{24b,256,16}_fg_code().
COLOR_DEPTH
Alias for rgb_to_ansi_fg_code().
Return ANSI escape code to set 24bit/256/16 background color (which color depth used is determined by COLOR_DEPTH environment setting or from Term::Detect::Software if that module is available). In other words, this function automatically chooses rgb_to_ansi{24b,256,16}_bg_code().
Alias for rgb_to_ansi_bg_code().
Observed by: ansi{fg,bg}.
Algorithm for finding closest indexed color from RGB color currently not very efficient. Probably can add some threshold square distance, below which we can shortcut to the final answer.
Routine to convert ANSI escape code, e.g. \e[31;1m into RGB value (ff0000).
\e[31;1m
Term::ANSIColor
http://en.wikipedia.org/wiki/ANSI_escape_code
Please visit the project's homepage at https://metacpan.org/release/Color-ANSI-Util.
Source repository is at https://github.com/sharyanto/perl-Color-ANSI-Util.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Color-ANSI-Util
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.
Steven Haryanto <stevenharyanto@gmail.com>
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.
To install Color::ANSI::Util, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Color::ANSI::Util
CPAN shell
perl -MCPAN -e shell install Color::ANSI::Util
For more information on module installation, please visit the detailed CPAN module installation guide.