This module looks for the location of the command line utilities supplied with the Qt Installer Framework (QtIFW).
The module also defines several commands to control the behavior of the CPack IFW
generator.
CPack IFW
generator helps you to create online and offline binary cross-platform installers with a graphical user interface.
CPack IFW generator prepares project installation and generates configuration and meta information for QtIFW tools.
The QtIFW provides a set of tools and utilities to create installers for the supported desktop Qt platforms: Linux, Microsoft Windows, and Mac OS X.
You should also install QtIFW to use CPack IFW
generator.
Generally, the CPack IFW
generator automatically finds QtIFW tools, but if you don’t use a default path for installation of the QtIFW tools, the path may be specified in either a CMake or an environment variable:
CPACK_IFW_ROOT
An CMake variable which specifies the location of the QtIFW tool suite.
The variable will be cached in the CPackConfig.cmake
file and used at CPack runtime.
QTIFWDIR
An environment variable which specifies the location of the QtIFW tool suite.
Note
The specified path should not contain “bin” at the end (for example: “D:\DevTools\QtIFW2.0.5”).
The CPACK_IFW_ROOT
variable has a higher priority and overrides the value of the QTIFWDIR
variable.
Some variables and command arguments support internationalization via CMake script. This is an optional feature.
Installers created by QtIFW tools have built-in support for internationalization and many phrases are localized to many languages, but this does not apply to the description of the your components and groups that will be distributed.
Localization of the description of your components and groups is useful for users of your installers.
A localized variable or argument can contain a single default value, and a set of pairs the name of the locale and the localized value.
For example:
set(LOCALIZABLE_VARIABLE "Default value" en "English value" en_US "American value" en_GB "Great Britain value" )
You can use the following variables to change behavior of CPack IFW
generator.
CPACK_IFW_VERBOSE
Set to ON
to enable addition debug output. By default is OFF
.
CPACK_IFW_PACKAGE_TITLE
Name of the installer as displayed on the title bar. By default used CPACK_PACKAGE_DESCRIPTION_SUMMARY
.
CPACK_IFW_PACKAGE_PUBLISHER
Publisher of the software (as shown in the Windows Control Panel). By default used CPACK_PACKAGE_VENDOR
.
CPACK_IFW_PRODUCT_URL
URL to a page that contains product information on your web site.
CPACK_IFW_PACKAGE_ICON
Filename for a custom installer icon. The actual file is ‘.icns’ (Mac OS X), ‘.ico’ (Windows). No functionality on Unix.
CPACK_IFW_PACKAGE_WINDOW_ICON
Filename for a custom window icon in PNG format for the Installer application.
CPACK_IFW_PACKAGE_LOGO
Filename for a logo is used as QWizard::LogoPixmap.
CPACK_IFW_PACKAGE_WATERMARK
Filename for a watermark is used as QWizard::WatermarkPixmap.
CPACK_IFW_PACKAGE_BANNER
Filename for a banner is used as QWizard::BannerPixmap.
CPACK_IFW_PACKAGE_BACKGROUND
Filename for an image used as QWizard::BackgroundPixmap (only used by MacStyle).
CPACK_IFW_PACKAGE_WIZARD_STYLE
Wizard style to be used (“Modern”, “Mac”, “Aero” or “Classic”).
CPACK_IFW_PACKAGE_WIZARD_DEFAULT_WIDTH
Default width of the wizard in pixels. Setting a banner image will override this.
CPACK_IFW_PACKAGE_WIZARD_DEFAULT_HEIGHT
Default height of the wizard in pixels. Setting a watermark image will override this.
CPACK_IFW_PACKAGE_TITLE_COLOR
Color of the titles and subtitles (takes an HTML color code, such as “#88FF33”).
CPACK_IFW_PACKAGE_START_MENU_DIRECTORY
Name of the default program group for the product in the Windows Start menu.
By default used CPACK_IFW_PACKAGE_NAME
.
CPACK_IFW_TARGET_DIRECTORY
Default target directory for installation. By default used “@ApplicationsDir@/CPACK_PACKAGE_INSTALL_DIRECTORY
”
You can use predefined variables.
CPACK_IFW_ADMIN_TARGET_DIRECTORY
Default target directory for installation with administrator rights.
You can use predefined variables.
CPACK_IFW_PACKAGE_GROUP
The group, which will be used to configure the root package
CPACK_IFW_PACKAGE_NAME
The root package name, which will be used if configuration group is not specified
CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_NAME
Filename of the generated maintenance tool. The platform-specific executable file extension is appended.
By default used QtIFW defaults (maintenancetool
).
CPACK_IFW_PACKAGE_REMOVE_TARGET_DIR
Set to OFF
if the target directory should not be deleted when uninstalling.
Is ON
by default
CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_INI_FILE
Filename for the configuration of the generated maintenance tool.
By default used QtIFW defaults (maintenancetool.ini
).
CPACK_IFW_PACKAGE_ALLOW_NON_ASCII_CHARACTERS
Set to ON
if the installation path can contain non-ASCII characters.
Is ON
for QtIFW less 2.0 tools.
CPACK_IFW_PACKAGE_ALLOW_SPACE_IN_PATH
Set to OFF
if the installation path cannot contain space characters.
Is ON
for QtIFW less 2.0 tools.
CPACK_IFW_PACKAGE_CONTROL_SCRIPT
Filename for a custom installer control script.
CPACK_IFW_PACKAGE_RESOURCES
List of additional resources (‘.qrc’ files) to include in the installer binary.
You can use cpack_ifw_add_package_resources()
command to resolve relative paths.
CPACK_IFW_PACKAGE_FILE_EXTENSION
The target binary extension.
On Linux, the name of the target binary is automatically extended with ‘.run’, if you do not specify the extension.
On Windows, the target is created as an application with the extension ‘.exe’, which is automatically added, if not supplied.
On Mac, the target is created as an DMG disk image with the extension ‘.dmg’, which is automatically added, if not supplied.
CPACK_IFW_REPOSITORIES_ALL
The list of remote repositories.
The default value of this variable is computed by CPack and contains all repositories added with command cpack_ifw_add_repository()
or updated with command cpack_ifw_update_repository()
.
CPACK_IFW_DOWNLOAD_ALL
If this is ON
all components will be downloaded. By default is OFF
or used value from CPACK_DOWNLOAD_ALL
if set
CPACK_IFW_RESOLVE_DUPLICATE_NAMES
Resolve duplicate names when installing components with groups.
CPACK_IFW_PACKAGES_DIRECTORIES
Additional prepared packages dirs that will be used to resolve dependent components.
CPACK_IFW_REPOSITORIES_DIRECTORIES
Additional prepared repository dirs that will be used to resolve and repack dependent components. This feature available only since QtIFW 3.1.
CPACK_IFW_FRAMEWORK_VERSION
The version of used QtIFW tools.
CPACK_IFW_BINARYCREATOR_EXECUTABLE
The path to “binarycreator” command line client.
This variable is cached and may be configured if needed.
CPACK_IFW_REPOGEN_EXECUTABLE
The path to “repogen” command line client.
This variable is cached and may be configured if needed.
CPACK_IFW_INSTALLERBASE_EXECUTABLE
The path to “installerbase” installer executable base.
This variable is cached and may be configured if needed.
CPACK_IFW_DEVTOOL_EXECUTABLE
The path to “devtool” command line client.
This variable is cached and may be configured if needed.
The module defines the following commands:
cpack_ifw_configure_component
Sets the arguments specific to the CPack IFW generator.
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> ...] [REPLACES <comp_id> ...] [CHECKABLE <value>])
This command should be called after cpack_add_component()
command.
COMMON
ESSENTIAL
VIRTUAL
HIDDEN
option from the cpack_add_component()
command.FORCED_INSTALLATION
REQUARED
option from the cpack_add_component()
command.REQUIRES_ADMIN_RIGHTS
NAME
DISPLAY_NAME
cpack_add_component()
command.DESCRIPTION
cpack_add_component()
command.UPDATE_TEXT
VERSION
CPACK_PACKAGE_VERSION
.RELEASE_DATE
SCRIPT
PRIORITY | SORTING_PRIORITY
PRIORITY
option is deprecated and will be removed in a future version of CMake. Please use SORTING_PRIORITY
option instead.DEPENDS | DEPENDENCIES
AUTO_DEPEND_ON
LICENSES
DEFAULT
SCRIPT
option).USER_INTERFACES
TRANSLATIONS
REPLACES
CHECKABLE
cpack_ifw_configure_component_group
Sets the arguments specific to the CPack IFW generator.
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> ...] [REPLACES <comp_id> ...] [CHECKABLE <value>])
This command should be called after cpack_add_component_group()
command.
VIRTUAL
FORCED_INSTALLATION
REQUIRES_ADMIN_RIGHTS
NAME
DISPLAY_NAME
cpack_add_component_group()
command.DESCRIPTION
cpack_add_component_group()
command.UPDATE_TEXT
VERSION
CPACK_PACKAGE_VERSION
.RELEASE_DATE
SCRIPT
PRIORITY | SORTING_PRIORITY
PRIORITY
option is deprecated and will be removed in a future version of CMake. Please use SORTING_PRIORITY
option instead.DEPENDS | DEPENDENCIES
AUTO_DEPEND_ON
LICENSES
DEFAULT
SCRIPT
option).USER_INTERFACES
TRANSLATIONS
REPLACES
CHECKABLE
cpack_ifw_add_repository
Add QtIFW specific remote repository to binary installer.
cpack_ifw_add_repository(<reponame> [DISABLED] URL <url> [USERNAME <username>] [PASSWORD <password>] [DISPLAY_NAME <display_name>])
This command will also add the <reponame> repository to a variable CPACK_IFW_REPOSITORIES_ALL
.
DISABLED
URL
USERNAME
PASSWORD
DISPLAY_NAME
cpack_ifw_update_repository
Update QtIFW specific repository from remote repository.
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>])
This command will also add the <reponame> repository to a variable CPACK_IFW_REPOSITORIES_ALL
.
URL
OLD_URL
NEW_URL
USERNAME
PASSWORD
DISPLAY_NAME
cpack_ifw_add_package_resources
Add additional resources in the installer binary.
cpack_ifw_add_package_resources(<file_path> <file_path> ...)
This command will also add the specified files to a variable 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")
By default CPack IFW generator makes offline installer. This means that all components will be packaged into a binary file.
To make a component downloaded, you must set the DOWNLOADED
option in cpack_add_component()
.
Then you would use the command cpack_configure_downloads()
. If you set ALL
option all components will be downloaded.
You also can use command cpack_ifw_add_repository()
and variable CPACK_IFW_DOWNLOAD_ALL
for more specific configuration.
CPack IFW generator creates “repository” dir in current binary dir. You would copy content of this dir to specified site
(url
).
Qt Installer Framework Manual:
© 2000–2018 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.12/module/CPackIFW.html