CPack IFW 生成器

版本 3.1 新增。

配置并运行 Qt 安装程序框架以生成 Qt 安装程序。

概述

此 cpack generator 为 Qt 安装程序框架 (QtIFW) 生成配置和元信息，并运行 QtIFW 工具以生成 Qt 安装程序。

QtIFW 提供了工具和实用程序，用于为 Qt 支持的平台（Linux、Microsoft Windows 和 macOS）创建安装程序。

要使用此生成器，需要安装 QtIFW。CPackIFW 模块查找 QtIFW 命令行实用程序的位置，并定义了几个命令来控制此生成器的行为。请参阅 查找 QtIFW 的提示。

变量

您可以使用以下变量来更改 CPack IFW 生成器的行为。

调试

CPACK_IFW_VERBOSE

版本 3.3 新增。

设置为 ON 以启用额外的调试输出。 默认值为 OFF。

包

CPACK_IFW_PACKAGE_TITLE

安装程序在标题栏上显示的名称。 如果未指定，则默认为 CPACK_PACKAGE_DESCRIPTION_SUMMARY。

CPACK_IFW_PACKAGE_PUBLISHER

软件的发布者（如 Windows 控制面板中所示）。 如果未指定，则默认为 CPACK_PACKAGE_VENDOR。

CPACK_IFW_PRODUCT_URL

包含您网站上产品信息的页面的 URL。

CPACK_IFW_PACKAGE_ICON

自定义安装程序图标的文件名。 它必须是绝对路径。 在 macOS 上应为 .icns 文件，在 Windows 上应为 .ico 文件。 在其他平台上将被忽略。

CPACK_IFW_PACKAGE_WINDOW_ICON

安装程序应用程序的 PNG 格式的自定义窗口图标的文件名。 它必须是绝对路径。

PNG 格式的徽标图像的文件名，用作 QWizard::LogoPixmap。 它必须是绝对路径。

CPACK_IFW_PACKAGE_WATERMARK

版本 3.8 新增。

PNG 格式的水印图像的文件名，用作 QWizard::WatermarkPixmap。 它必须是绝对路径。

CPACK_IFW_PACKAGE_BANNER

版本 3.8 新增。

PNG 格式的横幅图像的文件名，用作 QWizard::BannerPixmap。 它必须是绝对路径。

CPACK_IFW_PACKAGE_BACKGROUND

版本 3.8 新增。

PNG 格式的背景图像的文件名，用作 QWizard::BackgroundPixmap（仅由 MacStyle 使用）。 它必须是绝对路径。

CPACK_IFW_PACKAGE_WIZARD_STYLE

版本 3.8 新增。

要使用的向导样式（Modern、Mac、Aero 或 Classic）。

CPACK_IFW_PACKAGE_WIZARD_DEFAULT_WIDTH

版本 3.8 新增。

向导的默认宽度（以像素为单位）。 设置横幅图像将覆盖此设置。

CPACK_IFW_PACKAGE_WIZARD_DEFAULT_HEIGHT

版本 3.8 新增。

向导的默认高度（以像素为单位）。 设置水印图像将覆盖此设置。

CPACK_IFW_PACKAGE_WIZARD_SHOW_PAGE_LIST

版本 3.20 新增。

如果不想显示向导左侧列出安装程序页面的小部件，请设置为 OFF。

默认情况下为 ON，但仅在使用 QtIFW 4.0 或更高版本时才有效。

CPACK_IFW_PACKAGE_TITLE_COLOR

版本 3.8 新增。

标题和副标题的颜色（采用 HTML 颜色代码，例如 #88FF33）。

CPACK_IFW_PACKAGE_STYLE_SHEET

版本 3.15 新增。

样式表的文件名。 它必须是绝对路径。

CPACK_IFW_TARGET_DIRECTORY

安装的默认目标目录。 如果设置了 CPACK_PACKAGE_INSTALL_DIRECTORY，则默认为 @ApplicationsDir@/${CPACK_PACKAGE_INSTALL_DIRECTORY}。 如果未设置该变量，则使用的默认值为 @RootDir@/usr/local。 形式为 @...@ 的预定义变量由 QtIFW 脚本引擎 展开。

CPACK_IFW_ADMIN_TARGET_DIRECTORY

使用管理员权限安装的默认目标目录。

您可以使用预定义的变量。

CPACK_IFW_PACKAGE_REMOVE_TARGET_DIR

版本 3.11 新增。

如果卸载时不应删除目标目录，请设置为 OFF。

默认情况下为 ON

CPACK_IFW_PACKAGE_GROUP

将用于配置根包的组。

CPACK_IFW_PACKAGE_NAME

根包名称，如果未指定配置组，将使用此名称。

