CPack WIX 生成器¶

使用 WiX Toolset 生成 Windows 安装程序 .msi 数据库。

3.7 版本新增: 现在支持 CPACK_COMPONENT_<compName>_DISABLED 变量。

WiX Toolsets¶

CPack 基于 CPACK_WIX_VERSION 变量选择以下 WiX Toolset 的变体之一

WiX .NET 工具
WiX Toolset v3

WiX .NET 工具¶

打包使用以下工具执行

wix build

将 WiX 源文件直接构建到 Windows 安装程序 .msi 数据库中。

可以使用特定于工具的变量自定义调用

CPACK_WIX_BUILD_EXTENSIONS
CPACK_WIX_BUILD_EXTRA_FLAGS

WiX 扩展必须以 WixToolset.<Name>.wixext 的形式命名。

CPack 期望 wix .NET 工具可用于命令行，并且已安装任何必需的 WiX 扩展。请确保 wix 版本与 CPACK_WIX_VERSION 兼容，并且 WiX 扩展版本与 wix 工具版本匹配。例如

使用 dotnet 安装 wix 命令行工具。

要为当前用户全局安装 wix
dotnet tool install --global wix --version 4.0.4
这会将 wix.exe 放置在 %USERPROFILE%\.dotnet\tools 中，并将该目录添加到当前用户的 PATH 环境变量。

或者，要在特定路径（例如 c:\WiX）中安装 wix
dotnet tool install --tool-path c:\WiX wix --version 4.0.4
这会将 wix.exe 放置在 c:\WiX 中，但不会将其添加到当前用户的 PATH 环境变量中。可以设置 WIX 环境变量来告诉 CPack 在哪里找到该工具，例如 set WIX=c:\WiX。

添加 WiX UI 扩展，CPack 的默认 WiX 模板需要它

wix extension add --global WixToolset.UI.wixext/4.0.4
全局添加的扩展存储在 %USERPROFILE%\.wix 中，或者如果设置了 WIX_EXTENSIONS 环境变量，则存储在 %WIX_EXTENSIONS%\.wix 中。

WiX Toolset v3¶

打包使用以下工具执行

candle

将 WiX 源文件编译为 .wixobj 文件。

可以使用特定于工具的变量自定义调用

CPACK_WIX_CANDLE_EXTENSIONS
CPACK_WIX_CANDLE_EXTRA_FLAGS

light

将 .wixobj 文件链接到 Windows 安装程序 .msi 数据库中。

可以使用特定于工具的变量自定义调用

CPACK_WIX_LIGHT_EXTENSIONS
CPACK_WIX_LIGHT_EXTRA_FLAGS

CPack 根据需要调用这两个工具。中间 .wixobj 文件被认为是实现细节。

WiX 扩展必须以 Wix<Name>Extension 的形式命名。

CPack 期望上述工具可通过 PATH 用于命令行。或者，如果设置了 WIX 环境变量，CPack 将在 %WIX% 和 %WIX%\bin 中查找这些工具。

CPack WIX 生成器特有的变量¶

以下变量是 Windows 上使用 WiX 构建的安装程序特有的。

CPACK_WIX_VERSION¶

3.30 版本新增。

指定为其编写配置的 WiX Toolset 版本。该值必须是以下之一

4: 使用 WiX .NET 工具打包。
3: 使用 WiX Toolset v3 打包。这是默认值。

CPACK_WIX_UPGRADE_GUID¶

升级 GUID (Product/@UpgradeCode)

除非显式提供，否则将自动生成。

应将其显式设置为常量全局唯一标识符 (GUID)，以允许您的安装程序替换使用相同 GUID 的现有安装。

例如，您可以在 CMakeLists.txt 中将此变量显式设置为默认生成的值。您不应使用您自己未生成的或可能属于其他项目的 GUID。

GUID 应具有以下固定长度语法

XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

（每个 X 代表一个大写十六进制数字）

CPACK_WIX_PRODUCT_GUID¶

产品 GUID (Product/@Id)

除非显式提供，否则将自动生成。

如果显式提供，这将设置安装程序的产品 ID。

如果安装程序检测到使用相同 GUID 的预先存在的安装，则会中止。

GUID 应使用为 CPACK_WIX_UPGRADE_GUID 描述的语法。

CPACK_WIX_LICENSE_RTF¶

RTF 许可证文件

如果 CPACK_RESOURCE_FILE_LICENSE 具有 .rtf 扩展名，则按原样使用。

如果 CPACK_RESOURCE_FILE_LICENSE 具有 .txt 扩展名，则 WIX 生成器会将其隐式转换为 RTF。 .txt 文件的预期编码为 UTF-8。

使用 CPACK_WIX_LICENSE_RTF，您可以覆盖 WIX 生成器使用的许可证文件，以防 CPACK_RESOURCE_FILE_LICENSE 格式不受支持或 .txt -> .rtf 转换未按预期工作。

CPACK_WIX_PRODUCT_ICON¶

“添加/删除程序”中程序名称旁边显示的图标。

