CPackIFW

Этот модуль ищет расположение командных утилит, поставляемых с Qt Installer Framework (QtIFW).

Модуль также определяет несколько команд для управления поведением генератора CPack IFW.

Обзор

Генератор CPack IFW помогает создавать кроссплатформенные установщики бинарных файлов с графическим интерфейсом пользователя, как онлайн, так и оффлайн.

Генератор CPack IFW подготавливает установку проекта и генерирует конфигурационную и мета-информацию для инструментов QtIFW.

QtIFW предоставляет набор инструментов и утилит для создания установщиков для поддерживаемых настольных платформ Qt: Linux, Microsoft Windows и Mac OS X.

Для использования генератора CPack IFW также необходимо установить QtIFW. Если вы используете нестандартный путь установки, пожалуйста, задайте используемый путь в переменной QTIFWDIR.

Переменные

Вы можете использовать следующие переменные для изменения поведения генератора CPack IFW.

Отладка

CPACK_IFW_VERBOSE: Установите в 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: Имя файла для пользовательской иконки установщика. Файл должен быть в формате ‘.icns’ (Mac OS X), ‘.ico’ (Windows). На Unix не работает.

CPACK_IFW_PACKAGE_WINDOW_ICON: Имя файла для пользовательской иконки окна приложения установщика в формате PNG.

CPACK_IFW_PACKAGE_LOGO: Имя файла для логотипа, используемого как QWizard::LogoPixmap.

CPACK_IFW_PACKAGE_WATERMARK: Имя файла для водяного знака, используемого как QWizard::WatermarkPixmap.

CPACK_IFW_PACKAGE_BANNER: Имя файла для баннера, используемого как QWizard::BannerPixmap.

CPACK_IFW_PACKAGE_BACKGROUND: Имя файла для изображения, используемого как QWizard::BackgroundPixmap (используется только стилем MacStyle).

CPACK_IFW_PACKAGE_WIZARD_STYLE: Стиль мастера (“Modern”, “Mac”, “Aero” или “Classic”).

CPACK_IFW_PACKAGE_WIZARD_DEFAULT_WIDTH: По умолчанию ширина мастера в пикселях. Установка изображения баннера переопределит это значение.

CPACK_IFW_PACKAGE_WIZARD_DEFAULT_HEIGHT: По умолчанию высота мастера в пикселях. Установка изображения водяного знака переопределит это значение.

