OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	04/04/2023 07:10:48 PM	rwxr-xr-x
📄 add_compile_definitions.html	8.97 KB	04/04/2023 07:04:57 PM	rw-r--r--
📄 add_compile_options.html	13.11 KB	04/04/2023 07:04:57 PM	rw-r--r--
📄 add_custom_command.html	67.2 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_custom_target.html	26.7 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_definitions.html	9.72 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_dependencies.html	8.79 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_executable.html	20.23 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_library.html	43.25 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_link_options.html	17.79 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_subdirectory.html	8.85 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 add_test.html	17.09 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 aux_source_directory.html	6.45 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 block.html	13.15 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 break.html	5.97 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 build_command.html	10.66 KB	04/04/2023 07:04:58 PM	rw-r--r--
📄 build_name.html	6.43 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_host_system_information.html	38.46 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_language.html	59.74 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_minimum_required.html	13.56 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_parse_arguments.html	18.62 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_path.html	80.45 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 cmake_policy.html	23.14 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 configure_file.html	20.36 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 continue.html	6.15 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 create_test_sourcelist.html	7.61 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_build.html	14.87 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_configure.html	10.28 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_coverage.html	9.93 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_empty_binary_directory.html	5.54 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_memcheck.html	11.73 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_read_custom_files.html	5.78 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_run_script.html	6.72 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_sleep.html	5.66 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_start.html	14.68 KB	04/04/2023 07:04:59 PM	rw-r--r--
📄 ctest_submit.html	16.18 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_test.html	38.64 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_update.html	8.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 ctest_upload.html	6.7 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 define_property.html	15.53 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 else.html	5.35 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 elseif.html	5.44 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 enable_language.html	10.08 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 enable_testing.html	6.04 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endblock.html	5.66 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endforeach.html	5.88 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endfunction.html	5.85 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endif.html	5.71 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endmacro.html	5.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 endwhile.html	5.79 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 exec_program.html	7.52 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 execute_process.html	20.95 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 export.html	19.49 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 export_library_dependencies.html	8.01 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 file.html	128.25 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 find_file.html	39.65 KB	04/04/2023 07:05:00 PM	rw-r--r--
📄 find_library.html	46.52 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_package.html	91.29 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_path.html	40.22 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 find_program.html	37.17 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 fltk_wrap_ui.html	5.8 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 foreach.html	18.65 KB	04/04/2023 07:05:01 PM	rw-r--r--
📄 function.html	12.42 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_cmake_property.html	8.05 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_directory_property.html	9.08 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_filename_component.html	12.57 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_property.html	15.95 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_source_file_property.html	11.47 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_target_property.html	9.1 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 get_test_property.html	8.06 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 if.html	41.89 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include.html	8.04 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_directories.html	10.54 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_external_msproject.html	8.14 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_guard.html	8.85 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 include_regular_expression.html	6.14 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install.html	126.44 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_files.html	9.13 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_programs.html	9.09 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 install_targets.html	7 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 link_directories.html	11.99 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 link_libraries.html	7.36 KB	04/04/2023 07:05:02 PM	rw-r--r--
📄 list.html	35.79 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 load_cache.html	6.78 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 load_command.html	6.61 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 macro.html	20.49 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 make_directory.html	5.77 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 mark_as_advanced.html	6.73 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 math.html	9.01 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 message.html	27.67 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 option.html	6.48 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 output_required_files.html	6.59 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 project.html	30.84 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 qt_wrap_cpp.html	7.2 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 qt_wrap_ui.html	7.43 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 remove.html	6 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 remove_definitions.html	6.15 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 return.html	16.06 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 separate_arguments.html	11.04 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set.html	18.35 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_directory_properties.html	7.58 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_property.html	17.74 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_source_files_properties.html	10.63 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_target_properties.html	8.33 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 set_tests_properties.html	7.98 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 site_name.html	5.46 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 source_group.html	10.97 KB	04/04/2023 07:05:03 PM	rw-r--r--
📄 string.html	64.24 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 subdir_depends.html	5.69 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 subdirs.html	7.51 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_definitions.html	16.09 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_features.html	14.47 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_compile_options.html	18.02 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_include_directories.html	22.39 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_directories.html	16.03 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_libraries.html	60.83 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_link_options.html	23.66 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_precompile_headers.html	24.42 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 target_sources.html	38.35 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 try_compile.html	57.47 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 try_run.html	24.62 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 unset.html	9.21 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 use_mangled_mesa.html	5.91 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 utility_source.html	6.78 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 variable_requires.html	6.84 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 variable_watch.html	8.98 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 while.html	9.14 KB	04/04/2023 07:05:04 PM	rw-r--r--
📄 write_file.html	7.25 KB	04/04/2023 07:05:04 PM	rw-r--r--

Editing: find_package.html

<!DOCTYPE html>

<title>find_package &mdash; CMake 3.26.3 Documentation</title>

</head><body>

<div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 accesskey="I">index</a></li>
 <li class="right" >
 <a href="find_path.html" title="find_path"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="find_library.html" title="find_library"
 accesskey="P">previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" accesskey="U">cmake-commands(7)</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">find_package</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="find-package">