如果设置，则此图标将代替默认图标使用。

CPACK_WIX_UI_REF¶

指定 WiX UI 扩展的对话框集

对于 WiX .NET 工具，这是默认 WiX 模板中 <ui:WixUI> 元素的 ID。
对于 WiX Toolset v3，这是默认 WiX 模板中 <UIRef> 元素的 ID。

如果没有定义 CPack 组件，则默认为 WixUI_InstallDir，否则为 WixUI_FeatureTree。

CPACK_WIX_UI_BANNER¶

位图将出现在欢迎对话框和完成对话框以外的所有安装程序页面顶部。

如果设置，此图像将替换默认横幅图像。

此图像必须为 493 像素 x 58 像素。

CPACK_WIX_UI_DIALOG¶

欢迎对话框和完成对话框上使用的背景位图。

如果设置了此变量，安装程序将替换默认对话框图像。

此图像必须为 493 像素 x 312 像素。

CPACK_WIX_PROGRAM_MENU_FOLDER¶

启动器的开始菜单文件夹名称。

如果未设置此变量，它将使用 CPACK_PACKAGE_NAME 初始化

3.16 版本新增: 如果此变量设置为 .，则应用程序快捷方式将直接在开始菜单中创建，并且将省略卸载程序快捷方式。

CPACK_WIX_CULTURES¶

安装程序的语言

语言被编译到 Wix UI 扩展库中。要使用它们，只需提供文化名称。如果您在逗号或分号分隔的列表中指定多个文化标识符，则将使用找到的第一个。您可以在以下位置找到支持的语言列表：https://docs.firegiant.com/wix3/wixui/wixui_localization/

CPACK_WIX_TEMPLATE¶

WiX 生成的模板文件

如果设置了此变量，则将使用指定的模板来生成 WiX wxs 文件。如果需要进一步自定义输出，则应使用此选项。模板内容将覆盖大多数 CPACK_WIX_ 变量的效果。

如果未设置此变量，则将使用 CMake 附带的默认 MSI 模板。

CPACK_WIX_PATCH_FILE¶

要插入到生成的 WiX 源中的片段的可选 XML 文件列表。

3.5 版本新增: 支持列出多个补丁文件。

此可选变量可用于指定 WIX 生成器将用来将其片段注入到其生成的源文件中的 XML 文件。

CPack WIX 生成器理解的补丁文件大致遵循此 RELAX NG 紧凑模式

start = CPackWiXPatch

CPackWiXPatch = element CPackWiXPatch { CPackWiXFragment* }

CPackWiXFragment = element CPackWiXFragment
{
    attribute Id { string },
    fragmentContent*
}

fragmentContent = element * - CPackWiXFragment
{
    (attribute * { text } | text | fragmentContent)*
}

当前，片段可以注入到大多数 Component、File、Directory 和 Feature 元素中。

3.3 版本新增: 可以使用以下附加的特殊 ID

#PRODUCT 用于 <Product> 元素。
#PRODUCTFEATURE 用于根 <Feature> 元素。

3.7 版本新增: 支持修补任意 <Feature> 元素。

3.9 版本新增: 允许设置其他属性。

以下示例说明了其工作原理。

假设 WIX 生成器创建以下 XML 元素

<Component Id="CM_CP_applications.bin.my_libapp.exe" Guid="*"/>

以下 XML 补丁文件可用于将 Environment 元素注入到其中

<CPackWiXPatch>
  <CPackWiXFragment Id="CM_CP_applications.bin.my_libapp.exe">
    <Environment Id="MyEnvironment" Action="set"
      Name="MyVariableName" Value="MyVariableValue"/>
  </CPackWiXFragment>
</CPackWiXPatch>

CPACK_WIX_EXTRA_SOURCES¶

额外的 WiX 源文件

此变量提供了一个可选的额外 WiX 源文件 (.wxs) 列表，应将其编译和链接。路径必须是绝对路径。

CPACK_WIX_EXTRA_OBJECTS¶

要与 WiX Toolset v3 一起使用的额外 WiX 对象文件或库。

此变量提供了一个可选的额外 WiX 对象 (.wixobj) 和/或 WiX 库 (.wixlib) 文件列表。路径必须是绝对路径。

CPACK_WIX_EXTENSIONS¶: 指定 WiX 工具的附加扩展列表。有关扩展命名模式，请参见 WiX Toolsets。

CPACK_WIX_<TOOL>_EXTENSIONS¶: 指定特定 WiX 工具的附加扩展列表。有关可能的 <TOOL> 名称，请参见 WiX Toolsets。

CPACK_WIX_<TOOL>_EXTRA_FLAGS¶

指定特定 WiX 工具的附加命令行标志列表。有关可能的 <TOOL> 名称，请参见 WiX Toolsets。

使用风险自负。未来版本的 CPack 可能会生成与您自己的标志冲突的标志。

CPACK_WIX_CMAKE_PACKAGE_REGISTRY¶

