CPackComponent

Настройка компонентов для установочных файлов и исходных пакетов.

• Введение
• Переменные

• Команды

  • Добавить компонент
  • Добавить группу компонентов
  • Добавить тип установки
  • Настроить загрузки

Введение

Этот модуль автоматически включается CPack.

Некоторые установочные файлы (особенно графические) генерируемые CPack позволяют пользователям выбирать отдельные компоненты приложения для установки. Этот модуль позволяет разработчикам настроить упаковку таких компонентов.

Содержимое назначается компонентам аргументом COMPONENT команды CMake install(). Компоненты могут быть снабжены удобочитаемыми именами и описаниями, зависимостями между компонентами и т.д., и сгруппированы различными способами для настройки конечного установочного файла, используя команды, описанные ниже.

Для задания различных группировок для разных генераторов 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 — это имя компонента установки, как определено аргументом COMPONENT одной или нескольких команд CMake install(). С помощью команды 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 предоставляет имя файла, передаваемое pkgbuild с аргументом --component-plist при использовании генератора productbuild.

Добавить группу компонентов

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 — произвольное имя, используемое для идентификации группы в аргументе GROUP команды cpack_add_component, который используется для размещения компонента в группе. Имя группы не должно совпадать с именем какого-либо компонента.

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 определяет набор предварительно выбранных компонентов, представляющих общий случай использования приложения. Например, тип установки «Разработчик» может включать приложение вместе с его заголовочными файлами и библиотеками, в то время как тип установки «Конечный пользователь» может включать только исполняемый файл приложения. Каждый компонент идентифицирует себя с помощью одного или нескольких типов установки с помощью аргумента INSTALL_TYPES в команде cpack_add_component.

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 функциональность загрузки компонентов требует плагина ZipDLL для NSIS, доступного по адресу:

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

На macOS установщики, которые загружают компоненты на лету, могут быть построены и установлены только на системах, использующих macOS 10.5 или более поздние версии.

Аргумент site — это URL, на котором будут храниться архивы для загружаемых компонентов, например, https://cmake.org/files/2.6.1/installer/ Все архивы, созданные CPack, должны быть загружены в это место.

UPLOAD_DIRECTORY — это локальный каталог, где CPack создаст различные архивы для каждого компонента. Содержимое этого каталога должно быть загружено в место, доступное по URL, указанному в аргументе site. Если опущено, CPack будет использовать каталог CPackUploads внутри каталога двоичных файлов CMake для хранения сгенерированных архивов.

Флаг ALL указывает, что должны быть загружены все компоненты. В противном случае будут загружены только те компоненты, которые явно помечены как DOWNLOADED или которые имеют указанный ARCHIVE_FILE. Кроме того, опция ALL подразумевает ADD_REMOVE (если не указан NO_ADD_REMOVE).

ADD_REMOVE указывает, что CPack должен установить копию установщика, которую можно вызвать из диалогового окна «Установка и удаление программ» Windows (через кнопку «Изменить»), чтобы изменить набор установленных компонентов. NO_ADD_REMOVE отключает это поведение. Эта опция игнорируется в Mac OS X.