cmake-gui(1)¶
概要¶
cmake-gui [<options>]
cmake-gui [<options>] -B <path-to-build> [-S <path-to-source>]
cmake-gui [<options>] <path-to-source | path-to-existing-build>
cmake-gui [<options>] --browse-manual [<filename>]
描述¶
cmake-gui 可执行文件是 CMake GUI。项目配置设置可以交互式地指定。程序运行时，窗口底部会提供简要说明。
CMake 是一个跨平台构建系统生成器。项目使用平台无关的 CMake 列表文件（包含在源树的每个目录中，文件名为 CMakeLists.txt）来指定其构建过程。用户通过使用 CMake 为其平台上的原生工具生成构建系统来构建项目。
选项¶
- -S <path-to-source>¶
CMake 项目根目录的路径，用于构建。
- -B <path-to-build>¶
CMake 将用作构建目录根目录的路径。
如果该目录尚不存在，CMake 将创建它。
- --browse-manual [<filename>]¶
在浏览器中打开 CMake 参考手册并立即退出。如果指定了
<filename>，则在该参考手册中打开该文件，而不是index.html。
- -version [<file>], --version [<file>], /V [<file>]¶
显示程序名称/版本横幅并退出。如果给定，输出将打印到指定的
<file>。
- -h, -H, --help, -help, -usage, /?¶
打印用法信息并退出。
用法描述了基本的命令行界面及其选项。
- --help <keyword> [<file>]¶
打印一个 CMake 关键字的帮助信息。
<keyword>可以是属性、变量、命令、策略、生成器或模块。以人类可读的文本格式打印
<keyword>的相关手册条目。如果给定，输出将打印到指定的<file>。在 3.28 版本中变更: 在 CMake 3.28 之前，此选项仅支持命令名称。
- --help-full [<file>]¶
打印所有帮助手册并退出。
所有手册都以人类可读的文本格式打印。如果给定，输出将打印到指定的
<file>。
- --help-manual <man> [<file>]¶
打印一个帮助手册并退出。
指定的手册以人类可读的文本格式打印。如果给定，输出将打印到指定的
<file>。
- --help-manual-list [<file>]¶
列出可用的帮助手册并退出。
该列表包含所有手册，可以使用
--help-manual选项后跟手册名称来获取这些手册的帮助。如果给定，输出将打印到指定的<file>。
- --help-command <cmd> [<file>]¶
打印一个命令的帮助信息并退出。
以人类可读的文本格式打印
<cmd>的cmake-commands(7)手册条目。如果给定，输出将打印到指定的<file>。
- --help-command-list [<file>]¶
列出可用的命令帮助并退出。
该列表包含所有命令，可以使用
--help-command选项后跟命令名称来获取这些命令的帮助。如果给定，输出将打印到指定的<file>。
- --help-commands [<file>]¶
打印 cmake-commands 手册并退出。
以人类可读的文本格式打印
cmake-commands(7)手册。如果给定，输出将打印到指定的<file>。
- --help-module <mod> [<file>]¶
打印一个模块的帮助信息并退出。
以人类可读的文本格式打印
<mod>的cmake-modules(7)手册条目。如果给定，输出将打印到指定的<file>。
- --help-module-list [<file>]¶
列出可用的模块帮助并退出。
该列表包含所有模块，可以使用
--help-module选项后跟模块名称来获取这些模块的帮助。如果给定，输出将打印到指定的<file>。
- --help-modules [<file>]¶
打印 cmake-modules 手册并退出。
以人类可读的文本格式打印
cmake-modules(7)手册。如果给定，输出将打印到指定的<file>。
- --help-policy <cmp> [<file>]¶
打印一个策略的帮助信息并退出。
以人类可读的文本格式打印
<cmp>的cmake-policies(7)手册条目。如果给定，输出将打印到指定的<file>。
- --help-policy-list [<file>]¶
列出可用的策略帮助并退出。
该列表包含所有策略，可以使用
--help-policy选项后跟策略名称来获取这些策略的帮助。如果给定，输出将打印到指定的<file>。
- --help-policies [<file>]¶
打印 cmake-policies 手册并退出。
以人类可读的文本格式打印
cmake-policies(7)手册。如果给定，输出将打印到指定的<file>。
- --help-property <prop> [<file>]¶
打印一个属性的帮助信息并退出。
以人类可读的文本格式打印
<prop>的cmake-properties(7)手册条目。如果给定，输出将打印到指定的<file>。
- --help-property-list [<file>]¶
列出可用的属性帮助并退出。
该列表包含所有属性，可以使用
--help-property选项后跟属性名称来获取这些属性的帮助。如果给定，输出将打印到指定的<file>。
- --help-properties [<file>]¶
打印 cmake-properties 手册并退出。
以人类可读的文本格式打印
cmake-properties(7)手册。如果给定，输出将打印到指定的<file>。
- --help-variable <var> [<file>]¶
打印一个变量的帮助信息并退出。
以人类可读的文本格式打印
<var>的cmake-variables(7)手册条目。如果给定，输出将打印到指定的<file>。
- --help-variable-list [<file>]¶
列出可用的变量帮助并退出。
该列表包含所有变量，可以使用
--help-variable选项后跟变量名称来获取这些变量的帮助。如果给定，输出将打印到指定的<file>。
- --help-variables [<file>]¶
打印 cmake-variables 手册并退出。
以人类可读的文本格式打印
cmake-variables(7)手册。如果给定，输出将打印到指定的<file>。
参见¶
以下资源可用于获取 CMake 使用方面的帮助
- 主页
-
了解 CMake 的主要起点。
- 在线文档和社区资源
https://cmake.com.cn/documentation
可用的文档和社区资源的链接可以在此网页上找到。
- Discourse 论坛
-
Discourse 论坛托管关于 CMake 的讨论和问题。