<h1><a class="toc-backref" href="#id5" role="doc-backlink">find_package</a><a class="headerlink" href="#find-package" title="Permalink to this heading">¶</a></h1>
<nav class="contents" id="contents">
Contents
<ul class="simple">
<li><a class="reference internal" href="#find-package" id="id5">find_package</a>
<ul>
<li><a class="reference internal" href="#search-modes" id="id6">Search Modes</a></li>
<li><a class="reference internal" href="#basic-signature" id="id7">Basic Signature</a></li>
<li><a class="reference internal" href="#full-signature" id="id8">Full Signature</a></li>
<li><a class="reference internal" href="#config-mode-search-procedure" id="id9">Config Mode Search Procedure</a></li>
<li><a class="reference internal" href="#config-mode-version-selection" id="id10">Config Mode Version Selection</a></li>
<li><a class="reference internal" href="#package-file-interface-variables" id="id11">Package File Interface Variables</a></li>
</ul>
</li>
</ul>
</nav>
<div class="admonition note">
Note
The <a class="reference internal" href="../guide/using-dependencies/index.html#guide:Using Dependencies Guide" title="Using Dependencies Guide"><code class="xref cmake cmake-guide docutils literal notranslate">Using Dependencies Guide</code></a> provides a high-level
introduction to this general topic. It provides a broader overview of
where the <code class="docutils literal notranslate">find_package()</code> command fits into the bigger picture,
including its relationship to the <a class="reference internal" href="../module/FetchContent.html#module:FetchContent" title="FetchContent"><code class="xref cmake cmake-module docutils literal notranslate">FetchContent</code></a> module.
The guide is recommended pre-reading before moving on to the details below.
</div>
Find a package (usually provided by something external to the project),
and load its package-specific details. Calls to this command can also
be intercepted by <a class="reference internal" href="cmake_language.html#dependency-providers">dependency providers</a>.
<section id="search-modes">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Search Modes</a><a class="headerlink" href="#search-modes" title="Permalink to this heading">¶</a></h2>
The command has a few modes by which it searches for packages:
<dl>
<dt>Module mode</dt><dd>In this mode, CMake searches for a file called <code class="docutils literal notranslate">Find&lt;PackageName&gt;.cmake</code>,
looking first in the locations listed in the <a class="reference internal" href="../variable/CMAKE_MODULE_PATH.html#variable:CMAKE_MODULE_PATH" title="CMAKE_MODULE_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_MODULE_PATH</code></a>,
then among the <a class="reference internal" href="../manual/cmake-developer.7.html#find-modules">Find Modules</a> provided by the CMake installation.
If the file is found, it is read and processed by CMake. It is responsible
for finding the package, checking the version, and producing any needed
messages. Some Find modules provide limited or no support for versioning;
check the Find module's documentation.
The <code class="docutils literal notranslate">Find&lt;PackageName&gt;.cmake</code> file is not typically provided by the
package itself. Rather, it is normally provided by something external to
the package, such as the operating system, CMake itself, or even the project
from which the <code class="docutils literal notranslate">find_package()</code> command was called. Being externally
provided, <a class="reference internal" href="../manual/cmake-developer.7.html#find-modules">Find Modules</a> tend to be heuristic in nature and are
susceptible to becoming out-of-date. They typically search for certain
libraries, files and other package artifacts.
Module mode is only supported by the
<a class="reference internal" href="#basic-signature">basic command signature</a>.
</dd>
<dt>Config mode</dt><dd>In this mode, CMake searches for a file called
<code class="docutils literal notranslate">&lt;lowercasePackageName&gt;-config.cmake</code> or <code class="docutils literal notranslate">&lt;PackageName&gt;Config.cmake</code>.
It will also look for <code class="docutils literal notranslate">&lt;lowercasePackageName&gt;-config-version.cmake</code> or
<code class="docutils literal notranslate">&lt;PackageName&gt;ConfigVersion.cmake</code> if version details were specified
(see <a class="reference internal" href="#version-selection">Config Mode Version Selection</a> for an explanation of how these separate
version files are used).
In config mode, the command can be given a list of names to search for
as package names. The locations where CMake searches for the config and
version files is considerably more complicated than for Module mode
(see <a class="reference internal" href="#search-procedure">Config Mode Search Procedure</a>).
The config and version files are typically installed as part of the
package, so they tend to be more reliable than Find modules. They usually
contain direct knowledge of the package contents, so no searching or
heuristics are needed within the config or version files themselves.
Config mode is supported by both the <a class="reference internal" href="#basic-signature">basic</a> and
<a class="reference internal" href="#full-signature">full</a> command signatures.
</dd>
<dt>FetchContent redirection mode</dt><dd><div class="versionadded">
New in version 3.24: A call to <code class="docutils literal notranslate">find_package()</code> can be redirected internally to a package
provided by the <a class="reference internal" href="../module/FetchContent.html#module:FetchContent" title="FetchContent"><code class="xref cmake cmake-module docutils literal notranslate">FetchContent</code></a> module. To the caller, the behavior
will appear similar to Config mode, except that the search logic is
by-passed and the component information is not used. See
<a class="reference internal" href="../module/FetchContent.html#command:fetchcontent_declare" title="fetchcontent_declare"><code class="xref cmake cmake-command docutils literal notranslate">FetchContent_Declare()</code></a> and <a class="reference internal" href="../module/FetchContent.html#command:fetchcontent_makeavailable" title="fetchcontent_makeavailable"><code class="xref cmake cmake-command docutils literal notranslate">FetchContent_MakeAvailable()</code></a>
for further details.
</div>
</dd>
</dl>
When not redirected to a package provided by <a class="reference internal" href="../module/FetchContent.html#module:FetchContent" title="FetchContent"><code class="xref cmake cmake-module docutils literal notranslate">FetchContent</code></a>, the
command arguments determine whether Module or Config mode is used. When the
<a class="reference internal" href="#basic-signature">basic signature</a> is used, the command searches in Module mode first.
If the package is not found, the search falls back to Config mode.
A user may set the <a class="reference internal" href="../variable/CMAKE_FIND_PACKAGE_PREFER_CONFIG.html#variable:CMAKE_FIND_PACKAGE_PREFER_CONFIG" title="CMAKE_FIND_PACKAGE_PREFER_CONFIG"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_PACKAGE_PREFER_CONFIG</code></a> variable
to true to reverse the priority and direct CMake to search using Config mode
first before falling back to Module mode. The basic signature can also be
forced to use only Module mode with a <code class="docutils literal notranslate">MODULE</code> keyword. If the
<a class="reference internal" href="#full-signature">full signature</a> is used, the command only searches in Config mode.
Where possible, user code should generally look for packages using the
<a class="reference internal" href="#basic-signature">basic signature</a>, since that allows the package to be found with any mode.
Project maintainers wishing to provide a config package should understand
the bigger picture, as explained in <a class="reference internal" href="#full-signature">Full Signature</a> and all subsequent
sections on this page.
</section>
<section id="basic-signature">
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Basic Signature</a><a class="headerlink" href="#basic-signature" title="Permalink to this heading">¶</a></h2>
<div class="highlight-none notranslate"><div class="highlight"><pre>find_package(&lt;PackageName&gt; [version] [EXACT] [QUIET] [MODULE]
 [REQUIRED] [[COMPONENTS] [components...]]
 [OPTIONAL_COMPONENTS components...]
 [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
 [GLOBAL]
 [NO_POLICY_SCOPE]
 [BYPASS_PROVIDER])
</pre></div>
</div>
The basic signature is supported by both Module and Config modes.
The <code class="docutils literal notranslate">MODULE</code> keyword implies that only Module mode can be used to find
the package, with no fallback to Config mode.
Regardless of the mode used, a <code class="docutils literal notranslate">&lt;PackageName&gt;_FOUND</code> variable will be
set to indicate whether the package was found. When the package is found,
package-specific information may be provided through other variables and
<a class="reference internal" href="../manual/cmake-buildsystem.7.html#imported-targets">Imported Targets</a> documented by the package itself. The
<code class="docutils literal notranslate">QUIET</code> option disables informational messages, including those indicating
that the package cannot be found if it is not <code class="docutils literal notranslate">REQUIRED</code>. The <code class="docutils literal notranslate">REQUIRED</code>
option stops processing with an error message if the package cannot be found.
A package-specific list of required components may be listed after the
<code class="docutils literal notranslate">COMPONENTS</code> keyword. If any of these components are not able to be
satisfied, the package overall is considered to be not found. If the
<code class="docutils literal notranslate">REQUIRED</code> option is also present, this is treated as a fatal error,
otherwise execution still continues. As a form of shorthand, if the
<code class="docutils literal notranslate">REQUIRED</code> option is present, the <code class="docutils literal notranslate">COMPONENTS</code> keyword can be omitted
and the required components can be listed directly after <code class="docutils literal notranslate">REQUIRED</code>.
Additional optional components may be listed after
<code class="docutils literal notranslate">OPTIONAL_COMPONENTS</code>. If these cannot be satisfied, the package overall
can still be considered found, as long as all required components are
satisfied.
The set of available components and their meaning are defined by the
target package. Formally, it is up to the target package how to
interpret the component information given to it, but it should follow
the expectations stated above. For calls where no components are specified,
there is no single expected behavior and target packages should clearly
define what occurs in such cases. Common arrangements include assuming it
should find all components, no components or some well-defined subset of the
available components.
<div class="versionadded">
New in version 3.24: The <code class="docutils literal notranslate">REGISTRY_VIEW</code> keyword specifies which registry views should be
queried. This keyword is only meaningful on <code class="docutils literal notranslate">Windows</code> platforms and will
be ignored on all others. Formally, it is up to the target package how to
interpret the registry view information given to it.
</div>
<div class="versionadded">
New in version 3.24: Specifying the <code class="docutils literal notranslate">GLOBAL</code> keyword will promote all imported targets to
a global scope in the importing project. Alternatively, this functionality
can be enabled by setting the <a class="reference internal" href="../variable/CMAKE_FIND_PACKAGE_TARGETS_GLOBAL.html#variable:CMAKE_FIND_PACKAGE_TARGETS_GLOBAL" title="CMAKE_FIND_PACKAGE_TARGETS_GLOBAL"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_PACKAGE_TARGETS_GLOBAL</code></a>
variable.
</div>
The <code class="docutils literal notranslate">[version]</code> argument requests a version with which the package found
should be compatible. There are two possible forms in which it may be
specified:
<blockquote>
<div><ul class="simple">
<li>A single version with the format <code class="docutils literal notranslate">major[.minor[.patch[.tweak]]]</code>, where
each component is a numeric value.</li>
<li>A version range with the format <code class="docutils literal notranslate">versionMin...[&lt;]versionMax</code> where
<code class="docutils literal notranslate">versionMin</code> and <code class="docutils literal notranslate">versionMax</code> have the same format and constraints
on components being integers as the single version. By default, both end
points are included. By specifying <code class="docutils literal notranslate">&lt;</code>, the upper end point will be
excluded. Version ranges are only supported with CMake 3.19 or later.</li>
</ul>
</div></blockquote>
The <code class="docutils literal notranslate">EXACT</code> option requests that the version be matched exactly. This option
is incompatible with the specification of a version range.
If no <code class="docutils literal notranslate">[version]</code> and/or component list is given to a recursive invocation
inside a find-module, the corresponding arguments are forwarded
automatically from the outer call (including the <code class="docutils literal notranslate">EXACT</code> flag for
<code class="docutils literal notranslate">[version]</code>). Version support is currently provided only on a
package-by-package basis (see the <a class="reference internal" href="#version-selection">Version Selection</a> section below).
When a version range is specified but the package is only designed to expect
a single version, the package will ignore the upper end point of the range and
only take the single version at the lower end of the range into account.
See the <a class="reference internal" href="cmake_policy.html#command:cmake_policy" title="cmake_policy"><code class="xref cmake cmake-command docutils literal notranslate">cmake_policy()</code></a> command documentation for discussion
of the <code class="docutils literal notranslate">NO_POLICY_SCOPE</code> option.
<div class="versionadded">
New in version 3.24: The <code class="docutils literal notranslate">BYPASS_PROVIDER</code> keyword is only allowed when <code class="docutils literal notranslate">find_package()</code> is
being called by a <a class="reference internal" href="cmake_language.html#dependency-providers">dependency provider</a>.
It can be used by providers to call the built-in <code class="docutils literal notranslate">find_package()</code>
implementation directly and prevent that call from being re-routed back to
itself. Future versions of CMake may detect attempts to use this keyword
from places other than a dependency provider and halt with a fatal error.
</div>
</section>
<section id="full-signature">
<h2><a class="toc-backref" href="#id8" role="doc-backlink">Full Signature</a><a class="headerlink" href="#full-signature" title="Permalink to this heading">¶</a></h2>
<div class="highlight-none notranslate"><div class="highlight"><pre>find_package(&lt;PackageName&gt; [version] [EXACT] [QUIET]
 [REQUIRED] [[COMPONENTS] [components...]]
 [OPTIONAL_COMPONENTS components...]
 [CONFIG|NO_MODULE]
 [GLOBAL]
 [NO_POLICY_SCOPE]
 [BYPASS_PROVIDER]
 [NAMES name1 [name2 ...]]
 [CONFIGS config1 [config2 ...]]
 [HINTS path1 [path2 ... ]]
 [PATHS path1 [path2 ... ]]
 [REGISTRY_VIEW (64|32|64_32|32_64|HOST|TARGET|BOTH)]
 [PATH_SUFFIXES suffix1 [suffix2 ...]]
 [NO_DEFAULT_PATH]
 [NO_PACKAGE_ROOT_PATH]
 [NO_CMAKE_PATH]
 [NO_CMAKE_ENVIRONMENT_PATH]
 [NO_SYSTEM_ENVIRONMENT_PATH]
 [NO_CMAKE_PACKAGE_REGISTRY]
 [NO_CMAKE_BUILDS_PATH] # Deprecated; does nothing.
 [NO_CMAKE_SYSTEM_PATH]
 [NO_CMAKE_INSTALL_PREFIX]
 [NO_CMAKE_SYSTEM_PACKAGE_REGISTRY]
 [CMAKE_FIND_ROOT_PATH_BOTH |
 ONLY_CMAKE_FIND_ROOT_PATH |
 NO_CMAKE_FIND_ROOT_PATH])
</pre></div>
</div>
The <code class="docutils literal notranslate">CONFIG</code> option, the synonymous <code class="docutils literal notranslate">NO_MODULE</code> option, or the use
of options not specified in the <a class="reference internal" href="#basic-signature">basic signature</a> all enforce pure Config
mode. In pure Config mode, the command skips Module mode search and
proceeds at once with Config mode search.
Config mode search attempts to locate a configuration file provided by the
package to be found. A cache entry called <code class="docutils literal notranslate">&lt;PackageName&gt;_DIR</code> is created to
hold the directory containing the file. By default, the command searches for
a package with the name <code class="docutils literal notranslate">&lt;PackageName&gt;</code>. If the <code class="docutils literal notranslate">NAMES</code> option is given,
the names following it are used instead of <code class="docutils literal notranslate">&lt;PackageName&gt;</code>. The names are
also considered when determining whether to redirect the call to a package
provided by <a class="reference internal" href="../module/FetchContent.html#module:FetchContent" title="FetchContent"><code class="xref cmake cmake-module docutils literal notranslate">FetchContent</code></a>.
The command searches for a file called <code class="docutils literal notranslate">&lt;PackageName&gt;Config.cmake</code> or
<code class="docutils literal notranslate">&lt;lowercasePackageName&gt;-config.cmake</code> for each name specified.
A replacement set of possible configuration file names may be given
using the <code class="docutils literal notranslate">CONFIGS</code> option. The <a class="reference internal" href="#search-procedure">Config Mode Search Procedure</a> is specified below.
Once found, any <a class="reference internal" href="#version-selection">version constraint</a> is checked,
and if satisfied, the configuration file is read and processed by CMake.
Since the file is provided by the package it already knows the
location of package contents. The full path to the configuration file
is stored in the cmake variable <code class="docutils literal notranslate">&lt;PackageName&gt;_CONFIG</code>.
All configuration files which have been considered by CMake while
searching for the package with an appropriate version are stored in the
<code class="docutils literal notranslate">&lt;PackageName&gt;_CONSIDERED_CONFIGS</code> variable, and the associated versions
in the <code class="docutils literal notranslate">&lt;PackageName&gt;_CONSIDERED_VERSIONS</code> variable.
If the package configuration file cannot be found CMake will generate
an error describing the problem unless the <code class="docutils literal notranslate">QUIET</code> argument is
specified. If <code class="docutils literal notranslate">REQUIRED</code> is specified and the package is not found a
fatal error is generated and the configure step stops executing. If
<code class="docutils literal notranslate">&lt;PackageName&gt;_DIR</code> has been set to a directory not containing a
configuration file CMake will ignore it and search from scratch.
Package maintainers providing CMake package configuration files are
encouraged to name and install them such that the <a class="reference internal" href="#search-procedure">Config Mode Search Procedure</a>
outlined below will find them without requiring use of additional options.
</section>
<section id="config-mode-search-procedure">
<h2><a class="toc-backref" href="#id9" role="doc-backlink">Config Mode Search Procedure</a><a class="headerlink" href="#config-mode-search-procedure" title="Permalink to this heading">¶</a></h2>
<div class="admonition note">
Note
When Config mode is used, this search procedure is applied regardless of
whether the <a class="reference internal" href="#full-signature">full</a> or <a class="reference internal" href="#basic-signature">basic</a>
signature was given.
</div>
<div class="versionadded">
New in version 3.24: All calls to <code class="docutils literal notranslate">find_package()</code> (even in Module mode) first look for a config
package file in the <a class="reference internal" href="../variable/CMAKE_FIND_PACKAGE_REDIRECTS_DIR.html#variable:CMAKE_FIND_PACKAGE_REDIRECTS_DIR" title="CMAKE_FIND_PACKAGE_REDIRECTS_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_PACKAGE_REDIRECTS_DIR</code></a> directory.
The <a class="reference internal" href="../module/FetchContent.html#module:FetchContent" title="FetchContent"><code class="xref cmake cmake-module docutils literal notranslate">FetchContent</code></a> module, or even the project itself, may write files
to that location to redirect <code class="docutils literal notranslate">find_package()</code> calls to content already
provided by the project. If no config package file is found in that location,
the search proceeds with the logic described below.
</div>
CMake constructs a set of possible installation prefixes for the
package. Under each prefix several directories are searched for a
configuration file. The tables below show the directories searched.
Each entry is meant for installation trees following Windows (<code class="docutils literal notranslate">W</code>), UNIX
(<code class="docutils literal notranslate">U</code>), or Apple (<code class="docutils literal notranslate">A</code>) conventions:
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head">Entry</th>
<th class="head">Convention</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">&lt;prefix&gt;/</code></td>
<td>W</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">&lt;prefix&gt;/(cmake|CMake)/</code></td>
<td>W</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;*/</code></td>
<td>W</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;*/(cmake|CMake)/</code></td>
<td>W</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;*/(cmake|CMake)/&lt;name&gt;*/</code> <a class="footnote-reference brackets" href="#id4" id="id3" role="doc-noteref">[1]</a></td>
<td>W</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">&lt;prefix&gt;/(lib/&lt;arch&gt;|lib*|share)/cmake/&lt;name&gt;*/</code></td>
<td>U</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">&lt;prefix&gt;/(lib/&lt;arch&gt;|lib*|share)/&lt;name&gt;*/</code></td>
<td>U</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">&lt;prefix&gt;/(lib/&lt;arch&gt;|lib*|share)/&lt;name&gt;*/(cmake|CMake)/</code></td>
<td>U</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;*/(lib/&lt;arch&gt;|lib*|share)/cmake/&lt;name&gt;*/</code></td>
<td>W/U</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;*/(lib/&lt;arch&gt;|lib*|share)/&lt;name&gt;*/</code></td>
<td>W/U</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;*/(lib/&lt;arch&gt;|lib*|share)/&lt;name&gt;*/(cmake|CMake)/</code></td>
<td>W/U</td>
</tr>
</tbody>
</table>
<aside class="footnote brackets" id="id4" role="note">
[<a role="doc-backlink" href="#id3">1</a>]
<div class="versionadded">
New in version 3.25.
</div>
</aside>
On systems supporting macOS <a class="reference internal" href="../prop_tgt/FRAMEWORK.html#prop_tgt:FRAMEWORK" title="FRAMEWORK"><code class="xref cmake cmake-prop_tgt docutils literal notranslate">FRAMEWORK</code></a> and <a class="reference internal" href="../prop_tgt/BUNDLE.html#prop_tgt:BUNDLE" title="BUNDLE"><code class="xref cmake cmake-prop_tgt docutils literal notranslate">BUNDLE</code></a>, the
following directories are searched for Frameworks or Application Bundles
containing a configuration file:
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head">Entry</th>
<th class="head">Convention</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;.framework/Resources/</code></td>
<td>A</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;.framework/Resources/CMake/</code></td>
<td>A</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;.framework/Versions/*/Resources/</code></td>
<td>A</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;.framework/Versions/*/Resources/CMake/</code></td>
<td>A</td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;.app/Contents/Resources/</code></td>
<td>A</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">&lt;prefix&gt;/&lt;name&gt;.app/Contents/Resources/CMake/</code></td>
<td>A</td>
</tr>
</tbody>
</table>
In all cases the <code class="docutils literal notranslate">&lt;name&gt;</code> is treated as case-insensitive and corresponds
to any of the names specified (<code class="docutils literal notranslate">&lt;PackageName&gt;</code> or names given by <code class="docutils literal notranslate">NAMES</code>).
Paths with <code class="docutils literal notranslate">lib/&lt;arch&gt;</code> are enabled if the
<a class="reference internal" href="../variable/CMAKE_LIBRARY_ARCHITECTURE.html#variable:CMAKE_LIBRARY_ARCHITECTURE" title="CMAKE_LIBRARY_ARCHITECTURE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_LIBRARY_ARCHITECTURE</code></a> variable is set. <code class="docutils literal notranslate">lib*</code> includes one
or more of the values <code class="docutils literal notranslate">lib64</code>, <code class="docutils literal notranslate">lib32</code>, <code class="docutils literal notranslate">libx32</code> or <code class="docutils literal notranslate">lib</code> (searched in
that order).
<ul class="simple">
<li>Paths with <code class="docutils literal notranslate">lib64</code> are searched on 64 bit platforms if the
<a class="reference internal" href="../prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS.html#prop_gbl:FIND_LIBRARY_USE_LIB64_PATHS" title="FIND_LIBRARY_USE_LIB64_PATHS"><code class="xref cmake cmake-prop_gbl docutils literal notranslate">FIND_LIBRARY_USE_LIB64_PATHS</code></a> property is set to <code class="docutils literal notranslate">TRUE</code>.</li>
<li>Paths with <code class="docutils literal notranslate">lib32</code> are searched on 32 bit platforms if the
<a class="reference internal" href="../prop_gbl/FIND_LIBRARY_USE_LIB32_PATHS.html#prop_gbl:FIND_LIBRARY_USE_LIB32_PATHS" title="FIND_LIBRARY_USE_LIB32_PATHS"><code class="xref cmake cmake-prop_gbl docutils literal notranslate">FIND_LIBRARY_USE_LIB32_PATHS</code></a> property is set to <code class="docutils literal notranslate">TRUE</code>.</li>
<li>Paths with <code class="docutils literal notranslate">libx32</code> are searched on platforms using the x32 ABI
if the <a class="reference internal" href="../prop_gbl/FIND_LIBRARY_USE_LIBX32_PATHS.html#prop_gbl:FIND_LIBRARY_USE_LIBX32_PATHS" title="FIND_LIBRARY_USE_LIBX32_PATHS"><code class="xref cmake cmake-prop_gbl docutils literal notranslate">FIND_LIBRARY_USE_LIBX32_PATHS</code></a> property is set to <code class="docutils literal notranslate">TRUE</code>.</li>
<li>The <code class="docutils literal notranslate">lib</code> path is always searched.</li>
</ul>
<div class="versionchanged">
Changed in version 3.24: On <code class="docutils literal notranslate">Windows</code> platform, it is possible to include registry queries as part
of the directories specified through <code class="docutils literal notranslate">HINTS</code> and <code class="docutils literal notranslate">PATHS</code> keywords, using
a <a class="reference internal" href="../manual/cmake-developer.7.html#find-using-windows-registry">dedicated syntax</a>. Such specifications
will be ignored on all other platforms.
</div>
<div class="versionadded">
New in version 3.24: <code class="docutils literal notranslate">REGISTRY_VIEW</code> can be specified to manage <code class="docutils literal notranslate">Windows</code> registry queries
specified as part of <code class="docutils literal notranslate">PATHS</code> and <code class="docutils literal notranslate">HINTS</code>.
</div>
Specify which registry views must be queried. This option is only meaningful
on <code class="docutils literal notranslate">Windows</code> platforms and will be ignored on other ones. When not
specified, the <code class="docutils literal notranslate">TARGET</code> view is used when the
<a class="reference internal" href="../policy/CMP0134.html#policy:CMP0134" title="CMP0134"><code class="xref cmake cmake-policy docutils literal notranslate">CMP0134</code></a> policy is <code class="docutils literal notranslate">NEW</code>. Refer to <a class="reference internal" href="../policy/CMP0134.html#policy:CMP0134" title="CMP0134"><code class="xref cmake cmake-policy docutils literal notranslate">CMP0134</code></a> for the
default view when the policy is <code class="docutils literal notranslate">OLD</code>.
<dl>
<dt><code class="docutils literal notranslate">64</code></dt><dd>Query the 64-bit registry. On 32-bit Windows, it always returns the string
<code class="docutils literal notranslate">/REGISTRY-NOTFOUND</code>.
</dd>
<dt><code class="docutils literal notranslate">32</code></dt><dd>Query the 32-bit registry.
</dd>
<dt><code class="docutils literal notranslate">64_32</code></dt><dd>Query both views (<code class="docutils literal notranslate">64</code> and <code class="docutils literal notranslate">32</code>) and generate a path for each.
</dd>
<dt><code class="docutils literal notranslate">32_64</code></dt><dd>Query both views (<code class="docutils literal notranslate">32</code> and <code class="docutils literal notranslate">64</code>) and generate a path for each.
</dd>
<dt><code class="docutils literal notranslate">HOST</code></dt><dd>Query the registry matching the architecture of the host: <code class="docutils literal notranslate">64</code> on 64-bit
Windows and <code class="docutils literal notranslate">32</code> on 32-bit Windows.
</dd>
<dt><code class="docutils literal notranslate">TARGET</code></dt><dd>Query the registry matching the architecture specified by the
<a class="reference internal" href="../variable/CMAKE_SIZEOF_VOID_P.html#variable:CMAKE_SIZEOF_VOID_P" title="CMAKE_SIZEOF_VOID_P"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SIZEOF_VOID_P</code></a> variable. If not defined, fall back to
<code class="docutils literal notranslate">HOST</code> view.
</dd>
<dt><code class="docutils literal notranslate">BOTH</code></dt><dd>Query both views (<code class="docutils literal notranslate">32</code> and <code class="docutils literal notranslate">64</code>). The order depends on the following
rules: If the <a class="reference internal" href="../variable/CMAKE_SIZEOF_VOID_P.html#variable:CMAKE_SIZEOF_VOID_P" title="CMAKE_SIZEOF_VOID_P"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SIZEOF_VOID_P</code></a> variable is defined, use the
following view depending on the content of this variable:
<ul class="simple">
<li><code class="docutils literal notranslate">8</code>: <code class="docutils literal notranslate">64_32</code></li>
<li><code class="docutils literal notranslate">4</code>: <code class="docutils literal notranslate">32_64</code></li>
</ul>
If the <a class="reference internal" href="../variable/CMAKE_SIZEOF_VOID_P.html#variable:CMAKE_SIZEOF_VOID_P" title="CMAKE_SIZEOF_VOID_P"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SIZEOF_VOID_P</code></a> variable is not defined, rely on the
architecture of the host:
<ul class="simple">
<li>64-bit: <code class="docutils literal notranslate">64_32</code></li>
<li>32-bit: <code class="docutils literal notranslate">32</code></li>
</ul>
</dd>
</dl>
If <code class="docutils literal notranslate">PATH_SUFFIXES</code> is specified, the suffixes are appended to each
(<code class="docutils literal notranslate">W</code>) or (<code class="docutils literal notranslate">U</code>) directory entry one-by-one.
This set of directories is intended to work in cooperation with
projects that provide configuration files in their installation trees.
Directories above marked with (<code class="docutils literal notranslate">W</code>) are intended for installations on
Windows where the prefix may point at the top of an application's
installation directory. Those marked with (<code class="docutils literal notranslate">U</code>) are intended for
installations on UNIX platforms where the prefix is shared by multiple
packages. This is merely a convention, so all (<code class="docutils literal notranslate">W</code>) and (<code class="docutils literal notranslate">U</code>) directories
are still searched on all platforms. Directories marked with (<code class="docutils literal notranslate">A</code>) are
intended for installations on Apple platforms. The
<a class="reference internal" href="../variable/CMAKE_FIND_FRAMEWORK.html#variable:CMAKE_FIND_FRAMEWORK" title="CMAKE_FIND_FRAMEWORK"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_FRAMEWORK</code></a> and <a class="reference internal" href="../variable/CMAKE_FIND_APPBUNDLE.html#variable:CMAKE_FIND_APPBUNDLE" title="CMAKE_FIND_APPBUNDLE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_APPBUNDLE</code></a>
variables determine the order of preference.
The set of installation prefixes is constructed using the following
steps. If <code class="docutils literal notranslate">NO_DEFAULT_PATH</code> is specified all <code class="docutils literal notranslate">NO_*</code> options are
enabled.
<ol class="arabic">
<li><div class="versionadded">
New in version 3.12: Search paths specified in the <a class="reference internal" href="../variable/PackageName_ROOT.html#variable:&lt;PackageName&gt;_ROOT" title="&lt;PackageName&gt;_ROOT"><code class="xref cmake cmake-variable docutils literal notranslate">&lt;PackageName&gt;_ROOT</code></a> CMake
variable and the <a class="reference internal" href="../envvar/PackageName_ROOT.html#envvar:&lt;PackageName&gt;_ROOT" title="&lt;PackageName&gt;_ROOT"><code class="xref cmake cmake-envvar docutils literal notranslate">&lt;PackageName&gt;_ROOT</code></a> environment variable,
where <code class="docutils literal notranslate">&lt;PackageName&gt;</code> is the package to be found
(the case-preserved first argument to <code class="docutils literal notranslate">find_package</code>).
The package root variables are maintained as a stack so if
called from within a find module, root paths from the parent's find
module will also be searched after paths for the current package.
This can be skipped if <code class="docutils literal notranslate">NO_PACKAGE_ROOT_PATH</code> is passed or by setting
the <a class="reference internal" href="../variable/CMAKE_FIND_USE_PACKAGE_ROOT_PATH.html#variable:CMAKE_FIND_USE_PACKAGE_ROOT_PATH" title="CMAKE_FIND_USE_PACKAGE_ROOT_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_USE_PACKAGE_ROOT_PATH</code></a> to <code class="docutils literal notranslate">FALSE</code>.
See policy <a class="reference internal" href="../policy/CMP0074.html#policy:CMP0074" title="CMP0074"><code class="xref cmake cmake-policy docutils literal notranslate">CMP0074</code></a>.
</div>
</li>
<li>Search paths specified in cmake-specific cache variables. These
are intended to be used on the command line with a <a class="reference internal" href="../manual/cmake.1.html#cmdoption-cmake-D"><code class="xref std std-option docutils literal notranslate">-DVAR=VALUE</code></a>.
The values are interpreted as <a class="reference internal" href="../manual/cmake-language.7.html#cmake-language-lists">semicolon-separated lists</a>.
This can be skipped if <code class="docutils literal notranslate">NO_CMAKE_PATH</code> is passed or by setting the
<a class="reference internal" href="../variable/CMAKE_FIND_USE_CMAKE_PATH.html#variable:CMAKE_FIND_USE_CMAKE_PATH" title="CMAKE_FIND_USE_CMAKE_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_USE_CMAKE_PATH</code></a> to <code class="docutils literal notranslate">FALSE</code>:
<ul class="simple">
<li><a class="reference internal" href="../variable/CMAKE_PREFIX_PATH.html#variable:CMAKE_PREFIX_PATH" title="CMAKE_PREFIX_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_PREFIX_PATH</code></a></li>
<li><a class="reference internal" href="../variable/CMAKE_FRAMEWORK_PATH.html#variable:CMAKE_FRAMEWORK_PATH" title="CMAKE_FRAMEWORK_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FRAMEWORK_PATH</code></a></li>
<li><a class="reference internal" href="../variable/CMAKE_APPBUNDLE_PATH.html#variable:CMAKE_APPBUNDLE_PATH" title="CMAKE_APPBUNDLE_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_APPBUNDLE_PATH</code></a></li>
</ul>
</li>
<li>Search paths specified in cmake-specific environment variables.
These are intended to be set in the user's shell configuration,
and therefore use the host's native path separator
(<code class="docutils literal notranslate">;</code> on Windows and <code class="docutils literal notranslate">:</code> on UNIX).
This can be skipped if <code class="docutils literal notranslate">NO_CMAKE_ENVIRONMENT_PATH</code> is passed or by setting
the <a class="reference internal" href="../variable/CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH.html#variable:CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH" title="CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_USE_CMAKE_ENVIRONMENT_PATH</code></a> to <code class="docutils literal notranslate">FALSE</code>:
<ul class="simple">
<li><code class="docutils literal notranslate">&lt;PackageName&gt;_DIR</code></li>
<li><a class="reference internal" href="../envvar/CMAKE_PREFIX_PATH.html#envvar:CMAKE_PREFIX_PATH" title="CMAKE_PREFIX_PATH"><code class="xref cmake cmake-envvar docutils literal notranslate">CMAKE_PREFIX_PATH</code></a></li>
<li><code class="docutils literal notranslate">CMAKE_FRAMEWORK_PATH</code></li>
<li><code class="docutils literal notranslate">CMAKE_APPBUNDLE_PATH</code></li>
</ul>
</li>
<li>Search paths specified by the <code class="docutils literal notranslate">HINTS</code> option. These should be paths
computed by system introspection, such as a hint provided by the
location of another item already found. Hard-coded guesses should
be specified with the <code class="docutils literal notranslate">PATHS</code> option.</li>
<li>Search the standard system environment variables. This can be
skipped if <code class="docutils literal notranslate">NO_SYSTEM_ENVIRONMENT_PATH</code> is passed or by setting the
<a class="reference internal" href="../variable/CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH.html#variable:CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH" title="CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_USE_SYSTEM_ENVIRONMENT_PATH</code></a> to <code class="docutils literal notranslate">FALSE</code>. Path entries
ending in <code class="docutils literal notranslate">/bin</code> or <code class="docutils literal notranslate">/sbin</code> are automatically converted to their
parent directories:
<ul class="simple">
<li><code class="docutils literal notranslate">PATH</code></li>
</ul>
</li>
<li>Search paths stored in the CMake <a class="reference internal" href="../manual/cmake-packages.7.html#user-package-registry">User Package Registry</a>.
This can be skipped if <code class="docutils literal notranslate">NO_CMAKE_PACKAGE_REGISTRY</code> is passed or by
setting the variable <a class="reference internal" href="../variable/CMAKE_FIND_USE_PACKAGE_REGISTRY.html#variable:CMAKE_FIND_USE_PACKAGE_REGISTRY" title="CMAKE_FIND_USE_PACKAGE_REGISTRY"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_USE_PACKAGE_REGISTRY</code></a>
to <code class="docutils literal notranslate">FALSE</code> or the deprecated variable
<a class="reference internal" href="../variable/CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY.html#variable:CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY" title="CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY</code></a> to <code class="docutils literal notranslate">TRUE</code>.
See the <a class="reference internal" href="../manual/cmake-packages.7.html#manual:cmake-packages(7)" title="cmake-packages(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-packages(7)</code></a> manual for details on the user
package registry.
</li>
<li>Search cmake variables defined in the Platform files for the
current system. The searching of <a class="reference internal" href="../variable/CMAKE_INSTALL_PREFIX.html#variable:CMAKE_INSTALL_PREFIX" title="CMAKE_INSTALL_PREFIX"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_INSTALL_PREFIX</code></a> and
<a class="reference internal" href="../variable/CMAKE_STAGING_PREFIX.html#variable:CMAKE_STAGING_PREFIX" title="CMAKE_STAGING_PREFIX"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_STAGING_PREFIX</code></a> can be
skipped if <code class="docutils literal notranslate">NO_CMAKE_INSTALL_PREFIX</code> is passed or by setting the
<a class="reference internal" href="../variable/CMAKE_FIND_USE_INSTALL_PREFIX.html#variable:CMAKE_FIND_USE_INSTALL_PREFIX" title="CMAKE_FIND_USE_INSTALL_PREFIX"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_USE_INSTALL_PREFIX</code></a> to <code class="docutils literal notranslate">FALSE</code>. All these locations
can be skipped if <code class="docutils literal notranslate">NO_CMAKE_SYSTEM_PATH</code> is passed or by setting the
<a class="reference internal" href="../variable/CMAKE_FIND_USE_CMAKE_SYSTEM_PATH.html#variable:CMAKE_FIND_USE_CMAKE_SYSTEM_PATH" title="CMAKE_FIND_USE_CMAKE_SYSTEM_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_USE_CMAKE_SYSTEM_PATH</code></a> to <code class="docutils literal notranslate">FALSE</code>:
<ul class="simple">
<li><a class="reference internal" href="../variable/CMAKE_SYSTEM_PREFIX_PATH.html#variable:CMAKE_SYSTEM_PREFIX_PATH" title="CMAKE_SYSTEM_PREFIX_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSTEM_PREFIX_PATH</code></a></li>
<li><a class="reference internal" href="../variable/CMAKE_SYSTEM_FRAMEWORK_PATH.html#variable:CMAKE_SYSTEM_FRAMEWORK_PATH" title="CMAKE_SYSTEM_FRAMEWORK_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSTEM_FRAMEWORK_PATH</code></a></li>
<li><a class="reference internal" href="../variable/CMAKE_SYSTEM_APPBUNDLE_PATH.html#variable:CMAKE_SYSTEM_APPBUNDLE_PATH" title="CMAKE_SYSTEM_APPBUNDLE_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSTEM_APPBUNDLE_PATH</code></a></li>
</ul>
The platform paths that these variables contain are locations that
typically include installed software. An example being <code class="docutils literal notranslate">/usr/local</code> for
UNIX based platforms.
</li>
<li>Search paths stored in the CMake <a class="reference internal" href="../manual/cmake-packages.7.html#system-package-registry">System Package Registry</a>.
This can be skipped if <code class="docutils literal notranslate">NO_CMAKE_SYSTEM_PACKAGE_REGISTRY</code> is passed
or by setting the <a class="reference internal" href="../variable/CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY.html#variable:CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY" title="CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_USE_SYSTEM_PACKAGE_REGISTRY</code></a>
variable to <code class="docutils literal notranslate">FALSE</code> or the deprecated variable
<a class="reference internal" href="../variable/CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY.html#variable:CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY" title="CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY</code></a> to <code class="docutils literal notranslate">TRUE</code>.
See the <a class="reference internal" href="../manual/cmake-packages.7.html#manual:cmake-packages(7)" title="cmake-packages(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-packages(7)</code></a> manual for details on the system
package registry.
</li>
<li>Search paths specified by the <code class="docutils literal notranslate">PATHS</code> option. These are typically
hard-coded guesses.</li>
</ol>
The <a class="reference internal" href="../variable/CMAKE_IGNORE_PATH.html#variable:CMAKE_IGNORE_PATH" title="CMAKE_IGNORE_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_IGNORE_PATH</code></a>, <a class="reference internal" href="../variable/CMAKE_IGNORE_PREFIX_PATH.html#variable:CMAKE_IGNORE_PREFIX_PATH" title="CMAKE_IGNORE_PREFIX_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_IGNORE_PREFIX_PATH</code></a>,
<a class="reference internal" href="../variable/CMAKE_SYSTEM_IGNORE_PATH.html#variable:CMAKE_SYSTEM_IGNORE_PATH" title="CMAKE_SYSTEM_IGNORE_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSTEM_IGNORE_PATH</code></a> and
<a class="reference internal" href="../variable/CMAKE_SYSTEM_IGNORE_PREFIX_PATH.html#variable:CMAKE_SYSTEM_IGNORE_PREFIX_PATH" title="CMAKE_SYSTEM_IGNORE_PREFIX_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSTEM_IGNORE_PREFIX_PATH</code></a> variables can also cause some
of the above locations to be ignored.
<div class="versionadded">
New in version 3.16: Added the <code class="docutils literal notranslate">CMAKE_FIND_USE_&lt;CATEGORY&gt;</code> variables to globally disable
various search locations.
</div>
The CMake variable <a class="reference internal" href="../variable/CMAKE_FIND_ROOT_PATH.html#variable:CMAKE_FIND_ROOT_PATH" title="CMAKE_FIND_ROOT_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_ROOT_PATH</code></a> specifies one or more
directories to be prepended to all other search directories. This
effectively &quot;re-roots&quot; the entire search under given locations.
Paths which are descendants of the <a class="reference internal" href="../variable/CMAKE_STAGING_PREFIX.html#variable:CMAKE_STAGING_PREFIX" title="CMAKE_STAGING_PREFIX"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_STAGING_PREFIX</code></a> are excluded
from this re-rooting, because that variable is always a path on the host system.
By default the <a class="reference internal" href="../variable/CMAKE_FIND_ROOT_PATH.html#variable:CMAKE_FIND_ROOT_PATH" title="CMAKE_FIND_ROOT_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_ROOT_PATH</code></a> is empty.
The <a class="reference internal" href="../variable/CMAKE_SYSROOT.html#variable:CMAKE_SYSROOT" title="CMAKE_SYSROOT"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSROOT</code></a> variable can also be used to specify exactly one
directory to use as a prefix. Setting <a class="reference internal" href="../variable/CMAKE_SYSROOT.html#variable:CMAKE_SYSROOT" title="CMAKE_SYSROOT"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSROOT</code></a> also has other
effects. See the documentation for that variable for more.
These variables are especially useful when cross-compiling to
point to the root directory of the target environment and CMake will
search there too. By default at first the directories listed in
<a class="reference internal" href="../variable/CMAKE_FIND_ROOT_PATH.html#variable:CMAKE_FIND_ROOT_PATH" title="CMAKE_FIND_ROOT_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_ROOT_PATH</code></a> are searched, then the <a class="reference internal" href="../variable/CMAKE_SYSROOT.html#variable:CMAKE_SYSROOT" title="CMAKE_SYSROOT"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SYSROOT</code></a>
directory is searched, and then the non-rooted directories will be
searched. The default behavior can be adjusted by setting
<a class="reference internal" href="../variable/CMAKE_FIND_ROOT_PATH_MODE_PACKAGE.html#variable:CMAKE_FIND_ROOT_PATH_MODE_PACKAGE" title="CMAKE_FIND_ROOT_PATH_MODE_PACKAGE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_ROOT_PATH_MODE_PACKAGE</code></a>. This behavior can be manually
overridden on a per-call basis using options:
<dl class="simple">
<dt><code class="docutils literal notranslate">CMAKE_FIND_ROOT_PATH_BOTH</code></dt><dd>Search in the order described above.
</dd>
<dt><code class="docutils literal notranslate">NO_CMAKE_FIND_ROOT_PATH</code></dt><dd>Do not use the <a class="reference internal" href="../variable/CMAKE_FIND_ROOT_PATH.html#variable:CMAKE_FIND_ROOT_PATH" title="CMAKE_FIND_ROOT_PATH"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_ROOT_PATH</code></a> variable.
</dd>
<dt><code class="docutils literal notranslate">ONLY_CMAKE_FIND_ROOT_PATH</code></dt><dd>Search only the re-rooted directories and directories below
<a class="reference internal" href="../variable/CMAKE_STAGING_PREFIX.html#variable:CMAKE_STAGING_PREFIX" title="CMAKE_STAGING_PREFIX"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_STAGING_PREFIX</code></a>.
</dd>
</dl>
The default search order is designed to be most-specific to
least-specific for common use cases.
Projects may override the order by simply calling the command
multiple times and using the <code class="docutils literal notranslate">NO_*</code> options:
<pre class="literal-block">find_package (&lt;PackageName&gt; PATHS paths... NO_DEFAULT_PATH)
find_package (&lt;PackageName&gt;)</pre>
Once one of the calls succeeds the result variable will be set
and stored in the cache so that no call will search again.
By default the value stored in the result variable will be the path at
which the file is found. The <a class="reference internal" href="../variable/CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS.html#variable:CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS" title="CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_PACKAGE_RESOLVE_SYMLINKS</code></a>
variable may be set to <code class="docutils literal notranslate">TRUE</code> before calling <code class="docutils literal notranslate">find_package</code> in order
to resolve symbolic links and store the real path to the file.
Every non-REQUIRED <code class="docutils literal notranslate">find_package</code> call can be disabled or made REQUIRED:
<ul class="simple">
<li>Setting the <a class="reference internal" href="../variable/CMAKE_DISABLE_FIND_PACKAGE_PackageName.html#variable:CMAKE_DISABLE_FIND_PACKAGE_&lt;PackageName&gt;" title="CMAKE_DISABLE_FIND_PACKAGE_&lt;PackageName&gt;"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_DISABLE_FIND_PACKAGE_&lt;PackageName&gt;</code></a> variable
to <code class="docutils literal notranslate">TRUE</code> disables the package. This also disables redirection to a
package provided by <a class="reference internal" href="../module/FetchContent.html#module:FetchContent" title="FetchContent"><code class="xref cmake cmake-module docutils literal notranslate">FetchContent</code></a>.</li>
<li>Setting the <a class="reference internal" href="../variable/CMAKE_REQUIRE_FIND_PACKAGE_PackageName.html#variable:CMAKE_REQUIRE_FIND_PACKAGE_&lt;PackageName&gt;" title="CMAKE_REQUIRE_FIND_PACKAGE_&lt;PackageName&gt;"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_REQUIRE_FIND_PACKAGE_&lt;PackageName&gt;</code></a> variable
to <code class="docutils literal notranslate">TRUE</code> makes the package REQUIRED.</li>
</ul>
Setting both variables to <code class="docutils literal notranslate">TRUE</code> simultaneously is an error.
</section>
<section id="config-mode-version-selection">
<h2><a class="toc-backref" href="#id10" role="doc-backlink">Config Mode Version Selection</a><a class="headerlink" href="#config-mode-version-selection" title="Permalink to this heading">¶</a></h2>
<div class="admonition note">
Note
When Config mode is used, this version selection process is applied
regardless of whether the <a class="reference internal" href="#full-signature">full</a> or
<a class="reference internal" href="#basic-signature">basic</a> signature was given.
</div>
When the <code class="docutils literal notranslate">[version]</code> argument is given, Config mode will only find a
version of the package that claims compatibility with the requested
version (see <a class="reference internal" href="#find-package-version-format">format specification</a>). If the
<code class="docutils literal notranslate">EXACT</code> option is given, only a version of the package claiming an exact match
of the requested version may be found. CMake does not establish any
convention for the meaning of version numbers. Package version
numbers are checked by &quot;version&quot; files provided by the packages themselves
or by <a class="reference internal" href="../module/FetchContent.html#module:FetchContent" title="FetchContent"><code class="xref cmake cmake-module docutils literal notranslate">FetchContent</code></a>. For a candidate package configuration file
<code class="docutils literal notranslate">&lt;config-file&gt;.cmake</code> the corresponding version file is located next
to it and named either <code class="docutils literal notranslate">&lt;config-file&gt;-version.cmake</code> or
<code class="docutils literal notranslate">&lt;config-file&gt;Version.cmake</code>. If no such version file is available
then the configuration file is assumed to not be compatible with any
requested version. A basic version file containing generic version
matching code can be created using the
<a class="reference internal" href="../module/CMakePackageConfigHelpers.html#module:CMakePackageConfigHelpers" title="CMakePackageConfigHelpers"><code class="xref cmake cmake-module docutils literal notranslate">CMakePackageConfigHelpers</code></a> module. When a version file
is found it is loaded to check the requested version number. The
version file is loaded in a nested scope in which the following
variables have been defined:
<dl class="simple">
<dt><code class="docutils literal notranslate">PACKAGE_FIND_NAME</code></dt><dd>The <code class="docutils literal notranslate">&lt;PackageName&gt;</code>
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION</code></dt><dd>Full requested version string
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MAJOR</code></dt><dd>Major version if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MINOR</code></dt><dd>Minor version if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_PATCH</code></dt><dd>Patch version if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_TWEAK</code></dt><dd>Tweak version if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_COUNT</code></dt><dd>Number of version components, 0 to 4
</dd>
</dl>
When a version range is specified, the above version variables will hold
values based on the lower end of the version range. This is to preserve
compatibility with packages that have not been implemented to expect version
ranges. In addition, the version range will be described by the following
variables:
<dl class="simple">
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_RANGE</code></dt><dd>Full requested version range string
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_RANGE_MIN</code></dt><dd>This specifies whether the lower end point of the version range should be
included or excluded. Currently, the only supported value for this variable
is <code class="docutils literal notranslate">INCLUDE</code>.
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_RANGE_MAX</code></dt><dd>This specifies whether the upper end point of the version range should be
included or excluded. The supported values for this variable are
<code class="docutils literal notranslate">INCLUDE</code> and <code class="docutils literal notranslate">EXCLUDE</code>.
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MIN</code></dt><dd>Full requested version string of the lower end point of the range
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MIN_MAJOR</code></dt><dd>Major version of the lower end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MIN_MINOR</code></dt><dd>Minor version of the lower end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MIN_PATCH</code></dt><dd>Patch version of the lower end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MIN_TWEAK</code></dt><dd>Tweak version of the lower end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MIN_COUNT</code></dt><dd>Number of version components of the lower end point, 0 to 4
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MAX</code></dt><dd>Full requested version string of the upper end point of the range
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MAX_MAJOR</code></dt><dd>Major version of the upper end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MAX_MINOR</code></dt><dd>Minor version of the upper end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MAX_PATCH</code></dt><dd>Patch version of the upper end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MAX_TWEAK</code></dt><dd>Tweak version of the upper end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_FIND_VERSION_MAX_COUNT</code></dt><dd>Number of version components of the upper end point, 0 to 4
</dd>
</dl>
Regardless of whether a single version or a version range is specified, the
variable <code class="docutils literal notranslate">PACKAGE_FIND_VERSION_COMPLETE</code> will be defined and will hold
the full requested version string as specified.
The version file checks whether it satisfies the requested version and
sets these variables:
<dl class="simple">
<dt><code class="docutils literal notranslate">PACKAGE_VERSION</code></dt><dd>Full provided version string
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_VERSION_EXACT</code></dt><dd>True if version is exact match
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_VERSION_COMPATIBLE</code></dt><dd>True if version is compatible
</dd>
<dt><code class="docutils literal notranslate">PACKAGE_VERSION_UNSUITABLE</code></dt><dd>True if unsuitable as any version
</dd>
</dl>
These variables are checked by the <code class="docutils literal notranslate">find_package</code> command to determine
whether the configuration file provides an acceptable version. They
are not available after the <code class="docutils literal notranslate">find_package</code> call returns. If the version
is acceptable the following variables are set:
<dl class="simple">
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_VERSION</code></dt><dd>Full provided version string
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_VERSION_MAJOR</code></dt><dd>Major version if provided, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_VERSION_MINOR</code></dt><dd>Minor version if provided, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_VERSION_PATCH</code></dt><dd>Patch version if provided, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_VERSION_TWEAK</code></dt><dd>Tweak version if provided, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_VERSION_COUNT</code></dt><dd>Number of version components, 0 to 4
</dd>
</dl>
and the corresponding package configuration file is loaded.
When multiple package configuration files are available whose version files
claim compatibility with the version requested it is unspecified which
one is chosen: unless the variable <a class="reference internal" href="../variable/CMAKE_FIND_PACKAGE_SORT_ORDER.html#variable:CMAKE_FIND_PACKAGE_SORT_ORDER" title="CMAKE_FIND_PACKAGE_SORT_ORDER"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_PACKAGE_SORT_ORDER</code></a>
is set no attempt is made to choose a highest or closest version number.
To control the order in which <code class="docutils literal notranslate">find_package</code> checks for compatibility use
the two variables <a class="reference internal" href="../variable/CMAKE_FIND_PACKAGE_SORT_ORDER.html#variable:CMAKE_FIND_PACKAGE_SORT_ORDER" title="CMAKE_FIND_PACKAGE_SORT_ORDER"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_PACKAGE_SORT_ORDER</code></a> and
<a class="reference internal" href="../variable/CMAKE_FIND_PACKAGE_SORT_DIRECTION.html#variable:CMAKE_FIND_PACKAGE_SORT_DIRECTION" title="CMAKE_FIND_PACKAGE_SORT_DIRECTION"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_PACKAGE_SORT_DIRECTION</code></a>.
For instance in order to select the highest version one can set
<div class="highlight-cmake notranslate"><div class="highlight"><pre>SET(CMAKE_FIND_PACKAGE_SORT_ORDER NATURAL)
SET(CMAKE_FIND_PACKAGE_SORT_DIRECTION DEC)
</pre></div>
</div>
before calling <code class="docutils literal notranslate">find_package</code>.
</section>
<section id="package-file-interface-variables">
<h2><a class="toc-backref" href="#id11" role="doc-backlink">Package File Interface Variables</a><a class="headerlink" href="#package-file-interface-variables" title="Permalink to this heading">¶</a></h2>
When loading a find module or package configuration file <code class="docutils literal notranslate">find_package</code>
defines variables to provide information about the call arguments (and
restores their original state before returning):
<dl class="simple">
<dt><code class="docutils literal notranslate">CMAKE_FIND_PACKAGE_NAME</code></dt><dd>The <code class="docutils literal notranslate">&lt;PackageName&gt;</code> which is searched for
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_REQUIRED</code></dt><dd>True if <code class="docutils literal notranslate">REQUIRED</code> option was given
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_QUIETLY</code></dt><dd>True if <code class="docutils literal notranslate">QUIET</code> option was given
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_REGISTRY_VIEW</code></dt><dd>The requested view if <code class="docutils literal notranslate">REGISTRY_VIEW</code> option was given
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION</code></dt><dd>Full requested version string
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MAJOR</code></dt><dd>Major version if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MINOR</code></dt><dd>Minor version if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_PATCH</code></dt><dd>Patch version if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_TWEAK</code></dt><dd>Tweak version if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_COUNT</code></dt><dd>Number of version components, 0 to 4
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_EXACT</code></dt><dd>True if <code class="docutils literal notranslate">EXACT</code> option was given
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_COMPONENTS</code></dt><dd>List of specified components (required and optional)
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_REQUIRED_&lt;c&gt;</code></dt><dd>True if component <code class="docutils literal notranslate">&lt;c&gt;</code> is required,
false if component <code class="docutils literal notranslate">&lt;c&gt;</code> is optional
</dd>
</dl>
When a version range is specified, the above version variables will hold
values based on the lower end of the version range. This is to preserve
compatibility with packages that have not been implemented to expect version
ranges. In addition, the version range will be described by the following
variables:
<dl class="simple">
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_RANGE</code></dt><dd>Full requested version range string
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_RANGE_MIN</code></dt><dd>This specifies whether the lower end point of the version range is
included or excluded. Currently, <code class="docutils literal notranslate">INCLUDE</code> is the only supported value.
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_RANGE_MAX</code></dt><dd>This specifies whether the upper end point of the version range is
included or excluded. The possible values for this variable are
<code class="docutils literal notranslate">INCLUDE</code> or <code class="docutils literal notranslate">EXCLUDE</code>.
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MIN</code></dt><dd>Full requested version string of the lower end point of the range
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MIN_MAJOR</code></dt><dd>Major version of the lower end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MIN_MINOR</code></dt><dd>Minor version of the lower end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MIN_PATCH</code></dt><dd>Patch version of the lower end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MIN_TWEAK</code></dt><dd>Tweak version of the lower end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MIN_COUNT</code></dt><dd>Number of version components of the lower end point, 0 to 4
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MAX</code></dt><dd>Full requested version string of the upper end point of the range
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MAX_MAJOR</code></dt><dd>Major version of the upper end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MAX_MINOR</code></dt><dd>Minor version of the upper end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MAX_PATCH</code></dt><dd>Patch version of the upper end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MAX_TWEAK</code></dt><dd>Tweak version of the upper end point if requested, else 0
</dd>
<dt><code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_MAX_COUNT</code></dt><dd>Number of version components of the upper end point, 0 to 4
</dd>
</dl>
Regardless of whether a single version or a version range is specified, the
variable <code class="docutils literal notranslate">&lt;PackageName&gt;_FIND_VERSION_COMPLETE</code> will be defined and will hold
the full requested version string as specified.
In Module mode the loaded find module is responsible to honor the
request detailed by these variables; see the find module for details.
In Config mode <code class="docutils literal notranslate">find_package</code> handles <code class="docutils literal notranslate">REQUIRED</code>, <code class="docutils literal notranslate">QUIET</code>, and
<code class="docutils literal notranslate">[version]</code> options automatically but leaves it to the package
configuration file to handle components in a way that makes sense
for the package. The package configuration file may set
<code class="docutils literal notranslate">&lt;PackageName&gt;_FOUND</code> to false to tell <code class="docutils literal notranslate">find_package</code> that component
requirements are not satisfied.
</section>
</section>

<div class="clearer"></div>
 </div>
 </div>
 </div>
 <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
 <div class="sphinxsidebarwrapper">
 <div>
 <h3><a href="../index.html">Table of Contents</a></h3>
 <ul>
<li><a class="reference internal" href="#">find_package</a><ul>
<li><a class="reference internal" href="#search-modes">Search Modes</a></li>
<li><a class="reference internal" href="#basic-signature">Basic Signature</a></li>
<li><a class="reference internal" href="#full-signature">Full Signature</a></li>
<li><a class="reference internal" href="#config-mode-search-procedure">Config Mode Search Procedure</a></li>
<li><a class="reference internal" href="#config-mode-version-selection">Config Mode Version Selection</a></li>
<li><a class="reference internal" href="#package-file-interface-variables">Package File Interface Variables</a></li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="find_library.html"
 title="previous chapter">find_library</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="find_path.html"
 title="next chapter">find_path</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/command/find_package.rst.txt"
 rel="nofollow">Show Source</a></li>
 </ul>
 </div>
<div id="searchbox" style="display: none" role="search">
 <h3 id="searchlabel">Quick search</h3>
 <div class="searchformwrapper">
 <form class="search" action="../search.html" method="get">
 <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
 <input type="submit" value="Go" />
 </form>
 </div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
 </div>
 </div>
 <div class="clearer"></div>
 </div>
 <div class="related" role="navigation" aria-label="related navigation">
 <h3>Navigation</h3>
 <ul>
 <li class="right" style="margin-right: 10px">
 <a href="../genindex.html" title="General Index"
 >index</a></li>
 <li class="right" >
 <a href="find_path.html" title="find_path"
 >next</a> |</li>
 <li class="right" >
 <a href="find_library.html" title="find_library"
 >previous</a> |</li>
 <li>
 <img src="../_static/cmake-logo-16.png" alt=""
 style="vertical-align: middle; margin-top: -2px" />
 </li>
 <li>
 <a href="https://cmake.org/">CMake</a> &#187;
 </li>
 <li>
 <a href="../index.html">3.26.3 Documentation</a> &#187;
 </li>

<li class="nav-item nav-item-1"><a href="../manual/cmake-commands.7.html" >cmake-commands(7)</a> &#187;</li>
 <li class="nav-item nav-item-this"><a href="">find_package</a></li> 
 </ul>
 </div>

<div class="footer" role="contentinfo">
 &#169; Copyright 2000-2023 Kitware, Inc. and Contributors.
 Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 5.0.2.
 </div>
 </body>
</html>