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 config‐
13 uration settings may be specified interactively through this GUI.
14 Brief instructions are provided at the bottom of the terminal when the
15 program 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 -C <initial-cache>
25 Pre-load a script to populate the cache.
26 When cmake is first run in an empty build tree, it creates a
28 CMakeCache.txt file and populates it with customizable settings
29 for the project. This option may be used to specify a file from
30 which to load cache entries before the first pass through the
31 project’s cmake listfiles. The loaded entries take priority
32 over the project’s default values. The given file should be a
33 CMake script containing SET commands that use the CACHE option,
34 not a cache-format file.
35 -D <var>:<type>=<value>, -D <var>=<value>
37 Create a cmake cache entry.
38 When cmake is first run in an empty build tree, it creates a
40 CMakeCache.txt file and populates it with customizable settings
41 for the project. This option may be used to specify a setting
42 that takes priority over the project’s default value. The
43 option may be repeated for as many cache entries as desired.
44 If the :<type> portion is given it must be one of the types
46 specified by the set() command documentation for its CACHE sig‐
47 nature. If the :<type> portion is omitted the entry will be
48 created with no type if it does not exist with a type already.
49 If a command in the project sets the type to PATH or FILEPATH
50 then the <value> will be converted to an absolute path.
51 This option may also be given as a single argument:
53 -D<var>:<type>=<value> or -D<var>=<value>.
54 -U <globbing_expr>
56 Remove matching entries from CMake cache.
57 This option may be used to remove one or more variables from the
59 CMakeCache.txt file, globbing expressions using * and ? are sup‐
60 ported. The option may be repeated for as many cache entries as
61 desired.
62 Use with care, you can make your CMakeCache.txt non-working.
64 -G <generator-name>
66 Specify a build system generator.
67 CMake may support multiple native build systems on certain plat‐
69 forms. A generator is responsible for generating a particular
70 build system. Possible generator names are specified in the
71 cmake-generators(7) manual.
72 -T <toolset-spec>
74 Toolset specification for the generator, if supported.
75 Some CMake generators support a toolset specification to tell
77 the native build system how to choose a compiler. See the
78 CMAKE_GENERATOR_TOOLSET variable for details.
79 -A <platform-name>
81 Specify platform name if supported by generator.
82 Some CMake generators support a platform name to be given to the
84 native build system to choose a compiler or SDK. See the
85 CMAKE_GENERATOR_PLATFORM variable for details.
86 -Wno-dev
88 Suppress developer warnings.
89 Suppress warnings that are meant for the author of the CMake‐
91 Lists.txt files. By default this will also turn off deprecation
92 warnings.
93 -Wdev Enable developer warnings.
95 Enable warnings that are meant for the author of the CMake‐
97 Lists.txt files. By default this will also turn on deprecation
98 warnings.
99 -Werror=dev
101 Make developer warnings errors.
102 Make warnings that are meant for the author of the CMake‐
104 Lists.txt files errors. By default this will also turn on depre‐
105 cated warnings as errors.
106 -Wno-error=dev
108 Make developer warnings not errors.
109 Make warnings that are meant for the author of the CMake‐
111 Lists.txt files not errors. By default this will also turn off
112 deprecated warnings as errors.
113 -Wdeprecated
115 Enable deprecated functionality warnings.
116 Enable warnings for usage of deprecated functionality, that are
118 meant for the author of the CMakeLists.txt files.
119 -Wno-deprecated
121 Suppress deprecated functionality warnings.
122 Suppress warnings for usage of deprecated functionality, that
124 are meant for the author of the CMakeLists.txt files.
125 -Werror=deprecated
127 Make deprecated macro and function warnings errors.
128 Make warnings for usage of deprecated macros and functions, that
130 are meant for the author of the CMakeLists.txt files, errors.
131 -Wno-error=deprecated
133 Make deprecated macro and function warnings not errors.
134 Make warnings for usage of deprecated macros and functions, that
136 are meant for the author of the CMakeLists.txt files, not
137 errors.
138 --help,-help,-usage,-h,-H,/?
140 Print usage information and exit.
141 Usage describes the basic command line interface and its
143 options.
144 --version,-version,/V [<f>]
146 Show program name/version banner and exit.
147 If a file is specified, the version is written into it. The
149 help is printed to a named <f>ile if given.
150 --help-full [<f>]
152 Print all help manuals and exit.
153 All manuals are printed in a human-readable text format. The
155 help is printed to a named <f>ile if given.
156 --help-manual <man> [<f>]
158 Print one help manual and exit.
159 The specified manual is printed in a human-readable text format.
161 The help is printed to a named <f>ile if given.
162 --help-manual-list [<f>]
164 List help manuals available and exit.
165 The list contains all manuals for which help may be obtained by
167 using the --help-manual option followed by a manual name. The
168 help is printed to a named <f>ile if given.
169 --help-command <cmd> [<f>]
171 Print help for one command and exit.
172 The cmake-commands(7) manual entry for <cmd> is printed in a
174 human-readable text format. The help is printed to a named
175 <f>ile if given.
176 --help-command-list [<f>]
178 List commands with help available and exit.
179 The list contains all commands for which help may be obtained by
181 using the --help-command option followed by a command name. The
182 help is printed to a named <f>ile if given.
183 --help-commands [<f>]
185 Print cmake-commands manual and exit.
186 The cmake-commands(7) manual is printed in a human-readable text
188 format. The help is printed to a named <f>ile if given.
189 --help-module <mod> [<f>]
191 Print help for one module and exit.
192 The cmake-modules(7) manual entry for <mod> is printed in a
194 human-readable text format. The help is printed to a named
195 <f>ile if given.
196 --help-module-list [<f>]
198 List modules with help available and exit.
199 The list contains all modules for which help may be obtained by
201 using the --help-module option followed by a module name. The
202 help is printed to a named <f>ile if given.
203 --help-modules [<f>]
205 Print cmake-modules manual and exit.
206 The cmake-modules(7) manual is printed in a human-readable text
208 format. The help is printed to a named <f>ile if given.
209 --help-policy <cmp> [<f>]
211 Print help for one policy and exit.
212 The cmake-policies(7) manual entry for <cmp> is printed in a
214 human-readable text format. The help is printed to a named
215 <f>ile if given.
216 --help-policy-list [<f>]
218 List policies with help available and exit.
219 The list contains all policies for which help may be obtained by
221 using the --help-policy option followed by a policy name. The
222 help is printed to a named <f>ile if given.
223 --help-policies [<f>]
225 Print cmake-policies manual and exit.
226 The cmake-policies(7) manual is printed in a human-readable text
228 format. The help is printed to a named <f>ile if given.
229 --help-property <prop> [<f>]
231 Print help for one property and exit.
232 The cmake-properties(7) manual entries for <prop> are printed in
234 a human-readable text format. The help is printed to a named
235 <f>ile if given.
236 --help-property-list [<f>]
238 List properties with help available and exit.
239 The list contains all properties for which help may be obtained
241 by using the --help-property option followed by a property name.
242 The help is printed to a named <f>ile if given.
243 --help-properties [<f>]
245 Print cmake-properties manual and exit.
246 The cmake-properties(7) manual is printed in a human-readable
248 text format. The help is printed to a named <f>ile if given.
249 --help-variable <var> [<f>]
251 Print help for one variable and exit.
252 The cmake-variables(7) manual entry for <var> is printed in a
254 human-readable text format. The help is printed to a named
255 <f>ile if given.
256 --help-variable-list [<f>]
258 List variables with help available and exit.
259 The list contains all variables for which help may be obtained
261 by using the --help-variable option followed by a variable name.
262 The help is printed to a named <f>ile if given.
263 --help-variables [<f>]
265 Print cmake-variables manual and exit.
266 The cmake-variables(7) manual is printed in a human-readable
268 text format. The help is printed to a named <f>ile if given.
269
271 The following resources are available to get help using CMake:
272 Home Page
274 https://cmake.org
275 The primary starting point for learning about CMake.
277 Frequently Asked Questions
279 https://cmake.org/Wiki/CMake_FAQ
280 A Wiki is provided containing answers to frequently asked ques‐
282 tions.
283 Online Documentation
285 https://cmake.org/documentation
286 Links to available documentation may be found on this web page.
288 Mailing List
290 https://cmake.org/mailing-lists
291 For help and discussion about using cmake, a mailing list is
293 provided at cmake@cmake.org. The list is member-post-only but
294 one may sign up on the CMake web page. Please first read the
295 full documentation at https://cmake.org before posting questions
296 to the list.
297
299 2000-2018 Kitware, Inc. and Contributors
3003.11.4 May 13, 2019 CCMAKE(1)