CPACK_IFW_PACKAGE_TITLE_COLOR: Цвет заголовков и подзаголовков (принимает HTML цвет, например “#88FF33”).

CPACK_IFW_PACKAGE_START_MENU_DIRECTORY

Имя группы программ по умолчанию для продукта в меню Пуск Windows.

По умолчанию используется CPACK_IFW_PACKAGE_NAME.

CPACK_IFW_TARGET_DIRECTORY

Директория назначения по умолчанию для установки. По умолчанию используется “@ApplicationsDir@/CPACK_PACKAGE_INSTALL_DIRECTORY”

Вы можете использовать предопределённые переменные.

CPACK_IFW_ADMIN_TARGET_DIRECTORY

Директория назначения по умолчанию для установки с правами администратора.

Вы можете использовать предопределённые переменные.

CPACK_IFW_PACKAGE_GROUP: Группа, которая будет использована для конфигурации корневого пакета

CPACK_IFW_PACKAGE_NAME: Название корневого пакета, которое будет использоваться, если группа конфигурации не указана

CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_NAME

Имя файла сгенерированного инструмента обслуживания. Добавляется платформа-специфическое расширение исполняемого файла.

По умолчанию используются значения по умолчанию QtIFW (maintenancetool).

CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_INI_FILE

Имя файла конфигурации сгенерированного инструмента обслуживания.

По умолчанию используются значения по умолчанию QtIFW (maintenancetool.ini).

CPACK_IFW_PACKAGE_ALLOW_NON_ASCII_CHARACTERS

Установите в ON, если путь установки может содержать не-ASCII символы.

По умолчанию ON для инструментов QtIFW версии ниже 2.0.

CPACK_IFW_PACKAGE_ALLOW_SPACE_IN_PATH

Установите в OFF, если путь установки не может содержать пробелы.

По умолчанию ON для инструментов QtIFW версии ниже 2.0.

CPACK_IFW_PACKAGE_CONTROL_SCRIPT: Имя файла пользовательского скрипта управления установкой.

CPACK_IFW_PACKAGE_RESOURCES

Список дополнительных ресурсов (‘.qrc’ файлы) для включения в бинарник установщика.

Вы можете использовать команду cpack_ifw_add_package_resources() для разрешения относительных путей.

CPACK_IFW_REPOSITORIES_ALL

Список удаленных репозиториев.

Значение по умолчанию этой переменной вычисляется CPack и содержит все репозитории, добавленные с помощью команды cpack_ifw_add_repository() или обновлённые с помощью команды cpack_ifw_update_repository().

CPACK_IFW_DOWNLOAD_ALL: Если это ON, все компоненты будут загружены. По умолчанию установлено OFF или используется значение из CPACK_DOWNLOAD_ALL, если оно установлено

Компоненты

CPACK_IFW_RESOLVE_DUPLICATE_NAMES: Разрешить дублирование имён при установке компонентов с группами.

CPACK_IFW_PACKAGES_DIRECTORIES: Дополнительные подготовленные директории пакетов, которые будут использоваться для разрешения зависимых компонентов.

Инструменты

CPACK_IFW_FRAMEWORK_VERSION: Версия используемых инструментов QtIFW.

CPACK_IFW_BINARYCREATOR_EXECUTABLE

Путь к командной строке «binarycreator».

Эта переменная кэшируется и может быть настроена пользователем при необходимости.

CPACK_IFW_REPOGEN_EXECUTABLE

Путь к командной строке «repogen».

Эта переменная кэшируется и может быть настроена пользователем при необходимости.

Команды

Модуль определяет следующие команды:

cpack_ifw_configure_component

Устанавливает аргументы, специфичные для генератора CPack IFW.

cpack_ifw_configure_component(<compname> [COMMON] [ESSENTIAL] [VIRTUAL]
                    [FORCED_INSTALLATION] [REQUIRES_ADMIN_RIGHTS]
                    [NAME <name>]
                    [DISPLAY_NAME <display_name>]
                    [DESCRIPTION <description>]
                    [UPDATE_TEXT <update_text>]
                    [VERSION <version>]
                    [RELEASE_DATE <release_date>]
                    [SCRIPT <script>]
                    [PRIORITY|SORTING_PRIORITY <sorting_priority>] # Note: PRIORITY is deprecated
                    [DEPENDS|DEPENDENCIES <com_id> ...]
                    [AUTO_DEPEND_ON <comp_id> ...]
                    [LICENSES <display_name> <file_path> ...]
                    [DEFAULT <value>]
                    [USER_INTERFACES <file_path> <file_path> ...]
                    [TRANSLATIONS <file_path> <file_path> ...])

Эта команда должна быть вызвана после команды cpack_add_component().

COMMON: если установлено, то компонент будет упакован и установлен как часть группы, к которой он принадлежит.
ESSENTIAL: если установлено, то менеджер пакетов остаётся отключённым до обновления этого компонента.
VIRTUAL: если установлено, то компонент будет скрыт от установщика. Это эквивалентно параметру HIDDEN команды cpack_add_component().
FORCED_INSTALLATION: если установлено, то компонент всегда должен быть установлен. Это эквивалентно параметру REQUARED команды cpack_add_component().
REQUIRES_ADMIN_RIGHTS: установите его, если для установки компонента требуются повышенные права.
NAME: используется для создания идентификации типа домена для этого компонента. По умолчанию используется имя исходного компонента.
DISPLAY_NAME: установите, чтобы перезаписать исходное имя, настроенное командой cpack_add_component().
DESCRIPTION: установите, чтобы перезаписать исходное описание, настроенное командой cpack_add_component().
UPDATE_TEXT: будет добавлено к описанию компонента, если это обновление компонента.
VERSION: является версией компонента. По умолчанию используется CPACK_PACKAGE_VERSION.
RELEASE_DATE: оставьте пустым для автоматического создания.
SCRIPT: является относительным или абсолютным путём к скрипту операций для этого компонента.
PRIORITY | SORTING_PRIORITY: имеет приоритет компонента в дереве. Параметр PRIORITY устарел и будет удалён в будущих версиях CMake. Используйте вместо него параметр SORTING_PRIORITY.
DEPENDS | DEPENDENCIES: список идентификаторов зависимых компонентов или групп компонентов в стиле QtIFW.
AUTO_DEPEND_ON: список идентификаторов компонентов или групп компонентов в стиле QtIFW, от которых этот компонент автоматически зависит.
LICENSES: пара <display_name> и <file_path> текста лицензии для этого компонента. Можно указать более одной лицензии.
DEFAULT: Возможные значения: TRUE, FALSE и SCRIPT. Установите в FALSE, чтобы отключить компонент в установщике, или в SCRIPT, чтобы разрешить во время выполнения (не забудьте добавить файл скрипта как значение параметра SCRIPT).
USER_INTERFACES: является списком путей к файлам <file_path> (файлы '.ui'), представляющим страницы для загрузки.
TRANSLATIONS: является списком путей к файлам <file_path> (файлы '.qm'), представляющим языковые локали для загрузки.

cpack_ifw_configure_component_group

Устанавливает аргументы, специфичные для генератора CPack IFW.

cpack_ifw_configure_component_group(<groupname> [VIRTUAL]
                    [FORCED_INSTALLATION] [REQUIRES_ADMIN_RIGHTS]
                    [NAME <name>]
                    [DISPLAY_NAME <display_name>]
                    [DESCRIPTION <description>]
                    [UPDATE_TEXT <update_text>]
                    [VERSION <version>]
                    [RELEASE_DATE <release_date>]
                    [SCRIPT <script>]
                    [PRIORITY|SORTING_PRIORITY <sorting_priority>] # Note: PRIORITY is deprecated
                    [DEPENDS|DEPENDENCIES <com_id> ...]
                    [AUTO_DEPEND_ON <comp_id> ...]
                    [LICENSES <display_name> <file_path> ...]
                    [DEFAULT <value>]
                    [USER_INTERFACES <file_path> <file_path> ...]
                    [TRANSLATIONS <file_path> <file_path> ...])

Эта команда должна быть вызвана после команды cpack_add_component_group().

VIRTUAL: если установлено, то группа будет скрыта от установщика. Примечание: установка этого параметра для корневого компонента не работает.
FORCED_INSTALLATION: если установлено, то группа всегда должна быть установлена.
REQUIRES_ADMIN_RIGHTS: установите, если для группы компонентов требуются повышенные права.
NAME: используется для создания идентификации типа домена для этой группы компонентов. По умолчанию используется имя исходной группы компонентов.
DISPLAY_NAME: установите, чтобы перезаписать исходное имя, настроенное командой cpack_add_component_group().
DESCRIPTION: установите, чтобы перезаписать исходное описание, настроенное командой cpack_add_component_group().
UPDATE_TEXT: будет добавлено к описанию группы компонентов, если это обновление группы компонентов.
VERSION: является версией группы компонентов. По умолчанию используется CPACK_PACKAGE_VERSION.
RELEASE_DATE: оставьте пустым для автоматического создания.
SCRIPT: является относительным или абсолютным путём к скрипту операций для этой группы компонентов.
PRIORITY | SORTING_PRIORITY: имеет приоритет группы компонентов в дереве. Параметр PRIORITY устарел и будет удалён в будущих версиях CMake. Используйте вместо него параметр SORTING_PRIORITY.
DEPENDS | DEPENDENCIES: список идентификаторов зависимых компонентов или групп компонентов в стиле QtIFW.
AUTO_DEPEND_ON: список идентификаторов компонентов или групп компонентов в стиле QtIFW, от которых эта группа компонентов автоматически зависит.
LICENSES: пара <display_name> и <file_path> текста лицензии для этой группы компонентов. Можно указать более одной лицензии.
DEFAULT: Возможные значения: TRUE, FALSE и SCRIPT. Установите в TRUE, чтобы предварительно выбрать группу в установщике (это действует только на группы, у которых нет видимых дочерних компонентов), или в SCRIPT, чтобы разрешить во время выполнения (не забудьте добавить файл скрипта как значение параметра SCRIPT).
USER_INTERFACES: является списком путей к файлам <file_path> (файлы '.ui'), представляющим страницы для загрузки.
TRANSLATIONS: является списком путей к файлам <file_path> (файлы '.qm'), представляющим языковые локали для загрузки.

cpack_ifw_add_repository

Добавляет удалённый репозиторий, специфичный для QtIFW, в установщик бинарных файлов.

cpack_ifw_add_repository(<reponame> [DISABLED]
                    URL <url>
                    [USERNAME <username>]
                    [PASSWORD <password>]
                    [DISPLAY_NAME <display_name>])

Эта команда также добавит репозиторий <reponame> в переменную CPACK_IFW_REPOSITORIES_ALL.

DISABLED: если установлено, то репозиторий по умолчанию будет отключён.
URL: указывает на список доступных компонентов.
USERNAME: используется как пользователь в защищённом репозитории.
PASSWORD: является паролем для использования в защищённом репозитории.
DISPLAY_NAME: является строкой, отображаемой вместо URL.

cpack_ifw_update_repository

Обновляет репозиторий, специфичный для QtIFW, из удалённого репозитория.

cpack_ifw_update_repository(<reponame>
                    [[ADD|REMOVE] URL <url>]|
                     [REPLACE OLD_URL <old_url> NEW_URL <new_url>]]
                    [USERNAME <username>]
                    [PASSWORD <password>]
                    [DISPLAY_NAME <display_name>])

