1CMAKE-GUI(1) CMake CMAKE-GUI(1)
2
6 cmake-gui - CMake GUI Command-Line Reference
7
9 cmake-gui [<options>]
10 cmake-gui [<options>] <path-to-source | path-to-existing-build>
11 cmake-gui [<options>] -S <path-to-source> -B <path-to-build>
12 cmake-gui [<options>] --browse-manual
13
15 The cmake-gui executable is the CMake GUI. Project configuration set‐
16 tings may be specified interactively. Brief instructions are provided
17 at the bottom of the window when the program is running.
18 CMake is a cross-platform build system generator. Projects specify
20 their build process with platform-independent CMake listfiles included
21 in each directory of a source tree with the name CMakeLists.txt. Users
22 build a project by using CMake to generate a build system for a native
23 tool on their platform.
24
26 -S <path-to-source>
27 Path to root directory of the CMake project to build.
28 -B <path-to-build>
30 Path to directory which CMake will use as the root of build di‐
31 rectory.
32 If the directory doesn't already exist CMake will make it.
34 --preset=<preset-name>
36 Name of the preset to use from the project's presets files, if
37 it has them.
38 --browse-manual
40 Open the CMake reference manual in a browser and immediately
41 exit.
42 -version [<file>], --version [<file>], /V [<file>]
44 Show program name/version banner and exit. The output is
45 printed to a named <file> if given.
46 -h, -H, --help, -help, -usage, /?
48 Print usage information and exit.
49 Usage describes the basic command line interface and its op‐
51 tions.
52 --help-full [<file>]
54 Print all help manuals and exit.
55 All manuals are printed in a human-readable text format. The
57 output is printed to a named <file> if given.
58 --help-manual <man> [<file>]
60 Print one help manual and exit.
61 The specified manual is printed in a human-readable text format.
63 The output is printed to a named <file> if given.
64 --help-manual-list [<file>]
66 List help manuals available and exit.
67 The list contains all manuals for which help may be obtained by
69 using the --help-manual option followed by a manual name. The
70 output is printed to a named <file> if given.
71 --help-command <cmd> [<file>]
73 Print help for one command and exit.
74 The cmake-commands(7) manual entry for <cmd> is printed in a hu‐
76 man-readable text format. The output is printed to a named
77 <file> if given.
78 --help-command-list [<file>]
80 List commands with help available and exit.
81 The list contains all commands for which help may be obtained by
83 using the --help-command option followed by a command name. The
84 output is printed to a named <file> if given.
85 --help-commands [<file>]
87 Print cmake-commands manual and exit.
88 The cmake-commands(7) manual is printed in a human-readable text
90 format. The output is printed to a named <file> if given.
91 --help-module <mod> [<file>]
93 Print help for one module and exit.
94 The cmake-modules(7) manual entry for <mod> is printed in a hu‐
96 man-readable text format. The output is printed to a named
97 <file> if given.
98 --help-module-list [<file>]
100 List modules with help available and exit.
101 The list contains all modules for which help may be obtained by
103 using the --help-module option followed by a module name. The
104 output is printed to a named <file> if given.
105 --help-modules [<file>]
107 Print cmake-modules manual and exit.
108 The cmake-modules(7) manual is printed in a human-readable text
110 format. The output is printed to a named <file> if given.
111 --help-policy <cmp> [<file>]
113 Print help for one policy and exit.
114 The cmake-policies(7) manual entry for <cmp> is printed in a hu‐
116 man-readable text format. The output is printed to a named
117 <file> if given.
118 --help-policy-list [<file>]
120 List policies with help available and exit.
121 The list contains all policies for which help may be obtained by
123 using the --help-policy option followed by a policy name. The
124 output is printed to a named <file> if given.
125 --help-policies [<file>]
127 Print cmake-policies manual and exit.
128 The cmake-policies(7) manual is printed in a human-readable text
130 format. The output is printed to a named <file> if given.
131 --help-property <prop> [<file>]
133 Print help for one property and exit.
134 The cmake-properties(7) manual entries for <prop> are printed in
136 a human-readable text format. The output is printed to a named
137 <file> if given.
138 --help-property-list [<file>]
140 List properties with help available and exit.
141 The list contains all properties for which help may be obtained
143 by using the --help-property option followed by a property name.
144 The output is printed to a named <file> if given.
145 --help-properties [<file>]
147 Print cmake-properties manual and exit.
148 The cmake-properties(7) manual is printed in a human-readable
150 text format. The output is printed to a named <file> if given.
151 --help-variable <var> [<file>]
153 Print help for one variable and exit.
154 The cmake-variables(7) manual entry for <var> is printed in a
156 human-readable text format. The output is printed to a named
157 <file> if given.
158 --help-variable-list [<file>]
160 List variables with help available and exit.
161 The list contains all variables for which help may be obtained
163 by using the --help-variable option followed by a variable name.
164 The output is printed to a named <file> if given.
165 --help-variables [<file>]
167 Print cmake-variables manual and exit.
168 The cmake-variables(7) manual is printed in a human-readable
170 text format. The output is printed to a named <file> if given.
171
173 The following resources are available to get help using CMake:
174 Home Page
176 https://cmake.org
177 The primary starting point for learning about CMake.
179 Online Documentation and Community Resources
181 https://cmake.org/documentation
182 Links to available documentation and community resources may be
184 found on this web page.
185 Discourse Forum
187 https://discourse.cmake.org
188 The Discourse Forum hosts discussion and questions about CMake.
190
192 2000-2023 Kitware, Inc. and Contributors
1933.25.2 Jan 19, 2023 CMAKE-GUI(1)