OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	04/04/2023 07:10:48 PM	rwxr-xr-x
📄 ccmake.1.html	44.19 KB	04/04/2023 07:05:08 PM	rw-r--r--
📄 cmake-buildsystem.7.html	161.14 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-commands.7.html	21.66 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-compile-features.7.html	46.17 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-configure-log.7.html	35.93 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-developer.7.html	60.56 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-env-variables.7.html	15.36 KB	04/04/2023 07:05:09 PM	rw-r--r--
📄 cmake-file-api.7.html	174.79 KB	04/04/2023 07:05:10 PM	rw-r--r--
📄 cmake-generator-expressions.7.html	229.68 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-generators.7.html	16.07 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-gui.1.html	27.62 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-language.7.html	67.9 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-modules.7.html	37.63 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-packages.7.html	84.94 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-policies.7.html	48.41 KB	04/04/2023 07:05:11 PM	rw-r--r--
📄 cmake-presets.7.html	122.21 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-properties.7.html	80.47 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-qt.7.html	47.92 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-server.7.html	5.39 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-toolchains.7.html	92.74 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake-variables.7.html	105.71 KB	04/04/2023 07:05:12 PM	rw-r--r--
📄 cmake.1.html	170.8 KB	04/04/2023 07:05:13 PM	rw-r--r--
📄 cpack-generators.7.html	7.54 KB	04/04/2023 07:05:13 PM	rw-r--r--
📄 cpack.1.html	39.49 KB	04/04/2023 07:05:13 PM	rw-r--r--
📄 ctest.1.html	230.72 KB	04/04/2023 07:05:13 PM	rw-r--r--

Editing: cmake.1.html

<!DOCTYPE html>

<title>cmake(1) &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="ctest.1.html" title="ctest(1)"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="../index.html" title="Introduction"
 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-this"><a href="">cmake(1)</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="cmake-1">
<h1>cmake(1)<a class="headerlink" href="#cmake-1" title="Permalink to this heading">¶</a></h1>
<section id="synopsis">
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this heading">¶</a></h2>
<pre class="literal-block"><a class="reference internal" href="#generate-a-project-buildsystem">Generate a Project Buildsystem</a>
 cmake [&lt;options&gt;] &lt;path-to-source | path-to-existing-build&gt;
 cmake [&lt;options&gt;] -S &lt;path-to-source&gt; -B &lt;path-to-build&gt;

<a class="reference internal" href="#build-a-project">Build a Project</a>
 cmake --build &lt;dir&gt; [&lt;options&gt;] [-- &lt;build-tool-options&gt;]

<a class="reference internal" href="#install-a-project">Install a Project</a>
 cmake --install &lt;dir&gt; [&lt;options&gt;]

<a class="reference internal" href="#open-a-project">Open a Project</a>
 cmake --open &lt;dir&gt;

<a class="reference internal" href="#run-a-script">Run a Script</a>
 cmake [-D &lt;var&gt;=&lt;value&gt;]... -P &lt;cmake-script-file&gt;

<a class="reference internal" href="#run-a-command-line-tool">Run a Command-Line Tool</a>
 cmake -E &lt;command&gt; [&lt;options&gt;]

<a class="reference internal" href="#run-the-find-package-tool">Run the Find-Package Tool</a>
 cmake --find-package [&lt;options&gt;]

<a class="reference internal" href="#run-a-workflow-preset">Run a Workflow Preset</a>
 cmake --workflow [&lt;options&gt;]

<a class="reference internal" href="#view-help">View Help</a>
 cmake --help[-&lt;topic&gt;]</pre>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
