1
0
mirror of https://github.com/Kitware/CMake.git synced 2025-10-14 02:08:27 +08:00
Files
CMake/Help/envvar/NO_COLOR.rst
Brad King 6aa604ef10 StdIo: Honor NO_COLOR environment variable
This convention is documented by https://bixense.com/clicolors/

Closes: #26458
2025-05-20 11:57:29 -04:00

20 lines
638 B
ReStructuredText

NO_COLOR
--------
.. versionadded:: 4.1
.. include:: include/ENV_VAR.rst
Set to a non-empty value, other than ``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` and :envvar:`CLICOLOR` environment
variables. If :envvar:`!NO_COLOR` is activated, it takes precedence
over both of them.
See the :variable:`CMAKE_COLOR_DIAGNOSTICS` variable to control
color in a generated build system.
.. _`common convention`: https://web.archive.org/web/20250410160803/https://bixense.com/clicolors/