CPackComponent ¶

此模块提供了用于配置二进制安装程序和源包的组件的命令。

在 CMake 项目中加载此模块，使用

include(CPackComponent)

简介 ¶

此模块也由 CPack 自动包含。

CPack 生成的某些二进制安装程序（尤其是图形安装程序）允许用户选择要安装的单个应用程序组件。此模块允许开发人员配置此类组件的打包。

内容通过 CMake 的 install() 命令的 COMPONENT 参数分配给组件。组件可以添加用户友好的名称和描述、组件间依赖关系等，并以各种方式分组以自定义生成的安装程序，使用下面描述的命令。

要为不同的 CPack 生成器指定不同的分组，请使用 CPACK_PROJECT_CONFIG_FILE。

变量 ¶

以下变量会影响组件特定的打包

CPACK_COMPONENTS_ALL¶

要安装的组件列表。

此变量的默认值由 CPack 计算，并包含项目定义的所有组件。用户可以将其设置为仅包含指定的组件。

与其指定所有所需的组件，不如获取所有已定义组件的列表，然后从中删除不需要的组件。可以使用 get_cmake_property() 命令获取 COMPONENTS 属性，然后使用 list(REMOVE_ITEM) 命令删除不需要的组件。例如，要使用除 foo 和 bar 之外的所有已定义组件

get_cmake_property(CPACK_COMPONENTS_ALL COMPONENTS)
list(REMOVE_ITEM CPACK_COMPONENTS_ALL "foo" "bar")

CPACK_<GENNAME>_COMPONENT_INSTALL¶

为 CPack 生成器 <GENNAME> 启用/禁用组件安装。

每个 CPack 生成器（RPM、DEB、ARCHIVE、NSIS、DMG 等）都有一个传统的默认行为。例如，RPM 构建为整体的，而 NSIS 构建为组件的。可以通过将此变量设置为 0/1 或 OFF/ON 来更改默认行为。

CPACK_COMPONENTS_GROUPING¶

指定组件如何分组以用于多包组件感知的 CPack 生成器。

像 RPM 或 ARCHIVE（TGZ、ZIP 等）这样的某些生成器在存在组件时可能会生成多个包文件，具体取决于此变量的值。

ONE_PER_GROUP（默认）：每个组件组创建一个包
IGNORE：每个组件创建一个包（忽略组）
ALL_COMPONENTS_IN_ONE：创建一个包含所有请求组件的单个包

CPACK_COMPONENT_<compName>_DISPLAY_NAME¶: 要显示的组件名称。

CPACK_COMPONENT_<compName>_DESCRIPTION¶: 组件的描述。

CPACK_COMPONENT_<compName>_GROUP¶: 组件所属的组。

CPACK_COMPONENT_<compName>_DEPENDS¶: 此组件依赖的组件列表。

CPACK_COMPONENT_<compName>_HIDDEN¶: 如果此组件对用户隐藏，则为 True。

CPACK_COMPONENT_<compName>_REQUIRED¶: 如果此组件是必需的，则为 True。

CPACK_COMPONENT_<compName>_DISABLED¶: 如果此组件默认未选中安装，则为 True。

命令 (Commands)¶

添加组件 ¶

cpack_add_component¶

描述一个安装组件。

cpack_add_component(compname
                    [DISPLAY_NAME name]
                    [DESCRIPTION description]
                    [HIDDEN | REQUIRED | DISABLED ]
                    [GROUP group]
                    [DEPENDS comp1 comp2 ... ]
                    [INSTALL_TYPES type1 type2 ... ]
                    [DOWNLOADED]
                    [ARCHIVE_FILE filename]
                    [PLIST filename])

compname 是安装组件的名称，由一个或多个 CMake install() 命令的 COMPONENT 参数定义。使用 cpack_add_component 命令，可以设置安装组件的名称、描述和其他属性。还可以将组件分配给组件组。

DISPLAY_NAME 是组件的显示名称，用于图形安装程序以显示组件名称。此值可以是任何字符串。

DESCRIPTION 是组件的扩展描述，用于图形安装程序以向用户提供有关组件的额外信息。描述可以使用 \n 作为行分隔符来跨越多行。通常，这些描述不应超过几行。

HIDDEN 表示此组件将在图形安装程序中隐藏，因此用户无法直接更改是否安装它。

REQUIRED 表示此组件是必需的，因此将始终安装。它将在图形安装程序中可见，但无法取消选中。（通常，必需组件会显示为灰色）。

DISABLED 表示此组件默认应禁用（未选中）。用户可以自由选择安装此组件，除非它也被 HIDDEN。

DEPENDS 列出了此组件所依赖的组件。如果选择了此组件，那么列出的每个组件也必须被选中。依赖信息已编码在安装程序本身中，因此用户无法安装不一致的组件集。

GROUP 为组件指定所属的组件组。如果未提供，则该组件将是一个独立组件，不属于任何组件组。组件组使用 cpack_add_component_group 命令描述，如下文所述。