The cmake executable is the command-line interface of the cross-platform
buildsystem generator CMake. The above <a class="reference internal" href="#synopsis">Synopsis</a> lists various actions
the tool can perform as described in sections below.
To build a software project with CMake, <a class="reference internal" href="#generate-a-project-buildsystem">Generate a Project Buildsystem</a>.
Optionally use cmake to <a class="reference internal" href="#build-a-project">Build a Project</a>, <a class="reference internal" href="#install-a-project">Install a Project</a> or just
run the corresponding build tool (e.g. <code class="docutils literal notranslate">make</code>) directly. cmake can also
be used to <a class="reference internal" href="#view-help">View Help</a>.
The other actions are meant for use by software developers writing
scripts in the <a class="reference internal" href="cmake-language.7.html#manual:cmake-language(7)" title="cmake-language(7)"><code class="xref cmake cmake-manual docutils literal notranslate">CMake language</code></a> to support
their builds.
For graphical user interfaces that may be used in place of cmake,
see <a class="reference internal" href="ccmake.1.html#manual:ccmake(1)" title="ccmake(1)"><code class="xref cmake cmake-manual docutils literal notranslate">ccmake</code></a> and <a class="reference internal" href="cmake-gui.1.html#manual:cmake-gui(1)" title="cmake-gui(1)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-gui</code></a>.
For command-line interfaces to the CMake testing and packaging facilities,
see <a class="reference internal" href="ctest.1.html#manual:ctest(1)" title="ctest(1)"><code class="xref cmake cmake-manual docutils literal notranslate">ctest</code></a> and <a class="reference internal" href="cpack.1.html#manual:cpack(1)" title="cpack(1)"><code class="xref cmake cmake-manual docutils literal notranslate">cpack</code></a>.
For more information on CMake at large, <a class="reference internal" href="#see-also">see also</a> the links at the end
of this manual.
</section>
<section id="introduction-to-cmake-buildsystems">
<h2>Introduction to CMake Buildsystems<a class="headerlink" href="#introduction-to-cmake-buildsystems" title="Permalink to this heading">¶</a></h2>
A buildsystem describes how to build a project's executables and libraries
from its source code using a build tool to automate the process. For
example, a buildsystem may be a <code class="docutils literal notranslate">Makefile</code> for use with a command-line
<code class="docutils literal notranslate">make</code> tool or a project file for an Integrated Development Environment
(IDE). In order to avoid maintaining multiple such buildsystems, a project
may specify its buildsystem abstractly using files written in the
<a class="reference internal" href="cmake-language.7.html#manual:cmake-language(7)" title="cmake-language(7)"><code class="xref cmake cmake-manual docutils literal notranslate">CMake language</code></a>. From these files CMake
generates a preferred buildsystem locally for each user through a backend
called a generator.
To generate a buildsystem with CMake, the following must be selected:
<dl>
<dt>Source Tree</dt><dd>The top-level directory containing source files provided by the project.
The project specifies its buildsystem using files as described in the
<a class="reference internal" href="cmake-language.7.html#manual:cmake-language(7)" title="cmake-language(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-language(7)</code></a> manual, starting with a top-level file named
<code class="docutils literal notranslate">CMakeLists.txt</code>. These files specify build targets and their
dependencies as described in the <a class="reference internal" href="cmake-buildsystem.7.html#manual:cmake-buildsystem(7)" title="cmake-buildsystem(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-buildsystem(7)</code></a> manual.
</dd>
<dt>Build Tree</dt><dd>The top-level directory in which buildsystem files and build output
artifacts (e.g. executables and libraries) are to be stored.
CMake will write a <code class="docutils literal notranslate">CMakeCache.txt</code> file to identify the directory
as a build tree and store persistent information such as buildsystem
configuration options.
To maintain a pristine source tree, perform an out-of-source build
by using a separate dedicated build tree. An in-source build in
which the build tree is placed in the same directory as the source
tree is also supported, but discouraged.
</dd>
<dt>Generator</dt><dd>This chooses the kind of buildsystem to generate. See the
<a class="reference internal" href="cmake-generators.7.html#manual:cmake-generators(7)" title="cmake-generators(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-generators(7)</code></a> manual for documentation of all generators.
Run <a class="reference internal" href="#cmdoption-cmake-h"><code class="xref std std-option docutils literal notranslate">cmake --help</code></a> to see a list of generators available locally.
Optionally use the <a class="reference internal" href="#cmdoption-cmake-G"><code class="xref std std-option docutils literal notranslate">-G</code></a> option below to specify a
generator, or simply accept the default CMake chooses for the current
platform.
When using one of the <a class="reference internal" href="cmake-generators.7.html#command-line-build-tool-generators">Command-Line Build Tool Generators</a>
CMake expects that the environment needed by the compiler toolchain
is already configured in the shell. When using one of the
<a class="reference internal" href="cmake-generators.7.html#ide-build-tool-generators">IDE Build Tool Generators</a>, no particular environment is needed.
</dd>
</dl>
</section>
<section id="generate-a-project-buildsystem">
<h2>Generate a Project Buildsystem<a class="headerlink" href="#generate-a-project-buildsystem" title="Permalink to this heading">¶</a></h2>
Run CMake with one of the following command signatures to specify the
source and build trees and generate a buildsystem:
<dl>
<dt><code class="docutils literal notranslate">cmake [&lt;options&gt;] &lt;path-to-source&gt;</code></dt><dd>Uses the current working directory as the build tree, and
<code class="docutils literal notranslate">&lt;path-to-source&gt;</code> as the source tree. The specified path may
be absolute or relative to the current working directory.
The source tree must contain a <code class="docutils literal notranslate">CMakeLists.txt</code> file and must
not contain a <code class="docutils literal notranslate">CMakeCache.txt</code> file because the latter
identifies an existing build tree. For example:
<div class="highlight-console notranslate"><div class="highlight"><pre>$ mkdir build ; cd build
$ cmake ../src
</pre></div>
</div>
</dd>
<dt><code class="docutils literal notranslate">cmake [&lt;options&gt;] &lt;path-to-existing-build&gt;</code></dt><dd>Uses <code class="docutils literal notranslate">&lt;path-to-existing-build&gt;</code> as the build tree, and loads the
path to the source tree from its <code class="docutils literal notranslate">CMakeCache.txt</code> file, which must
have already been generated by a previous run of CMake. The specified
path may be absolute or relative to the current working directory.
For example:
<div class="highlight-console notranslate"><div class="highlight"><pre>$ cd build
$ cmake .
</pre></div>
</div>
</dd>
</dl>
<code class="docutils literal notranslate">cmake [&lt;options&gt;] -S &lt;path-to-source&gt; -B &lt;path-to-build&gt;</code>
<blockquote>
<div><div class="versionadded">
New in version 3.13.
</div>
Uses <code class="docutils literal notranslate">&lt;path-to-build&gt;</code> as the build tree and <code class="docutils literal notranslate">&lt;path-to-source&gt;</code>
as the source tree. The specified paths may be absolute or relative
to the current working directory. The source tree must contain a
<code class="docutils literal notranslate">CMakeLists.txt</code> file. The build tree will be created automatically
if it does not already exist. For example:
<div class="highlight-console notranslate"><div class="highlight"><pre>$ cmake -S src -B build
</pre></div>
</div>
</div></blockquote>
In all cases the <code class="docutils literal notranslate">&lt;options&gt;</code> may be zero or more of the <a class="reference internal" href="#options">Options</a> below.
The above styles for specifying the source and build trees may be mixed.
Paths specified with <a class="reference internal" href="#cmdoption-cmake-S"><code class="xref std std-option docutils literal notranslate">-S</code></a> or <a class="reference internal" href="#cmdoption-cmake-B"><code class="xref std std-option docutils literal notranslate">-B</code></a>
are always classified as source or build trees, respectively. Paths
specified with plain arguments are classified based on their content
and the types of paths given earlier. If only one type of path is given,
the current working directory (cwd) is used for the other. For example:
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head">Command Line</th>
<th class="head">Source Dir</th>
<th class="head">Build Dir</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><code class="docutils literal notranslate">cmake src</code></td>
<td><code class="docutils literal notranslate">src</code></td>
<td><cite>cwd</cite></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">cmake build</code> (existing)</td>
<td><cite>loaded</cite></td>
<td><code class="docutils literal notranslate">build</code></td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">cmake -S src</code></td>
<td><code class="docutils literal notranslate">src</code></td>
<td><cite>cwd</cite></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">cmake -S src build</code></td>
<td><code class="docutils literal notranslate">src</code></td>
<td><code class="docutils literal notranslate">build</code></td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">cmake -S src -B build</code></td>
<td><code class="docutils literal notranslate">src</code></td>
<td><code class="docutils literal notranslate">build</code></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">cmake -B build</code></td>
<td><cite>cwd</cite></td>
<td><code class="docutils literal notranslate">build</code></td>
</tr>
<tr class="row-even"><td><code class="docutils literal notranslate">cmake -B build src</code></td>
<td><code class="docutils literal notranslate">src</code></td>
<td><code class="docutils literal notranslate">build</code></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal notranslate">cmake -B build -S src</code></td>
<td><code class="docutils literal notranslate">src</code></td>
<td><code class="docutils literal notranslate">build</code></td>
</tr>
</tbody>
</table>
<div class="versionchanged">
Changed in version 3.23: CMake warns when multiple source paths are specified. This has never
been officially documented or supported, but older versions accidentally
accepted multiple source paths and used the last path specified.
Avoid passing multiple source path arguments.
</div>
After generating a buildsystem one may use the corresponding native
build tool to build the project. For example, after using the
<a class="reference internal" href="../generator/Unix%20Makefiles.html#generator:Unix Makefiles" title="Unix Makefiles"><code class="xref cmake cmake-generator docutils literal notranslate">Unix Makefiles</code></a> generator one may run <code class="docutils literal notranslate">make</code> directly:
<blockquote>
<div><div class="highlight-console notranslate"><div class="highlight"><pre>$ make
$ make install
</pre></div>
</div>
</div></blockquote>
Alternatively, one may use cmake to <a class="reference internal" href="#build-a-project">Build a Project</a> by
automatically choosing and invoking the appropriate native build tool.
<section id="options">
<h3>Options<a class="headerlink" href="#options" title="Permalink to this heading">¶</a></h3>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-S">
-S &lt;path-to-source&gt;<a class="headerlink" href="#cmdoption-cmake-S" title="Permalink to this definition">¶</a></dt>
<dd>Path to root directory of the CMake project to build.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-B">
-B &lt;path-to-build&gt;<a class="headerlink" href="#cmdoption-cmake-B" title="Permalink to this definition">¶</a></dt>
<dd>Path to directory which CMake will use as the root of build directory.
If the directory doesn't already exist CMake will make it.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-C">
-C &lt;initial-cache&gt;<a class="headerlink" href="#cmdoption-cmake-C" title="Permalink to this definition">¶</a></dt>
<dd>Pre-load a script to populate the cache.
When CMake is first run in an empty build tree, it creates a
<code class="docutils literal notranslate">CMakeCache.txt</code> file and populates it with customizable settings for
the project. This option may be used to specify a file from which
to load cache entries before the first pass through the project's
CMake listfiles. The loaded entries take priority over the
project's default values. The given file should be a CMake script
containing <a class="reference internal" href="../command/set.html#command:set" title="set"><code class="xref cmake cmake-command docutils literal notranslate">set()</code></a> commands that use the <code class="docutils literal notranslate">CACHE</code> option, not a
cache-format file.
References to <a class="reference internal" href="../variable/CMAKE_SOURCE_DIR.html#variable:CMAKE_SOURCE_DIR" title="CMAKE_SOURCE_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SOURCE_DIR</code></a> and <a class="reference internal" href="../variable/CMAKE_BINARY_DIR.html#variable:CMAKE_BINARY_DIR" title="CMAKE_BINARY_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_BINARY_DIR</code></a>
within the script evaluate to the top-level source and build tree.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-D">
-D &lt;var&gt;:&lt;type&gt;=&lt;value&gt;, -D &lt;var&gt;=&lt;value&gt;<a class="headerlink" href="#cmdoption-cmake-D" title="Permalink to this definition">¶</a></dt>
<dd>Create or update a CMake <code class="docutils literal notranslate">CACHE</code> entry.
When CMake is first run in an empty build tree, it creates a
<code class="docutils literal notranslate">CMakeCache.txt</code> file and populates it with customizable settings for
the project. This option may be used to specify a setting that
takes priority over the project's default value. The option may be
repeated for as many <code class="docutils literal notranslate">CACHE</code> entries as desired.
If the <code class="docutils literal notranslate">:&lt;type&gt;</code> portion is given it must be one of the types
specified by the <a class="reference internal" href="../command/set.html#command:set" title="set"><code class="xref cmake cmake-command docutils literal notranslate">set()</code></a> command documentation for its
<code class="docutils literal notranslate">CACHE</code> signature.
If the <code class="docutils literal notranslate">:&lt;type&gt;</code> portion is omitted the entry will be created
with no type if it does not exist with a type already. If a
command in the project sets the type to <code class="docutils literal notranslate">PATH</code> or <code class="docutils literal notranslate">FILEPATH</code>
then the <code class="docutils literal notranslate">&lt;value&gt;</code> will be converted to an absolute path.
This option may also be given as a single argument:
<code class="docutils literal notranslate">-D&lt;var&gt;:&lt;type&gt;=&lt;value&gt;</code> or <code class="docutils literal notranslate">-D&lt;var&gt;=&lt;value&gt;</code>.
It's important to note that the order of <code class="docutils literal notranslate">-C</code> and <code class="docutils literal notranslate">-D</code> arguments is
significant. They will be carried out in the order they are listed, with the
last argument taking precedence over the previous ones. For example, if you
specify <code class="docutils literal notranslate">-DCMAKE_BUILD_TYPE=Debug</code>, followed by a <code class="docutils literal notranslate">-C</code> argument with a
file that calls:
<div class="highlight-cmake notranslate"><div class="highlight"><pre>set(CMAKE_BUILD_TYPE &quot;Release&quot; CACHE STRING &quot;&quot; FORCE)
</pre></div>
</div>
then the <code class="docutils literal notranslate">-C</code> argument will take precedence, and <code class="docutils literal notranslate">CMAKE_BUILD_TYPE</code> will
be set to <code class="docutils literal notranslate">Release</code>. However, if the <code class="docutils literal notranslate">-D</code> argument comes after the <code class="docutils literal notranslate">-C</code>
argument, it will be set to <code class="docutils literal notranslate">Debug</code>.
If a <code class="docutils literal notranslate">set(... CACHE ...)</code> call in the <code class="docutils literal notranslate">-C</code> file does not use <code class="docutils literal notranslate">FORCE</code>,
and a <code class="docutils literal notranslate">-D</code> argument sets the same variable, the <code class="docutils literal notranslate">-D</code> argument will take
precedence regardless of order because of the nature of non-<code class="docutils literal notranslate">FORCE</code>
<code class="docutils literal notranslate">set(... CACHE ...)</code> calls.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-U">
-U &lt;globbing_expr&gt;<a class="headerlink" href="#cmdoption-cmake-U" title="Permalink to this definition">¶</a></dt>
<dd>Remove matching entries from CMake <code class="docutils literal notranslate">CACHE</code>.
This option may be used to remove one or more variables from the
<code class="docutils literal notranslate">CMakeCache.txt</code> file, globbing expressions using <code class="docutils literal notranslate">*</code> and <code class="docutils literal notranslate">?</code> are
supported. The option may be repeated for as many <code class="docutils literal notranslate">CACHE</code> entries as
desired.
Use with care, you can make your <code class="docutils literal notranslate">CMakeCache.txt</code> non-working.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-G">
-G &lt;generator-name&gt;<a class="headerlink" href="#cmdoption-cmake-G" title="Permalink to this definition">¶</a></dt>
<dd>Specify a build system generator.
CMake may support multiple native build systems on certain
platforms. A generator is responsible for generating a particular
build system. Possible generator names are specified in the
<a class="reference internal" href="cmake-generators.7.html#manual:cmake-generators(7)" title="cmake-generators(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-generators(7)</code></a> manual.
If not specified, CMake checks the <a class="reference internal" href="../envvar/CMAKE_GENERATOR.html#envvar:CMAKE_GENERATOR" title="CMAKE_GENERATOR"><code class="xref cmake cmake-envvar docutils literal notranslate">CMAKE_GENERATOR</code></a> environment
variable and otherwise falls back to a builtin default selection.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-T">
-T &lt;toolset-spec&gt;<a class="headerlink" href="#cmdoption-cmake-T" title="Permalink to this definition">¶</a></dt>
<dd>Toolset specification for the generator, if supported.
Some CMake generators support a toolset specification to tell
the native build system how to choose a compiler. See the
<a class="reference internal" href="../variable/CMAKE_GENERATOR_TOOLSET.html#variable:CMAKE_GENERATOR_TOOLSET" title="CMAKE_GENERATOR_TOOLSET"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_GENERATOR_TOOLSET</code></a> variable for details.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-A">
-A &lt;platform-name&gt;<a class="headerlink" href="#cmdoption-cmake-A" title="Permalink to this definition">¶</a></dt>
<dd>Specify platform name if supported by generator.
Some CMake generators support a platform name to be given to the
native build system to choose a compiler or SDK. See the
<a class="reference internal" href="../variable/CMAKE_GENERATOR_PLATFORM.html#variable:CMAKE_GENERATOR_PLATFORM" title="CMAKE_GENERATOR_PLATFORM"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_GENERATOR_PLATFORM</code></a> variable for details.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-toolchain">
--toolchain &lt;path-to-file&gt;<a class="headerlink" href="#cmdoption-cmake-toolchain" title="Permalink to this definition">¶</a></dt>
<dd>Specify the cross compiling toolchain file, equivalent to setting
<a class="reference internal" href="../variable/CMAKE_TOOLCHAIN_FILE.html#variable:CMAKE_TOOLCHAIN_FILE" title="CMAKE_TOOLCHAIN_FILE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_TOOLCHAIN_FILE</code></a> variable.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-install-prefix">
--install-prefix &lt;directory&gt;<a class="headerlink" href="#cmdoption-cmake-install-prefix" title="Permalink to this definition">¶</a></dt>
<dd>Specify the installation directory, used by the
<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> variable. Must be an absolute path.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-Wno-dev">
-Wno-dev<a class="headerlink" href="#cmdoption-cmake-Wno-dev" title="Permalink to this definition">¶</a></dt>
<dd>Suppress developer warnings.
Suppress warnings that are meant for the author of the
<code class="docutils literal notranslate">CMakeLists.txt</code> files. By default this will also turn off
deprecation warnings.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-Wdev">
-Wdev<a class="headerlink" href="#cmdoption-cmake-Wdev" title="Permalink to this definition">¶</a></dt>
<dd>Enable developer warnings.
Enable warnings that are meant for the author of the <code class="docutils literal notranslate">CMakeLists.txt</code>
files. By default this will also turn on deprecation warnings.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-Wdeprecated">
-Wdeprecated<a class="headerlink" href="#cmdoption-cmake-Wdeprecated" title="Permalink to this definition">¶</a></dt>
<dd>Enable deprecated functionality warnings.
Enable warnings for usage of deprecated functionality, that are meant
for the author of the <code class="docutils literal notranslate">CMakeLists.txt</code> files.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-Wno-deprecated">
-Wno-deprecated<a class="headerlink" href="#cmdoption-cmake-Wno-deprecated" title="Permalink to this definition">¶</a></dt>
<dd>Suppress deprecated functionality warnings.
Suppress warnings for usage of deprecated functionality, that are meant
for the author of the <code class="docutils literal notranslate">CMakeLists.txt</code> files.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-Werror">
-Werror=&lt;what&gt;<a class="headerlink" href="#cmdoption-cmake-Werror" title="Permalink to this definition">¶</a></dt>
<dd>Treat CMake warnings as errors. <code class="docutils literal notranslate">&lt;what&gt;</code> must be one of the following:
<dl>
<dt><code class="docutils literal notranslate">dev</code></dt><dd>Make developer warnings errors.
Make warnings that are meant for the author of the <code class="docutils literal notranslate">CMakeLists.txt</code> files
errors. By default this will also turn on deprecated warnings as errors.
</dd>
<dt><code class="docutils literal notranslate">deprecated</code></dt><dd>Make deprecated macro and function warnings errors.
Make warnings for usage of deprecated macros and functions, that are meant
for the author of the <code class="docutils literal notranslate">CMakeLists.txt</code> files, errors.
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-Wno-error">
-Wno-error=&lt;what&gt;<a class="headerlink" href="#cmdoption-cmake-Wno-error" title="Permalink to this definition">¶</a></dt>
<dd>Do not treat CMake warnings as errors. <code class="docutils literal notranslate">&lt;what&gt;</code> must be one of the following:
<dl class="simple">
<dt><code class="docutils literal notranslate">dev</code></dt><dd>Make warnings that are meant for the author of the <code class="docutils literal notranslate">CMakeLists.txt</code> files not
errors. By default this will also turn off deprecated warnings as errors.
</dd>
<dt><code class="docutils literal notranslate">deprecated</code></dt><dd>Make warnings for usage of deprecated macros and functions, that are meant
for the author of the <code class="docutils literal notranslate">CMakeLists.txt</code> files, not errors.
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-fresh">
--fresh<a class="headerlink" href="#cmdoption-cmake-fresh" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.24.
</div>
Perform a fresh configuration of the build tree.
This removes any existing <code class="docutils literal notranslate">CMakeCache.txt</code> file and associated
<code class="docutils literal notranslate">CMakeFiles/</code> directory, and recreates them from scratch.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-L-A-H">
-L[A][H]<a class="headerlink" href="#cmdoption-cmake-L-A-H" title="Permalink to this definition">¶</a></dt>
<dd>List non-advanced cached variables.
List <code class="docutils literal notranslate">CACHE</code> variables will run CMake and list all the variables from
the CMake <code class="docutils literal notranslate">CACHE</code> that are not marked as <code class="docutils literal notranslate">INTERNAL</code> or <a class="reference internal" href="../prop_cache/ADVANCED.html#prop_cache:ADVANCED" title="ADVANCED"><code class="xref cmake cmake-prop_cache docutils literal notranslate">ADVANCED</code></a>.
This will effectively display current CMake settings, which can then be
changed with <a class="reference internal" href="#cmdoption-cmake-D"><code class="xref std std-option docutils literal notranslate">-D</code></a> option. Changing some of the variables
may result in more variables being created. If <code class="docutils literal notranslate">A</code> is specified, then it
will display also advanced variables. If <code class="docutils literal notranslate">H</code> is specified, it will also
display help for each variable.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-N">
-N<a class="headerlink" href="#cmdoption-cmake-N" title="Permalink to this definition">¶</a></dt>
<dd>View mode only.
Only load the cache. Do not actually run configure and generate
steps.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-graphviz">
--graphviz=&lt;file&gt;<a class="headerlink" href="#cmdoption-cmake-graphviz" title="Permalink to this definition">¶</a></dt>
<dd>Generate graphviz of dependencies, see <a class="reference internal" href="../module/CMakeGraphVizOptions.html#module:CMakeGraphVizOptions" title="CMakeGraphVizOptions"><code class="xref cmake cmake-module docutils literal notranslate">CMakeGraphVizOptions</code></a> for more.
Generate a graphviz input file that will contain all the library and
executable dependencies in the project. See the documentation for
<a class="reference internal" href="../module/CMakeGraphVizOptions.html#module:CMakeGraphVizOptions" title="CMakeGraphVizOptions"><code class="xref cmake cmake-module docutils literal notranslate">CMakeGraphVizOptions</code></a> for more details.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-system-information">
--system-information [file]<a class="headerlink" href="#cmdoption-cmake-system-information" title="Permalink to this definition">¶</a></dt>
<dd>Dump information about this system.
Dump a wide range of information about the current system. If run
from the top of a binary tree for a CMake project it will dump
additional information such as the cache, log files etc.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-log-level">
--log-level=&lt;level&gt;<a class="headerlink" href="#cmdoption-cmake-log-level" title="Permalink to this definition">¶</a></dt>
<dd>Set the log <code class="docutils literal notranslate">&lt;level&gt;</code>.
The <a class="reference internal" href="../command/message.html#command:message" title="message"><code class="xref cmake cmake-command docutils literal notranslate">message()</code></a> command will only output messages of the specified
log level or higher. The valid log levels are <code class="docutils literal notranslate">ERROR</code>, <code class="docutils literal notranslate">WARNING</code>,
<code class="docutils literal notranslate">NOTICE</code>, <code class="docutils literal notranslate">STATUS</code> (default), <code class="docutils literal notranslate">VERBOSE</code>, <code class="docutils literal notranslate">DEBUG</code>, or <code class="docutils literal notranslate">TRACE</code>.
To make a log level persist between CMake runs, set
<a class="reference internal" href="../variable/CMAKE_MESSAGE_LOG_LEVEL.html#variable:CMAKE_MESSAGE_LOG_LEVEL" title="CMAKE_MESSAGE_LOG_LEVEL"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_MESSAGE_LOG_LEVEL</code></a> as a cache variable instead.
If both the command line option and the variable are given, the command line
option takes precedence.
For backward compatibility reasons, <code class="docutils literal notranslate">--loglevel</code> is also accepted as a
synonym for this option.
<div class="versionadded">
New in version 3.25: See the <a class="reference internal" href="../command/cmake_language.html#command:cmake_language" title="cmake_language"><code class="xref cmake cmake-command docutils literal notranslate">cmake_language()</code></a> command for a way to
<a class="reference internal" href="../command/cmake_language.html#query-message-log-level">query the current message logging level</a>.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-log-context">
--log-context<a class="headerlink" href="#cmdoption-cmake-log-context" title="Permalink to this definition">¶</a></dt>
<dd>Enable the <a class="reference internal" href="../command/message.html#command:message" title="message"><code class="xref cmake cmake-command docutils literal notranslate">message()</code></a> command outputting context attached to each
message.
This option turns on showing context for the current CMake run only.
To make showing the context persistent for all subsequent CMake runs, set
<a class="reference internal" href="../variable/CMAKE_MESSAGE_CONTEXT_SHOW.html#variable:CMAKE_MESSAGE_CONTEXT_SHOW" title="CMAKE_MESSAGE_CONTEXT_SHOW"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_MESSAGE_CONTEXT_SHOW</code></a> as a cache variable instead.
When this command line option is given, <a class="reference internal" href="../variable/CMAKE_MESSAGE_CONTEXT_SHOW.html#variable:CMAKE_MESSAGE_CONTEXT_SHOW" title="CMAKE_MESSAGE_CONTEXT_SHOW"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_MESSAGE_CONTEXT_SHOW</code></a>
is ignored.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-debug-trycompile">
--debug-trycompile<a class="headerlink" href="#cmdoption-cmake-debug-trycompile" title="Permalink to this definition">¶</a></dt>
<dd>Do not delete the files and directories created for
<a class="reference internal" href="../command/try_compile.html#command:try_compile" title="try_compile"><code class="xref cmake cmake-command docutils literal notranslate">try_compile()</code></a> / <a class="reference internal" href="../command/try_run.html#command:try_run" title="try_run"><code class="xref cmake cmake-command docutils literal notranslate">try_run()</code></a> calls.
This is useful in debugging failed checks.
Note that some uses of <a class="reference internal" href="../command/try_compile.html#command:try_compile" title="try_compile"><code class="xref cmake cmake-command docutils literal notranslate">try_compile()</code></a> may use the same build tree,
which will limit the usefulness of this option if a project executes more
than one <a class="reference internal" href="../command/try_compile.html#command:try_compile" title="try_compile"><code class="xref cmake cmake-command docutils literal notranslate">try_compile()</code></a>. For example, such uses may change results
as artifacts from a previous try-compile may cause a different test to either
pass or fail incorrectly. This option is best used only when debugging.
(With respect to the preceding, the <a class="reference internal" href="../command/try_run.html#command:try_run" title="try_run"><code class="xref cmake cmake-command docutils literal notranslate">try_run()</code></a> command
is effectively a <a class="reference internal" href="../command/try_compile.html#command:try_compile" title="try_compile"><code class="xref cmake cmake-command docutils literal notranslate">try_compile()</code></a>. Any combination of the two
is subject to the potential issues described.)
<div class="versionadded">
New in version 3.25: When this option is enabled, every try-compile check prints a log
message reporting the directory in which the check is performed.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-debug-output">
--debug-output<a class="headerlink" href="#cmdoption-cmake-debug-output" title="Permalink to this definition">¶</a></dt>
<dd>Put cmake in a debug mode.
Print extra information during the cmake run like stack traces with
<a class="reference internal" href="../command/message.html#command:message" title="message"><code class="xref cmake cmake-command docutils literal notranslate">message(SEND_ERROR)</code></a> calls.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-debug-find">
--debug-find<a class="headerlink" href="#cmdoption-cmake-debug-find" title="Permalink to this definition">¶</a></dt>
<dd>Put cmake find commands in a debug mode.
Print extra find call information during the cmake run to standard
error. Output is designed for human consumption and not for parsing.
See also the <a class="reference internal" href="../variable/CMAKE_FIND_DEBUG_MODE.html#variable:CMAKE_FIND_DEBUG_MODE" title="CMAKE_FIND_DEBUG_MODE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_FIND_DEBUG_MODE</code></a> variable for debugging
a more local part of the project.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-debug-find-pkg">
--debug-find-pkg=&lt;pkg&gt;[,...]<a class="headerlink" href="#cmdoption-cmake-debug-find-pkg" title="Permalink to this definition">¶</a></dt>
<dd>Put cmake find commands in a debug mode when running under calls
to <a class="reference internal" href="../command/find_package.html#command:find_package" title="find_package"><code class="xref cmake cmake-command docutils literal notranslate">find_package(&lt;pkg&gt;)</code></a>, where <code class="docutils literal notranslate">&lt;pkg&gt;</code>
is an entry in the given comma-separated list of case-sensitive package
names.
Like <a class="reference internal" href="#cmdoption-cmake-debug-find"><code class="xref std std-option docutils literal notranslate">--debug-find</code></a>, but limiting scope
to the specified packages.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-debug-find-var">
--debug-find-var=&lt;var&gt;[,...]<a class="headerlink" href="#cmdoption-cmake-debug-find-var" title="Permalink to this definition">¶</a></dt>
<dd>Put cmake find commands in a debug mode when called with <code class="docutils literal notranslate">&lt;var&gt;</code>
as the result variable, where <code class="docutils literal notranslate">&lt;var&gt;</code> is an entry in the given
comma-separated list.
Like <a class="reference internal" href="#cmdoption-cmake-debug-find"><code class="xref std std-option docutils literal notranslate">--debug-find</code></a>, but limiting scope
to the specified variable names.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-trace">
--trace<a class="headerlink" href="#cmdoption-cmake-trace" title="Permalink to this definition">¶</a></dt>
<dd>Put cmake in trace mode.
Print a trace of all calls made and from where.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-trace-expand">
--trace-expand<a class="headerlink" href="#cmdoption-cmake-trace-expand" title="Permalink to this definition">¶</a></dt>
<dd>Put cmake in trace mode.
Like <a class="reference internal" href="#cmdoption-cmake-trace"><code class="xref std std-option docutils literal notranslate">--trace</code></a>, but with variables expanded.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-trace-format">
--trace-format=&lt;format&gt;<a class="headerlink" href="#cmdoption-cmake-trace-format" title="Permalink to this definition">¶</a></dt>
<dd>Put cmake in trace mode and sets the trace output format.
<code class="docutils literal notranslate">&lt;format&gt;</code> can be one of the following values.
<blockquote>
<div><dl>
<dt><code class="docutils literal notranslate">human</code></dt><dd>Prints each trace line in a human-readable format. This is the
default format.
</dd>
<dt><code class="docutils literal notranslate">json-v1</code></dt><dd>Prints each line as a separate JSON document. Each document is
separated by a newline ( <code class="docutils literal notranslate">\n</code> ). It is guaranteed that no
newline characters will be present inside a JSON document.
<div class="literal-block-wrapper docutils container" id="id3">
<div class="code-block-caption">JSON trace format<a class="headerlink" href="#id3" title="Permalink to this code">¶</a></div>
<div class="highlight-json notranslate"><div class="highlight"><pre>{
 &quot;file&quot;: &quot;/full/path/to/the/CMake/file.txt&quot;,
 &quot;line&quot;: 0,
 &quot;cmd&quot;: &quot;add_executable&quot;,
 &quot;args&quot;: [&quot;foo&quot;, &quot;bar&quot;],
 &quot;time&quot;: 1579512535.9687231,
 &quot;frame&quot;: 2,
 &quot;global_frame&quot;: 4
}
</pre></div>
</div>
</div>
The members are:
<dl class="simple">
<dt><code class="docutils literal notranslate">file</code></dt><dd>The full path to the CMake source file where the function
was called.
</dd>
<dt><code class="docutils literal notranslate">line</code></dt><dd>The line in <code class="docutils literal notranslate">file</code> where the function call begins.
</dd>
<dt><code class="docutils literal notranslate">line_end</code></dt><dd>If the function call spans multiple lines, this field will
be set to the line where the function call ends. If the function
calls spans a single line, this field will be unset. This field
was added in minor version 2 of the <code class="docutils literal notranslate">json-v1</code> format.
</dd>
<dt><code class="docutils literal notranslate">defer</code></dt><dd>Optional member that is present when the function call was deferred
by <a class="reference internal" href="../command/cmake_language.html#command:cmake_language" title="cmake_language"><code class="xref cmake cmake-command docutils literal notranslate">cmake_language(DEFER)</code></a>. If present, its value is a
string containing the deferred call <code class="docutils literal notranslate">&lt;id&gt;</code>.
</dd>
<dt><code class="docutils literal notranslate">cmd</code></dt><dd>The name of the function that was called.
</dd>
<dt><code class="docutils literal notranslate">args</code></dt><dd>A string list of all function parameters.
</dd>
<dt><code class="docutils literal notranslate">time</code></dt><dd>Timestamp (seconds since epoch) of the function call.
</dd>
<dt><code class="docutils literal notranslate">frame</code></dt><dd>Stack frame depth of the function that was called, within the
context of the <code class="docutils literal notranslate">CMakeLists.txt</code> being processed currently.
</dd>
<dt><code class="docutils literal notranslate">global_frame</code></dt><dd>Stack frame depth of the function that was called, tracked globally
across all <code class="docutils literal notranslate">CMakeLists.txt</code> files involved in the trace. This field
was added in minor version 2 of the <code class="docutils literal notranslate">json-v1</code> format.
</dd>
</dl>
Additionally, the first JSON document outputted contains the
<code class="docutils literal notranslate">version</code> key for the current major and minor version of the
<div class="literal-block-wrapper docutils container" id="id4">
<div class="code-block-caption">JSON version format<a class="headerlink" href="#id4" title="Permalink to this code">¶</a></div>
<div class="highlight-json notranslate"><div class="highlight"><pre>{
 &quot;version&quot;: {
 &quot;major&quot;: 1,
 &quot;minor&quot;: 2
 }
}
</pre></div>
</div>
</div>
The members are:
<dl class="simple">
<dt><code class="docutils literal notranslate">version</code></dt><dd>Indicates the version of the JSON format. The version has a
major and minor components following semantic version conventions.
</dd>
</dl>
</dd>
</dl>
</div></blockquote>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-trace-source">
--trace-source=&lt;file&gt;<a class="headerlink" href="#cmdoption-cmake-trace-source" title="Permalink to this definition">¶</a></dt>
<dd>Put cmake in trace mode, but output only lines of a specified file.
Multiple options are allowed.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-trace-redirect">
--trace-redirect=&lt;file&gt;<a class="headerlink" href="#cmdoption-cmake-trace-redirect" title="Permalink to this definition">¶</a></dt>
<dd>Put cmake in trace mode and redirect trace output to a file instead of stderr.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-warn-uninitialized">
--warn-uninitialized<a class="headerlink" href="#cmdoption-cmake-warn-uninitialized" title="Permalink to this definition">¶</a></dt>
<dd>Warn about uninitialized values.
Print a warning when an uninitialized variable is used.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-warn-unused-vars">
--warn-unused-vars<a class="headerlink" href="#cmdoption-cmake-warn-unused-vars" title="Permalink to this definition">¶</a></dt>
<dd>Does nothing. In CMake versions 3.2 and below this enabled warnings about
unused variables. In CMake versions 3.3 through 3.18 the option was broken.
In CMake 3.19 and above the option has been removed.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-no-warn-unused-cli">
--no-warn-unused-cli<a class="headerlink" href="#cmdoption-cmake-no-warn-unused-cli" title="Permalink to this definition">¶</a></dt>
<dd>Don't warn about command line options.
Don't find variables that are declared on the command line, but not
used.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-check-system-vars">
--check-system-vars<a class="headerlink" href="#cmdoption-cmake-check-system-vars" title="Permalink to this definition">¶</a></dt>
<dd>Find problems with variable usage in system files.
Normally, unused and uninitialized variables are searched for only
in <a class="reference internal" href="../variable/CMAKE_SOURCE_DIR.html#variable:CMAKE_SOURCE_DIR" title="CMAKE_SOURCE_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_SOURCE_DIR</code></a> and <a class="reference internal" href="../variable/CMAKE_BINARY_DIR.html#variable:CMAKE_BINARY_DIR" title="CMAKE_BINARY_DIR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_BINARY_DIR</code></a>.
This flag tells CMake to warn about other files as well.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-compile-no-warning-as-error">
--compile-no-warning-as-error<a class="headerlink" href="#cmdoption-cmake-compile-no-warning-as-error" title="Permalink to this definition">¶</a></dt>
<dd>Ignore target property <a class="reference internal" href="../prop_tgt/COMPILE_WARNING_AS_ERROR.html#prop_tgt:COMPILE_WARNING_AS_ERROR" title="COMPILE_WARNING_AS_ERROR"><code class="xref cmake cmake-prop_tgt docutils literal notranslate">COMPILE_WARNING_AS_ERROR</code></a> and variable
<a class="reference internal" href="../variable/CMAKE_COMPILE_WARNING_AS_ERROR.html#variable:CMAKE_COMPILE_WARNING_AS_ERROR" title="CMAKE_COMPILE_WARNING_AS_ERROR"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_COMPILE_WARNING_AS_ERROR</code></a>, preventing warnings from being
treated as errors on compile.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-profiling-output">
--profiling-output=&lt;path&gt;<a class="headerlink" href="#cmdoption-cmake-profiling-output" title="Permalink to this definition">¶</a></dt>
<dd>Used in conjunction with
<a class="reference internal" href="#cmdoption-cmake-profiling-format"><code class="xref std std-option docutils literal notranslate">--profiling-format</code></a> to output to a
given path.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-profiling-format">
--profiling-format=&lt;file&gt;<a class="headerlink" href="#cmdoption-cmake-profiling-format" title="Permalink to this definition">¶</a></dt>
<dd>Enable the output of profiling data of CMake script in the given format.
This can aid performance analysis of CMake scripts executed. Third party
applications should be used to process the output into human readable format.
Currently supported values are:
<code class="docutils literal notranslate">google-trace</code> Outputs in Google Trace Format, which can be parsed by the
<a class="reference external" href="about:tracing">about:tracing</a> tab of Google Chrome or using a plugin for a tool like Trace
Compass.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-preset">
--preset &lt;preset&gt;, --preset=&lt;preset&gt;<a class="headerlink" href="#cmdoption-cmake-preset" title="Permalink to this definition">¶</a></dt>
<dd>Reads a <a class="reference internal" href="cmake-presets.7.html#manual:cmake-presets(7)" title="cmake-presets(7)"><code class="xref cmake cmake-manual docutils literal notranslate">preset</code></a> from
<code class="docutils literal notranslate">&lt;path-to-source&gt;/CMakePresets.json</code> and
<code class="docutils literal notranslate">&lt;path-to-source&gt;/CMakeUserPresets.json</code>. The preset may specify the
generator and the build directory, and a list of variables and other
arguments to pass to CMake. The current working directory must contain
CMake preset files. The <a class="reference internal" href="cmake-gui.1.html#manual:cmake-gui(1)" title="cmake-gui(1)"><code class="xref cmake cmake-manual docutils literal notranslate">CMake GUI</code></a> can
also recognize <code class="docutils literal notranslate">CMakePresets.json</code> and <code class="docutils literal notranslate">CMakeUserPresets.json</code> files. For
full details on these files, see <a class="reference internal" href="cmake-presets.7.html#manual:cmake-presets(7)" title="cmake-presets(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-presets(7)</code></a>.
The presets are read before all other command line options. The options
specified by the preset (variables, generator, etc.) can all be overridden by
manually specifying them on the command line. For example, if the preset sets
a variable called <code class="docutils literal notranslate">MYVAR</code> to <code class="docutils literal notranslate">1</code>, but the user sets it to <code class="docutils literal notranslate">2</code> with a
<code class="docutils literal notranslate">-D</code> argument, the value <code class="docutils literal notranslate">2</code> is preferred.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-list-presets">
--list-presets[=&lt;type&gt;]<a class="headerlink" href="#cmdoption-cmake-list-presets" title="Permalink to this definition">¶</a></dt>
<dd>Lists the available presets of the specified <code class="docutils literal notranslate">&lt;type&gt;</code>. Valid values for
<code class="docutils literal notranslate">&lt;type&gt;</code> are <code class="docutils literal notranslate">configure</code>, <code class="docutils literal notranslate">build</code>, <code class="docutils literal notranslate">test</code>, <code class="docutils literal notranslate">package</code>, or <code class="docutils literal notranslate">all</code>.
If <code class="docutils literal notranslate">&lt;type&gt;</code> is omitted, <code class="docutils literal notranslate">configure</code> is assumed. The current working
directory must contain CMake preset files.
</dd></dl>

