Help/manual/cmake-gui.1.rst

   1 .. cmake-manual-description: CMake GUI Command-Line Reference
   2
   3 cmake-gui(1)
   4 ************
   5
   6 Synopsis
   7 ========
   8
   9 .. parsed-literal::
  10
  11  cmake-gui [<options>]
  12  cmake-gui [<options>] {<path-to-source> | <path-to-existing-build>}
  13  cmake-gui [<options>] -S <path-to-source> -B <path-to-build>
  14  cmake-gui [<options>] --browse-manual
  15
  16 Description
  17 ===========
  18
  19 The **cmake-gui** executable is the CMake GUI.  Project configuration
  20 settings may be specified interactively.  Brief instructions are
  21 provided at the bottom of the window when the program is running.
  22
  23 CMake is a cross-platform build system generator.  Projects specify
  24 their build process with platform-independent CMake listfiles included
  25 in each directory of a source tree with the name ``CMakeLists.txt``.
  26 Users build a project by using CMake to generate a build system for a
  27 native tool on their platform.
  28
  29 Options
  30 =======
  31
  32 ``-S <path-to-source>``
  33  Path to root directory of the CMake project to build.
  34
  35 ``-B <path-to-build>``
  36  Path to directory which CMake will use as the root of build directory.
  37
  38  If the directory doesn't already exist CMake will make it.
  39
  40 ``--preset=<preset-name>``
  41  Name of the preset to use from the project's
  42  :manual:`presets <cmake-presets(7)>` files, if it has them.
  43
  44 ``--browse-manual``
  45  Open the CMake reference manual in a browser and immediately exit.
  46
  47 .. include:: OPTIONS_HELP.txt
  48
  49 See Also
  50 ========
  51
  52 .. include:: LINKS.txt