CPACK_IFW_PACKAGE_START_MENU_DIRECTORY

版本 3.3 新增。

Windows“开始”菜单中产品的默认程序组的名称。 如果未指定，则默认为 CPACK_IFW_PACKAGE_NAME。

CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_NAME

版本 3.3 新增。

生成的维护工具的文件名。 将附加特定于平台的exe可执行文件扩展名。

如果未指定，QtIFW 将提供默认名称 (maintenancetool)。

CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_INI_FILE

版本 3.3 新增。

生成的维护工具的配置的文件名。

如果未指定，QtIFW 使用默认文件名 (maintenancetool.ini)。

CPACK_IFW_PACKAGE_ALLOW_NON_ASCII_CHARACTERS

版本 3.3 新增。

如果安装路径可以包含非 ASCII 字符，请设置为 ON。 仅 QtIFW 2.0 及更高版本支持。 较旧的 QtIFW 版本将始终允许非 ASCII 字符。

CPACK_IFW_PACKAGE_ALLOW_SPACE_IN_PATH

版本 3.3 新增。

如果安装路径不能包含空格字符，请设置为 OFF。

对于 QtIFW 2.0 之前的工具，为 ON。

CPACK_IFW_PACKAGE_DISABLE_COMMAND_LINE_INTERFACE

版本 3.23 新增。

如果应禁用命令行界面功能，请设置为 ON。 默认情况下为 OFF，且仅在使用 QtIFW 4.0 或更高版本时才有效。

CPACK_IFW_PACKAGE_CONTROL_SCRIPT

版本 3.3 新增。

自定义安装程序控制脚本的文件名。

CPACK_IFW_PACKAGE_RESOURCES

版本 3.7 新增。

要包含在安装程序二进制文件中的其他资源（.qrc 文件）的列表。 它们应指定为绝对路径，并且任何两个资源文件都不能具有相同的文件名。

您可以使用 cpack_ifw_add_package_resources() 命令来解析相对路径。

CPACK_IFW_PACKAGE_FILE_EXTENSION

版本 3.10 新增。

目标二进制文件扩展名。

在 Linux 上，如果未指定扩展名，则目标二进制文件的名称会自动扩展为 .run。

在 Windows 上，目标创建为扩展名为 .exe 的应用程序，如果未提供，则会自动添加。

在 Mac 上，目标创建为扩展名为 .dmg 的 DMG 磁盘映像，如果未提供，则会自动添加。

CPACK_IFW_REPOSITORIES_ALL

远程存储库的列表。

此变量的默认值由 CPack 计算，并包含使用 cpack_ifw_add_repository() 添加或使用 cpack_ifw_update_repository() 更新的所有存储库。

CPACK_IFW_DOWNLOAD_ALL

如果此项为 ON，则将下载所有组件。 如果未设置，则行为取决于是否已使用 ALL 选项调用 cpack_configure_downloads()。

CPACK_IFW_PACKAGE_PRODUCT_IMAGES

版本 3.23 新增。

要在 PerformInstallationPage 上显示的图像列表。 这些必须是绝对路径，并且图像必须为 PNG 格式。

此功能适用于 QtIFW 4.0.0 及更高版本。

CPACK_IFW_PACKAGE_PRODUCT_IMAGE_URLS

版本 3.31 新增。

与 ProductImages 关联的 URL 列表。 仅当定义了 CPACK_IFW_PACKAGE_PRODUCT_IMAGES 且大小相同时使用。

此功能适用于 QtIFW 4.0.0 及更高版本。

CPACK_IFW_PACKAGE_RUN_PROGRAM

版本 3.23 新增。

如果用户接受该操作，则在安装程序完成后执行的命令。 提供应用程序的完整路径，如安装时所找到的路径。 这通常意味着路径应以 QtIFW 预定义变量 @TargetDir@ 开头。

此功能适用于 QtIFW 4.0.0 及更高版本。

CPACK_IFW_PACKAGE_RUN_PROGRAM_ARGUMENTS

版本 3.23 新增。

传递给 CPACK_IFW_PACKAGE_RUN_PROGRAM 中指定的程序的参数列表。

此功能适用于 QtIFW 4.0.0 及更高版本。

CPACK_IFW_PACKAGE_RUN_PROGRAM_DESCRIPTION

版本 3.23 新增。

安装后运行程序时，复选框旁边显示的文本。 如果设置了 CPACK_IFW_PACKAGE_RUN_PROGRAM 但未提供描述，则 QtIFW 将使用默认消息，例如 立即运行 <Name>。

此功能适用于 QtIFW 4.0.0 及更高版本。

CPACK_IFW_PACKAGE_SIGNING_IDENTITY

