NAME
    XTerm::Util - Utility routines for xterm-compatible terminal (emulator)s

VERSION
    This document describes version 0.004 of XTerm::Util (from Perl
    distribution XTerm-Util), released on 2019-07-12.

SYNOPSIS
     use XTerm::Util qw(
         get_term_bgcolor
         set_term_bgcolor
     );

     # when you're on a black background
     say get_term_bgcolor(); # => "000000"

     # when you're on a dark purple background
     say get_term_bgcolor(); # => "310035"

     # set terminal background to dark blue
     set_term_bgcolor("00002b");

DESCRIPTION
    Keywords: xterm, xterm-256color, terminal

FUNCTIONS
  get_term_bgcolor
    Usage:

     get_term_bgcolor(%args) -> any

    Get terminal background color.

    Get the terminal's current background color (in 6-hexdigit format e.g.
    000000 or ffff33), or undef if unavailable. This routine tries the
    following mechanisms, from most useful to least useful, in order. Each
    mechanism can be turned off via argument.

    *query_terminal*. Querying the terminal is done via sending the
    following xterm control sequence:

     \e]11;?\a

    and a compatible terminal will issue back the same sequence but with the
    question mark replaced by the RGB code, e.g.:

     \e]11;rgb:0000/0000/0000\a

    I have tested that this works on the following terminal software (and
    version) on Linux:

     MATE Terminal (1.18.2)
     GNOME Terminal (3.18.3)
     Konsole (16.04.3)

    And does not work with the following terminal software (and version) on
    Linux:

     LXTerminal (0.2.0)
     rxvt (2.7.10)

    *read_colorfgbg*. Some terminals like Konsole set the environment
    variable "COLORFGBG" containing 16-color color code for foreground and
    background, e.g.: "15;0".

    This function is not exported by default, but exportable.

    Arguments ('*' denotes required arguments):

    *   query_terminal => *bool* (default: 1)

    *   read_colorfgbg => *bool* (default: 1)

    Return value: (any)

  set_term_bgcolor
    Usage:

     set_term_bgcolor($rgb, $stderr) -> any

    Set terminal background color.

    Set terminal background color. This prints the following xterm control
    sequence to STDOUT (or STDERR, if ~stderr~ is set to true:

     \e]11;#123456\a

    where *123456* is the 6-hexdigit RGB color code.

    This function is not exported by default, but exportable.

    Arguments ('*' denotes required arguments):

    *   $rgb* => *color::rgb24*

    *   $stderr => *true*

    Return value: (any)

  term_bgcolor_is_dark
    Usage:

     term_bgcolor_is_dark(%args) -> [status, msg, payload, meta]

    Check if terminal background color is dark.

    This is basically get_term_bgcolor + rgb_is_dark.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   query_terminal => *bool* (default: 1)

    *   quiet => *bool*

    *   read_colorfgbg => *bool* (default: 1)

    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 (payload) is optional, the actual result. Fourth element (meta)
    is called result metadata and is optional, a hash that contains extra
    information.

    Return value: (any)

  term_bgcolor_is_light
    Usage:

     term_bgcolor_is_light(%args) -> [status, msg, payload, meta]

    Check if terminal background color is light.

    This is basically get_term_bgcolor + rgb_is_light.

    This function is not exported.

    Arguments ('*' denotes required arguments):

    *   query_terminal => *bool* (default: 1)

    *   quiet => *bool*

    *   read_colorfgbg => *bool* (default: 1)

    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 (payload) is optional, the actual result. Fourth element (meta)
    is called result metadata and is optional, a hash that contains extra
    information.

    Return value: (any)

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/XTerm-Util>.

SOURCE
    Source repository is at <https://github.com/perlancar/perl-XTerm-Util>.

BUGS
    Please report any bugs or feature requests on the bugtracker website
    <https://rt.cpan.org/Public/Dist/Display.html?Name=XTerm-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.

SEE ALSO
    Color::ANSI::Util

    XTerm control sequence:
    <http://invisible-island.net/xterm/ctlseqs/ctlseqs.html>.

AUTHOR
    perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE
    This software is copyright (c) 2019, 2018 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.

