ccmake(1)¶
概要¶
ccmake [<options>] <path-to-source | path-to-existing-build>
描述¶
ccmake 可执行文件是 CMake curses 接口。可以通过此 GUI 以交互方式指定项目配置设置。程序运行时，终端底部会提供简要说明。
CMake 是一个跨平台构建系统生成器。项目使用独立于平台的 CMake 列表文件指定其构建过程，该列表文件包含在名为“CMakeLists.txt”的源代码树的每个目录中。用户通过使用 CMake 为他们平台上的原生工具生成构建系统来构建项目。
选项¶
- -S <path-to-source>¶
要构建的 CMake 项目的根目录路径。
- -B <path-to-build>¶
CMake 将用作构建目录根目录的目录路径。
如果该目录不存在，CMake 会创建它。
- -C <initial-cache>¶
预加载脚本以填充缓存。
当 CMake 首次在一个空的构建树中运行时，它会创建一个“CMakeCache.txt”文件并使用项目的可自定义设置填充它。此选项可用于指定在第一次通过项目的 CMake 列表文件之前加载缓存条目的文件。加载的条目优先于项目的默认值。给定的文件应该是一个 CMake 脚本，其中包含使用
CACHE选项的set()命令，而不是缓存格式文件。脚本中对
CMAKE_SOURCE_DIR和CMAKE_BINARY_DIR的引用评估为顶级源代码和构建树。
- -D <var>:<type>=<value>, -D <var>=<value>¶
创建或更新 CMake
CACHE条目。当 CMake 首次在一个空的构建树中运行时，它会创建一个“CMakeCache.txt”文件并使用项目的可自定义设置填充它。此选项可用于指定优先于项目默认值的设置。可以根据需要为尽可能多的“CACHE”条目重复该选项。
如果给出了
:<type>部分，它必须是set()命令文档为其CACHE签名指定的类型之一。如果省略:<type>部分，如果条目不存在，则将创建没有类型的条目。如果项目中的命令将类型设置为“PATH”或“FILEPATH”，则“<value>”将转换为绝对路径。此选项也可以作为单个参数给出：
-D<var>:<type>=<value>或``-D<var>=<value>``。重要的是要注意“-C”和“-D”参数的顺序很重要。它们将按照列出的顺序执行，最后一个参数优先于前面的参数。例如，如果您指定“-DCMAKE_BUILD_TYPE=Debug”，后跟一个“-C”参数和一个调用的文件：
set(CMAKE_BUILD_TYPE "Release" CACHE STRING "" FORCE)
那么
-C参数将优先，CMAKE_BUILD_TYPE将设置为Release。但是，如果-D参数出现在-C参数之后，它将被设置为Debug。如果
-C文件中的set(... CACHE ...)调用不使用FORCE，而-D参数设置相同的变量，则由于非``FORCE``set(... CACHE ...)调用的性质，无论顺序如何，-D参数都将优先。
- -U <globbing_expr>¶
从 CMake
CACHE中删除匹配条目。此选项可用于从“CMakeCache.txt”文件中删除一个或多个变量，支持使用“*”和“?”的通配表达式。可以根据需要为尽可能多的“CACHE”条目重复该选项。
小心使用，你可以让你的
CMakeCache.txt不工作。
- -G <generator-name>¶
指定构建系统生成器。
CMake 可能在某些平台上支持多个本机构建系统。生成器负责生成特定的构建系统。可能的生成器名称在
cmake-generators(7)手册中指定。如果未指定，CMake 会检查
CMAKE_GENERATOR环境变量，否则会回退到内置默认选择。
- -T <toolset-spec>¶
生成器的工具集规范（如果支持）。
一些 CMake 生成器支持工具集规范来告诉本机构建系统如何选择编译器。有关详细信息，请参阅
CMAKE_GENERATOR_TOOLSET变量。
- -A <platform-name>¶
如果生成器支持，请指定平台名称。
一些 CMake 生成器支持将平台名称提供给本机构建系统以选择编译器或 SDK。有关详细信息，请参阅
CMAKE_GENERATOR_PLATFORM变量。
- --toolchain <path-to-file>¶
指定交叉编译工具链文件，相当于设置
CMAKE_TOOLCHAIN_FILE变量。
- --install-prefix <directory>¶
指定安装目录，由
CMAKE_INSTALL_PREFIX变量使用。必须是绝对路径。
- -Wno-dev¶
禁止开发人员警告。
抑制针对 CMakeLists.txt 文件作者的警告。默认情况下，这也会关闭弃用警告。
- -Wdev¶
启用开发人员警告。
启用针对 CMakeLists.txt 文件作者的警告。默认情况下，这也会打开弃用警告。
- -Wdeprecated¶
启用弃用的功能警告。
为使用已弃用的功能启用警告，这是针对
CMakeLists.txt文件的作者。
- -Wno-deprecated¶
禁止弃用的功能警告。
禁止使用已弃用功能的警告，这些警告是针对“CMakeLists.txt”文件的作者的。
- -Werror=<what>¶
将 CMake 警告视为错误。
<what>必须是以下之一：开发使开发人员警告错误。
为 CMakeLists.txt 文件错误的作者发出警告。默认情况下，这也会将不推荐使用的警告作为错误打开。
已弃用使不推荐使用的宏和函数警告错误。
对不推荐使用的宏和函数的使用发出警告，这是针对
CMakeLists.txt文件的作者，错误。
- -Wno-error=<what>¶
不要将 CMake 警告视为错误。
<what>必须是以下之一：开发发出针对
CMakeLists.txt文件而非错误的作者的警告。默认情况下，这也会将不推荐使用的警告作为错误关闭。已弃用对不推荐使用的宏和函数的使用发出警告，这是针对
CMakeLists.txt文件的作者，而不是错误。
- -h, -H, --help, -help, -usage, /?¶
打印使用信息并退出。
用法描述了基本的命令行界面及其选项。
- --help-command <cmd> [<file>]¶
打印一个命令的帮助并退出。
<cmd>的cmake-commands(7)手册条目以人类可读的文本格式打印。 |文件|
- --help-commands [<file>]¶
打印 cmake-commands 手册并退出。
cmake-commands(7)手册以人类可读的文本格式打印。 |文件|
- --help-module <mod> [<file>]¶
打印一个模块的帮助并退出。
<mod>的cmake-modules(7)手册条目以人类可读的文本格式打印。 |文件|
- --help-modules [<file>]¶
打印 cmake-modules 手册并退出。
cmake-modules(7)手册以人类可读的文本格式打印。 |文件|
- --help-policy <cmp> [<file>]¶
打印一项政策的帮助并退出。
<cmp>的cmake-policies(7)手册条目以人类可读的文本格式打印。 |文件|
- --help-policies [<file>]¶
打印 cmake-policies 手册并退出。
cmake-policies(7)手册以人类可读的文本格式打印。 |文件|
- --help-property <prop> [<file>]¶
打印一个属性的帮助并退出。
<prop>的cmake-properties(7)手册条目以人类可读的文本格式打印。 |文件|
- --help-properties [<file>]¶
打印 cmake-properties 手册并退出。
cmake-properties(7)手册以人类可读的文本格式打印。 |文件|
- --help-variable <var> [<file>]¶
打印一个变量的帮助并退出。
<var>的cmake-variables(7)手册条目以人类可读的文本格式打印。 |文件|
- --help-variables [<file>]¶
打印 cmake-variables 手册并退出。
cmake-variables(7)手册以人类可读的文本格式打印。 |文件|
也可以看看¶
以下资源可用于获取使用 CMake 的帮助：
- 主页
-
学习 CMake 的主要起点。
- 在线文档和社区资源
-
可在此网页上找到指向可用文档和社区资源的链接。
- 话语论坛
-
Discourse Forum 主持关于 CMake 的讨论和问题。