CPack productbuild 生成器

3.7 版本中新增。

productbuild CPack 生成器 (macOS)。

CPack productbuild 生成器专用变量

以下变量特定于使用 ProductBuild 在 Mac macOS 上构建的安装程序

CPACK_COMMAND_PRODUCTBUILD

用于为 macOS 安装程序或 Mac App Store 生成产品归档的 productbuild(1) 命令的路径。此变量可用于覆盖自动检测到的命令(或指定其位置,如果自动检测未能找到它)。

CPACK_PRODUCTBUILD_IDENTIFIER

在版本 3.23 中添加。

设置要与产品关联的唯一(非本地化)产品标识符(例如,com.kitware.cmake)。任何组件的产品名称都将附加到此值。

CPACK_PRODUCTBUILD_IDENTITY_NAME

版本 3.8 新增。

为生成的包添加数字签名。

CPACK_PRODUCTBUILD_KEYCHAIN_PATH

版本 3.8 新增。

指定用于搜索签名身份的特定钥匙串。

CPACK_COMMAND_PKGBUILD

用于在 macOS 上生成 macOS 组件包的 pkgbuild(1) 命令的路径。此变量可用于覆盖自动检测到的命令(或指定其位置,如果自动检测未能找到它)。

CPACK_PKGBUILD_IDENTITY_NAME

版本 3.8 新增。

为生成的包添加数字签名。

CPACK_PKGBUILD_KEYCHAIN_PATH

版本 3.8 新增。

指定用于搜索签名身份的特定钥匙串。

CPACK_PREFLIGHT_<COMP>_SCRIPT

将用作命名为 <COMP> 的组件的包的 preinstall 脚本的文件的完整路径,其中 <COMP> 是大写的组件名称。如果未为给定组件定义此变量,则不会添加 preinstall 脚本。

CPACK_POSTFLIGHT_<COMP>_SCRIPT

将用作命名为 <COMP> 的组件的包的 postinstall 脚本的文件的完整路径,其中 <COMP> 是大写的组件名称。如果未为给定组件定义此变量,则不会添加 postinstall 脚本。

CPACK_PRODUCTBUILD_RESOURCES_DIR

版本 3.9 中添加。

如果指定了此项,productbuild 生成器会将此目录中的文件(包括子目录)复制到 Resources 目录。这将在复制 CPACK_RESOURCE_FILE_WELCOMECPACK_RESOURCE_FILE_READMECPACK_RESOURCE_FILE_LICENSE 文件之前完成。

CPACK_PRODUCTBUILD_DOMAINS

在版本 3.23 中添加。

此选项可对产品可能安装的位置进行更精细控制。当其设置为 true 时(请参阅策略 CMP0161),将以以下形式的 domains 元素添加到 productbuild 分发 XML 中

<domains enable_anywhere="true" enable_currentUserHome="false" enable_localSystem="true"/>

默认值如上所示,但可以通过 CPACK_PRODUCTBUILD_DOMAINS_ANYWHERECPACK_PRODUCTBUILD_DOMAINS_USERCPACK_PRODUCTBUILD_DOMAINS_ROOT 进行覆盖。

CPACK_PRODUCTBUILD_DOMAINS_ANYWHERE

在版本 3.23 中添加。

可用于覆盖分发 XML 中 domains 元素的 enable_anywhere 属性。当设置为 true 时,产品可以安装在任何卷的根目录,包括非系统卷。

CPACK_PRODUCTBUILD_DOMAINS 必须设置为 true 才能使此变量生效。

CPACK_PRODUCTBUILD_DOMAINS_USER

在版本 3.23 中添加。

可用于覆盖分发 XML 中 domains 元素的 enable_currentUserHome 属性。当设置为 true 时,产品可以安装到当前用户的主目录。请注意,安装到用户主目录时,将应用以下附加要求:

CPACK_PRODUCTBUILD_DOMAINS 必须设置为 true 才能使此变量生效。

CPACK_PRODUCTBUILD_DOMAINS_ROOT

在版本 3.23 中添加。

可用于覆盖分发 XML 中 domains 元素的 enable_localSystem 属性。当设置为 true 时,产品可以安装在根目录中。除非产品只能安装到用户主目录,否则通常应将其设置为 true。

CPACK_PRODUCTBUILD_DOMAINS 必须设置为 true 才能使此变量生效。

背景图像

在 3.17 版本中添加。

这组变量控制生成安装程序的背景图像。

CPACK_PRODUCTBUILD_BACKGROUND

如果指定,则将背景添加到分发 XML。该值包含 Resources 目录中图像的路径。

CPACK_PRODUCTBUILD_BACKGROUND_ALIGNMENT

alignment 属性添加到分发 XML 中的背景。有关有效值,请参阅 Apple 文档。

CPACK_PRODUCTBUILD_BACKGROUND_SCALING

scaling 属性添加到分发 XML 中的背景。有关有效值,请参阅 Apple 文档。

CPACK_PRODUCTBUILD_BACKGROUND_MIME_TYPE

mime-type 属性添加到分发 XML 中的背景。该选项包含图像的 MIME 类型。

CPACK_PRODUCTBUILD_BACKGROUND_UTI

uti 属性添加到分发 XML 中的背景。该选项包含图像的 UTI 类型。

CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA

如果指定,则为深色主题添加分发 XML 的背景。该值包含 Resources 目录中图像的路径。

CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_ALIGNMENT

CPACK_PRODUCTBUILD_BACKGROUND_ALIGNMENT 选项相同,但用于深色主题。

CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_SCALING

CPACK_PRODUCTBUILD_BACKGROUND_SCALING 选项相同,但用于深色主题。

CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_MIME_TYPE

CPACK_PRODUCTBUILD_BACKGROUND_MIME_TYPE 选项相同,但用于深色主题。

CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_UTI

CPACK_PRODUCTBUILD_BACKGROUND_UTI 选项相同,但用于深色主题。

分发 XML 模板

CPack 使用模板文件来生成此包生成器内部使用的 distribution.dist 文件。通常,CMake 提供模板文件,但项目可以通过在 CMAKE_MODULE_PATH 变量列出的目录之一中放置一个名为 CPack.distribution.dist.in 的文件来提供自己的模板文件。然后,CPack 将使用项目的模板文件,而不是自己的文件。

通过执行类似于 configure_file() 命令的替换来生成 distribution.dist 文件。CPack 运行时设置的任何变量都可以使用通常的 @...@ 形式进行替换。以下变量也在内部设置并提供给替换:

CPACK_RESOURCE_FILE_LICENSE_NOPATH

CPACK_RESOURCE_FILE_LICENSE 相同,但没有路径。该命名文件将在与生成的 distribution.dist 文件相同的目录中可用。

CPACK_RESOURCE_FILE_README_NOPATH

CPACK_RESOURCE_FILE_README 相同,但没有路径。该命名文件将在与生成的 distribution.dist 文件相同的目录中可用。

CPACK_RESOURCE_FILE_WELCOME_NOPATH

CPACK_RESOURCE_FILE_WELCOME 相同,但没有路径。该命名文件将在与生成的 distribution.dist 文件相同的目录中可用。

CPACK_APPLE_PKG_INSTALLER_CONTENT

在版本 3.23 中添加。

这包含指定安装程序范围的选项(包括域详细信息)、默认背景和选择项大纲的所有 XML 元素。

CPACK_PACKAGEMAKER_CHOICES

自 3.23 版本起已弃用。

这仅包含指定默认背景和选择项大纲的 XML 元素。它不包括安装程序范围的选项或任何域详细信息。请改用 CPACK_APPLE_PKG_INSTALLER_CONTENT