Эта команда также добавит репозиторий <reponame> в переменную CPACK_IFW_REPOSITORIES_ALL.

URL: указывает на список доступных компонентов.
OLD_URL: указывает на список, который будет заменён.
NEW_URL: указывает на список, который будет подменён на.
USERNAME: используется как пользователь в защищённом репозитории.
PASSWORD: является паролем для использования в защищённом репозитории.
DISPLAY_NAME: является строкой, отображаемой вместо URL.

cpack_ifw_add_package_resources

Добавляет дополнительные ресурсы в бинарный установщик.

cpack_ifw_add_package_resources(<file_path> <file_path> ...)

Эта команда также добавит указанные файлы в переменную CPACK_IFW_PACKAGE_RESOURCES.

Пример использования

set(CPACK_PACKAGE_NAME "MyPackage")
set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "MyPackage Installation Example")
set(CPACK_PACKAGE_VERSION "1.0.0") # Version of installer

include(CPack)
include(CPackIFW)

cpack_add_component(myapp
    DISPLAY_NAME "MyApp"
    DESCRIPTION "My Application")
cpack_ifw_configure_component(myapp
    VERSION "1.2.3" # Version of component
    SCRIPT "operations.qs")
cpack_add_component(mybigplugin
    DISPLAY_NAME "MyBigPlugin"
    DESCRIPTION "My Big Downloadable Plugin"
    DOWNLOADED)