</section>
</section>
<section id="build-a-project">
<h2>Build a Project<a class="headerlink" href="#build-a-project" title="Permalink to this heading">¶</a></h2>
CMake provides a command-line signature to build an already-generated
project binary tree:
<div class="highlight-shell notranslate"><div class="highlight"><pre>cmake --build &lt;dir&gt; [&lt;options&gt;] [-- &lt;build-tool-options&gt;]
cmake --build --preset &lt;preset&gt; [&lt;options&gt;] [-- &lt;build-tool-options&gt;]
</pre></div>
</div>
This abstracts a native build tool's command-line interface with the
following options:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-build">
--build &lt;dir&gt;<a class="headerlink" href="#cmdoption-cmake-build" title="Permalink to this definition">¶</a></dt>
<dd>Project binary directory to be built. This is required (unless a preset
is specified) and must be first.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-build-preset">
--preset &lt;preset&gt;, --preset=&lt;preset&gt;<a class="headerlink" href="#cmdoption-cmake-build-preset" title="Permalink to this definition">¶</a></dt>
<dd>Use a build preset to specify build options. The project binary directory
is inferred from the <code class="docutils literal notranslate">configurePreset</code> key. The current working directory
must contain CMake preset files.
See <a class="reference internal" href="cmake-presets.7.html#manual:cmake-presets(7)" title="cmake-presets(7)"><code class="xref cmake cmake-manual docutils literal notranslate">preset</code></a> for more details.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-build-list-presets">
--list-presets<a class="headerlink" href="#cmdoption-cmake-build-list-presets" title="Permalink to this definition">¶</a></dt>
<dd>Lists the available build presets. The current working directory must
contain CMake preset files.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-build-j">
-j [&lt;jobs&gt;], --parallel [&lt;jobs&gt;]<a class="headerlink" href="#cmdoption-cmake-build-j" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.12.
</div>
The maximum number of concurrent processes to use when building.
If <code class="docutils literal notranslate">&lt;jobs&gt;</code> is omitted the native build tool's default number is used.
The <a class="reference internal" href="../envvar/CMAKE_BUILD_PARALLEL_LEVEL.html#envvar:CMAKE_BUILD_PARALLEL_LEVEL" title="CMAKE_BUILD_PARALLEL_LEVEL"><code class="xref cmake cmake-envvar docutils literal notranslate">CMAKE_BUILD_PARALLEL_LEVEL</code></a> environment variable, if set,
specifies a default parallel level when this option is not given.
Some native build tools always build in parallel. The use of <code class="docutils literal notranslate">&lt;jobs&gt;</code>
value of <code class="docutils literal notranslate">1</code> can be used to limit to a single job.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-build-t">
-t &lt;tgt&gt;..., --target &lt;tgt&gt;...<a class="headerlink" href="#cmdoption-cmake-build-t" title="Permalink to this definition">¶</a></dt>
<dd>Build <code class="docutils literal notranslate">&lt;tgt&gt;</code> instead of the default target. Multiple targets may be
given, separated by spaces.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-build-config">
--config &lt;cfg&gt;<a class="headerlink" href="#cmdoption-cmake-build-config" title="Permalink to this definition">¶</a></dt>
<dd>For multi-configuration tools, choose configuration <code class="docutils literal notranslate">&lt;cfg&gt;</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-build-clean-first">
--clean-first<a class="headerlink" href="#cmdoption-cmake-build-clean-first" title="Permalink to this definition">¶</a></dt>
<dd>Build target <code class="docutils literal notranslate">clean</code> first, then build.
(To clean only, use <a class="reference internal" href="#cmdoption-cmake-build-t"><code class="xref std std-option docutils literal notranslate">--target clean</code></a>.)
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-build-resolve-package-references">
--resolve-package-references=&lt;value&gt;<a class="headerlink" href="#cmdoption-cmake-build-resolve-package-references" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.23.
</div>
Resolve remote package references from external package managers (e.g. NuGet)
before build. When <code class="docutils literal notranslate">&lt;value&gt;</code> is set to <code class="docutils literal notranslate">on</code> (default), packages will be
restored before building a target. When <code class="docutils literal notranslate">&lt;value&gt;</code> is set to <code class="docutils literal notranslate">only</code>, the
packages will be restored, but no build will be performed. When
<code class="docutils literal notranslate">&lt;value&gt;</code> is set to <code class="docutils literal notranslate">off</code>, no packages will be restored.
If the target does not define any package references, this option does nothing.
This setting can be specified in a build preset (using
<code class="docutils literal notranslate">resolvePackageReferences</code>). The preset setting will be ignored, if this
command line option is specified.
If no command line parameter or preset option are provided, an environment-
specific cache variable will be evaluated to decide, if package restoration
should be performed.
When using the Visual Studio generator, package references are defined
using the <a class="reference internal" href="../prop_tgt/VS_PACKAGE_REFERENCES.html#prop_tgt:VS_PACKAGE_REFERENCES" title="VS_PACKAGE_REFERENCES"><code class="xref cmake cmake-prop_tgt docutils literal notranslate">VS_PACKAGE_REFERENCES</code></a> property. Package references
are restored using NuGet. It can be disabled by setting the
<code class="docutils literal notranslate">CMAKE_VS_NUGET_PACKAGE_RESTORE</code> variable to <code class="docutils literal notranslate">OFF</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-build-use-stderr">
--use-stderr<a class="headerlink" href="#cmdoption-cmake-build-use-stderr" title="Permalink to this definition">¶</a></dt>
<dd>Ignored. Behavior is default in CMake &gt;= 3.0.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-build-v">
-v, --verbose<a class="headerlink" href="#cmdoption-cmake-build-v" title="Permalink to this definition">¶</a></dt>
<dd>Enable verbose output - if supported - including the build commands to be
executed.
This option can be omitted if <a class="reference internal" href="../envvar/VERBOSE.html#envvar:VERBOSE" title="VERBOSE"><code class="xref cmake cmake-envvar docutils literal notranslate">VERBOSE</code></a> environment variable or
<a class="reference internal" href="../variable/CMAKE_VERBOSE_MAKEFILE.html#variable:CMAKE_VERBOSE_MAKEFILE" title="CMAKE_VERBOSE_MAKEFILE"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_VERBOSE_MAKEFILE</code></a> cached variable is set.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake--build-0">
--<a class="headerlink" href="#cmdoption-cmake--build-0" title="Permalink to this definition">¶</a></dt>
<dd>Pass remaining options to the native tool.
</dd></dl>

