From a8634b878a071815989049ec814e6016087f96ce Mon Sep 17 00:00:00 2001 From: scivision Date: Thu, 17 Aug 2023 09:57:57 -0400 Subject: Help:ENV: note escaping needed for special characters --- Help/variable/ENV.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/Help/variable/ENV.rst b/Help/variable/ENV.rst index 6791853..71df3dd 100644 --- a/Help/variable/ENV.rst +++ b/Help/variable/ENV.rst @@ -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{})`` 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 ` section in the :manual:`cmake-language(7)` manual. -- cgit v0.12