cpack_ifw_add_repository(myrepo
    URL "http://example.com/ifw/repo/myapp"
    DISPLAY_NAME "My Application Repository")

Онлайн-установщик

По умолчанию генератор CPack IFW создаёт автономный установщик. Это означает, что все компоненты будут упакованы в один бинарный файл.

Чтобы компонент загружался, необходимо установить параметр DOWNLOADED в команде cpack_add_component().

Затем вы можете использовать команду cpack_configure_downloads(). Если установить параметр ALL, все компоненты будут загружены.

Также можно использовать команду cpack_ifw_add_repository() и переменную CPACK_IFW_DOWNLOAD_ALL для более подробной настройки.

Генератор CPack IFW создаёт папку «repository» в текущей бинарной директории. Вам нужно будет скопировать содержимое этой папки в указанную site (url).

См. также

Руководство по Qt Installer Framework:

Главная страница: http://doc.qt.io/qtinstallerframework/index.html
Сценарии компонентов: http://doc.qt.io/qtinstallerframework/scripting.html
Предопределённые переменные: http://doc.qt.io/qtinstallerframework/scripting.html#predefined-variables
Продвижение обновлений: http://doc.qt.io/qtinstallerframework/ifw-updates.html

Загрузите Qt Installer Framework для вашей платформы с сайта Qt:: http://download.qt.io/official_releases/qt-installer-framework

© 2000–2019 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.8/module/CPackIFW.html