cmake/man/man1/ccmake.1

.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CCMAKE" "1" "Jan 23, 2025" "3.31.5" "CMake"
.SH NAME
ccmake \- CMake Curses Dialog Command-Line Reference
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
ccmake [<options>] \-B <path\-to\-build> [\-S <path\-to\-source>]
ccmake [<options>] <path\-to\-source | path\-to\-existing\-build>
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
The \fBccmake\fP 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.
.sp
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 \fBCMakeLists.txt\fP\&.
Users build a project by using CMake to generate a build system for a
native tool on their platform.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-S <path\-to\-source>
Path to root directory of the CMake project to build.
.UNINDENT
.INDENT 0.0
.TP
.B \-B <path\-to\-build>
Path to directory which CMake will use as the root of build directory.
.sp
If the directory doesn\(aqt already exist CMake will make it.
.UNINDENT
.INDENT 0.0
.TP
.B \-C <initial\-cache>
Pre\-load a script to populate the cache.
.sp
When CMake is first run in an empty build tree, it creates a
\fBCMakeCache.txt\fP 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\(aqs
CMake listfiles.  The loaded entries take priority over the
project\(aqs default values.  The given file should be a CMake script
containing \X'tty: link #command:set'\fI\%set()\fP\X'tty: link' commands that use the \fBCACHE\fP option, not a
cache\-format file.
.sp
References to \X'tty: link #variable:CMAKE_SOURCE_DIR'\fI\%CMAKE_SOURCE_DIR\fP\X'tty: link' and \X'tty: link #variable:CMAKE_BINARY_DIR'\fI\%CMAKE_BINARY_DIR\fP\X'tty: link'
within the script evaluate to the top\-level source and build tree.
.UNINDENT
.INDENT 0.0
.TP
.B \-D <var>:<type>=<value>, \-D <var>=<value>
Create or update a CMake \fBCACHE\fP entry.
.sp
When CMake is first run in an empty build tree, it creates a
\fBCMakeCache.txt\fP 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\(aqs default value.  The option may be
repeated for as many \fBCACHE\fP entries as desired.
.sp
If the \fB:<type>\fP portion is given it must be one of the types
specified by the \X'tty: link #command:set'\fI\%set()\fP\X'tty: link' command documentation for its
\fBCACHE\fP signature.
If the \fB:<type>\fP 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 \fBPATH\fP or \fBFILEPATH\fP
then the \fB<value>\fP will be converted to an absolute path.
.sp
This option may also be given as a single argument:
\fB\-D<var>:<type>=<value>\fP or \fB\-D<var>=<value>\fP\&.
.sp
It\(aqs important to note that the order of \fB\-C\fP and \fB\-D\fP arguments is
significant. They will be carried out in the order they are listed, with the
last argument taking precedence over the previous ones. For example, if you
specify \fB\-DCMAKE_BUILD_TYPE=Debug\fP, followed by a \fB\-C\fP argument with a
file that calls:
.INDENT 7.0
.INDENT 3.5
.sp
.nf
.ft C
set(CMAKE_BUILD_TYPE \(dqRelease\(dq CACHE STRING \(dq\(dq FORCE)
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
then the \fB\-C\fP argument will take precedence, and \fBCMAKE_BUILD_TYPE\fP will
be set to \fBRelease\fP\&. However, if the \fB\-D\fP argument comes after the \fB\-C\fP
argument, it will be set to \fBDebug\fP\&.
.sp
If a \fBset(... CACHE ...)\fP call in the \fB\-C\fP file does not use \fBFORCE\fP,
and a \fB\-D\fP argument sets the same variable, the \fB\-D\fP argument will take
precedence regardless of order because of the nature of non\-\fBFORCE\fP
\fBset(... CACHE ...)\fP calls.
.UNINDENT
.INDENT 0.0
.TP
.B \-U <globbing_expr>
Remove matching entries from CMake \fBCACHE\fP\&.
.sp
This option may be used to remove one or more variables from the
\fBCMakeCache.txt\fP file, globbing expressions using \fB*\fP and \fB?\fP are
supported.  The option may be repeated for as many \fBCACHE\fP entries as
desired.
.sp
Use with care, you can make your \fBCMakeCache.txt\fP non\-working.
.UNINDENT
.INDENT 0.0
.TP
.B \-G <generator\-name>
Specify a build system generator.
.sp
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
\X'tty: link #manual:cmake-generators(7)'\fI\%cmake\-generators(7)\fP\X'tty: link' manual.
.sp
If not specified, CMake checks the \X'tty: link #envvar:CMAKE_GENERATOR'\fI\%CMAKE_GENERATOR\fP\X'tty: link' environment
variable and otherwise falls back to a builtin default selection.
.UNINDENT
.INDENT 0.0
.TP
.B \-T <toolset\-spec>
Toolset specification for the generator, if supported.
.sp
Some CMake generators support a toolset specification to tell
the native build system how to choose a compiler.  See the
\X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' variable for details.
.UNINDENT
.INDENT 0.0
.TP
.B \-A <platform\-name>
Specify platform name if supported by generator.
.sp
Some CMake generators support a platform name to be given to the
native build system to choose a compiler or SDK.  See the
\X'tty: link #variable:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link' variable for details.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-toolchain <path\-to\-file>
Added in version 3.21.

.sp
Specify the cross compiling toolchain file, equivalent to setting
\X'tty: link #variable:CMAKE_TOOLCHAIN_FILE'\fI\%CMAKE_TOOLCHAIN_FILE\fP\X'tty: link' variable. Relative paths are interpreted as
relative to the build directory, and if not found, relative to the source
directory.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-install\-prefix <directory>
Added in version 3.21.

.sp
Specify the installation directory, used by the
\X'tty: link #variable:CMAKE_INSTALL_PREFIX'\fI\%CMAKE_INSTALL_PREFIX\fP\X'tty: link' variable. Must be an absolute path.
.UNINDENT
.INDENT 0.0
.TP
.B \-Wno\-dev
Suppress developer warnings.
.sp
Suppress warnings that are meant for the author of the
\fBCMakeLists.txt\fP files. By default this will also turn off
deprecation warnings.
.UNINDENT
.INDENT 0.0
.TP
.B \-Wdev
Enable developer warnings.
.sp
Enable warnings that are meant for the author of the \fBCMakeLists.txt\fP
files. By default this will also turn on deprecation warnings.
.UNINDENT
.INDENT 0.0
.TP
.B \-Wdeprecated
Enable deprecated functionality warnings.
.sp
Enable warnings for usage of deprecated functionality, that are meant
for the author of the \fBCMakeLists.txt\fP files.
.UNINDENT
.INDENT 0.0
.TP
.B \-Wno\-deprecated
Suppress deprecated functionality warnings.
.sp
Suppress warnings for usage of deprecated functionality, that are meant
for the author of the \fBCMakeLists.txt\fP files.
.UNINDENT
.INDENT 0.0
.TP
.B \-Werror=<what>
Treat CMake warnings as errors. \fB<what>\fP must be one of the following:
.INDENT 7.0
.TP
.B \fBdev\fP
Make developer warnings errors.
.sp
Make warnings that are meant for the author of the \fBCMakeLists.txt\fP files
errors. By default this will also turn on deprecated warnings as errors.
.TP
.B \fBdeprecated\fP
Make deprecated macro and function warnings errors.
.sp
Make warnings for usage of deprecated macros and functions, that are meant
for the author of the \fBCMakeLists.txt\fP files, errors.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-Wno\-error=<what>
Do not treat CMake warnings as errors. \fB<what>\fP must be one of the following:
.INDENT 7.0
.TP
.B \fBdev\fP
Make warnings that are meant for the author of the \fBCMakeLists.txt\fP files not
errors. By default this will also turn off deprecated warnings as errors.
.TP
.B \fBdeprecated\fP
Make warnings for usage of deprecated macros and functions, that are meant
for the author of the \fBCMakeLists.txt\fP files, not errors.
.UNINDENT
.UNINDENT
.INDENT 0.0
.TP
.B \-version [<file>], \-\-version [<file>], /V [<file>]
Show program name/version banner and exit.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-H, \-\-help, \-help, \-usage, /?
Print usage information and exit.
.sp
Usage describes the basic command line interface and its options.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help <keyword> [<file>]
Print help for one CMake keyword.
.sp
\fB<keyword>\fP can be a property, variable, command, policy, generator
or module.
.sp
The relevant manual entry for \fB<keyword>\fP is
printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.sp
Changed in version 3.28: Prior to CMake 3.28, this option supported command names only.

.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-full [<file>]
Print all help manuals and exit.
.sp
All manuals are printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-manual <man> [<file>]
Print one help manual and exit.
.sp
The specified manual is printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-manual\-list [<file>]
List help manuals available and exit.
.sp
The list contains all manuals for which help may be obtained by
using the \fB\-\-help\-manual\fP option followed by a manual name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-command <cmd> [<file>]
Print help for one command and exit.
.sp
The \X'tty: link #manual:cmake-commands(7)'\fI\%cmake\-commands(7)\fP\X'tty: link' manual entry for \fB<cmd>\fP is
printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-command\-list [<file>]
List commands with help available and exit.
.sp
The list contains all commands for which help may be obtained by
using the \fB\-\-help\-command\fP option followed by a command name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-commands [<file>]
Print cmake\-commands manual and exit.
.sp
The \X'tty: link #manual:cmake-commands(7)'\fI\%cmake\-commands(7)\fP\X'tty: link' manual is printed in a
human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-module <mod> [<file>]
Print help for one module and exit.
.sp
The \X'tty: link #manual:cmake-modules(7)'\fI\%cmake\-modules(7)\fP\X'tty: link' manual entry for \fB<mod>\fP is printed
in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-module\-list [<file>]
List modules with help available and exit.
.sp
The list contains all modules for which help may be obtained by
using the \fB\-\-help\-module\fP option followed by a module name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-modules [<file>]
Print cmake\-modules manual and exit.
.sp
The \X'tty: link #manual:cmake-modules(7)'\fI\%cmake\-modules(7)\fP\X'tty: link' manual is printed in a human\-readable
text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-policy <cmp> [<file>]
Print help for one policy and exit.
.sp
The \X'tty: link #manual:cmake-policies(7)'\fI\%cmake\-policies(7)\fP\X'tty: link' manual entry for \fB<cmp>\fP is
printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-policy\-list [<file>]
List policies with help available and exit.
.sp
The list contains all policies for which help may be obtained by
using the \fB\-\-help\-policy\fP option followed by a policy name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-policies [<file>]
Print cmake\-policies manual and exit.
.sp
The \X'tty: link #manual:cmake-policies(7)'\fI\%cmake\-policies(7)\fP\X'tty: link' manual is printed in a
human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-property <prop> [<file>]
Print help for one property and exit.
.sp
The \X'tty: link #manual:cmake-properties(7)'\fI\%cmake\-properties(7)\fP\X'tty: link' manual entries for \fB<prop>\fP are
printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-property\-list [<file>]
List properties with help available and exit.
.sp
The list contains all properties for which help may be obtained by
using the \fB\-\-help\-property\fP option followed by a property name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-properties [<file>]
Print cmake\-properties manual and exit.
.sp
The \X'tty: link #manual:cmake-properties(7)'\fI\%cmake\-properties(7)\fP\X'tty: link' manual is printed in a
human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-variable <var> [<file>]
Print help for one variable and exit.
.sp
The \X'tty: link #manual:cmake-variables(7)'\fI\%cmake\-variables(7)\fP\X'tty: link' manual entry for \fB<var>\fP is
printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-variable\-list [<file>]
List variables with help available and exit.
.sp
The list contains all variables for which help may be obtained by
using the \fB\-\-help\-variable\fP option followed by a variable name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-variables [<file>]
Print cmake\-variables manual and exit.
.sp
The \X'tty: link #manual:cmake-variables(7)'\fI\%cmake\-variables(7)\fP\X'tty: link' manual is printed in a
human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.SH SEE ALSO
.sp
The following resources are available to get help using CMake:
.INDENT 0.0
.TP
.B Home Page
\X'tty: link https://cmake.org'\fI\%https://cmake.org\fP\X'tty: link'
.sp
The primary starting point for learning about CMake.
.TP
.B Online Documentation and Community Resources
\X'tty: link https://cmake.org/documentation'\fI\%https://cmake.org/documentation\fP\X'tty: link'
.sp
Links to available documentation and community resources may be
found on this web page.
.TP
.B Discourse Forum
\X'tty: link https://discourse.cmake.org'\fI\%https://discourse.cmake.org\fP\X'tty: link'
.sp
The Discourse Forum hosts discussion and questions about CMake.
.UNINDENT
.SH COPYRIGHT
2000-2024 Kitware, Inc. and Contributors
.\" Generated by docutils manpage writer.
.