Run <a class="reference internal" href="#cmdoption-cmake-build"><code class="xref std std-option docutils literal notranslate">cmake --build</code></a> with no options for quick help.
</section>
<section id="install-a-project">
<h2>Install a Project<a class="headerlink" href="#install-a-project" title="Permalink to this heading">¶</a></h2>
CMake provides a command-line signature to install an already-generated
project binary tree:
<div class="highlight-shell notranslate"><div class="highlight"><pre>cmake --install &lt;dir&gt; [&lt;options&gt;]
</pre></div>
</div>
This may be used after building a project to run installation without
using the generated build system or the native build tool.
The options are:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-install">
--install &lt;dir&gt;<a class="headerlink" href="#cmdoption-cmake-install" title="Permalink to this definition">¶</a></dt>
<dd>Project binary directory to install. This is required and must be first.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-install-config">
--config &lt;cfg&gt;<a class="headerlink" href="#cmdoption-cmake-install-config" title="Permalink to this definition">¶</a></dt>
<dd>For multi-configuration generators, choose configuration <code class="docutils literal notranslate">&lt;cfg&gt;</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-install-component">
--component &lt;comp&gt;<a class="headerlink" href="#cmdoption-cmake-install-component" title="Permalink to this definition">¶</a></dt>
<dd>Component-based install. Only install component <code class="docutils literal notranslate">&lt;comp&gt;</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-install-default-directory-permissions">
--default-directory-permissions &lt;permissions&gt;<a class="headerlink" href="#cmdoption-cmake-install-default-directory-permissions" title="Permalink to this definition">¶</a></dt>
<dd>Default directory install permissions. Permissions in format <code class="docutils literal notranslate">&lt;u=rwx,g=rx,o=rx&gt;</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake--install-0">
--prefix &lt;prefix&gt;<a class="headerlink" href="#cmdoption-cmake--install-0" title="Permalink to this definition">¶</a></dt>
<dd>Override the installation prefix, <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>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-install-strip">
--strip<a class="headerlink" href="#cmdoption-cmake-install-strip" title="Permalink to this definition">¶</a></dt>
<dd>Strip before installing.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-install-v">
-v, --verbose<a class="headerlink" href="#cmdoption-cmake-install-v" title="Permalink to this definition">¶</a></dt>
<dd>Enable verbose output.
This option can be omitted if <a class="reference internal" href="../envvar/VERBOSE.html#envvar:VERBOSE" title="VERBOSE"><code class="xref cmake cmake-envvar docutils literal notranslate">VERBOSE</code></a> environment variable is set.
</dd></dl>

