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
29 directory.
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 option,
43 not a cache-format file.
44 -D <var>:<type>=<value>, -D <var>=<value>
46 Create or update a cmake cache entry.
47 When cmake is first run in an empty build tree, it creates a
49 CMakeCache.txt file and populates it with customizable settings
50 for the project. This option may be used to specify a setting
51 that takes priority over the project’s default value. The
52 option may be repeated for as many cache entries as desired.
53 If the :<type> portion is given it must be one of the types
55 specified by the set() command documentation for its CACHE sig‐
56 nature. If the :<type> portion is omitted the entry will be
57 created with no type if it does not exist with a type already.
58 If a command in the project sets the type to PATH or FILEPATH
59 then the <value> will be converted to an absolute path.
60 This option may also be given as a single argument:
62 -D<var>:<type>=<value> or -D<var>=<value>.
63 -U <globbing_expr>
65 Remove matching entries from CMake cache.
66 This option may be used to remove one or more variables from the
68 CMakeCache.txt file, globbing expressions using * and ? are sup‐
69 ported. The option may be repeated for as many cache entries as
70 desired.
71 Use with care, you can make your CMakeCache.txt non-working.
73 -G <generator-name>
75 Specify a build system generator.
76 CMake may support multiple native build systems on certain plat‐
78 forms. A generator is responsible for generating a particular
79 build system. Possible generator names are specified in the
80 cmake-generators(7) manual.
81 -T <toolset-spec>
83 Toolset specification for the generator, if supported.
84 Some CMake generators support a toolset specification to tell
86 the native build system how to choose a compiler. See the
87 CMAKE_GENERATOR_TOOLSET variable for details.
88 -A <platform-name>
90 Specify platform name if supported by generator.
91 Some CMake generators support a platform name to be given to the
93 native build system to choose a compiler or SDK. See the
94 CMAKE_GENERATOR_PLATFORM variable for details.
95 -Wno-dev
97 Suppress developer warnings.
98 Suppress warnings that are meant for the author of the CMake‐
100 Lists.txt files. By default this will also turn off deprecation
101 warnings.
102 -Wdev Enable developer warnings.
104 Enable warnings that are meant for the author of the CMake‐
106 Lists.txt files. By default this will also turn on deprecation
107 warnings.
108 -Werror=dev
110 Make developer warnings errors.
111 Make warnings that are meant for the author of the CMake‐
113 Lists.txt files errors. By default this will also turn on depre‐
114 cated warnings as errors.
115 -Wno-error=dev
117 Make developer warnings not errors.
118 Make warnings that are meant for the author of the CMake‐
120 Lists.txt files not errors. By default this will also turn off
121 deprecated warnings as errors.
122 -Wdeprecated
124 Enable deprecated functionality warnings.
125 Enable warnings for usage of deprecated functionality, that are
127 meant for the author of the CMakeLists.txt files.
128 -Wno-deprecated
130 Suppress deprecated functionality warnings.
131 Suppress warnings for usage of deprecated functionality, that
133 are meant for the author of the CMakeLists.txt files.
134 -Werror=deprecated
136 Make deprecated macro and function warnings errors.
137 Make warnings for usage of deprecated macros and functions, that
139 are meant for the author of the CMakeLists.txt files, errors.
140 -Wno-error=deprecated
142 Make deprecated macro and function warnings not errors.
143 Make warnings for usage of deprecated macros and functions, that
145 are meant for the author of the CMakeLists.txt files, not
146 errors.
147 --help,-help,-usage,-h,-H,/?
149 Print usage information and exit.
150 Usage describes the basic command line interface and its
152 options.
153 --version,-version,/V [<f>]
155 Show program name/version banner and exit.
156 If a file is specified, the version is written into it. The
158 help is printed to a named <f>ile if given.
159 --help-full [<f>]
161 Print all help manuals and exit.
162 All manuals are printed in a human-readable text format. The
164 help is printed to a named <f>ile if given.
165 --help-manual <man> [<f>]
167 Print one help manual and exit.
168 The specified manual is printed in a human-readable text format.
170 The help is printed to a named <f>ile if given.
171 --help-manual-list [<f>]
173 List help manuals available and exit.
174 The list contains all manuals for which help may be obtained by
176 using the --help-manual option followed by a manual name. The
177 help is printed to a named <f>ile if given.
178 --help-command <cmd> [<f>]
180 Print help for one command and exit.
181 The cmake-commands(7) manual entry for <cmd> is printed in a
183 human-readable text format. The help is printed to a named
184 <f>ile if given.
185 --help-command-list [<f>]
187 List commands with help available and exit.
188 The list contains all commands for which help may be obtained by
190 using the --help-command option followed by a command name. The
191 help is printed to a named <f>ile if given.
192 --help-commands [<f>]
194 Print cmake-commands manual and exit.
195 The cmake-commands(7) manual is printed in a human-readable text
197 format. The help is printed to a named <f>ile if given.
198 --help-module <mod> [<f>]
200 Print help for one module and exit.
201 The cmake-modules(7) manual entry for <mod> is printed in a
203 human-readable text format. The help is printed to a named
204 <f>ile if given.
205 --help-module-list [<f>]
207 List modules with help available and exit.
208 The list contains all modules for which help may be obtained by
210 using the --help-module option followed by a module name. The
211 help is printed to a named <f>ile if given.
212 --help-modules [<f>]
214 Print cmake-modules manual and exit.
215 The cmake-modules(7) manual is printed in a human-readable text
217 format. The help is printed to a named <f>ile if given.
218 --help-policy <cmp> [<f>]
220 Print help for one policy and exit.
221 The cmake-policies(7) manual entry for <cmp> is printed in a
223 human-readable text format. The help is printed to a named
224 <f>ile if given.
225 --help-policy-list [<f>]
227 List policies with help available and exit.
228 The list contains all policies for which help may be obtained by
230 using the --help-policy option followed by a policy name. The
231 help is printed to a named <f>ile if given.
232 --help-policies [<f>]
234 Print cmake-policies manual and exit.
235 The cmake-policies(7) manual is printed in a human-readable text
237 format. The help is printed to a named <f>ile if given.
238 --help-property <prop> [<f>]
240 Print help for one property and exit.
241 The cmake-properties(7) manual entries for <prop> are printed in
243 a human-readable text format. The help is printed to a named
244 <f>ile if given.
245 --help-property-list [<f>]
247 List properties with help available and exit.
248 The list contains all properties for which help may be obtained
250 by using the --help-property option followed by a property name.
251 The help is printed to a named <f>ile if given.
252 --help-properties [<f>]
254 Print cmake-properties manual and exit.
255 The cmake-properties(7) manual is printed in a human-readable
257 text format. The help is printed to a named <f>ile if given.
258 --help-variable <var> [<f>]
260 Print help for one variable and exit.
261 The cmake-variables(7) manual entry for <var> is printed in a
263 human-readable text format. The help is printed to a named
264 <f>ile if given.
265 --help-variable-list [<f>]
267 List variables with help available and exit.
268 The list contains all variables for which help may be obtained
270 by using the --help-variable option followed by a variable name.
271 The help is printed to a named <f>ile if given.
272 --help-variables [<f>]
274 Print cmake-variables manual and exit.
275 The cmake-variables(7) manual is printed in a human-readable
277 text format. The help is printed to a named <f>ile if given.
278
280 The following resources are available to get help using CMake:
281 Home Page
283 https://cmake.org
284 The primary starting point for learning about CMake.
286 Online Documentation and Community Resources
288 https://cmake.org/documentation
289 Links to available documentation and community resources may be
291 found on this web page.
292 Mailing List
294 https://cmake.org/mailing-lists
295 For help and discussion about using cmake, a mailing list is
297 provided at cmake@cmake.org. The list is member-post-only but
298 one may sign up on the CMake web page. Please first read the
299 full documentation at https://cmake.org before posting questions
300 to the list.
301
303 2000-2019 Kitware, Inc. and Contributors
3043.14.5 Jun 01, 2019 CCMAKE(1)