cpack(1)

概要

cpack [<options>]

描述

cpack 可执行文件是 CMake 打包程序。它生成各种格式的安装程序和源包。

对于每个安装程序或包格式， cpack 都有一个特定的后端，称为“生成器”。生成器负责生成所需的输入并调用特定的包创建工具。不要将这些安装程序或包生成器与 cmake 命令的 makefile 生成器混淆。

所有支持的生成器都在 cpack-generators 手册中指定。命令 cpack --help 打印目标平台支持的生成器列表。可以通过 CPACK_GENERATOR 变量或命令行选项 -G <cpack -G> 来选择要使用它们中的哪一个。

cpack 程序由以 CMake 语言 编写的配置文件控制。除非通过命令行选项 --config 选择不同，否则使用当前目录中的文件 CPackConfig.cmake。

在标准 CMake 工作流程中，文件“CPackConfig.cmake”由 cmake 可执行文件生成，前提是 CPack 模块包含在项目的“CMakeLists”中.txt`` 文件。

选项

-G <generators>

<generators> 是 分号分隔的生成器名称列表。 cpack 将遍历此列表并根据 CPackConfig.cmake 配置文件中提供的详细信息以该生成器的格式生成包。如果未给出此选项，CPACK_GENERATOR 变量将确定将使用的默认生成器集。

-C <configs>

指定要打包的项目配置（例如 Debug、Release 等），其中 <configs> 是 分号分隔的列表。当 CMake 项目使用 Xcode 或 Visual Studio 等多配置生成器时，需要此选项来告诉 cpack 哪个构建的可执行文件包含在包中。用户负责确保在调用 cpack 之前已经构建了列出的配置。

-D <var>=<value>

设置 CPack 变量。这将覆盖 cpack 读取的输入文件中为 <var> 设置的任何值。

--config <configFile>

指定 cpack 读取的配置文件以提供打包详细信息。默认情况下，将使用当前目录中的``CPackConfig.cmake``。

-V, --verbose

运行带有详细输出的 cpack。这可用于显示包生成工具的更多详细信息，适合项目开发人员。

--debug

使用调试输出运行 cpack。此选项主要供 cpack 本身的开发人员使用，项目开发人员通常不需要。

--trace

将底层 cmake 脚本置于跟踪模式。

--trace-expand

将底层 cmake 脚本置于扩展跟踪模式。

-P <packageName>

覆盖/定义用于打包的 CPACK_PACKAGE_NAME 变量的值。在 CPackConfig.cmake 文件中为此变量设置的任何值都将被忽略。

-R <packageVersion>

覆盖/定义用于打包的 CPACK_PACKAGE_VERSION 变量的值。它将覆盖 CPackConfig.cmake 文件中设置的值或从 CPACK_PACKAGE_VERSION_MAJOR 、CPACK_PACKAGE_VERSION_MINOR 和 CPACK_PACKAGE_VERSION_PATCH 自动计算的值。

-B <packageDirectory>

覆盖/定义 CPACK_PACKAGE_DIRECTORY，它控制 CPack 将执行其打包工作的目录。默认情况下，生成的包将在此位置创建，并且还将在此目录下创建一个 _CPack_Packages 子目录，以用作包创建期间的工作区域。

--vendor <vendorName>

覆盖/定义 CPACK_PACKAGE_VENDOR。

--preset <presetName>

使用 cmake-presets(7) 中的预设。

--list-presets

列出来自 cmake-presets(7) 的预设。

-version [<file>], --version [<file>], /V [<file>]

显示程序名称/版本横幅并退出。 |文件|

-h, -H, --help, -help, -usage, /?

打印使用信息并退出。

用法描述了基本的命令行界面及其选项。

--help-full [<file>]

打印所有帮助手册并退出。

所有手册均以人类可读的文本格式印刷。 |文件|

--help-manual <man> [<file>]

打印一份帮助手册并退出。

指定的手册以人类可读的文本格式打印。 |文件|

--help-manual-list [<file>]

列出可用的帮助手册并退出。

该列表包含所有可以通过使用“--help-manual”选项后跟手册名称来获取帮助的手册。 |文件|

--help-command <cmd> [<file>]

打印一个命令的帮助并退出。

<cmd> 的 cmake-commands(7) 手册条目以人类可读的文本格式打印。 |文件|

--help-command-list [<file>]

列出具有可用帮助的命令并退出。

该列表包含所有可以通过使用“--help-command”选项后跟命令名称来获取帮助的命令。 |文件|

--help-commands [<file>]

打印 cmake-commands 手册并退出。

cmake-commands(7) 手册以人类可读的文本格式打印。 |文件|

--help-module <mod> [<file>]

打印一个模块的帮助并退出。

<mod> 的 cmake-modules(7) 手册条目以人类可读的文本格式打印。 |文件|

--help-module-list [<file>]

列出具有可用帮助的模块并退出。

该列表包含所有可以通过使用“--help-module”选项后跟模块名称来获取帮助的模块。 |文件|

--help-modules [<file>]

打印 cmake-modules 手册并退出。

cmake-modules(7) 手册以人类可读的文本格式打印。 |文件|

--help-policy <cmp> [<file>]

打印一项政策的帮助并退出。

<cmp> 的 cmake-policies(7) 手册条目以人类可读的文本格式打印。 |文件|

--help-policy-list [<file>]

列出具有可用帮助的策略并退出。

该列表包含所有可以通过使用“--help-policy”选项后跟策略名称来获取帮助的策略。 |文件|

--help-policies [<file>]

打印 cmake-policies 手册并退出。

cmake-policies(7) 手册以人类可读的文本格式打印。 |文件|

--help-property <prop> [<file>]

打印一个属性的帮助并退出。

<prop> 的 cmake-properties(7) 手册条目以人类可读的文本格式打印。 |文件|

--help-property-list [<file>]

列出具有可用帮助的属性并退出。

该列表包含所有可以通过使用“--help-property”选项后跟属性名称来获取帮助的属性。 |文件|

--help-properties [<file>]

打印 cmake-properties 手册并退出。

cmake-properties(7) 手册以人类可读的文本格式打印。 |文件|

--help-variable <var> [<file>]

打印一个变量的帮助并退出。

<var> 的 cmake-variables(7) 手册条目以人类可读的文本格式打印。 |文件|

--help-variable-list [<file>]

列出可用帮助的变量并退出。

该列表包含所有变量，可以通过使用“--help-variable”选项后跟变量名来获得帮助。 |文件|

--help-variables [<file>]

打印 cmake-variables 手册并退出。

cmake-variables(7) 手册以人类可读的文本格式打印。 |文件|

也可以看看

以下资源可用于获取使用 CMake 的帮助：

主页

https://cmake.org

学习 CMake 的主要起点。

在线文档和社区资源

https://cmake.org/文档

可在此网页上找到指向可用文档和社区资源的链接。

话语论坛

https://discourse.cmake.org

Discourse Forum 主持关于 CMake 的讨论和问题。