Run <a class="reference internal" href="#cmdoption-cmake-install"><code class="xref std std-option docutils literal notranslate">cmake --install</code></a> with no options for quick help.
</section>
<section id="open-a-project">
<h2>Open a Project<a class="headerlink" href="#open-a-project" title="Permalink to this heading">¶</a></h2>
<div class="highlight-shell notranslate"><div class="highlight"><pre>cmake --open &lt;dir&gt;
</pre></div>
</div>
Open the generated project in the associated application. This is only
supported by some generators.
</section>
<section id="run-a-script">
<h2>Run a Script<a class="headerlink" href="#run-a-script" title="Permalink to this heading">¶</a></h2>
<div class="highlight-shell notranslate"><div class="highlight"><pre>cmake [-D &lt;var&gt;=&lt;value&gt;]... -P &lt;cmake-script-file&gt; [-- &lt;unparsed-options&gt;...]
</pre></div>
</div>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-P-D">
-D &lt;var&gt;=&lt;value&gt;<a class="headerlink" href="#cmdoption-cmake-P-D" title="Permalink to this definition">¶</a></dt>
<dd>Define a variable for script mode.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-P">
-P &lt;cmake-script-file&gt;<a class="headerlink" href="#cmdoption-cmake-P" title="Permalink to this definition">¶</a></dt>
<dd>Process the given cmake file as a script written in the CMake
language. No configure or generate step is performed and the cache
is not modified. If variables are defined using <code class="docutils literal notranslate">-D</code>, this must be
done before the <code class="docutils literal notranslate">-P</code> argument.
</dd></dl>

Any options after <code class="docutils literal notranslate">--</code> are not parsed by CMake, but they are still included
in the set of <a class="reference internal" href="../variable/CMAKE_ARGV0.html#variable:CMAKE_ARGV0" title="CMAKE_ARGV0"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_ARGV&lt;n&gt;</code></a> variables passed to the
script (including the <code class="docutils literal notranslate">--</code> itself).
</section>
<section id="run-a-command-line-tool">
<h2>Run a Command-Line Tool<a class="headerlink" href="#run-a-command-line-tool" title="Permalink to this heading">¶</a></h2>
CMake provides builtin command-line tools through the signature
<div class="highlight-shell notranslate"><div class="highlight"><pre>cmake -E &lt;command&gt; [&lt;options&gt;]
</pre></div>
</div>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E">
-E [help]<a class="headerlink" href="#cmdoption-cmake-E" title="Permalink to this definition">¶</a></dt>
<dd>Run <code class="docutils literal notranslate">cmake -E</code> or <code class="docutils literal notranslate">cmake -E help</code> for a summary of commands.
</dd></dl>

Available commands are:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-capabilities">
capabilities<a class="headerlink" href="#cmdoption-cmake-E-arg-capabilities" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.7.
</div>
Report cmake capabilities in JSON format. The output is a JSON object
with the following keys:
<dl>
<dt><code class="docutils literal notranslate">version</code></dt><dd>A JSON object with version information. Keys are:
<dl class="simple">
<dt><code class="docutils literal notranslate">string</code></dt><dd>The full version string as displayed by cmake <a class="reference internal" href="#cmdoption-cmake-version"><code class="xref std std-option docutils literal notranslate">--version</code></a>.
</dd>
<dt><code class="docutils literal notranslate">major</code></dt><dd>The major version number in integer form.
</dd>
<dt><code class="docutils literal notranslate">minor</code></dt><dd>The minor version number in integer form.
</dd>
<dt><code class="docutils literal notranslate">patch</code></dt><dd>The patch level in integer form.
</dd>
<dt><code class="docutils literal notranslate">suffix</code></dt><dd>The cmake version suffix string.
</dd>
<dt><code class="docutils literal notranslate">isDirty</code></dt><dd>A bool that is set if the cmake build is from a dirty tree.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">generators</code></dt><dd>A list available generators. Each generator is a JSON object with the
following keys:
<dl>
<dt><code class="docutils literal notranslate">name</code></dt><dd>A string containing the name of the generator.
</dd>
<dt><code class="docutils literal notranslate">toolsetSupport</code></dt><dd><code class="docutils literal notranslate">true</code> if the generator supports toolsets and <code class="docutils literal notranslate">false</code> otherwise.
</dd>
<dt><code class="docutils literal notranslate">platformSupport</code></dt><dd><code class="docutils literal notranslate">true</code> if the generator supports platforms and <code class="docutils literal notranslate">false</code> otherwise.
</dd>
<dt><code class="docutils literal notranslate">supportedPlatforms</code></dt><dd><div class="versionadded">
New in version 3.21.
</div>
Optional member that may be present when the generator supports
platform specification via <a class="reference internal" href="../variable/CMAKE_GENERATOR_PLATFORM.html#variable:CMAKE_GENERATOR_PLATFORM" title="CMAKE_GENERATOR_PLATFORM"><code class="xref cmake cmake-variable docutils literal notranslate">CMAKE_GENERATOR_PLATFORM</code></a>
(<a class="reference internal" href="#cmdoption-cmake-A"><code class="xref std std-option docutils literal notranslate">-A ...</code></a>). The value is a list of platforms known to
be supported.
</dd>
<dt><code class="docutils literal notranslate">extraGenerators</code></dt><dd>A list of strings with all the extra generators compatible with
the generator.
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">fileApi</code></dt><dd>Optional member that is present when the <a class="reference internal" href="cmake-file-api.7.html#manual:cmake-file-api(7)" title="cmake-file-api(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-file-api(7)</code></a>
is available. The value is a JSON object with one member:
<dl>
<dt><code class="docutils literal notranslate">requests</code></dt><dd>A JSON array containing zero or more supported file-api requests.
Each request is a JSON object with members:
<dl class="simple">
<dt><code class="docutils literal notranslate">kind</code></dt><dd>Specifies one of the supported <a class="reference internal" href="cmake-file-api.7.html#file-api-object-kinds">Object Kinds</a>.
</dd>
<dt><code class="docutils literal notranslate">version</code></dt><dd>A JSON array whose elements are each a JSON object containing
<code class="docutils literal notranslate">major</code> and <code class="docutils literal notranslate">minor</code> members specifying non-negative integer
version components.
</dd>
</dl>
</dd>
</dl>
</dd>
<dt><code class="docutils literal notranslate">serverMode</code></dt><dd><code class="docutils literal notranslate">true</code> if cmake supports server-mode and <code class="docutils literal notranslate">false</code> otherwise.
Always false since CMake 3.20.
</dd>
<dt><code class="docutils literal notranslate">tls</code></dt><dd><div class="versionadded">
New in version 3.25.
</div>
<code class="docutils literal notranslate">true</code> if TLS support is enabled and <code class="docutils literal notranslate">false</code> otherwise.
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-cat">
cat [--] &lt;files&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-cat" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.18.
</div>
Concatenate files and print on the standard output.
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_cat-0">
--<a class="headerlink" href="#cmdoption-cmake-E_cat-0" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.24.
</div>
Added support for the double dash argument <code class="docutils literal notranslate">--</code>. This basic implementation
of <code class="docutils literal notranslate">cat</code> does not support any options, so using a option starting with
<code class="docutils literal notranslate">-</code> will result in an error. Use <code class="docutils literal notranslate">--</code> to indicate the end of options, in
case a file starts with <code class="docutils literal notranslate">-</code>.
</dd></dl>

