| |
| <!DOCTYPE html> |
| |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| <title>ccmake(1) — CMake 3.23.1 Documentation</title> |
| |
| <link rel="stylesheet" type="text/css" href="../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../_static/cmake.css" /> |
| |
| <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> |
| <script src="../_static/jquery.js"></script> |
| <script src="../_static/underscore.js"></script> |
| <script src="../_static/doctools.js"></script> |
| |
| <link rel="shortcut icon" href="../_static/cmake-favicon.ico"/> |
| <link rel="index" title="Index" href="../genindex.html" /> |
| <link rel="search" title="Search" href="../search.html" /> |
| <link rel="next" title="cmake-buildsystem(7)" href="cmake-buildsystem.7.html" /> |
| <link rel="prev" title="cmake-gui(1)" href="cmake-gui.1.html" /> |
| |
| |
| </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> » |
| </li> |
| <li> |
| <a href="../index.html">3.23.1 Documentation</a> » |
| </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"> |
| |
| <span class="target" id="manual:ccmake(1)"></span><div class="section" id="ccmake-1"> |
| <h1>ccmake(1)<a class="headerlink" href="#ccmake-1" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="synopsis"> |
| <h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> |
| <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>ccmake [<options>] {<path-to-source> | <path-to-existing-build>} |
| </pre></div> |
| </div> |
| </div> |
| <div class="section" id="description"> |
| <h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> |
| <p>The <strong>ccmake</strong> 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.</p> |
| <p>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"><span class="pre">CMakeLists.txt</span></code>. |
| Users build a project by using CMake to generate a build system for a |
| native tool on their platform.</p> |
| </div> |
| <div class="section" id="options"> |
| <h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2> |
| <dl> |
| <dt><code class="docutils literal notranslate"><span class="pre">-S</span> <span class="pre"><path-to-source></span></code></dt><dd><p>Path to root directory of the CMake project to build.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-B</span> <span class="pre"><path-to-build></span></code></dt><dd><p>Path to directory which CMake will use as the root of build directory.</p> |
| <p>If the directory doesn't already exist CMake will make it.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-C</span> <span class="pre"><initial-cache></span></code></dt><dd><p>Pre-load a script to populate the cache.</p> |
| <p>When CMake is first run in an empty build tree, it creates a |
| <code class="docutils literal notranslate"><span class="pre">CMakeCache.txt</span></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 <span class="target" id="index-0-command:set"></span><a class="reference internal" href="../command/set.html#command:set" title="set"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">set()</span></code></a> commands that use the <code class="docutils literal notranslate"><span class="pre">CACHE</span></code> option, not a |
| cache-format file.</p> |
| <p>References to <span class="target" id="index-0-variable:CMAKE_SOURCE_DIR"></span><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"><span class="pre">CMAKE_SOURCE_DIR</span></code></a> and <span class="target" id="index-0-variable:CMAKE_BINARY_DIR"></span><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"><span class="pre">CMAKE_BINARY_DIR</span></code></a> |
| within the script evaluate to the top-level source and build tree.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-D</span> <span class="pre"><var>:<type>=<value>,</span> <span class="pre">-D</span> <span class="pre"><var>=<value></span></code></dt><dd><p>Create or update a CMake <code class="docutils literal notranslate"><span class="pre">CACHE</span></code> entry.</p> |
| <p>When CMake is first run in an empty build tree, it creates a |
| <code class="docutils literal notranslate"><span class="pre">CMakeCache.txt</span></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"><span class="pre">CACHE</span></code> entries as desired.</p> |
| <p>If the <code class="docutils literal notranslate"><span class="pre">:<type></span></code> portion is given it must be one of the types |
| specified by the <span class="target" id="index-1-command:set"></span><a class="reference internal" href="../command/set.html#command:set" title="set"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">set()</span></code></a> command documentation for its |
| <code class="docutils literal notranslate"><span class="pre">CACHE</span></code> signature. |
| If the <code class="docutils literal notranslate"><span class="pre">:<type></span></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"><span class="pre">PATH</span></code> or <code class="docutils literal notranslate"><span class="pre">FILEPATH</span></code> |
| then the <code class="docutils literal notranslate"><span class="pre"><value></span></code> will be converted to an absolute path.</p> |
| <p>This option may also be given as a single argument: |
| <code class="docutils literal notranslate"><span class="pre">-D<var>:<type>=<value></span></code> or <code class="docutils literal notranslate"><span class="pre">-D<var>=<value></span></code>.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-U</span> <span class="pre"><globbing_expr></span></code></dt><dd><p>Remove matching entries from CMake <code class="docutils literal notranslate"><span class="pre">CACHE</span></code>.</p> |
| <p>This option may be used to remove one or more variables from the |
| <code class="docutils literal notranslate"><span class="pre">CMakeCache.txt</span></code> file, globbing expressions using <code class="docutils literal notranslate"><span class="pre">*</span></code> and <code class="docutils literal notranslate"><span class="pre">?</span></code> are |
| supported. The option may be repeated for as many <code class="docutils literal notranslate"><span class="pre">CACHE</span></code> entries as |
| desired.</p> |
| <p>Use with care, you can make your <code class="docutils literal notranslate"><span class="pre">CMakeCache.txt</span></code> non-working.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-G</span> <span class="pre"><generator-name></span></code></dt><dd><p>Specify a build system generator.</p> |
| <p>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 |
| <span class="target" id="index-0-manual:cmake-generators(7)"></span><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"><span class="pre">cmake-generators(7)</span></code></a> manual.</p> |
| <p>If not specified, CMake checks the <span class="target" id="index-0-envvar:CMAKE_GENERATOR"></span><a class="reference internal" href="../envvar/CMAKE_GENERATOR.html#envvar:CMAKE_GENERATOR" title="CMAKE_GENERATOR"><code class="xref cmake cmake-envvar docutils literal notranslate"><span class="pre">CMAKE_GENERATOR</span></code></a> environment |
| variable and otherwise falls back to a builtin default selection.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-T</span> <span class="pre"><toolset-spec></span></code></dt><dd><p>Toolset specification for the generator, if supported.</p> |
| <p>Some CMake generators support a toolset specification to tell |
| the native build system how to choose a compiler. See the |
| <span class="target" id="index-0-variable:CMAKE_GENERATOR_TOOLSET"></span><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"><span class="pre">CMAKE_GENERATOR_TOOLSET</span></code></a> variable for details.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-A</span> <span class="pre"><platform-name></span></code></dt><dd><p>Specify platform name if supported by generator.</p> |
| <p>Some CMake generators support a platform name to be given to the |
| native build system to choose a compiler or SDK. See the |
| <span class="target" id="index-0-variable:CMAKE_GENERATOR_PLATFORM"></span><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"><span class="pre">CMAKE_GENERATOR_PLATFORM</span></code></a> variable for details.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--toolchain</span> <span class="pre"><path-to-file></span></code></dt><dd><p>Specify the cross compiling toolchain file, equivalent to setting |
| <span class="target" id="index-0-variable:CMAKE_TOOLCHAIN_FILE"></span><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"><span class="pre">CMAKE_TOOLCHAIN_FILE</span></code></a> variable.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--install-prefix</span> <span class="pre"><directory></span></code></dt><dd><p>Specify the installation directory, used by the |
| <span class="target" id="index-0-variable:CMAKE_INSTALL_PREFIX"></span><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"><span class="pre">CMAKE_INSTALL_PREFIX</span></code></a> variable. Must be an absolute path.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-Wno-dev</span></code></dt><dd><p>Suppress developer warnings.</p> |
| <p>Suppress warnings that are meant for the author of the |
| <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> files. By default this will also turn off |
| deprecation warnings.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-Wdev</span></code></dt><dd><p>Enable developer warnings.</p> |
| <p>Enable warnings that are meant for the author of the <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> |
| files. By default this will also turn on deprecation warnings.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-Werror=dev</span></code></dt><dd><p>Make developer warnings errors.</p> |
| <p>Make warnings that are meant for the author of the <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> files |
| errors. By default this will also turn on deprecated warnings as errors.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-Wno-error=dev</span></code></dt><dd><p>Make developer warnings not errors.</p> |
| <p>Make warnings that are meant for the author of the <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> files not |
| errors. By default this will also turn off deprecated warnings as errors.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-Wdeprecated</span></code></dt><dd><p>Enable deprecated functionality warnings.</p> |
| <p>Enable warnings for usage of deprecated functionality, that are meant |
| for the author of the <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> files.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-Wno-deprecated</span></code></dt><dd><p>Suppress deprecated functionality warnings.</p> |
| <p>Suppress warnings for usage of deprecated functionality, that are meant |
| for the author of the <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> files.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-Werror=deprecated</span></code></dt><dd><p>Make deprecated macro and function warnings errors.</p> |
| <p>Make warnings for usage of deprecated macros and functions, that are meant |
| for the author of the <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> files, errors.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">-Wno-error=deprecated</span></code></dt><dd><p>Make deprecated macro and function warnings not errors.</p> |
| <p>Make warnings for usage of deprecated macros and functions, that are meant |
| for the author of the <code class="docutils literal notranslate"><span class="pre">CMakeLists.txt</span></code> files, not errors.</p> |
| </dd> |
| </dl> |
| <dl> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help,-help,-usage,-h,-H,/?</span></code></dt><dd><p>Print usage information and exit.</p> |
| <p>Usage describes the basic command line interface and its options.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--version,-version,/V</span> <span class="pre">[<f>]</span></code></dt><dd><p>Show program name/version banner and exit.</p> |
| <p>If a file is specified, the version is written into it. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-full</span> <span class="pre">[<f>]</span></code></dt><dd><p>Print all help manuals and exit.</p> |
| <p>All manuals are printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-manual</span> <span class="pre"><man></span> <span class="pre">[<f>]</span></code></dt><dd><p>Print one help manual and exit.</p> |
| <p>The specified manual is printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-manual-list</span> <span class="pre">[<f>]</span></code></dt><dd><p>List help manuals available and exit.</p> |
| <p>The list contains all manuals for which help may be obtained by |
| using the <code class="docutils literal notranslate"><span class="pre">--help-manual</span></code> option followed by a manual name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-command</span> <span class="pre"><cmd></span> <span class="pre">[<f>]</span></code></dt><dd><p>Print help for one command and exit.</p> |
| <p>The <span class="target" id="index-0-manual:cmake-commands(7)"></span><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"><span class="pre">cmake-commands(7)</span></code></a> manual entry for <code class="docutils literal notranslate"><span class="pre"><cmd></span></code> is |
| printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-command-list</span> <span class="pre">[<f>]</span></code></dt><dd><p>List commands with help available and exit.</p> |
| <p>The list contains all commands for which help may be obtained by |
| using the <code class="docutils literal notranslate"><span class="pre">--help-command</span></code> option followed by a command name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-commands</span> <span class="pre">[<f>]</span></code></dt><dd><p>Print cmake-commands manual and exit.</p> |
| <p>The <span class="target" id="index-1-manual:cmake-commands(7)"></span><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"><span class="pre">cmake-commands(7)</span></code></a> manual is printed in a |
| human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-module</span> <span class="pre"><mod></span> <span class="pre">[<f>]</span></code></dt><dd><p>Print help for one module and exit.</p> |
| <p>The <span class="target" id="index-0-manual:cmake-modules(7)"></span><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"><span class="pre">cmake-modules(7)</span></code></a> manual entry for <code class="docutils literal notranslate"><span class="pre"><mod></span></code> is printed |
| in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-module-list</span> <span class="pre">[<f>]</span></code></dt><dd><p>List modules with help available and exit.</p> |
| <p>The list contains all modules for which help may be obtained by |
| using the <code class="docutils literal notranslate"><span class="pre">--help-module</span></code> option followed by a module name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-modules</span> <span class="pre">[<f>]</span></code></dt><dd><p>Print cmake-modules manual and exit.</p> |
| <p>The <span class="target" id="index-1-manual:cmake-modules(7)"></span><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"><span class="pre">cmake-modules(7)</span></code></a> manual is printed in a human-readable |
| text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-policy</span> <span class="pre"><cmp></span> <span class="pre">[<f>]</span></code></dt><dd><p>Print help for one policy and exit.</p> |
| <p>The <span class="target" id="index-0-manual:cmake-policies(7)"></span><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"><span class="pre">cmake-policies(7)</span></code></a> manual entry for <code class="docutils literal notranslate"><span class="pre"><cmp></span></code> is |
| printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-policy-list</span> <span class="pre">[<f>]</span></code></dt><dd><p>List policies with help available and exit.</p> |
| <p>The list contains all policies for which help may be obtained by |
| using the <code class="docutils literal notranslate"><span class="pre">--help-policy</span></code> option followed by a policy name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-policies</span> <span class="pre">[<f>]</span></code></dt><dd><p>Print cmake-policies manual and exit.</p> |
| <p>The <span class="target" id="index-1-manual:cmake-policies(7)"></span><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"><span class="pre">cmake-policies(7)</span></code></a> manual is printed in a |
| human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-property</span> <span class="pre"><prop></span> <span class="pre">[<f>]</span></code></dt><dd><p>Print help for one property and exit.</p> |
| <p>The <span class="target" id="index-0-manual:cmake-properties(7)"></span><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"><span class="pre">cmake-properties(7)</span></code></a> manual entries for <code class="docutils literal notranslate"><span class="pre"><prop></span></code> are |
| printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-property-list</span> <span class="pre">[<f>]</span></code></dt><dd><p>List properties with help available and exit.</p> |
| <p>The list contains all properties for which help may be obtained by |
| using the <code class="docutils literal notranslate"><span class="pre">--help-property</span></code> option followed by a property name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-properties</span> <span class="pre">[<f>]</span></code></dt><dd><p>Print cmake-properties manual and exit.</p> |
| <p>The <span class="target" id="index-1-manual:cmake-properties(7)"></span><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"><span class="pre">cmake-properties(7)</span></code></a> manual is printed in a |
| human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-variable</span> <span class="pre"><var></span> <span class="pre">[<f>]</span></code></dt><dd><p>Print help for one variable and exit.</p> |
| <p>The <span class="target" id="index-0-manual:cmake-variables(7)"></span><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"><span class="pre">cmake-variables(7)</span></code></a> manual entry for <code class="docutils literal notranslate"><span class="pre"><var></span></code> is |
| printed in a human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-variable-list</span> <span class="pre">[<f>]</span></code></dt><dd><p>List variables with help available and exit.</p> |
| <p>The list contains all variables for which help may be obtained by |
| using the <code class="docutils literal notranslate"><span class="pre">--help-variable</span></code> option followed by a variable name. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| <dt><code class="docutils literal notranslate"><span class="pre">--help-variables</span> <span class="pre">[<f>]</span></code></dt><dd><p>Print cmake-variables manual and exit.</p> |
| <p>The <span class="target" id="index-1-manual:cmake-variables(7)"></span><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"><span class="pre">cmake-variables(7)</span></code></a> manual is printed in a |
| human-readable text format. |
| The help is printed to a named <f>ile if given.</p> |
| </dd> |
| </dl> |
| </div> |
| <div class="section" id="see-also"> |
| <h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2> |
| <p>The following resources are available to get help using CMake:</p> |
| <dl> |
| <dt>Home Page</dt><dd><p><a class="reference external" href="https://cmake.org">https://cmake.org</a></p> |
| <p>The primary starting point for learning about CMake.</p> |
| </dd> |
| <dt>Online Documentation and Community Resources</dt><dd><p><a class="reference external" href="https://cmake.org/documentation">https://cmake.org/documentation</a></p> |
| <p>Links to available documentation and community resources may be |
| found on this web page.</p> |
| </dd> |
| <dt>Discourse Forum</dt><dd><p><a class="reference external" href="https://discourse.cmake.org">https://discourse.cmake.org</a></p> |
| <p>The Discourse Forum hosts discussion and questions about CMake.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| |
| |
| <div class="clearer"></div> |
| </div> |
| </div> |
| </div> |
| <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> |
| <div class="sphinxsidebarwrapper"> |
| <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> |
| |
| <h4>Previous topic</h4> |
| <p class="topless"><a href="cmake-gui.1.html" |
| title="previous chapter">cmake-gui(1)</a></p> |
| <h4>Next topic</h4> |
| <p class="topless"><a href="cmake-buildsystem.7.html" |
| title="next chapter">cmake-buildsystem(7)</a></p> |
| <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>$('#searchbox').show(0);</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> » |
| </li> |
| <li> |
| <a href="../index.html">3.23.1 Documentation</a> » |
| </li> |
| |
| <li class="nav-item nav-item-this"><a href="">ccmake(1)</a></li> |
| </ul> |
| </div> |
| |
| <div class="footer" role="contentinfo"> |
| © Copyright 2000-2022 Kitware, Inc. and Contributors. |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.1.2. |
| </div> |
| </body> |
| </html> |
