1CCMAKE(1) CMake CCMAKE(1)
2
6 ccmake - CMake Curses Dialog Command-Line Reference
7
9 ccmake [<options>] {<path-to-source> | <path-to-existing-build>}
10
12 The ccmake executable is the CMake curses interface. Project configu‐
13 ration settings may be specified interactively through this GUI. Brief
14 instructions are provided at the bottom of the terminal when the pro‐
15 gram is running.
16 CMake is a cross-platform build system generator. Projects specify
18 their build process with platform-independent CMake listfiles included
19 in each directory of a source tree with the name CMakeLists.txt. Users
20 build a project by using CMake to generate a build system for a native
21 tool on their platform.
22
24 -S <path-to-source>
25 Path to root directory of the CMake project to build.
26 -B <path-to-build>
28 Path to directory which CMake will use as the root of build di‐
29 rectory.
30 If the directory doesn't already exist CMake will make it.
32 -C <initial-cache>
34 Pre-load a script to populate the cache.
35 When CMake is first run in an empty build tree, it creates a
37 CMakeCache.txt file and populates it with customizable settings
38 for the project. This option may be used to specify a file from
39 which to load cache entries before the first pass through the
40 project's CMake listfiles. The loaded entries take priority
41 over the project's default values. The given file should be a
42 CMake script containing set() commands that use the CACHE op‐
43 tion, not a cache-format file.
44 References to CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR within the
46 script evaluate to the top-level source and build tree.
47 -D <var>:<type>=<value>, -D <var>=<value>
49 Create or update a CMake CACHE entry.
50 When CMake is first run in an empty build tree, it creates a
52 CMakeCache.txt file and populates it with customizable settings
53 for the project. This option may be used to specify a setting
54 that takes priority over the project's default value. The op‐
55 tion may be repeated for as many CACHE entries as desired.
56 If the :<type> portion is given it must be one of the types
58 specified by the set() command documentation for its CACHE sig‐
59 nature. If the :<type> portion is omitted the entry will be
60 created with no type if it does not exist with a type already.
61 If a command in the project sets the type to PATH or FILEPATH
62 then the <value> will be converted to an absolute path.
63 This option may also be given as a single argument:
65 -D<var>:<type>=<value> or -D<var>=<value>.
66 -U <globbing_expr>
68 Remove matching entries from CMake CACHE.
69 This option may be used to remove one or more variables from the
71 CMakeCache.txt file, globbing expressions using * and ? are sup‐
72 ported. The option may be repeated for as many CACHE entries as
73 desired.
74 Use with care, you can make your CMakeCache.txt non-working.
76 -G <generator-name>
78 Specify a build system generator.
79 CMake may support multiple native build systems on certain plat‐
81 forms. A generator is responsible for generating a particular
82 build system. Possible generator names are specified in the
83 cmake-generators(7) manual.
84 If not specified, CMake checks the CMAKE_GENERATOR environment
86 variable and otherwise falls back to a builtin default selec‐
87 tion.
88 -T <toolset-spec>
90 Toolset specification for the generator, if supported.
91 Some CMake generators support a toolset specification to tell
93 the native build system how to choose a compiler. See the
94 CMAKE_GENERATOR_TOOLSET variable for details.
95 -A <platform-name>
97 Specify platform name if supported by generator.
98 Some CMake generators support a platform name to be given to the
100 native build system to choose a compiler or SDK. See the
101 CMAKE_GENERATOR_PLATFORM variable for details.
102 --toolchain <path-to-file>
104 Specify the cross compiling toolchain file, equivalent to set‐
105 ting CMAKE_TOOLCHAIN_FILE variable.
106 --install-prefix <directory>
108 Specify the installation directory, used by the CMAKE_IN‐
109 STALL_PREFIX variable. Must be an absolute path.
110 -Wno-dev
112 Suppress developer warnings.
113 Suppress warnings that are meant for the author of the CMake‐
115 Lists.txt files. By default this will also turn off deprecation
116 warnings.
117 -Wdev Enable developer warnings.
119 Enable warnings that are meant for the author of the CMake‐
121 Lists.txt files. By default this will also turn on deprecation
122 warnings.
123 -Werror=dev
125 Make developer warnings errors.
126 Make warnings that are meant for the author of the CMake‐
128 Lists.txt files errors. By default this will also turn on depre‐
129 cated warnings as errors.
130 -Wno-error=dev
132 Make developer warnings not errors.
133 Make warnings that are meant for the author of the CMake‐
135 Lists.txt files not errors. By default this will also turn off
136 deprecated warnings as errors.
137 -Wdeprecated
139 Enable deprecated functionality warnings.
140 Enable warnings for usage of deprecated functionality, that are
142 meant for the author of the CMakeLists.txt files.
143 -Wno-deprecated
145 Suppress deprecated functionality warnings.
146 Suppress warnings for usage of deprecated functionality, that
148 are meant for the author of the CMakeLists.txt files.
149 -Werror=deprecated
151 Make deprecated macro and function warnings errors.
152 Make warnings for usage of deprecated macros and functions, that
154 are meant for the author of the CMakeLists.txt files, errors.
155 -Wno-error=deprecated
157 Make deprecated macro and function warnings not errors.
158 Make warnings for usage of deprecated macros and functions, that
160 are meant for the author of the CMakeLists.txt files, not er‐
161 rors.
162 --help,-help,-usage,-h,-H,/?
164 Print usage information and exit.
165 Usage describes the basic command line interface and its op‐
167 tions.
168 --version,-version,/V [<f>]
170 Show program name/version banner and exit.
171 If a file is specified, the version is written into it. The
173 help is printed to a named <f>ile if given.
174 --help-full [<f>]
176 Print all help manuals and exit.
177 All manuals are printed in a human-readable text format. The
179 help is printed to a named <f>ile if given.
180 --help-manual <man> [<f>]
182 Print one help manual and exit.
183 The specified manual is printed in a human-readable text format.
185 The help is printed to a named <f>ile if given.
186 --help-manual-list [<f>]
188 List help manuals available and exit.
189 The list contains all manuals for which help may be obtained by
191 using the --help-manual option followed by a manual name. The
192 help is printed to a named <f>ile if given.
193 --help-command <cmd> [<f>]
195 Print help for one command and exit.
196 The cmake-commands(7) manual entry for <cmd> is printed in a hu‐
198 man-readable text format. The help is printed to a named <f>ile
199 if given.
200 --help-command-list [<f>]
202 List commands with help available and exit.
203 The list contains all commands for which help may be obtained by
205 using the --help-command option followed by a command name. The
206 help is printed to a named <f>ile if given.
207 --help-commands [<f>]
209 Print cmake-commands manual and exit.
210 The cmake-commands(7) manual is printed in a human-readable text
212 format. The help is printed to a named <f>ile if given.
213 --help-module <mod> [<f>]
215 Print help for one module and exit.
216 The cmake-modules(7) manual entry for <mod> is printed in a hu‐
218 man-readable text format. The help is printed to a named <f>ile
219 if given.
220 --help-module-list [<f>]
222 List modules with help available and exit.
223 The list contains all modules for which help may be obtained by
225 using the --help-module option followed by a module name. The
226 help is printed to a named <f>ile if given.
227 --help-modules [<f>]
229 Print cmake-modules manual and exit.
230 The cmake-modules(7) manual is printed in a human-readable text
232 format. The help is printed to a named <f>ile if given.
233 --help-policy <cmp> [<f>]
235 Print help for one policy and exit.
236 The cmake-policies(7) manual entry for <cmp> is printed in a hu‐
238 man-readable text format. The help is printed to a named <f>ile
239 if given.
240 --help-policy-list [<f>]
242 List policies with help available and exit.
243 The list contains all policies for which help may be obtained by
245 using the --help-policy option followed by a policy name. The
246 help is printed to a named <f>ile if given.
247 --help-policies [<f>]
249 Print cmake-policies manual and exit.
250 The cmake-policies(7) manual is printed in a human-readable text
252 format. The help is printed to a named <f>ile if given.
253 --help-property <prop> [<f>]
255 Print help for one property and exit.
256 The cmake-properties(7) manual entries for <prop> are printed in
258 a human-readable text format. The help is printed to a named
259 <f>ile if given.
260 --help-property-list [<f>]
262 List properties with help available and exit.
263 The list contains all properties for which help may be obtained
265 by using the --help-property option followed by a property name.
266 The help is printed to a named <f>ile if given.
267 --help-properties [<f>]
269 Print cmake-properties manual and exit.
270 The cmake-properties(7) manual is printed in a human-readable
272 text format. The help is printed to a named <f>ile if given.
273 --help-variable <var> [<f>]
275 Print help for one variable and exit.
276 The cmake-variables(7) manual entry for <var> is printed in a
278 human-readable text format. The help is printed to a named
279 <f>ile if given.
280 --help-variable-list [<f>]
282 List variables with help available and exit.
283 The list contains all variables for which help may be obtained
285 by using the --help-variable option followed by a variable name.
286 The help is printed to a named <f>ile if given.
287 --help-variables [<f>]
289 Print cmake-variables manual and exit.
290 The cmake-variables(7) manual is printed in a human-readable
292 text format. The help is printed to a named <f>ile if given.
293
295 The following resources are available to get help using CMake:
296 Home Page
298 https://cmake.org
299 The primary starting point for learning about CMake.
301 Online Documentation and Community Resources
303 https://cmake.org/documentation
304 Links to available documentation and community resources may be
306 found on this web page.
307 Discourse Forum
309 https://discourse.cmake.org
310 The Discourse Forum hosts discussion and questions about CMake.
312
314 2000-2021 Kitware, Inc. and Contributors
3153.22.0 Dec 02, 2021 CCMAKE(1)