ccmake3(1)
NAME
ccmake – CMake Curses Dialog Command-Line Reference
SYNOPSIS
ccmake3 [<options>] (<path-to-source> | <path-to-existing-build>)
DESCRIPTION
The "ccmake3" executable is the CMake curses interface. Project configuration settings may be specified interactively through this GUI. Brief instructions are provided at the bottom of the terminal when the program is running.
CMake is a cross-platform build system generator. Projects specify their build process with platform-independent CMake listfiles included in each directory of a source tree with the name CMakeLists.txt. Users build a project by using CMake to generate a build system for a native tool on their platform.
OPTIONS
-C <initial-cache>- Pre-load a script to populate the cache.
-D <var>:<type>=<value>, -D <var>=<value>- Create a cmake cache entry.
-U <globbing_expr>- Remove matching entries from CMake cache.
-G <generator-name>- Specify a build system generator.
-T <toolset-name>- Specify toolset name if supported by generator.
-A <platform-name>- Specify platform name if supported by generator.
-Wno-dev- Suppress developer warnings.
-Wdev- Enable developer warnings.
-Werror=dev- Make developer warnings errors.
-Wno-error=dev- Make developer warnings not errors.
-Wdeprecated- Enable deprecated functionality warnings.
-Wno-deprecated- Suppress deprecated functionality warnings.
-Werror=deprecated- Make deprecated macro and function warnings errors.
-Wno-error=deprecated- Make deprecated macro and function warnings not errors.
–help,-help,-usage,-h,-H,/?- Print usage information and exit.
–version,-version,/V [<f>]- Show program name/version banner and exit.
–help-full [<f>]- Print all help manuals and exit.
–help-manual <man> [<f>]- Print one help manual and exit.
–help-manual-list [<f>]- List help manuals available and exit.
–help-command <cmd> [<f>]- Print help for one command and exit.
–help-command-list [<f>]- List commands with help available and exit.
–help-commands [<f>]- Print cmake-commands manual and exit.
–help-module <mod> [<f>]- Print help for one module and exit.
–help-module-list [<f>]- List modules with help available and exit.
–help-modules [<f>]- Print cmake-modules manual and exit.
–help-policy <cmp> [<f>]- Print help for one policy and exit.
–help-policy-list [<f>]- List policies with help available and exit.
–help-policies [<f>]- Print cmake-policies manual and exit.
–help-property <prop> [<f>]- Print help for one property and exit.
–help-property-list [<f>]- List properties with help available and exit.
–help-properties [<f>]- Print cmake-properties manual and exit.
–help-variable <var> [<f>]- Print help for one variable and exit.
–help-variable-list [<f>]- List variables with help available and exit.
–help-variables [<f>]- Print cmake-variables manual and exit.
When cmake is first run in an empty build tree, it creates a CMakeCache.txt file and populates it with customizable settings for the project. This option may be used to specify a file from which to load cache entries before the first pass through the project’s cmake listfiles. The loaded entries take priority over the project’s default values. The given file should be a CMake script containing SET commands that use the CACHE option, not a cache-format file.
When cmake is first run in an empty build tree, it creates a CMakeCache.txt file and populates it with customizable settings for the project. This option may be used to specify a setting that takes priority over the project’s default value. The option may be repeated for as many cache entries as desired.
If the :<type> portion is given it must be one of the types specified by the set() command documentation for its CACHE signature. If the :<type> portion is omitted the entry will be created with no type if it does not exist with a type already. If a command in the project sets the type to PATH or FILEPATH then the <value> will be converted to an absolute path.
This option may also be given as a single argument: -D<var>:<type>=<value> or -D<var>=<value>.
This option may be used to remove one or more variables from the CMakeCache.txt file, globbing expressions using * and ? are supported. The option may be repeated for as many cache entries as desired.
Use with care, you can make your CMakeCache.txt non-working.
CMake may support multiple native build systems on certain platforms. A generator is responsible for generating a particular build system. Possible generator names are specified in the cmake-generators(7) manual.
Some CMake generators support a toolset name to be given to the native build system to choose a compiler. This is supported only on specific generators:
Visual Studio >= 10 Xcode >= 3.0
See native build system documentation for allowed toolset names.
Some CMake generators support a platform name to be given to the native build system to choose a compiler or SDK. This is supported only on specific generators:
Visual Studio >= 8
See native build system documentation for allowed platform names.
Suppress warnings that are meant for the author of the CMakeLists.txt files. By default this will also turn off deprecation warnings.
Enable warnings that are meant for the author of the CMakeLists.txt files. By default this will also turn on deprecation warnings.
Make warnings that are meant for the author of the CMakeLists.txt files errors. By default this will also turn on deprecated warnings as errors.
Make warnings that are meant for the author of the CMakeLists.txt files not errors. By default this will also turn off deprecated warnings as errors.
Enable warnings for usage of deprecated functionality, that are meant for the author of the CMakeLists.txt files.
Suppress warnings for usage of deprecated functionality, that are meant for the author of the CMakeLists.txt files.
Make warnings for usage of deprecated macros and functions, that are meant for the author of the CMakeLists.txt files, errors.
Make warnings for usage of deprecated macros and functions, that are meant for the author of the CMakeLists.txt files, not errors.
Usage describes the basic command line interface and its options.
If a file is specified, the version is written into it. The help is printed to a named <f>ile if given.
All manuals are printed in a human-readable text format. The help is printed to a named <f>ile if given.
The specified manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all manuals for which help may be obtained by using the –help-manual option followed by a manual name. The help is printed to a named <f>ile if given.
The cmake-commands(7) manual entry for <cmd> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all commands for which help may be obtained by using the –help-command option followed by a command name. The help is printed to a named <f>ile if given.
The cmake-commands(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The cmake-modules(7) manual entry for <mod> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all modules for which help may be obtained by using the –help-module option followed by a module name. The help is printed to a named <f>ile if given.
The cmake-modules(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The cmake-policies(7) manual entry for <cmp> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all policies for which help may be obtained by using the –help-policy option followed by a policy name. The help is printed to a named <f>ile if given.
The cmake-policies(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The cmake-properties(7) manual entries for <prop> are printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all properties for which help may be obtained by using the –help-property option followed by a property name. The help is printed to a named <f>ile if given.
The cmake-properties(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The cmake-variables(7) manual entry for <var> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The list contains all variables for which help may be obtained by using the –help-variable option followed by a variable name. The help is printed to a named <f>ile if given.
The cmake-variables(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
SEE ALSO
The following resources are available to get help using CMake:
Home Page- https://cmake.org
Frequently Asked Questions- https://cmake.org/Wiki/CMake_FAQ
Online Documentation- https://cmake.org/documentation
Mailing List- https://cmake.org/mailing-lists
The primary starting point for learning about CMake.
A Wiki is provided containing answers to frequently asked questions.
Links to available documentation may be found on this web page.
For help and discussion about using cmake, a mailing list is provided at cmake [at] cmake.org. The list is member-post-only but one may sign up on the CMake web page. Please first read the full documentation at https://cmake.org before posting questions to the list.
COPYRIGHT
2000-2016 Kitware, Inc.