cmake-gui.1.rst 1.12 KB
Newer Older
1 2
.. cmake-manual-description: CMake GUI Command-Line Reference

3 4 5
cmake-gui(1)
************

6 7
Synopsis
========
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

15 16 17
Description
===========

18
The **cmake-gui** executable is the CMake GUI.  Project configuration
19 20 21 22 23
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
24
in each directory of a source tree with the name ``CMakeLists.txt``.
25 26 27
Users build a project by using CMake to generate a build system for a
native tool on their platform.

28 29 30
Options
=======

31 32 33 34 35 36 37 38
``-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.

39
.. include:: OPTIONS_HELP.txt
40

41 42
See Also
========
43

44
.. include:: LINKS.txt