版本 3.23 新增。

允许指定用于对生成的应用程序捆绑包进行签名的代码签名身份。 仅在 macOS 上可用，在其他平台上将被忽略。

CPACK_IFW_ARCHIVE_FORMAT

版本 3.23 新增。

设置打包新组件数据存档时使用的格式。 如果省略此选项，则默认使用 7z 格式。 支持的格式

  • 7z

  • zip

  • tar.gz

  • tar.bz2

  • tar.xz

注意

如果 Qt 安装程序框架工具是在没有 libarchive 支持的情况下构建的，则仅支持 7z 格式。

此功能适用于 QtIFW 4.2.0 及更高版本。

CPACK_IFW_ARCHIVE_COMPRESSION

版本 3.23 新增。

存档压缩级别。 允许的值为

  • 0 (无压缩)

  • 1 (最快压缩)

  • 3 (快速压缩)

  • 5 (正常压缩)

  • 7 (最大压缩)

  • 9 (超压缩)

如果未设置此变量，则 QtIFW 将使用默认压缩级别，通常为 5 (正常压缩)。

注意

某些格式不支持所有可能的值。 例如，zip 压缩仅支持 1 到 7 的值。

此功能适用于 QtIFW 4.2.0 及更高版本。

组件

CPACK_IFW_RESOLVE_DUPLICATE_NAMES

安装带有组的组件时，解析重复的名称。

CPACK_IFW_PACKAGES_DIRECTORIES

将用于解析依赖组件的其他预准备的包目录。

CPACK_IFW_REPOSITORIES_DIRECTORIES

版本 3.10 新增。

将用于解析和重新打包依赖组件的其他预准备的存储库目录。

此功能适用于 QtIFW 3.1 及更高版本。

QtIFW 工具

CPACK_IFW_FRAMEWORK_VERSION

版本 3.3 新增。

将使用的 QtIFW 工具的版本。 此变量由 CPackIFW 模块设置。

以下变量提供了 CPackIFW 模块发现的 QtIFW 命令行工具的位置。 这些变量被缓存，并且可以在需要时进行配置。

CPACK_IFW_ARCHIVEGEN_EXECUTABLE

版本 3.19 新增。

archivegen 的路径。

CPACK_IFW_BINARYCREATOR_EXECUTABLE

binarycreator 的路径。

CPACK_IFW_REPOGEN_EXECUTABLE

repogen 的路径。

CPACK_IFW_INSTALLERBASE_EXECUTABLE

installerbase 的路径。

CPACK_IFW_DEVTOOL_EXECUTABLE

devtool 的路径。

查找 QtIFW 的提示

通常，CPack IFW 生成器会自动查找 QtIFW 工具。 以下（按优先级顺序）也可以设置为扩充 find_program() 通常搜索的位置

CPACK_IFW_ROOT

版本 3.9 新增。

CMake 变量

CPACK_IFW_ROOT

版本 3.9 新增。

环境变量

QTIFWDIR

CMake 变量

QTIFWDIR

环境变量

注意

指定的路径不应在末尾包含 bin（例如：D:\\DevTools\\QtIFW2.0.5）。

其他设置

在线安装程序

默认情况下，此生成器生成离线安装程序。 这意味着所有打包的文件都完全包含在安装程序可执行文件中。

相反，在线安装程序将从远程服务器下载部分或全部组件。

cpack_add_component() 命令中的 DOWNLOADED 选项指定要下载组件。 或者，cpack_configure_downloads() 命令中的 ALL 选项指定要下载 所有 组件。

cpack_ifw_add_repository() 命令和 CPackIFW_DOWNLOAD_ALL 变量允许更具体的配置。

当存在在线组件时，CPack 会将它们写入存档文件。 CPackComponent 模块的帮助页面，尤其是关于 cpack_configure_downloads() 函数的部分，解释了如何使这些文件可通过下载 URL 访问。

国际化

版本 3.9 新增。

某些变量和命令参数通过 CMake 脚本支持国际化。 这是一个可选功能。

QtIFW 工具创建的安装程序内置了对国际化的支持，许多短语已本地化为多种语言，但这不适用于您的组件和组的描述。

组件和组描述的本地化对于您的安装程序的用户很有用。

本地化的变量或参数可以包含单个默认值，然后包含一组对，其中包含区域设置的名称和本地化的值。

例如

set(LOCALIZABLE_VARIABLE "Default value"
  en "English value"
  en_US "American value"
  en_GB "Great Britain value"
  )

另请参阅

Qt 安装程序框架手册

从 Qt 站点下载适用于您平台的 Qt 安装程序框架

https://download.qt.io/official_releases/qt-installer-framework