CPack组件 ¶

为二进制安装程序和源包配置组件。

介绍 ¶

该模块自动包含在 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¶: 如果此组件对用户隐藏，则为真。

CPACK_COMPONENT_<compName>_REQUIRED¶: 如果需要此组件，则为真。

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

命令 ¶

添加组件 ¶

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:command:install 命令的 COMPONENT 参数定义。使用 cpack_add_component 命令可以设置安装组件的名称、描述和其他属性。还可以将组件分配给组件组。

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

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

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

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

DISABLED 指示默认情况下应禁用（未选中）此组件。用户可以自由选择该组件进行安装，除非它也是隐藏的。

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.org/files/v3.25/ CPack 生成的所有存档都应上传到该位置。

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

ALL 标志指示下载所有组件。否则，只会下载那些明确标记为已下载或具有指定 ARCHIVE_FILE 的组件。此外，ALL 选项意味着 ADD_REMOVE（除非指定了 NO_ADD_REMOVE）。

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