如果设置了此变量，则生成的安装程序将在 Windows 注册表项 HKEY_LOCAL_MACHINE\Software\Kitware\CMake\Packages\<PackageName> 中创建一个条目。 <PackageName> 的值由此变量提供。

假设您还安装了 CMake 配置文件，这将允许其他 CMake 项目使用 find_package() 命令找到您的软件包。

CPACK_WIX_PROPERTY_<PROPERTY>¶

3.1 版本新增。

此变量可用于为 Windows Installer 属性 <PROPERTY> 提供值

以下列表包含一些示例属性，这些属性可用于自定义“程序和功能”（也称为“添加或删除程序”）下的信息

ARPCOMMENTS - 注释
ARPHELPLINK - 帮助和支持信息 URL
ARPURLINFOABOUT - 常规信息 URL
ARPURLUPDATEINFO - 更新信息 URL
ARPHELPTELEPHONE - 帮助和支持电话号码
ARPSIZE - 应用程序的大小（千字节）

CPACK_WIX_ROOT_FEATURE_TITLE¶: 3.7 版本新增。

设置 WIX 安装程序中根安装功能的名称。与组件的 CPACK_COMPONENT_<compName>_DISPLAY_NAME 相同。

CPACK_WIX_ROOT_FEATURE_DESCRIPTION¶: 3.7 版本新增。

设置 WIX 安装程序中根安装功能的描述。与组件的 CPACK_COMPONENT_<compName>_DESCRIPTION 相同。

CPACK_WIX_SKIP_PROGRAM_FOLDER¶: 3.7 版本新增。

如果此变量设置为 true，则生成的软件包的默认安装位置将直接是 CPACK_PACKAGE_INSTALL_DIRECTORY。安装位置将不位于 ProgramFiles 或 ProgramFiles64 下的相对位置。

注意

使用此功能创建的安装程序不会考虑创建安装程序的系统与可能使用安装程序的系统之间的差异。

因此，安装程序可能尝试安装到不可用或非预期的驱动器上，或者安装到不遵循执行安装的系统的本地化或约定的路径。

CPACK_WIX_ROOT_FOLDER_ID¶

3.9 版本新增。

此变量允许指定自定义根文件夹 ID。生成器特定的 <64> 令牌可用于具有 32 位和 64 位变体的文件夹 ID。在 32 位构建中，令牌将展开为空，而在 64 位构建中，它将展开为 64。

如果未设置，生成的安装程序将默认安装到 ProgramFiles<64>Folder。

CPACK_WIX_ROOT¶

此变量可以选择设置为自定义 WiX Toolset 安装的根目录。

如果未指定，CPack 将尝试通过 WIX 环境变量查找 WiX Toolset 安装。

CPACK_WIX_CUSTOM_XMLNS¶: 3.19 版本新增。

此变量提供必要的自定义命名空间声明列表，用于使用 WiX 扩展。每个声明应采用 name=url 的形式，其中 name 是没有常用 xmlns: 前缀的纯命名空间，而 url 是未加引号的命名空间 url。可以在此处找到常用 WiX 架构的列表：https://docs.firegiant.com/wix3/xsd/

CPACK_WIX_SKIP_WIX_UI_EXTENSION¶: 3.23 版本新增。

如果此变量设置为 true，则会跳过默认包含 WiX UI 扩展，即，-ext WixUIExtension 或 -ext WixToolset.UI.wixext 标志不会传递给 WiX 工具。

CPACK_WIX_ARCHITECTURE¶

3.24 版本新增。

此变量可以选择设置为指定安装程序的目标架构。例如，可以设置为 x64 或 arm64。

如果未指定，CPack 将默认为 x64 或 x86。

CPACK_WIX_INSTALL_SCOPE¶

3.29 版本新增。

此变量可以选择设置为指定安装程序的 InstallScope

perMachine

创建一个为所有用户安装并需要管理员权限的安装程序。安装程序创建的“开始”菜单项对所有用户可见。

这是默认值。请参见策略 CMP0172。

perUser

尚不支持。这为将来使用而保留。

NONE

创建一个不带任何 InstallScope 属性的安装程序。

仅当 CPACK_WIX_VERSION 未设置或设置为 3 时才支持此选项。

3.29 版本起已弃用: 此值仅用于与 CPack 3.28 及更早版本使用的不一致行为兼容。生成的安装程序需要管理员权限并安装到系统范围的 ProgramFiles 目录中，但“开始”菜单项和卸载程序注册仅为当前用户创建。

警告

由不带任何 InstallScope 的安装程序执行的安装无法由带有 InstallScope 的安装程序干净地更新或替换。为了将项目的安装程序从 NONE 转换为 perMachine，后一个安装程序应与首先手动卸载任何旧版本的说明一起分发。

请参阅 https://docs.firegiant.com/wix3/xsd/wix/package/

CPack WIX 生成器¶

WiX Toolsets¶

WiX .NET 工具¶

WiX Toolset v3¶

CPack WIX 生成器特有的变量¶

目录

上一个主题

下一个主题

本页