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: ccmake.1.html

<!DOCTYPE html>

<title>ccmake(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="cmake-buildsystem.7.html" title="cmake-buildsystem(7)"
 accesskey="N">next</a> |</li>
 <li class="right" >
 <a href="cmake-gui.1.html" title="cmake-gui(1)"
 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="">ccmake(1)</a></li> 
 </ul>
 </div>

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="ccmake-1">
<h1>ccmake(1)<a class="headerlink" href="#ccmake-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>
<div class="highlight-none notranslate"><div class="highlight"><pre>ccmake [&lt;options&gt;] &lt;path-to-source | path-to-existing-build&gt;
</pre></div>
</div>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
The ccmake executable is the CMake curses interface. Project
configuration settings may be specified interactively through this
GUI. Brief instructions are provided at the bottom of the terminal
when the program is running.
CMake is a cross-platform build system generator. Projects specify
their build process with platform-independent CMake listfiles included
in each directory of a source tree with the name <code class="docutils literal notranslate">CMakeLists.txt</code>.
Users build a project by using CMake to generate a build system for a
native tool on their platform.
</section>
<section id="options">
<h2>Options<a class="headerlink" href="#options" title="Permalink to this heading">¶</a></h2>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-ccmake-S">
-S &lt;path-to-source&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-B">
-B &lt;path-to-build&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-C">
-C &lt;initial-cache&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-D">
-D &lt;var&gt;:&lt;type&gt;=&lt;value&gt;, -D &lt;var&gt;=&lt;value&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-U">
-U &lt;globbing_expr&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-G">
-G &lt;generator-name&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-T">
-T &lt;toolset-spec&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-A">
-A &lt;platform-name&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-toolchain">
--toolchain &lt;path-to-file&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-install-prefix">
--install-prefix &lt;directory&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-Wno-dev">
-Wno-dev<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-Wdev">
-Wdev<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-Wdeprecated">
-Wdeprecated<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-Wno-deprecated">
-Wno-deprecated<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-Werror">
-Werror=&lt;what&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-Wno-error">
-Wno-error=&lt;what&gt;<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-version">
-version [&lt;file&gt;], --version [&lt;file&gt;], /V [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-h">
-h, -H, --help, -help, -usage, /?<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-full">
--help-full [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-manual">
--help-manual &lt;man&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-manual-list">
--help-manual-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-command">
--help-command &lt;cmd&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-command-list">
--help-command-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-commands">
--help-commands [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-module">
--help-module &lt;mod&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-module-list">
--help-module-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-modules">
--help-modules [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-policy">
--help-policy &lt;cmp&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-policy-list">
--help-policy-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-policies">
--help-policies [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-property">
--help-property &lt;prop&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-property-list">
--help-property-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-properties">
--help-properties [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-variable">
--help-variable &lt;var&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-variable-list">
--help-variable-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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-ccmake-help-variables">
--help-variables [&lt;file&gt;]<a class="headerlink" href="#cmdoption-ccmake-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>

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