OS Manuals

/usr/bin/ccmake

CMake is an open-source, cross-platform family of tools designed to build, test and package software

From cmake 4.4.5-r0 (os), captured 2026-11-05 by running ccmake --help (exit 0). permalink

Also provided by 1 other package version
Usage

  ccmake <path-to-source>
  ccmake <path-to-existing-build>

Specify a source directory to (re-)generate a build system for it in the
current working directory.  Specify an existing build directory to
re-generate its build system.

Options
  -S <path-to-source>          = Explicitly specify a source directory.
  -B <path-to-build>           = Explicitly specify a build directory.
  -C <initial-cache>           = Pre-load a script to populate the cache.
  -D <var>[:<type>]=<value>    = Create or update 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.
  --toolchain <file>           = Specify toolchain file
                                 [CMAKE_TOOLCHAIN_FILE].
  --install-prefix <directory> = Specify install directory
                                 [CMAKE_INSTALL_PREFIX].
  --project-file <project-file-name>
                               = Specify an alternate project file name.
  -W<category>                 = Enable the specified category of warnings.
  -Wno-<category>              = Suppress the specified category of warnings.
  -Werror=<category>           = Make the specified category of warnings
                                 errors.
  -Wno-error=<category>        = Make the specified category of warnings not
                                 errors.
  -h,-H,--help,-help,-usage,/? = Print usage information and exit.
  --version[=json-v1],-version[=json-v1],/V[=json-v1],/version[=json-v1] [<file>]
                               = Print version number and exit.
  --help <keyword> [<file>]    = Print help for one keyword and exit.
  --help-full [<file>]         = Print all help manuals and exit.
  --help-manual <man> [<file>] = Print one help manual and exit.
  --help-manual-list [<file>]  = List help manuals available and exit.
  --help-command <cmd> [<file>]= Print help for one command and exit.
  --help-command-list [<file>] = List commands with help available and exit.
  --help-commands [<file>]     = Print cmake-commands manual and exit.
  --help-diagnostic <diag> [<file>]
                               = Print help for one diagnostic and exit.
  --help-diagnostic-list [<file>]
                               = List diagnostics with help available and
                                 exit.
  --help-diagnostics [<file>]  = Print cmake-diagnostics manual and exit.
  --help-module <mod> [<file>] = Print help for one module and exit.
  --help-module-list [<file>]  = List modules with help available and exit.
  --help-modules [<file>]      = Print cmake-modules manual and exit.
  --help-policy <cmp> [<file>] = Print help for one policy and exit.
  --help-policy-list [<file>]  = List policies with help available and exit.
  --help-policies [<file>]     = Print cmake-policies manual and exit.
  --help-property <prop> [<file>]
                               = Print help for one property and exit.
  --help-property-list [<file>]= List properties with help available and
                                 exit.
  --help-properties [<file>]   = Print cmake-properties manual and exit.
  --help-variable var [<file>] = Print help for one variable and exit.
  --help-variable-list [<file>]= List variables with help available and exit.
  --help-variables [<file>]    = Print cmake-variables manual and exit.

Generators

The following generators are available on this platform (* marks default):
  Green Hills MULTI            = Generates Green Hills MULTI files
                                 (experimental, work-in-progress).
* Unix Makefiles               = Generates standard UNIX makefiles.
  Ninja                        = Generates build.ninja files.
  Ninja Multi-Config           = Generates build-<Config>.ninja files.
  FASTBuild                    = Generates fbuild.bff files.
  Watcom WMake                 = Generates Watcom WMake makefiles.
  CodeBlocks - Ninja           = Generates CodeBlocks project files
                                 (deprecated).
  CodeBlocks - Unix Makefiles  = Generates CodeBlocks project files
                                 (deprecated).
  CodeLite - Ninja             = Generates CodeLite project files
                                 (deprecated).
  CodeLite - Unix Makefiles    = Generates CodeLite project files
                                 (deprecated).
  Eclipse CDT4 - Ninja         = Generates Eclipse CDT 4.0 project files
                                 (deprecated).
  Eclipse CDT4 - Unix Makefiles= Generates Eclipse CDT 4.0 project files
                                 (deprecated).
  Kate - Ninja                 = Generates Kate project files (deprecated).
  Kate - Ninja Multi-Config    = Generates Kate project files (deprecated).
  Kate - Unix Makefiles        = Generates Kate project files (deprecated).
  Sublime Text 2 - Ninja       = Generates Sublime Text 2 project files
                                 (deprecated).
  Sublime Text 2 - Unix Makefiles
                               = Generates Sublime Text 2 project files
                                 (deprecated).
Options (27)
OptionDescriptionSource
-S path-to-source= Explicitly specify a source directory.help
-B path-to-build= Explicitly specify a build directory.help
-C initial-cache= Pre-load a script to populate the cache.help
-D var>[:<type>]=<value= Create or update a cmake cache entry.help
-U globbing_expr= Remove matching entries from CMake cache.help
-G generator-name= Specify a build system generator.help
-T toolset-name= Specify toolset name if supported by generator.help
-A platform-name= Specify platform name if supported by generator.help
--toolchain file= Specify toolchain file [CMAKE_TOOLCHAIN_FILE].help
--project-file project-file-name= Specify an alternate project file name.help
-W category= Enable the specified category of warnings.help
-Wno- category= Suppress the specified category of warnings.help
-Werror category= Make the specified category of warnings errors.help
-Wno-error category= Make the specified category of warnings not errors.help
--version, -version json-v1= Print version number and exit.help
--help keyword= Print help for one keyword and exit.help
--help-full file= Print all help manuals and exit.help
--help-manual-list file= List help manuals available and exit.help
--help-commands file= Print cmake-commands manual and exit.help
--help-diagnostic-list file= List diagnostics with help available and exit.help
--help-diagnostics file= Print cmake-diagnostics manual and exit.help
--help-module-list file= List modules with help available and exit.help
--help-modules file= Print cmake-modules manual and exit.help
--help-policy-list file= List policies with help available and exit.help
--help-policies file= Print cmake-policies manual and exit.help
--help-properties file= Print cmake-properties manual and exit.help
--help-variables file= Print cmake-variables manual and exit.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.