https://github.com/Kitware/CMake
Tip revision: a8bd06dfd47a56e09e660de5e58f26579105d2d4 authored by Brad King on 25 May 2022, 13:42:51 UTC
CMake 3.23.2
CMake 3.23.2
Tip revision: a8bd06d
cmake-gui.1.rst
.. cmake-manual-description: CMake GUI Command-Line Reference
cmake-gui(1)
************
Synopsis
========
.. parsed-literal::
cmake-gui [<options>]
cmake-gui [<options>] {<path-to-source> | <path-to-existing-build>}
cmake-gui [<options>] -S <path-to-source> -B <path-to-build>
cmake-gui [<options>] --browse-manual
Description
===========
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 ``CMakeLists.txt``.
Users build a project by using CMake to generate a build system for a
native tool on their platform.
Options
=======
``-S <path-to-source>``
Path to root directory of the CMake project to build.
``-B <path-to-build>``
Path to directory which CMake will use as the root of build directory.
If the directory doesn't already exist CMake will make it.
``--preset=<preset-name>``
Name of the preset to use from the project's
:manual:`presets <cmake-presets(7)>` files, if it has them.
``--browse-manual``
Open the CMake reference manual in a browser and immediately exit.
.. include:: OPTIONS_HELP.txt
See Also
========
.. include:: LINKS.txt