INSTALL_TYPES 列出了此组件所属的安装类型。当选择其中一种安装类型时，此组件将自动被选中。安装类型使用 cpack_add_install_type 命令描述，如下文所述。

DOWNLOADED 表示此组件应由安装程序按需下载，而不是随安装程序一起打包。有关更多信息，请参阅 cpack_configure_downloads 命令。

ARCHIVE_FILE 为 CPack 为下载组件创建的存档文件提供一个名称。如果未提供，CPack 将创建一个名称基于 CPACK_PACKAGE_FILE_NAME 和组件名称的文件。有关更多信息，请参阅 cpack_configure_downloads。

PLIST 提供一个文件名，在使用 productbuild 生成器时，该文件名将使用 --component-plist 参数传递给 pkgbuild。

添加组件组 ¶

cpack_add_component_group¶

描述一组相关的 CPack 安装组件。

cpack_add_component_group(groupname
                         [DISPLAY_NAME name]
                         [DESCRIPTION description]
                         [PARENT_GROUP parent]
                         [EXPANDED]
                         [BOLD_TITLE])

cpack_add_component_group 描述了一组安装组件，这些组件将在选项列表中一起显示。通常，组件组允许用户通过单个组级选项选择/取消选择组内的所有组件。使用组件组来减少具有许多选项的安装程序的复杂性。groupname 是一个任意名称，用于在 cpack_add_component 命令的 GROUP 参数中标识组，该参数用于将组件放入组中。组的名称不得与任何组件的名称冲突。

DISPLAY_NAME 是组件组的显示名称，用于图形安装程序以显示组件组名称。此值可以是任何字符串。

DESCRIPTION 是组件组的扩展描述，用于图形安装程序以向用户提供有关该组内组件的额外信息。描述可以使用 \n 作为行分隔符来跨越多行。通常，这些描述不应超过几行。

PARENT_GROUP（如果提供）指定此组的父组。父组用于建立组的层次结构，提供一个任意的组层次结构。

EXPANDED 指示默认情况下，组应显示为“展开”状态，以便用户立即看到组内的所有组件。否则，组将最初显示为单个条目。

BOLD_TITLE 指示组标题应以粗体显示，以引起用户的注意。

添加安装类型 ¶

cpack_add_install_type¶

向图形安装程序添加一个包含一组预定义组件选择的新安装类型。

cpack_add_install_type(typename
                       [DISPLAY_NAME name])

cpack_add_install_type 命令标识了一组预选的组件，这些组件代表了应用程序的常见用途。例如，“开发人员”安装类型可能包含应用程序及其头文件和库文件，而“最终用户”安装类型可能只包含应用程序的可执行文件。每个组件通过 cpack_add_component 的 INSTALL_TYPES 参数来标识自己属于一个或多个安装类型。

DISPLAY_NAME 是安装类型的显示名称，通常会显示在图形安装程序内的下拉框中。此值可以是任何字符串。

配置下载 ¶

cpack_configure_downloads¶

配置 CPack 在安装过程中按需下载所选组件。

cpack_configure_downloads(site
                          [UPLOAD_DIRECTORY dirname]
                          [ALL]
                          [ADD_REMOVE|NO_ADD_REMOVE])

cpack_configure_downloads 命令配置安装时下载所选组件。对于每个可下载组件，CPack 将创建一个包含该组件内容的存档，该存档应上传到指定的站点。当用户选择该组件进行安装时，安装程序将下载并将组件提取到指定位置。此功能有助于创建只下载所需组件的小型安装程序，从而节省带宽。此外，安装程序足够小，可以作为正常安装过程的一部分进行安装，并且 Windows 的“添加/删除程序”控制面板中的“修改”按钮允许在原始安装后添加或删除应用程序的部分。在 Windows 上，下载组件功能需要 NSIS 的 ZipDLL 插件，可在以下网址获得：

http://nsis.sourceforge.net/ZipDLL_plug-in

在 macOS 上，只能在运行 macOS 10.5 或更高版本的系统上构建和安装按需下载组件的安装程序。

site 参数是可下载组件的存档将驻留的 URL，例如 https://cmake.com.cn/files/v3.25/。CPack 生成的所有存档都应上传到该位置。

UPLOAD_DIRECTORY 是 CPack 将为每个组件创建各种存档的本地目录。此目录的内容应上传到 site 参数中给出的 URL 可访问的位置。如果省略，CPack 将使用 CMake 二进制目录内的 CPackUploads 目录来存储生成的存档。

ALL 标志表示将下载所有组件。否则，将只下载显式标记为 DOWNLOADED 或具有指定 ARCHIVE_FILE 的组件。此外，ALL 选项意味着 ADD_REMOVE（除非指定了 NO_ADD_REMOVE）。

ADD_REMOVE 表示 CPack 应安装一个安装程序的副本，该安装程序可以从 Windows 的“添加/删除程序”对话框（通过“修改”按钮）调用，以更改已安装组件的集合。NO_ADD_REMOVE 关闭此行为。此选项在 Mac OS X 上被忽略。