- COPYRIGHT AND LICENSE
get-term-bgcolor - Get terminal background color
This document describes version 0.005 of get-term-bgcolor (from Perl distribution App-XTermUtils), released on 2019-08-20.
% get-term-bgcolor [options]
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:
and a compatible terminal will issue back the same sequence but with the question mark replaced by the RGB code, e.g.:
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.:
* marks required options.
Choose output format, e.g. json, text.
Set output format to json.
When outputing as JSON, strip result envelope.
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C get-term-bgcolor get-term-bgcolor
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete get-term-bgcolor 'p/*/`get-term-bgcolor`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-XTermUtils.
Source repository is at https://github.com/perlancar/perl-App-XTermUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-XTermUtils
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.
This software is copyright (c) 2019, 2018 by email@example.com.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.