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 是一个跨平台的构建系统生成器。项目通过包含在源代码树每个目录中名为 CMakeLists.txt 的平台无关 CMake 列表文件来指定其构建过程。用户通过使用 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
此网页上可以找到可用文档和社区资源的链接。
- 论坛
-
论坛用于讨论和提问 CMake。