</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-chdir">
chdir &lt;dir&gt; &lt;cmd&gt; [&lt;arg&gt;...]<a class="headerlink" href="#cmdoption-cmake-E-arg-chdir" title="Permalink to this definition">¶</a></dt>
<dd>Change the current working directory and run a command.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-compare_files">
compare_files [--ignore-eol] &lt;file1&gt; &lt;file2&gt;<a class="headerlink" href="#cmdoption-cmake-E-arg-compare_files" title="Permalink to this definition">¶</a></dt>
<dd>Check if <code class="docutils literal notranslate">&lt;file1&gt;</code> is same as <code class="docutils literal notranslate">&lt;file2&gt;</code>. If files are the same,
then returns <code class="docutils literal notranslate">0</code>, if not it returns <code class="docutils literal notranslate">1</code>. In case of invalid
arguments, it returns 2.
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_compare_files-ignore-eol">
--ignore-eol<a class="headerlink" href="#cmdoption-cmake-E_compare_files-ignore-eol" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.14.
</div>
The option implies line-wise comparison and ignores LF/CRLF differences.
</dd></dl>

</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-copy">
copy &lt;file&gt;... &lt;destination&gt;, copy -t &lt;destination&gt; &lt;file&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-copy" title="Permalink to this definition">¶</a></dt>
<dd>Copy files to <code class="docutils literal notranslate">&lt;destination&gt;</code> (either file or directory).
If multiple files are specified, or if <code class="docutils literal notranslate">-t</code> is specified, the
<code class="docutils literal notranslate">&lt;destination&gt;</code> must be directory and it must exist. If <code class="docutils literal notranslate">-t</code> is not
specified, the last argument is assumed to be the <code class="docutils literal notranslate">&lt;destination&gt;</code>.
Wildcards are not supported. <code class="docutils literal notranslate">copy</code> does follow symlinks. That means it
does not copy symlinks, but the files or directories it point to.
<div class="versionadded">
New in version 3.5: Support for multiple input files.
</div>
<div class="versionadded">
New in version 3.26: Support for <code class="docutils literal notranslate">-t</code> argument.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-copy_directory">
copy_directory &lt;dir&gt;... &lt;destination&gt;<a class="headerlink" href="#cmdoption-cmake-E-arg-copy_directory" title="Permalink to this definition">¶</a></dt>
<dd>Copy content of <code class="docutils literal notranslate">&lt;dir&gt;...</code> directories to <code class="docutils literal notranslate">&lt;destination&gt;</code> directory.
If <code class="docutils literal notranslate">&lt;destination&gt;</code> directory does not exist it will be created.
<code class="docutils literal notranslate">copy_directory</code> does follow symlinks.
<div class="versionadded">
New in version 3.5: Support for multiple input directories.
</div>
<div class="versionadded">
New in version 3.15: The command now fails when the source directory does not exist.
Previously it succeeded by creating an empty destination directory.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-copy_directory_if_different">
copy_directory_if_different &lt;dir&gt;... &lt;destination&gt;<a class="headerlink" href="#cmdoption-cmake-E-arg-copy_directory_if_different" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.26.
</div>
Copy changed content of <code class="docutils literal notranslate">&lt;dir&gt;...</code> directories to <code class="docutils literal notranslate">&lt;destination&gt;</code> directory.
If <code class="docutils literal notranslate">&lt;destination&gt;</code> directory does not exist it will be created.
<code class="docutils literal notranslate">copy_directory_if_different</code> does follow symlinks.
The command fails when the source directory does not exist.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-copy_if_different">
copy_if_different &lt;file&gt;... &lt;destination&gt;<a class="headerlink" href="#cmdoption-cmake-E-arg-copy_if_different" title="Permalink to this definition">¶</a></dt>
<dd>Copy files to <code class="docutils literal notranslate">&lt;destination&gt;</code> (either file or directory) if
they have changed.
If multiple files are specified, the <code class="docutils literal notranslate">&lt;destination&gt;</code> must be
directory and it must exist.
<code class="docutils literal notranslate">copy_if_different</code> does follow symlinks.
<div class="versionadded">
New in version 3.5: Support for multiple input files.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-create_symlink">
create_symlink &lt;old&gt; &lt;new&gt;<a class="headerlink" href="#cmdoption-cmake-E-arg-create_symlink" title="Permalink to this definition">¶</a></dt>
<dd>Create a symbolic link <code class="docutils literal notranslate">&lt;new&gt;</code> naming <code class="docutils literal notranslate">&lt;old&gt;</code>.
<div class="versionadded">
New in version 3.13: Support for creating symlinks on Windows.
</div>
<div class="admonition note">
Note
Path to where <code class="docutils literal notranslate">&lt;new&gt;</code> symbolic link will be created has to exist beforehand.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-create_hardlink">
create_hardlink &lt;old&gt; &lt;new&gt;<a class="headerlink" href="#cmdoption-cmake-E-arg-create_hardlink" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.19.
</div>
Create a hard link <code class="docutils literal notranslate">&lt;new&gt;</code> naming <code class="docutils literal notranslate">&lt;old&gt;</code>.
<div class="admonition note">
Note
Path to where <code class="docutils literal notranslate">&lt;new&gt;</code> hard link will be created has to exist beforehand.
<code class="docutils literal notranslate">&lt;old&gt;</code> has to exist beforehand.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-echo">
echo [&lt;string&gt;...]<a class="headerlink" href="#cmdoption-cmake-E-arg-echo" title="Permalink to this definition">¶</a></dt>
<dd>Displays arguments as text.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-echo_append">
echo_append [&lt;string&gt;...]<a class="headerlink" href="#cmdoption-cmake-E-arg-echo_append" title="Permalink to this definition">¶</a></dt>
<dd>Displays arguments as text but no new line.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-env">
env [&lt;options&gt;] [--] &lt;command&gt; [&lt;arg&gt;...]<a class="headerlink" href="#cmdoption-cmake-E-arg-env" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.1.
</div>
Run command in a modified environment. Options are:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_env-arg-NAME">
NAME=VALUE<a class="headerlink" href="#cmdoption-cmake-E_env-arg-NAME" title="Permalink to this definition">¶</a></dt>
<dd>Replaces the current value of <code class="docutils literal notranslate">NAME</code> with <code class="docutils literal notranslate">VALUE</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_env-unset">
--unset=NAME<a class="headerlink" href="#cmdoption-cmake-E_env-unset" title="Permalink to this definition">¶</a></dt>
<dd>Unsets the current value of <code class="docutils literal notranslate">NAME</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_env-modify">
--modify ENVIRONMENT_MODIFICATION<a class="headerlink" href="#cmdoption-cmake-E_env-modify" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.25.
</div>
Apply a single <a class="reference internal" href="../prop_test/ENVIRONMENT_MODIFICATION.html#prop_test:ENVIRONMENT_MODIFICATION" title="ENVIRONMENT_MODIFICATION"><code class="xref cmake cmake-prop_test docutils literal notranslate">ENVIRONMENT_MODIFICATION</code></a> operation to the
modified environment.
The <code class="docutils literal notranslate">NAME=VALUE</code> and <code class="docutils literal notranslate">--unset=NAME</code> options are equivalent to
<code class="docutils literal notranslate">--modify NAME=set:VALUE</code> and <code class="docutils literal notranslate">--modify NAME=unset:</code>, respectively.
Note that <code class="docutils literal notranslate">--modify NAME=reset:</code> resets <code class="docutils literal notranslate">NAME</code> to the value it had
when cmake launched (or unsets it), not to the most recent
<code class="docutils literal notranslate">NAME=VALUE</code> option.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_env-0">
--<a class="headerlink" href="#cmdoption-cmake-E_env-0" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.24.
</div>
Added support for the double dash argument <code class="docutils literal notranslate">--</code>. Use <code class="docutils literal notranslate">--</code> to stop
interpreting options/environment variables and treat the next argument as
the command, even if it start with <code class="docutils literal notranslate">-</code> or contains a <code class="docutils literal notranslate">=</code>.
</dd></dl>

