Spec-Zone.ru › CMake 3.9

CPackIFW

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

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

Обзор

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

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

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

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

Рекомендации

В общем случае, генератор CPack IFW автоматически находит инструменты QtIFW, но если вы не используете стандартный путь для установки инструментов QtIFW, путь можно указать в переменной CMake или окружения:

CPACK_IFW_ROOT

Переменная CMake, которая указывает расположение набора инструментов QtIFW.

Переменная будет кэширована в файле CPackConfig.cmake и использоваться во время работы CPack.

QTIFWDIR

Переменная окружения, которая указывает расположение набора инструментов QtIFW.

Примечание

Указанный путь не должен содержать «bin» в конце (например: «D:\DevTools\QtIFW2.0.5»).

Переменная CPACK_IFW_ROOT имеет более высокий приоритет и переопределяет значение переменной QTIFWDIR.

Локализация

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

Инсталляторы, созданные инструментами QtIFW, имеют встроенную поддержку локализации, и многие фразы переведены на множество языков, но это не относится к описанию ваших компонентов и групп, которые будут распространяться.

Локализация описания ваших компонентов и групп полезна для пользователей ваших инсталляторов.

Локализованная переменная или аргумент может содержать одно значение по умолчанию и набор пар: имя локали и локализованное значение.

Например:

set(LOCALIZABLE_VARIABLE "Default value"
  en "English value"
  en_US "American value"
  en_GB "Great Britain value"
  )

Переменные

Вы можете использовать следующие переменные для изменения поведения генератора 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

Стиль мастера («Современный», «Mac», «Aero» или «Классический»).

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_INSTALLERBASE_EXECUTABLE

Путь к исполняемому файлу-основе установщика «installerbase».

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

CPACK_IFW_DEVTOOL_EXECUTABLE

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

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

Команды

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

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>] # Note: Internationalization supported
                    [DESCRIPTION <description>] # Note: Internationalization supported
                    [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
пара <название_для_отображения> и <путь_к_файлу> текстового файла лицензии для этого компонента. Можно указать несколько лицензий.
DEFAULT
Возможные значения: TRUE, FALSE и SCRIPT. Установите FALSE, чтобы отключить компонент в установщике, или SCRIPT, чтобы разрешить во время выполнения (не забудьте добавить файл скрипта как значение опции SCRIPT).
USER_INTERFACES
является списком <путей_к_файлам> (файлы '.ui'), представляющих страницы для загрузки.
TRANSLATIONS
является списком <путей_к_файлам> (файлы '.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>] # Note: Internationalization supported
                    [DESCRIPTION <description>] # Note: Internationalization supported
                    [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
пара <название_для_отображения> и <путь_к_файлу> текстового файла лицензии для этой группы компонентов. Можно указать несколько лицензий.
DEFAULT
Возможные значения: TRUE, FALSE и SCRIPT. Установите TRUE, чтобы предварительно выбрать группу в установщике (это действует только для групп, у которых нет видимых дочерних компонентов), или SCRIPT, чтобы разрешить во время выполнения (не забудьте добавить файл скрипта как значение опции SCRIPT).
USER_INTERFACES
является списком <путей_к_файлам> (файлы '.ui'), представляющих страницы для загрузки.
TRANSLATIONS
является списком <путей_к_файлам> (файлы '.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") # Default description
cpack_ifw_configure_component(myapp
    DESCRIPTION ru_RU "Мое Приложение" # Localized description
    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.9/module/CPackIFW.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API