diff options
| author | Jean-Michaël Celerier <jean-michael.celerier@kdab.com> | 2020-04-14 08:50:26 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2020-04-14 14:04:58 (GMT) |
| commit | 03b6f3a2e880cb9a1f25935e598716c943b5d942 (patch) | |
| tree | b6dbb080cbbc067fa13fe489a2a585b5eaa6f2b0 /Help/envvar/CMAKE_PREFIX_PATH.rst | |
| parent | deba768e1443d6aae0ccc640d5e50d42657aaf92 (diff) | |
| download | CMake-03b6f3a2e880cb9a1f25935e598716c943b5d942.zip CMake-03b6f3a2e880cb9a1f25935e598716c943b5d942.tar.gz CMake-03b6f3a2e880cb9a1f25935e598716c943b5d942.tar.bz2 | |
Help: Document the CMAKE_PREFIX_PATH environment variable
Diffstat (limited to 'Help/envvar/CMAKE_PREFIX_PATH.rst')
| -rw-r--r-- | Help/envvar/CMAKE_PREFIX_PATH.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/Help/envvar/CMAKE_PREFIX_PATH.rst b/Help/envvar/CMAKE_PREFIX_PATH.rst new file mode 100644 index 0000000..276fdd6 --- /dev/null +++ b/Help/envvar/CMAKE_PREFIX_PATH.rst @@ -0,0 +1,17 @@ +CMAKE_PREFIX_PATH +----------------- + +.. include:: ENV_VAR.txt + +The ``CMAKE_PREFIX_PATH`` environment variable may be set to a list of +directories specifying installation *prefixes* to be searched by the +:command:`find_package`, :command:`find_program`, :command:`find_library`, +:command:`find_file`, and :command:`find_path` commands. Each command will +add appropriate subdirectories (like ``bin``, ``lib``, or ``include``) +as specified in its own documentation. + +This variable may hold a single prefix or a list of prefixes separated +by ``:`` on UNIX or ``;`` on Windows (the same as the ``PATH`` environment +variable convention on those platforms). + +See also the :variable:`CMAKE_PREFIX_PATH` CMake variable. |