mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-06 05:40:54 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'doc_env'

Browse Source 
a8634b878a Help:ENV: note escaping needed for special characters

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8733
This commit is contained in:
Brad King
2023-08-19 12:43:33 +00:00
committed by Kitware Robot
parent a891f7d0bf a8634b878a
commit e17f17c7a0
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Help/variable/ENV.rst
View File

@@ -8,6 +8,17 @@ Use the syntax ``$ENV{VAR}`` to read environment variable ``VAR``.
To test whether an environment variable is defined, use the signature
``if(DEFINED ENV{<name>})`` of the :command:`if` command.
.. note::
Environment variable names containing special characters like parentheses
may need to be escaped. (Policy :policy:`CMP0053` must also be enabled.)
For example, to get the value of the Windows environment variable
``ProgramFiles(x86)``, use:
.. code-block:: cmake
set(ProgramFiles_x86 "$ENV{ProgramFiles\(x86\)}")
For general information on environment variables, see the
:ref:`Environment Variables <CMake Language Environment Variables>`
section in the :manual:`cmake-language(7)` manual.