Configure and run the Qt Installer Framework to generate a Qt installer.
Contents
This cpack generator generates configuration and meta information for the Qt Installer Framework (QtIFW), and runs QtIFW tools to generate a Qt installer.
QtIFW provides tools and utilities to create installers for the platforms supported by Qt: Linux, Microsoft Windows, and macOS.
To make use of this generator, QtIFW needs to be installed. The CPackIFW module looks for the location of the QtIFW command-line utilities, and defines several commands to control the behavior of this generator.
You can use the following variables to change behavior of CPack IFW generator.
Name of the installer as displayed on the title bar. By default used CPACK_PACKAGE_DESCRIPTION_SUMMARY.
Publisher of the software (as shown in the Windows Control Panel). By default used CPACK_PACKAGE_VENDOR.
URL to a page that contains product information on your web site.
Filename for a custom installer icon. The actual file is ‘.icns’ (macOS), ‘.ico’ (Windows). No functionality on Unix.
Filename for a custom window icon in PNG format for the Installer application.
Filename for a logo is used as QWizard::LogoPixmap.
Filename for a watermark is used as QWizard::WatermarkPixmap.
Filename for a banner is used as QWizard::BannerPixmap.
Filename for an image used as QWizard::BackgroundPixmap (only used by MacStyle).
Wizard style to be used (“Modern”, “Mac”, “Aero” or “Classic”).
Filename for a stylesheet.
Default width of the wizard in pixels. Setting a banner image will override this.
Default height of the wizard in pixels. Setting a watermark image will override this.
Color of the titles and subtitles (takes an HTML color code, such as “#88FF33”).
Name of the default program group for the product in the Windows Start menu.
By default used CPACK_IFW_PACKAGE_NAME.
Default target directory for installation. By default used “@ApplicationsDir@/CPACK_PACKAGE_INSTALL_DIRECTORY” (variables embedded in ‘@’ are expanded by the QtIFW scripting engine).
You can use predefined variables.
Default target directory for installation with administrator rights.
You can use predefined variables.
The group, which will be used to configure the root package
The root package name, which will be used if configuration group is not specified
Filename of the generated maintenance tool. The platform-specific executable file extension is appended.
By default used QtIFW defaults (maintenancetool).
Set to OFF if the target directory should not be deleted when uninstalling.
Is ON by default
Filename for the configuration of the generated maintenance tool.
By default used QtIFW defaults (maintenancetool.ini).
Set to ON if the installation path can contain non-ASCII characters.
Is ON for QtIFW less 2.0 tools.
Set to OFF if the installation path cannot contain space characters.
Is ON for QtIFW less 2.0 tools.
Filename for a custom installer control script.
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.
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.
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().
If this is ON all components will be downloaded. By default is OFF or used value from CPACK_DOWNLOAD_ALL if set
Resolve duplicate names when installing components with groups.
Additional prepared packages dirs that will be used to resolve dependent components.
Additional prepared repository dirs that will be used to resolve and repack dependent components. This feature available only since QtIFW 3.1.
The version of used QtIFW tools.
The following variables provide the locations of the QtIFW command-line tools as discovered by the module CPackIFW. These variables are cached, and may be configured if needed.
The path to binarycreator.
The path to repogen.
The path to installerbase.
The path to devtool.
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:
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.
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.
By default, this generator generates an offline installer. This means that that all packaged files are fully contained in the installer executable.
In contrast, an online installer will download some or all components from a remote server.
The DOWNLOADED option in the cpack_add_component() command specifies that a component is to be downloaded. Alternatively, the ALL option in the cpack_configure_downloads() command specifies that all components are to be be downloaded.
The cpack_ifw_add_repository() command and the CPACK_IFW_DOWNLOAD_ALL variable allow for more specific configuration.
When there are online components, CPack will write them to archive files. The help page of the CPackComponent module, especially the section on the cpack_configure_downloads() function, explains how to make these files accessible from a download URL.
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"
)
Qt Installer Framework Manual: