CMake/Help/envvar/CLICOLOR.rst
Brad King d94e3eac10 Help: Clarify CLICOLOR and CLICOLOR_FORCE environment variables
Document variable precedence.

Link to third-party documentation of the convention these follow.
For now, link to an older view of the documentation since our
implementation has not been updated for `NO_COLOR`.

Issue: #26458
2024-11-19 11:35:16 -05:00

20 lines
582 B
ReStructuredText

CLICOLOR
--------
.. versionadded:: 3.21
.. include:: ENV_VAR.txt
Set to ``0`` to tell command-line tools not to print color
messages even if connected to a terminal.
This is a `common convention`_ among command-line tools in general.
See also the :envvar:`CLICOLOR_FORCE` environment variable.
:envvar:`CLICOLOR_FORCE`, if activated, takes precedence over
:envvar:`!CLICOLOR`.
See the :variable:`CMAKE_COLOR_DIAGNOSTICS` variable to control
color in a generated build system.
.. _`common convention`: https://web.archive.org/web/20230417221418/https://bixense.com/clicolors/