Color::ANSI::Util - Routines for dealing with ANSI colors
This document describes version 0.162 of Color::ANSI::Util (from Perl distribution Color-ANSI-Util), released on 2018-12-02.
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
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.
Usage:
ansi16_to_rgb($color) -> color::rgb24
Convert ANSI-16 color to RGB.
Returns 6-hexdigit, e.g. 'ff00cc'.
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
$color* => color::ansi16
Return value: (color::rgb24)
ansi256_to_rgb($color) -> color::rgb24
Convert ANSI-256 color to RGB.
$color* => color::ansi256
rgb_to_ansi16($color) -> color::ansi16
Convert RGB to ANSI-16 color.
$color* => color::rgb24
Return value: (color::ansi16)
rgb_to_ansi16_bg_code($color) -> str
Convert RGB to ANSI-16 color escape sequence to change background color.
Return value: (str)
rgb_to_ansi16_fg_code($color) -> str
Convert RGB to ANSI-16 color escape sequence to change foreground color.
rgb_to_ansi24b_bg_code($color) -> str
Convert RGB to ANSI 24bit-color escape sequence to change background color.
rgb_to_ansi24b_fg_code($color) -> str
Convert RGB to ANSI 24bit-color escape sequence to change foreground color.
rgb_to_ansi256($color) -> color::ansi256
Convert RGB to ANSI-256 color.
Return value: (color::ansi256)
rgb_to_ansi256_bg_code($color) -> str
Convert RGB to ANSI-256 color escape sequence to change background color.
rgb_to_ansi256_fg_code($color) -> str
Convert RGB to ANSI-256 color escape sequence to change foreground color.
rgb_to_ansi_bg_code($color) -> str
Convert RGB to ANSI color escape sequence to change background color.
Autodetect terminal capability and can return either empty string, 16-color, 256-color, or 24bit-code.
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}bgcode().
COLOR_DEPTH
rgb_to_ansi_fg_code($color) -> str
Convert RGB to ANSI color escape sequence to change foreground color.
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}fgcode().
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().
Alias for rgb_to_ansi24b_fg_code().
Alias for rgb_to_ansi24b_bg_code().
Alias for rgb_to_ansi_fg_code().
Alias for rgb_to_ansi_bg_code().
Returns "\e[0m", which is the ANSI escape sequence to reset color. Normally you print this sequence after you print colored text.
Can be used to explicitly disable color. See https://no-color.org for more details.
Observed by: ansi{fg,bg}.
Can be used to explicitly disable color by setting it to 0.
Can be used to explicitly set color depth instead of trying to detect appropriate color depth.
Please visit the project's homepage at https://metacpan.org/release/Color-ANSI-Util.
Source repository is at https://github.com/perlancar/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.
Term::ANSIColor
http://en.wikipedia.org/wiki/ANSI_escape_code
perlancar <perlancar@cpan.org>
This software is copyright (c) 2018, 2017, 2016, 2015, 2014, 2013 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 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.