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-gui.1.html

<!DOCTYPE html>

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

<div class="document">
 <div class="documentwrapper">
 <div class="bodywrapper">
 <div class="body" role="main">
 
 <section id="cmake-gui-1">
<h1>cmake-gui(1)<a class="headerlink" href="#cmake-gui-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>cmake-gui [&lt;options&gt;]
cmake-gui [&lt;options&gt;] &lt;path-to-source | path-to-existing-build&gt;
cmake-gui [&lt;options&gt;] -S &lt;path-to-source&gt; -B &lt;path-to-build&gt;
cmake-gui [&lt;options&gt;] --browse-manual
</pre></div>
</div>
</section>
<section id="description">
<h2>Description<a class="headerlink" href="#description" title="Permalink to this heading">¶</a></h2>
The cmake-gui executable is the CMake GUI. Project configuration
settings may be specified interactively. Brief instructions are
provided at the bottom of the window 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-cmake-gui-S">
-S &lt;path-to-source&gt;<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-B">
-B &lt;path-to-build&gt;<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-preset">
--preset=&lt;preset-name&gt;<a class="headerlink" href="#cmdoption-cmake-gui-preset" title="Permalink to this definition">¶</a></dt>
<dd>Name of the preset to use from the project's
<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">presets</code></a> files, if it has them.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-gui-browse-manual">
--browse-manual<a class="headerlink" href="#cmdoption-cmake-gui-browse-manual" title="Permalink to this definition">¶</a></dt>
<dd>Open the CMake reference manual in a browser and immediately exit.
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-cmake-gui-version">
-version [&lt;file&gt;], --version [&lt;file&gt;], /V [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-h">
-h, -H, --help, -help, -usage, /?<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-full">
--help-full [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-manual">
--help-manual &lt;man&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-manual-list">
--help-manual-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-command">
--help-command &lt;cmd&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-command-list">
--help-command-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-commands">
--help-commands [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-module">
--help-module &lt;mod&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-module-list">
--help-module-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-modules">
--help-modules [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-policy">
--help-policy &lt;cmp&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-policy-list">
--help-policy-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-policies">
--help-policies [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-property">
--help-property &lt;prop&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-property-list">
--help-property-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-properties">
--help-properties [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-variable">
--help-variable &lt;var&gt; [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-variable-list">
--help-variable-list [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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-gui-help-variables">
--help-variables [&lt;file&gt;]<a class="headerlink" href="#cmdoption-cmake-gui-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="#">cmake-gui(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="cpack.1.html"
 title="previous chapter">cpack(1)</a>
 </div>
 <div>
 <h4>Next topic</h4>
 <a href="ccmake.1.html"
 title="next chapter">ccmake(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-gui.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="ccmake.1.html" title="ccmake(1)"
 >next</a> |</li>
 <li class="right" >
 <a href="cpack.1.html" title="cpack(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="">cmake-gui(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>