</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-environment">
environment<a class="headerlink" href="#cmdoption-cmake-E-arg-environment" title="Permalink to this definition">¶</a></dt>
<dd>Display the current environment variables.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-false">
false<a class="headerlink" href="#cmdoption-cmake-E-arg-false" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.16.
</div>
Do nothing, with an exit code of 1.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-make_directory">
make_directory &lt;dir&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-make_directory" title="Permalink to this definition">¶</a></dt>
<dd>Create <code class="docutils literal notranslate">&lt;dir&gt;</code> directories. If necessary, create parent
directories too. If a directory already exists it will be
silently ignored.
<div class="versionadded">
New in version 3.5: Support for multiple input directories.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-md5sum">
md5sum &lt;file&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-md5sum" title="Permalink to this definition">¶</a></dt>
<dd>Create MD5 checksum of files in <code class="docutils literal notranslate">md5sum</code> compatible format:
<div class="highlight-none notranslate"><div class="highlight"><pre>351abe79cd3800b38cdfb25d45015a15 file1.txt
052f86c15bbde68af55c7f7b340ab639 file2.txt
</pre></div>
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-sha1sum">
sha1sum &lt;file&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-sha1sum" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.10.
</div>
Create SHA1 checksum of files in <code class="docutils literal notranslate">sha1sum</code> compatible format:
<div class="highlight-none notranslate"><div class="highlight"><pre>4bb7932a29e6f73c97bb9272f2bdc393122f86e0 file1.txt
1df4c8f318665f9a5f2ed38f55adadb7ef9f559c file2.txt
</pre></div>
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-sha224sum">
sha224sum &lt;file&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-sha224sum" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.10.
</div>
Create SHA224 checksum of files in <code class="docutils literal notranslate">sha224sum</code> compatible format:
<div class="highlight-none notranslate"><div class="highlight"><pre>b9b9346bc8437bbda630b0b7ddfc5ea9ca157546dbbf4c613192f930 file1.txt
6dfbe55f4d2edc5fe5c9197bca51ceaaf824e48eba0cc453088aee24 file2.txt
</pre></div>
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-sha256sum">
sha256sum &lt;file&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-sha256sum" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.10.
</div>
Create SHA256 checksum of files in <code class="docutils literal notranslate">sha256sum</code> compatible format:
<div class="highlight-none notranslate"><div class="highlight"><pre>76713b23615d31680afeb0e9efe94d47d3d4229191198bb46d7485f9cb191acc file1.txt
15b682ead6c12dedb1baf91231e1e89cfc7974b3787c1e2e01b986bffadae0ea file2.txt
</pre></div>
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-sha384sum">
sha384sum &lt;file&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-sha384sum" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.10.
</div>
Create SHA384 checksum of files in <code class="docutils literal notranslate">sha384sum</code> compatible format:
<div class="highlight-none notranslate"><div class="highlight"><pre>acc049fedc091a22f5f2ce39a43b9057fd93c910e9afd76a6411a28a8f2b8a12c73d7129e292f94fc0329c309df49434 file1.txt
668ddeb108710d271ee21c0f3acbd6a7517e2b78f9181c6a2ff3b8943af92b0195dcb7cce48aa3e17893173c0a39e23d file2.txt
</pre></div>
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-sha512sum">
sha512sum &lt;file&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-sha512sum" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.10.
</div>
Create SHA512 checksum of files in <code class="docutils literal notranslate">sha512sum</code> compatible format:
<div class="highlight-none notranslate"><div class="highlight"><pre>2a78d7a6c5328cfb1467c63beac8ff21794213901eaadafd48e7800289afbc08e5fb3e86aa31116c945ee3d7bf2a6194489ec6101051083d1108defc8e1dba89 file1.txt
7a0b54896fe5e70cca6dd643ad6f672614b189bf26f8153061c4d219474b05dad08c4e729af9f4b009f1a1a280cb625454bf587c690f4617c27e3aebdf3b7a2d file2.txt
</pre></div>
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-remove">
remove [-f] &lt;file&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-remove" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 3.17.
</div>
Remove the file(s). The planned behavior was that if any of the
listed files already do not exist, the command returns a non-zero exit code,
but no message is logged. The <code class="docutils literal notranslate">-f</code> option changes the behavior to return a
zero exit code (i.e. success) in such situations instead.
<code class="docutils literal notranslate">remove</code> does not follow symlinks. That means it remove only symlinks
and not files it point to.
The implementation was buggy and always returned 0. It cannot be fixed without
breaking backwards compatibility. Use <code class="docutils literal notranslate">rm</code> instead.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-remove_directory">
remove_directory &lt;dir&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-remove_directory" title="Permalink to this definition">¶</a></dt>
<dd><div class="deprecated">
Deprecated since version 3.17.
</div>
Remove <code class="docutils literal notranslate">&lt;dir&gt;</code> directories and their contents. If a directory does
not exist it will be silently ignored.
Use <code class="docutils literal notranslate">rm</code> instead.
<div class="versionadded">
New in version 3.15: Support for multiple directories.
</div>
<div class="versionadded">
New in version 3.16: If <code class="docutils literal notranslate">&lt;dir&gt;</code> is a symlink to a directory, just the symlink will be removed.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-rename">
rename &lt;oldname&gt; &lt;newname&gt;<a class="headerlink" href="#cmdoption-cmake-E-arg-rename" title="Permalink to this definition">¶</a></dt>
<dd>Rename a file or directory (on one volume). If file with the <code class="docutils literal notranslate">&lt;newname&gt;</code> name
already exists, then it will be silently replaced.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-rm">
rm [-rRf] [--] &lt;file|dir&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-rm" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.17.
</div>
Remove the files <code class="docutils literal notranslate">&lt;file&gt;</code> or directories <code class="docutils literal notranslate">&lt;dir&gt;</code>.
Use <code class="docutils literal notranslate">-r</code> or <code class="docutils literal notranslate">-R</code> to remove directories and their contents recursively.
If any of the listed files/directories do not exist, the command returns a
non-zero exit code, but no message is logged. The <code class="docutils literal notranslate">-f</code> option changes
the behavior to return a zero exit code (i.e. success) in such
situations instead. Use <code class="docutils literal notranslate">--</code> to stop interpreting options and treat all
remaining arguments as paths, even if they start with <code class="docutils literal notranslate">-</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-sleep">
sleep &lt;number&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-sleep" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.0.
</div>
Sleep for given number of seconds.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-tar">
tar [cxt][vf][zjJ] file.tar [&lt;options&gt;] [--] [&lt;pathname&gt;...]<a class="headerlink" href="#cmdoption-cmake-E-arg-tar" title="Permalink to this definition">¶</a></dt>
<dd>Create or extract a tar or zip archive. Options are:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-arg-c">
c<a class="headerlink" href="#cmdoption-cmake-E_tar-arg-c" title="Permalink to this definition">¶</a></dt>
<dd>Create a new archive containing the specified files.
If used, the <code class="docutils literal notranslate">&lt;pathname&gt;...</code> argument is mandatory.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-arg-x">
x<a class="headerlink" href="#cmdoption-cmake-E_tar-arg-x" title="Permalink to this definition">¶</a></dt>
<dd>Extract to disk from the archive.
<div class="versionadded">
New in version 3.15: The <code class="docutils literal notranslate">&lt;pathname&gt;...</code> argument could be used to extract only selected files
or directories.
When extracting selected files or directories, you must provide their exact
names including the path, as printed by list (<code class="docutils literal notranslate">-t</code>).
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-arg-t">
t<a class="headerlink" href="#cmdoption-cmake-E_tar-arg-t" title="Permalink to this definition">¶</a></dt>
<dd>List archive contents.
<div class="versionadded">
New in version 3.15: The <code class="docutils literal notranslate">&lt;pathname&gt;...</code> argument could be used to list only selected files
or directories.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-arg-v">
v<a class="headerlink" href="#cmdoption-cmake-E_tar-arg-v" title="Permalink to this definition">¶</a></dt>
<dd>Produce verbose output.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-arg-z">
z<a class="headerlink" href="#cmdoption-cmake-E_tar-arg-z" title="Permalink to this definition">¶</a></dt>
<dd>Compress the resulting archive with gzip.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-arg-j">
j<a class="headerlink" href="#cmdoption-cmake-E_tar-arg-j" title="Permalink to this definition">¶</a></dt>
<dd>Compress the resulting archive with bzip2.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-arg-J">
J<a class="headerlink" href="#cmdoption-cmake-E_tar-arg-J" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.1.
</div>
Compress the resulting archive with XZ.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-zstd">
--zstd<a class="headerlink" href="#cmdoption-cmake-E_tar-zstd" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.15.
</div>
Compress the resulting archive with Zstandard.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-files-from">
--files-from=&lt;file&gt;<a class="headerlink" href="#cmdoption-cmake-E_tar-files-from" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.1.
</div>
Read file names from the given file, one per line.
Blank lines are ignored. Lines may not start in <code class="docutils literal notranslate">-</code>
except for <code class="docutils literal notranslate">--add-file=&lt;name&gt;</code> to add files whose
names start in <code class="docutils literal notranslate">-</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-format">
--format=&lt;format&gt;<a class="headerlink" href="#cmdoption-cmake-E_tar-format" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.3.
</div>
Specify the format of the archive to be created.
Supported formats are: <code class="docutils literal notranslate">7zip</code>, <code class="docutils literal notranslate">gnutar</code>, <code class="docutils literal notranslate">pax</code>,
<code class="docutils literal notranslate">paxr</code> (restricted pax, default), and <code class="docutils literal notranslate">zip</code>.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-mtime">
--mtime=&lt;date&gt;<a class="headerlink" href="#cmdoption-cmake-E_tar-mtime" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.1.
</div>
Specify modification time recorded in tarball entries.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-touch">
--touch<a class="headerlink" href="#cmdoption-cmake-E_tar-touch" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.24.
</div>
Use current local timestamp instead of extracting file timestamps
from the archive.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E_tar-0">
--<a class="headerlink" href="#cmdoption-cmake-E_tar-0" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.1.
</div>
Stop interpreting options and treat all remaining arguments
as file names, even if they start with <code class="docutils literal notranslate">-</code>.
</dd></dl>

<div class="versionadded">
New in version 3.1: LZMA (7zip) support.
</div>
<div class="versionadded">
New in version 3.15: The command now continues adding files to an archive even if some of the
files are not readable. This behavior is more consistent with the classic
<code class="docutils literal notranslate">tar</code> tool. The command now also parses all flags, and if an invalid flag
was provided, a warning is issued.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-time">
time &lt;command&gt; [&lt;args&gt;...]<a class="headerlink" href="#cmdoption-cmake-E-arg-time" title="Permalink to this definition">¶</a></dt>
<dd>Run command and display elapsed time.
<div class="versionadded">
New in version 3.5: The command now properly passes arguments with spaces or special characters
through to the child process. This may break scripts that worked around the
bug with their own extra quoting or escaping.
</div>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-touch">
touch &lt;file&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-touch" title="Permalink to this definition">¶</a></dt>
<dd>Creates <code class="docutils literal notranslate">&lt;file&gt;</code> if file do not exist.
If <code class="docutils literal notranslate">&lt;file&gt;</code> exists, it is changing <code class="docutils literal notranslate">&lt;file&gt;</code> access and modification times.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-touch_nocreate">
touch_nocreate &lt;file&gt;...<a class="headerlink" href="#cmdoption-cmake-E-arg-touch_nocreate" title="Permalink to this definition">¶</a></dt>
<dd>Touch a file if it exists but do not create it. If a file does
not exist it will be silently ignored.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-true">
true<a class="headerlink" href="#cmdoption-cmake-E-arg-true" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.16.
</div>
Do nothing, with an exit code of 0.
</dd></dl>

<section id="windows-specific-command-line-tools">
<h3>Windows-specific Command-Line Tools<a class="headerlink" href="#windows-specific-command-line-tools" title="Permalink to this heading">¶</a></h3>
The following <code class="docutils literal notranslate">cmake -E</code> commands are available only on Windows:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-delete_regv">
delete_regv &lt;key&gt;<a class="headerlink" href="#cmdoption-cmake-E-arg-delete_regv" title="Permalink to this definition">¶</a></dt>
<dd>Delete Windows registry value.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-env_vs8_wince">
env_vs8_wince &lt;sdkname&gt;<a class="headerlink" href="#cmdoption-cmake-E-arg-env_vs8_wince" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.2.
</div>
Displays a batch file which sets the environment for the provided
Windows CE SDK installed in VS2005.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-env_vs9_wince">
env_vs9_wince &lt;sdkname&gt;<a class="headerlink" href="#cmdoption-cmake-E-arg-env_vs9_wince" title="Permalink to this definition">¶</a></dt>
<dd><div class="versionadded">
New in version 3.2.
</div>
Displays a batch file which sets the environment for the provided
Windows CE SDK installed in VS2008.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-E-arg-write_regv">
write_regv &lt;key&gt; &lt;value&gt;<a class="headerlink" href="#cmdoption-cmake-E-arg-write_regv" title="Permalink to this definition">¶</a></dt>
<dd>Write Windows registry value.
</dd></dl>

