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 -Wno-dev
104 Suppress developer warnings.
105 Suppress warnings that are meant for the author of the CMake‐
107 Lists.txt files. By default this will also turn off deprecation
108 warnings.
109 -Wdev Enable developer warnings.
111 Enable warnings that are meant for the author of the CMake‐
113 Lists.txt files. By default this will also turn on deprecation
114 warnings.
115 -Werror=dev
117 Make developer warnings errors.
118 Make warnings that are meant for the author of the CMake‐
120 Lists.txt files errors. By default this will also turn on depre‐
121 cated warnings as errors.
122 -Wno-error=dev
124 Make developer warnings not errors.
125 Make warnings that are meant for the author of the CMake‐
127 Lists.txt files not errors. By default this will also turn off
128 deprecated warnings as errors.
129 -Wdeprecated
131 Enable deprecated functionality warnings.
132 Enable warnings for usage of deprecated functionality, that are
134 meant for the author of the CMakeLists.txt files.
135 -Wno-deprecated
137 Suppress deprecated functionality warnings.
138 Suppress warnings for usage of deprecated functionality, that
140 are meant for the author of the CMakeLists.txt files.
141 -Werror=deprecated
143 Make deprecated macro and function warnings errors.
144 Make warnings for usage of deprecated macros and functions, that
146 are meant for the author of the CMakeLists.txt files, errors.
147 -Wno-error=deprecated
149 Make deprecated macro and function warnings not errors.
150 Make warnings for usage of deprecated macros and functions, that
152 are meant for the author of the CMakeLists.txt files, not er‐
153 rors.
154 --help,-help,-usage,-h,-H,/?
156 Print usage information and exit.
157 Usage describes the basic command line interface and its op‐
159 tions.
160 --version,-version,/V [<f>]
162 Show program name/version banner and exit.
163 If a file is specified, the version is written into it. The
165 help is printed to a named <f>ile if given.
166 --help-full [<f>]
168 Print all help manuals and exit.
169 All manuals are printed in a human-readable text format. The
171 help is printed to a named <f>ile if given.
172 --help-manual <man> [<f>]
174 Print one help manual and exit.
175 The specified manual is printed in a human-readable text format.
177 The help is printed to a named <f>ile if given.
178 --help-manual-list [<f>]
180 List help manuals available and exit.
181 The list contains all manuals for which help may be obtained by
183 using the --help-manual option followed by a manual name. The
184 help is printed to a named <f>ile if given.
185 --help-command <cmd> [<f>]
187 Print help for one command and exit.
188 The cmake-commands(7) manual entry for <cmd> is printed in a hu‐
190 man-readable text format. The help is printed to a named <f>ile
191 if given.
192 --help-command-list [<f>]
194 List commands with help available and exit.
195 The list contains all commands for which help may be obtained by
197 using the --help-command option followed by a command name. The
198 help is printed to a named <f>ile if given.
199 --help-commands [<f>]
201 Print cmake-commands manual and exit.
202 The cmake-commands(7) manual is printed in a human-readable text
204 format. The help is printed to a named <f>ile if given.
205 --help-module <mod> [<f>]
207 Print help for one module and exit.
208 The cmake-modules(7) manual entry for <mod> is printed in a hu‐
210 man-readable text format. The help is printed to a named <f>ile
211 if given.
212 --help-module-list [<f>]
214 List modules with help available and exit.
215 The list contains all modules for which help may be obtained by
217 using the --help-module option followed by a module name. The
218 help is printed to a named <f>ile if given.
219 --help-modules [<f>]
221 Print cmake-modules manual and exit.
222 The cmake-modules(7) manual is printed in a human-readable text
224 format. The help is printed to a named <f>ile if given.
225 --help-policy <cmp> [<f>]
227 Print help for one policy and exit.
228 The cmake-policies(7) manual entry for <cmp> is printed in a hu‐
230 man-readable text format. The help is printed to a named <f>ile
231 if given.
232 --help-policy-list [<f>]
234 List policies with help available and exit.
235 The list contains all policies for which help may be obtained by
237 using the --help-policy option followed by a policy name. The
238 help is printed to a named <f>ile if given.
239 --help-policies [<f>]
241 Print cmake-policies manual and exit.
242 The cmake-policies(7) manual is printed in a human-readable text
244 format. The help is printed to a named <f>ile if given.
245 --help-property <prop> [<f>]
247 Print help for one property and exit.
248 The cmake-properties(7) manual entries for <prop> are printed in
250 a human-readable text format. The help is printed to a named
251 <f>ile if given.
252 --help-property-list [<f>]
254 List properties with help available and exit.
255 The list contains all properties for which help may be obtained
257 by using the --help-property option followed by a property name.
258 The help is printed to a named <f>ile if given.
259 --help-properties [<f>]
261 Print cmake-properties manual and exit.
262 The cmake-properties(7) manual is printed in a human-readable
264 text format. The help is printed to a named <f>ile if given.
265 --help-variable <var> [<f>]
267 Print help for one variable and exit.
268 The cmake-variables(7) manual entry for <var> is printed in a
270 human-readable text format. The help is printed to a named
271 <f>ile if given.
272 --help-variable-list [<f>]
274 List variables with help available and exit.
275 The list contains all variables for which help may be obtained
277 by using the --help-variable option followed by a variable name.
278 The help is printed to a named <f>ile if given.
279 --help-variables [<f>]
281 Print cmake-variables manual and exit.
282 The cmake-variables(7) manual is printed in a human-readable
284 text format. The help is printed to a named <f>ile if given.
285
287 The following resources are available to get help using CMake:
288 Home Page
290 https://cmake.org
291 The primary starting point for learning about CMake.
293 Online Documentation and Community Resources
295 https://cmake.org/documentation
296 Links to available documentation and community resources may be
298 found on this web page.
299 Discourse Forum
301 https://discourse.cmake.org
302 The Discourse Forum hosts discussion and questions about CMake.
304
306 2000-2021 Kitware, Inc. and Contributors
3073.20.3 May 30, 2021 CCMAKE(1)