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>]¶
打印一个命令的帮助并退出。
cmake-commands(7)手册条目，用于<cmd>以人类可读的文本格式输出。如果指定了特定<file>，则将输出内容输出到该文件。
- --help-command-list [<file>]¶
列出有可用的帮助的命令，然后退出。
此列表包含所有命令，可以通过使用
--help-command选项，后跟命令名称来获取对应的帮助。如果指定了特定<file>，则将输出内容输出到该文件。
- --help-commands [<file>]¶
打印 cmake-commands 手册，然后退出。
cmake-commands(7)手册以人类可读的文本格式输出。如果指定了特定<file>，则将输出内容输出到该文件。
- --help-module <mod> [<file>]¶
打印一个模块的帮助，然后退出。
cmake-modules(7)手册条目，用于<mod>以人类可读的文本格式输出。如果指定了特定<file>，则将输出内容输出到该文件。
- --help-module-list [<file>]¶
列出有可用的帮助的模块，然后退出。
此列表包含所有模块，可以通过使用
--help-module选项，后跟模块名称来获取对应的帮助。如果指定了特定<file>，则将输出内容输出到该文件。
- --help-modules [<file>]¶
打印 cmake-modules 手册，然后退出。
cmake-modules(7)手册以人类可读的文本格式输出。如果指定了特定<file>，则将输出内容输出到该文件。
- --help-policy <cmp> [<file>]¶
打印一个策略的帮助，然后退出。
cmake-policies(7)<cmp>手册分录以可读的文本格式打印。如果给出，则输出打印到一个已命名的<file>中。
- --help-policy-list [<file>]¶
列出可获得帮助的策略并退出。
此列表包含所有策略，可以通过使用
--help-policy选项后跟策略名称获得帮助。如果给出，则输出打印到一个已命名的<file>中。
- --help-policies [<file>]¶
打印 cmake-policies 手册并退出。
cmake-policies(7)手册以可读的文本格式打印。如果给出，则输出打印到一个已命名的<file>中。
- --help-property <prop> [<file>]¶
打印一个属性的帮助并退出。
cmake-properties(7)代码的<prop>手册分录以可度文本格式打印。如果给出，则输出打印到一个已命名的<file>中。
- --help-property-list [<file>]¶
列出有帮助可获得的属性并退出。
此列表包含所有属性，可以通过使用
--help-property选项后跟属性名称来获得帮助。如果给出，则输出打印到一个已命名的<file>中。
- --help-properties [<file>]¶
打印 cmake-properties 手册并退出。
cmake-properties(7)手册以可读的文本格式打印。如果给出，则输出打印到一个已命名的<file>中。
- --help-variable <var> [<file>]¶
为一个变量打印帮助并退出。
cmake-variables(7)手册<var>的条目以人类可读的文本格式打印。如果已给定，则输出会打印到具有指定名称的<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 的讨论和问题。