</section>
</section>
<section id="run-the-find-package-tool">
<h2>Run the Find-Package Tool<a class="headerlink" href="#run-the-find-package-tool" title="Permalink to this heading">¶</a></h2>
CMake provides a pkg-config like helper for Makefile-based projects:
<div class="highlight-shell notranslate"><div class="highlight"><pre>cmake --find-package [&lt;options&gt;]
</pre></div>
</div>
It searches a package using <a class="reference internal" href="../command/find_package.html#command:find_package" title="find_package"><code class="xref cmake cmake-command docutils literal notranslate">find_package()</code></a> and prints the
resulting flags to stdout. This can be used instead of pkg-config
to find installed libraries in plain Makefile-based projects or in
autoconf-based projects (via <code class="docutils literal notranslate">share/aclocal/cmake.m4</code>).
<div class="admonition note">
Note
This mode is not well-supported due to some technical limitations.
It is kept for compatibility but should not be used in new projects.
</div>
</section>
<section id="run-a-workflow-preset">
<h2>Run a Workflow Preset<a class="headerlink" href="#run-a-workflow-preset" title="Permalink to this heading">¶</a></h2>
<a class="reference internal" href="cmake-presets.7.html#manual:cmake-presets(7)" title="cmake-presets(7)"><code class="xref cmake cmake-manual docutils literal notranslate">CMake Presets</code></a> provides a way to execute multiple
build steps in order:
<div class="highlight-shell notranslate"><div class="highlight"><pre>cmake --workflow [&lt;options&gt;]
</pre></div>
</div>
The options are:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-workflow">
--workflow<a class="headerlink" href="#cmdoption-cmake-workflow" title="Permalink to this definition">¶</a></dt>
<dd>Select a <a class="reference internal" href="cmake-presets.7.html#workflow-preset">Workflow Preset</a> using one of the following options.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-workflow-preset">
--preset &lt;preset&gt;, --preset=&lt;preset&gt;<a class="headerlink" href="#cmdoption-cmake-workflow-preset" title="Permalink to this definition">¶</a></dt>
<dd>Use a workflow preset to specify a workflow. The project binary directory
is inferred from the initial configure preset. The current working directory
must contain CMake preset files.
See <a class="reference internal" href="cmake-presets.7.html#manual:cmake-presets(7)" title="cmake-presets(7)"><code class="xref cmake cmake-manual docutils literal notranslate">preset</code></a> for more details.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-workflow-list-presets">
--list-presets<a class="headerlink" href="#cmdoption-cmake-workflow-list-presets" title="Permalink to this definition">¶</a></dt>
<dd>Lists the available workflow presets. The current working directory must
contain CMake preset files.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-workflow-fresh">
--fresh<a class="headerlink" href="#cmdoption-cmake-workflow-fresh" title="Permalink to this definition">¶</a></dt>
<dd>Perform a fresh configuration of the build tree.
This removes any existing <code class="docutils literal notranslate">CMakeCache.txt</code> file and associated
<code class="docutils literal notranslate">CMakeFiles/</code> directory, and recreates them from scratch.
</dd></dl>

</section>
<section id="view-help">
<h2>View Help<a class="headerlink" href="#view-help" title="Permalink to this heading">¶</a></h2>
To print selected pages from the CMake documentation, use
<div class="highlight-shell notranslate"><div class="highlight"><pre>cmake --help[-&lt;topic&gt;]
</pre></div>
</div>
with one of the following options:
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-version">
-version [&lt;file&gt;], --version [&lt;file&gt;], /V [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-version" title="Permalink to this definition">¶</a></dt>
<dd>Show program name/version banner and exit.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-h">
-h, -H, --help, -help, -usage, /?<a class="headerlink" href="#cmdoption-cmake-h" title="Permalink to this definition">¶</a></dt>
<dd>Print usage information and exit.
Usage describes the basic command line interface and its options.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-full">
--help-full [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-full" title="Permalink to this definition">¶</a></dt>
<dd>Print all help manuals and exit.
All manuals are printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-manual">
--help-manual &lt;man&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-manual" title="Permalink to this definition">¶</a></dt>
<dd>Print one help manual and exit.
The specified manual is printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-manual-list">
--help-manual-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-manual-list" title="Permalink to this definition">¶</a></dt>
<dd>List help manuals available and exit.
The list contains all manuals for which help may be obtained by
using the <code class="docutils literal notranslate">--help-manual</code> option followed by a manual name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-command">
--help-command &lt;cmd&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-command" title="Permalink to this definition">¶</a></dt>
<dd>Print help for one command and exit.
The <a class="reference internal" href="cmake-commands.7.html#manual:cmake-commands(7)" title="cmake-commands(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-commands(7)</code></a> manual entry for <code class="docutils literal notranslate">&lt;cmd&gt;</code> is
printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-command-list">
--help-command-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-command-list" title="Permalink to this definition">¶</a></dt>
<dd>List commands with help available and exit.
The list contains all commands for which help may be obtained by
using the <code class="docutils literal notranslate">--help-command</code> option followed by a command name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-commands">
--help-commands [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-commands" title="Permalink to this definition">¶</a></dt>
<dd>Print cmake-commands manual and exit.
The <a class="reference internal" href="cmake-commands.7.html#manual:cmake-commands(7)" title="cmake-commands(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-commands(7)</code></a> manual is printed in a
human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-module">
--help-module &lt;mod&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-module" title="Permalink to this definition">¶</a></dt>
<dd>Print help for one module and exit.
The <a class="reference internal" href="cmake-modules.7.html#manual:cmake-modules(7)" title="cmake-modules(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-modules(7)</code></a> manual entry for <code class="docutils literal notranslate">&lt;mod&gt;</code> is printed
in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-module-list">
--help-module-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-module-list" title="Permalink to this definition">¶</a></dt>
<dd>List modules with help available and exit.
The list contains all modules for which help may be obtained by
using the <code class="docutils literal notranslate">--help-module</code> option followed by a module name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-modules">
--help-modules [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-modules" title="Permalink to this definition">¶</a></dt>
<dd>Print cmake-modules manual and exit.
The <a class="reference internal" href="cmake-modules.7.html#manual:cmake-modules(7)" title="cmake-modules(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-modules(7)</code></a> manual is printed in a human-readable
text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-policy">
--help-policy &lt;cmp&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-policy" title="Permalink to this definition">¶</a></dt>
<dd>Print help for one policy and exit.
The <a class="reference internal" href="cmake-policies.7.html#manual:cmake-policies(7)" title="cmake-policies(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-policies(7)</code></a> manual entry for <code class="docutils literal notranslate">&lt;cmp&gt;</code> is
printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-policy-list">
--help-policy-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-policy-list" title="Permalink to this definition">¶</a></dt>
<dd>List policies with help available and exit.
The list contains all policies for which help may be obtained by
using the <code class="docutils literal notranslate">--help-policy</code> option followed by a policy name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-policies">
--help-policies [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-policies" title="Permalink to this definition">¶</a></dt>
<dd>Print cmake-policies manual and exit.
The <a class="reference internal" href="cmake-policies.7.html#manual:cmake-policies(7)" title="cmake-policies(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-policies(7)</code></a> manual is printed in a
human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-property">
--help-property &lt;prop&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-property" title="Permalink to this definition">¶</a></dt>
<dd>Print help for one property and exit.
The <a class="reference internal" href="cmake-properties.7.html#manual:cmake-properties(7)" title="cmake-properties(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-properties(7)</code></a> manual entries for <code class="docutils literal notranslate">&lt;prop&gt;</code> are
printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-property-list">
--help-property-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-property-list" title="Permalink to this definition">¶</a></dt>
<dd>List properties with help available and exit.
The list contains all properties for which help may be obtained by
using the <code class="docutils literal notranslate">--help-property</code> option followed by a property name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-properties">
--help-properties [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-properties" title="Permalink to this definition">¶</a></dt>
<dd>Print cmake-properties manual and exit.
The <a class="reference internal" href="cmake-properties.7.html#manual:cmake-properties(7)" title="cmake-properties(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-properties(7)</code></a> manual is printed in a
human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-variable">
--help-variable &lt;var&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-variable" title="Permalink to this definition">¶</a></dt>
<dd>Print help for one variable and exit.
The <a class="reference internal" href="cmake-variables.7.html#manual:cmake-variables(7)" title="cmake-variables(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-variables(7)</code></a> manual entry for <code class="docutils literal notranslate">&lt;var&gt;</code> is
printed in a human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-variable-list">
--help-variable-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-variable-list" title="Permalink to this definition">¶</a></dt>
<dd>List variables with help available and exit.
The list contains all variables for which help may be obtained by
using the <code class="docutils literal notranslate">--help-variable</code> option followed by a variable name.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-help-variables">
--help-variables [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-help-variables" title="Permalink to this definition">¶</a></dt>
<dd>Print cmake-variables manual and exit.
The <a class="reference internal" href="cmake-variables.7.html#manual:cmake-variables(7)" title="cmake-variables(7)"><code class="xref cmake cmake-manual docutils literal notranslate">cmake-variables(7)</code></a> manual is printed in a
human-readable text format.
The output is printed to a named <code class="docutils literal notranslate">&lt;file&gt;</code> if given.
</dd></dl>

To view the presets available for a project, use
<div class="highlight-shell notranslate"><div class="highlight"><pre>cmake &lt;source-dir&gt; --list-presets
</pre></div>
</div>
</section>
<section id="return-value-exit-code">
<h2>Return Value (Exit Code)<a class="headerlink" href="#return-value-exit-code" title="Permalink to this heading">¶</a></h2>
Upon regular termination, the cmake executable returns the exit code <code class="docutils literal notranslate">0</code>.
If termination is caused by the command <a class="reference internal" href="../command/message.html#command:message" title="message"><code class="xref cmake cmake-command docutils literal notranslate">message(FATAL_ERROR)</code></a>,
or another error condition, then a non-zero exit code is returned.
</section>
<section id="see-also">
<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this heading">¶</a></h2>
The following resources are available to get help using CMake:
<dl>
<dt>Home Page</dt><dd><a class="reference external" href="https://cmake.org">https://cmake.org</a>
The primary starting point for learning about CMake.
</dd>
<dt>Online Documentation and Community Resources</dt><dd><a class="reference external" href="https://cmake.org/documentation">https://cmake.org/documentation</a>
Links to available documentation and community resources may be
found on this web page.
</dd>
<dt>Discourse Forum</dt><dd><a class="reference external" href="https://discourse.cmake.org">https://discourse.cmake.org</a>
The Discourse Forum hosts discussion and questions about CMake.
</dd>
</dl>
</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="#">cmake(1)</a><ul>
<li><a class="reference internal" href="#synopsis">Synopsis</a></li>
<li><a class="reference internal" href="#description">Description</a></li>
<li><a class="reference internal" href="#introduction-to-cmake-buildsystems">Introduction to CMake Buildsystems</a></li>
<li><a class="reference internal" href="#generate-a-project-buildsystem">Generate a Project Buildsystem</a><ul>
<li><a class="reference internal" href="#options">Options</a></li>
</ul>
</li>
<li><a class="reference internal" href="#build-a-project">Build a Project</a></li>
<li><a class="reference internal" href="#install-a-project">Install a Project</a></li>
<li><a class="reference internal" href="#open-a-project">Open a Project</a></li>
<li><a class="reference internal" href="#run-a-script">Run a Script</a></li>
<li><a class="reference internal" href="#run-a-command-line-tool">Run a Command-Line Tool</a><ul>
<li><a class="reference internal" href="#windows-specific-command-line-tools">Windows-specific Command-Line Tools</a></li>
</ul>
</li>
<li><a class="reference internal" href="#run-the-find-package-tool">Run the Find-Package Tool</a></li>
<li><a class="reference internal" href="#run-a-workflow-preset">Run a Workflow Preset</a></li>
<li><a class="reference internal" href="#view-help">View Help</a></li>
<li><a class="reference internal" href="#return-value-exit-code">Return Value (Exit Code)</a></li>
<li><a class="reference internal" href="#see-also">See Also</a></li>
</ul>
</li>
</ul>

</div>
 <div>
 <h4>Previous topic</h4>
 <a href="../index.html"
 title="previous chapter">Introduction</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="ctest.1.html"
 title="next chapter">ctest(1)</a>
 </div>
 <div role="note" aria-label="source link">
 <h3>This Page</h3>
 <ul class="this-page-menu">
 <li><a href="../_sources/manual/cmake.1.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="ctest.1.html" title="ctest(1)"
 >next</a> |</li>
 <li class="right" >
 <a href="../index.html" title="Introduction"
 >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-this"><a href="">cmake(1)</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>