NAME
cpack-generators - CPack Generator ReferenceGENERATORS
CPack Archive Generator
CPack generator for packaging files into an archive, which can have any of the following formats:- •
- 7Z - 7zip - (.7z)
- •
- TBZ2 (.tar.bz2)
- •
- TGZ (.tar.gz)
- •
- TXZ (.tar.xz)
- •
- TZ (.tar.Z)
- •
- TZST (.tar.zst)
- •
- ZIP (.zip)
set(CPACK_SOURCE_GENERATOR "TGZ") set(CPACK_SOURCE_IGNORE_FILES \\.git/ build/ ".*~$" ) set(CPACK_VERBATIM_VARIABLES YES) include(CPack)
Variables specific to CPack Archive generator
- CPACK_ARCHIVE_FILE_NAME
- CPACK_ARCHIVE_<component>_FILE_NAME
- Package file name without extension. The extension is determined from the archive format (see list above) and automatically appended to the file name. Note that <component> is all uppercase in the variable name. The default is <CPACK_PACKAGE_FILE_NAME>[-<component>], with spaces replaced by '-'. New in version 3.9: Per-component CPACK_ARCHIVE_<component>_FILE_NAME variables.
- CPACK_ARCHIVE_FILE_EXTENSION
- New in version 3.25. Package file extension. Default values are given in the list above.
- CPACK_ARCHIVE_COMPONENT_INSTALL
- Enable component packaging. If enabled (ON), then the archive generator creates multiple packages. The default is OFF, which means that a single package containing files of all components is generated.
Variables used by CPack Archive generator
These variables are used by the Archive generator, but are also available to CPack generators which are essentially archives at their core. These include:- •
- CPack Cygwin Generator
- •
- CPack FreeBSD Generator
- CPACK_ARCHIVE_THREADS
- New in version 3.18. The number of threads to use when performing the compression. If set to 0, the number of available cores on the machine will be used instead. The default is 1 which limits compression to a single thread. Note that not all compression modes support threading in all environments. Currently, only the XZ compression may support it. See also the CPACK_THREADS variable. New in version 3.21: Official CMake binaries available on cmake.org now ship with a liblzma that supports parallel compression. Older versions did not.
CPack Bundle Generator
CPack Bundle generator (macOS) specific optionsVariables specific to CPack Bundle generator
Installers built on macOS using the Bundle generator use the aforementioned DragNDrop ( CPACK_DMG_xxx) variables, plus the following Bundle-specific parameters ( CPACK_BUNDLE_xxx).- CPACK_BUNDLE_NAME
- The name of the generated bundle. This appears in the macOS Finder as the bundle name. Required.
- CPACK_BUNDLE_PLIST
- Path to an macOS Property List (.plist) file that will be used for the generated bundle. This assumes that the caller has generated or specified their own Info.plist file. Required.
- CPACK_BUNDLE_ICON
- Path to an macOS icon file that will be used as the icon for the generated bundle. This is the icon that appears in the macOS Finder for the bundle, and in the macOS dock when the bundle is opened. Required.
- CPACK_BUNDLE_STARTUP_COMMAND
- Path to a startup script. This is a path to an executable or script that will be run whenever an end-user double-clicks the generated bundle in the macOS Finder. Optional.
- CPACK_BUNDLE_APPLE_CERT_APP
- New in version 3.2. The name of your Apple supplied code signing certificate for the application. The name usually takes the form Developer ID Application: [Name] or 3rd Party Mac Developer Application: [Name]. If this variable is not set the application will not be signed.
- CPACK_BUNDLE_APPLE_ENTITLEMENTS
- New in version 3.2. The name of the Property List ( .plist) file that contains your Apple entitlements for sandboxing your application. This file is required for submission to the macOS App Store.
- CPACK_BUNDLE_APPLE_CODESIGN_FILES
- New in version 3.2. A list of additional files that you wish to be signed. You do not need to list the main application folder, or the main executable. You should list any frameworks and plugins that are included in your app bundle.
- CPACK_BUNDLE_APPLE_CODESIGN_PARAMETER
- New in version 3.3. Additional parameter that will passed to codesign. Default value: --deep -f
- CPACK_COMMAND_CODESIGN
- New in version 3.2. Path to the codesign(1) command used to sign applications with an Apple cert. This variable can be used to override the automatically detected command (or specify its location if the auto-detection fails to find it).
CPack Cygwin Generator
Cygwin CPack generator (Cygwin).Variables affecting the CPack Cygwin generator
- •
- New in version 3.18: CPACK_ARCHIVE_THREADS
Variables specific to CPack Cygwin generator
The following variable is specific to installers build on and/or for Cygwin:- CPACK_CYGWIN_PATCH_NUMBER
- The Cygwin patch number. FIXME: This documentation is incomplete.
- CPACK_CYGWIN_PATCH_FILE
- The Cygwin patch file. FIXME: This documentation is incomplete.
- CPACK_CYGWIN_BUILD_SCRIPT
- The Cygwin build script. FIXME: This documentation is incomplete.
CPack DEB Generator
The built in (binary) CPack DEB generator (Unix only)Variables specific to CPack Debian (DEB) generator
The CPack DEB generator may be used to create DEB package using CPack. The CPack DEB generator is a CPack generator thus it uses the CPACK_XXX variables used by CPack.- CPACK_DEB_COMPONENT_INSTALL
- Enable component packaging for CPackDEB
- •
- Mandatory : NO
- •
- Default : OFF
- CPACK_DEBIAN_PACKAGE_NAME
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_NAME
- Set Package control field (variable is automatically transformed to lower case).
- •
- Mandatory : YES
- •
- Default :
- •
- CPACK_PACKAGE_NAME for non-component based installations
- •
- CPACK_DEBIAN_PACKAGE_NAME suffixed with -<COMPONENT> for component-based installations.
- CPACK_DEBIAN_FILE_NAME
- CPACK_DEBIAN_<COMPONENT>_FILE_NAME
- New in version 3.6. Package file name.
- •
- Mandatory : YES
- •
- Default : <CPACK_PACKAGE_FILE_NAME>[-<component>].deb
<PackageName>_<VersionNumber>-<DebianRevisionNumber>_<DebianArchitecture>.deb
Preferred setting of this variable is
DEB-DEFAULT but for backward compatibility with the CPack DEB generator
in CMake prior to version 3.6 this feature is disabled by default.
By using non default filenames duplicate names
may occur. Duplicate files get overwritten and it is up to the packager to set
the variables in a manner that will prevent such errors.
- CPACK_DEBIAN_PACKAGE_EPOCH
- New in version 3.10. The Debian package epoch
- •
- Mandatory : No
- •
- Default : -
- CPACK_DEBIAN_PACKAGE_VERSION
- The Debian package version
- •
- Mandatory : YES
- •
- Default : CPACK_PACKAGE_VERSION
For backward compatibility with CMake 3.9 and
lower a failed test of this variable's content is not a hard error when both
CPACK_DEBIAN_PACKAGE_RELEASE and CPACK_DEBIAN_PACKAGE_EPOCH
variables are not set. An author warning is reported instead.
- CPACK_DEBIAN_PACKAGE_RELEASE
- New in version 3.6. The Debian package release - Debian revision number.
- •
- Mandatory : No
- •
- Default : -
- CPACK_DEBIAN_PACKAGE_ARCHITECTURE
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_ARCHITECTURE
- The Debian package architecture
- •
- Mandatory : YES
- •
- Default : Output of dpkg --print-architecture (or i386 if dpkg is not found)
- CPACK_DEBIAN_PACKAGE_DEPENDS
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_DEPENDS
- Sets the Debian dependencies of this package.
- •
- Mandatory : NO
- •
- Default :
- •
- An empty string for non-component based installations
- •
- CPACK_DEBIAN_PACKAGE_DEPENDS for component-based installations.
If CPACK_DEBIAN_PACKAGE_SHLIBDEPS or
more specifically CPACK_DEBIAN_<COMPONENT>_PACKAGE_SHLIBDEPS is
set for this component, the discovered dependencies will be appended to
CPACK_DEBIAN_<COMPONENT>_PACKAGE_DEPENDS instead of
CPACK_DEBIAN_PACKAGE_DEPENDS. If
CPACK_DEBIAN_<COMPONENT>_PACKAGE_DEPENDS is an empty string, only
the automatically discovered dependencies will be set for this
component.
set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6 (>= 2.3.1-6), libc6 (< 2.4)")
- CPACK_DEBIAN_ENABLE_COMPONENT_DEPENDS
- New in version 3.6. Sets inter-component dependencies if listed with CPACK_COMPONENT_<compName>_DEPENDS variables.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_DEBIAN_PACKAGE_MAINTAINER
- The Debian package maintainer
- •
- Mandatory : YES
- •
- Default : CPACK_PACKAGE_CONTACT
- CPACK_DEBIAN_PACKAGE_DESCRIPTION
- CPACK_DEBIAN_<COMPONENT>_DESCRIPTION
- The Debian package description
- •
- Mandatory : YES
- •
- Default :
- •
- CPACK_DEBIAN_<COMPONENT>_DESCRIPTION (component based installers only) if set, or CPACK_DEBIAN_PACKAGE_DESCRIPTION if set, or
- •
- CPACK_COMPONENT_<compName>_DESCRIPTION (component based installers only) if set, or CPACK_PACKAGE_DESCRIPTION if set, or
- •
- content of the file specified in CPACK_PACKAGE_DESCRIPTION_FILE if set
- CPACK_DEBIAN_PACKAGE_SECTION
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_SECTION
- Set Section control field e.g. admin, devel, doc, ...
- •
- Mandatory : YES
- •
- Default : "devel"
- CPACK_DEBIAN_ARCHIVE_TYPE
- New in version 3.7. Deprecated since version 3.14. The archive format used for creating the Debian package.
- •
- Mandatory : YES
- •
- Default : "gnutar"
- •
- gnutar
This variable previously defaulted to the
paxr value, but dpkg has never supported that tar format. For
backwards compatibility the paxr value will be mapped to gnutar
and a deprecation message will be emitted.
- CPACK_DEBIAN_COMPRESSION_TYPE
- New in version 3.1. The compression used for creating the Debian package.
- •
- Mandatory : YES
- •
- Default : "gzip"
- lzma
- Lempel–Ziv–Markov chain algorithm
- xz
- XZ Utils compression
- bzip2
- bzip2 Burrows–Wheeler algorithm
- gzip
- GNU Gzip compression
- zstd
- New in version 3.22. Zstandard compression
- CPACK_DEBIAN_PACKAGE_PRIORITY
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_PRIORITY
- Set Priority control field e.g. required, important, standard, optional, extra
- •
- Mandatory : YES
- •
- Default : "optional"
- CPACK_DEBIAN_PACKAGE_HOMEPAGE
- The URL of the web site for this package, preferably (when applicable) the site from which the original source can be obtained and any additional upstream documentation or information may be found.
- •
- Mandatory : NO
- •
- Default : CMAKE_PROJECT_HOMEPAGE_URL
The content of this field is a simple URL
without any surrounding characters such as <>.
- CPACK_DEBIAN_PACKAGE_SHLIBDEPS
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_SHLIBDEPS
- May be set to ON in order to use dpkg-shlibdeps to generate better package dependency list.
- •
- Mandatory : NO
- •
- Default :
- •
- CPACK_DEBIAN_PACKAGE_SHLIBDEPS if set or
- •
- OFF
You may need set CMAKE_INSTALL_RPATH to
an appropriate value if you use this feature, because if you don't
dpkg-shlibdeps may fail to find your own shared libs. See
https://gitlab.kitware.com/cmake/community/-/wikis/doc/cmake/RPATH-handling
You can also set
CPACK_DEBIAN_PACKAGE_SHLIBDEPS_PRIVATE_DIRS to an appropriate value if
you use this feature, in order to please dpkg-shlibdeps. However, you
should only do this for private shared libraries that could not get resolved
otherwise.
- CPACK_DEBIAN_PACKAGE_SHLIBDEPS_PRIVATE_DIRS
- New in version 3.20. May be set to a list of directories that will be given to dpkg-shlibdeps via its -l option. These will be searched by dpkg-shlibdeps in order to find private shared library dependencies.
- •
- Mandatory : NO
- •
- Default :
You should prefer to set
CMAKE_INSTALL_RPATH to an appropriate value if you use
dpkg-shlibdeps. The current option is really only needed for private
shared library dependencies.
- CPACK_DEBIAN_PACKAGE_DEBUG
- May be set when invoking cpack in order to trace debug information during the CPack DEB generator run.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_DEBIAN_PACKAGE_PREDEPENDS
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_PREDEPENDS
- Sets the Pre-Depends field of the Debian package. Like Depends, except that it also forces dpkg to complete installation of the packages named before even starting the installation of the package which declares the pre-dependency.
- •
- Mandatory : NO
- •
- Default :
- •
- An empty string for non-component based installations
- •
- CPACK_DEBIAN_PACKAGE_PREDEPENDS for component-based installations.
- CPACK_DEBIAN_PACKAGE_ENHANCES
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_ENHANCES
- Sets the Enhances field of the Debian package. Similar to Suggests but works in the opposite direction: declares that a package can enhance the functionality of another package.
- •
- Mandatory : NO
- •
- Default :
- •
- An empty string for non-component based installations
- •
- CPACK_DEBIAN_PACKAGE_ENHANCES for component-based installations.
- CPACK_DEBIAN_PACKAGE_BREAKS
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_BREAKS
- Sets the Breaks field of the Debian package. When a binary package (P) declares that it breaks other packages (B), dpkg will not allow the package (P) which declares Breaks be unpacked unless the packages that will be broken (B) are deconfigured first. As long as the package (P) is configured, the previously deconfigured packages (B) cannot be reconfigured again.
- •
- Mandatory : NO
- •
- Default :
- •
- An empty string for non-component based installations
- •
- CPACK_DEBIAN_PACKAGE_BREAKS for component-based installations.
- CPACK_DEBIAN_PACKAGE_CONFLICTS
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_CONFLICTS
- Sets the Conflicts field of the Debian package. When one binary package declares a conflict with another using a Conflicts field, dpkg will not allow them to be unpacked on the system at the same time.
- •
- Mandatory : NO
- •
- Default :
- •
- An empty string for non-component based installations
- •
- CPACK_DEBIAN_PACKAGE_CONFLICTS for component-based installations.
This is a stronger restriction than
Breaks, which prevents the broken package from being configured while
the breaking package is in the "Unpacked" state but allows both
packages to be unpacked at the same time.
- CPACK_DEBIAN_PACKAGE_PROVIDES
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_PROVIDES
- Sets the Provides field of the Debian package. A virtual package is one which appears in the Provides control field of another package.
- •
- Mandatory : NO
- •
- Default :
- •
- An empty string for non-component based installations
- •
- CPACK_DEBIAN_PACKAGE_PROVIDES for component-based installations.
- CPACK_DEBIAN_PACKAGE_REPLACES
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_REPLACES
- Sets the Replaces field of the Debian package. Packages can declare in their control file that they should overwrite files in certain other packages, or completely replace other packages.
- •
- Mandatory : NO
- •
- Default :
- •
- An empty string for non-component based installations
- •
- CPACK_DEBIAN_PACKAGE_REPLACES for component-based installations.
- CPACK_DEBIAN_PACKAGE_RECOMMENDS
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_RECOMMENDS
- Sets the Recommends field of the Debian package. Allows packages to declare a strong, but not absolute, dependency on other packages.
- •
- Mandatory : NO
- •
- Default :
- •
- An empty string for non-component based installations
- •
- CPACK_DEBIAN_PACKAGE_RECOMMENDS for component-based installations.
- CPACK_DEBIAN_PACKAGE_SUGGESTS
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_SUGGESTS
- Sets the Suggests field of the Debian package. Allows packages to declare a suggested package install grouping.
- •
- Mandatory : NO
- •
- Default :
- •
- An empty string for non-component based installations
- •
- CPACK_DEBIAN_PACKAGE_SUGGESTS for component-based installations.
- CPACK_DEBIAN_PACKAGE_GENERATE_SHLIBS
- New in version 3.6.
- •
- Mandatory : NO
- •
- Default : OFF
Libraries are only considered if they have
both library name and version set. This can be done by setting SOVERSION
property with set_target_properties() command.
- CPACK_DEBIAN_PACKAGE_GENERATE_SHLIBS_POLICY
- New in version 3.6. Compatibility policy for auto-generated shlibs control file.
- •
- Mandatory : NO
- •
- Default : "="
- CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_CONTROL_EXTRA
- This variable allow advanced user to add custom script to the control.tar.gz. Typical usage is for conffiles, postinst, postrm, prerm.
- •
- Mandatory : NO
- •
- Default : -
set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/prerm;${CMAKE_CURRENT_SOURCE_DIR}/postrm")
- CPACK_DEBIAN_PACKAGE_CONTROL_STRICT_PERMISSION
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_CONTROL_STRICT_PERMISSION
- New in version 3.4. This variable indicates if the Debian policy on control files should be strictly followed.
- •
- Mandatory : NO
- •
- Default : FALSE
set(CPACK_DEBIAN_PACKAGE_CONTROL_STRICT_PERMISSION TRUE)
The original permissions of the files will be
used in the final package unless this variable is set to TRUE. In
particular, the scripts should have the proper executable flag prior to the
generation of the package.
- CPACK_DEBIAN_PACKAGE_SOURCE
- CPACK_DEBIAN_<COMPONENT>_PACKAGE_SOURCE
- New in version 3.5. Sets the Source field of the binary Debian package. When the binary package name is not the same as the source package name (in particular when several components/binaries are generated from one source) the source from which the binary has been generated should be indicated with the field Source.
- •
- Mandatory : NO
- •
- Default :
- •
- An empty string for non-component based installations
- •
- CPACK_DEBIAN_PACKAGE_SOURCE for component-based installations.
This value is not interpreted. It is possible
to pass an optional revision number of the referenced source package as
well.
Packaging of debug information
New in version 3.13.- CPACK_DEBIAN_DEBUGINFO_PACKAGE
- CPACK_DEBIAN_<component>_DEBUGINFO_PACKAGE
- Enable generation of dbgsym .ddeb package(s).
- •
- Mandatory : NO
- •
- Default : OFF
Setting this also strips the ELF files in the
generated non-dbgsym package, which results in debuginfo only being available
in the dbgsym package.
Binaries must contain debug symbols before
packaging so use either Debug or RelWithDebInfo for
CMAKE_BUILD_TYPE variable value.
Additionally, if CPACK_STRIP_FILES is set, the files will be stripped
before they get to the DEB generator, so will not contain debug symbols and a
dbgsym package will not get built. Do not use with
CPACK_STRIP_FILES.
Building Debian packages on Windows
New in version 3.10.Reproducible packages
New in version 3.13.CPack DragNDrop Generator
The DragNDrop CPack generator (macOS) creates a DMG image.Variables specific to CPack DragNDrop generator
The following variables are specific to the DragNDrop installers built on macOS:- CPACK_DMG_VOLUME_NAME
- The volume name of the generated disk image. Defaults to CPACK_PACKAGE_FILE_NAME.
- CPACK_DMG_FORMAT
- The disk image format. Common values are UDRO (UDIF read-only), UDZO (UDIF zlib-compressed) or UDBZ (UDIF bzip2-compressed). Refer to hdiutil(1) for more information on other available formats. Defaults to UDZO.
- CPACK_DMG_DS_STORE
- Path to a custom .DS_Store file. This .DS_Store file can be used to specify the Finder window position/geometry and layout (such as hidden toolbars, placement of the icons etc.). This file has to be generated by the Finder (either manually or through AppleScript) using a normal folder from which the .DS_Store file can then be extracted.
- CPACK_DMG_DS_STORE_SETUP_SCRIPT
- New in version 3.5. Path to a custom AppleScript file. This AppleScript is used to generate a .DS_Store file which specifies the Finder window position/geometry and layout (such as hidden toolbars, placement of the icons etc.). By specifying a custom AppleScript there is no need to use CPACK_DMG_DS_STORE, as the .DS_Store that is generated by the AppleScript will be packaged.
- CPACK_DMG_BACKGROUND_IMAGE
- Path to an image file to be used as the background. This file will be copied to .background/background.<ext>, where <ext> is the original image file extension. The background image is installed into the image before CPACK_DMG_DS_STORE_SETUP_SCRIPT is executed or CPACK_DMG_DS_STORE is installed. By default no background image is set.
- CPACK_DMG_DISABLE_APPLICATIONS_SYMLINK
- New in version 3.6. Default behavior is to include a symlink to /Applications in the DMG. Set this option to ON to avoid adding the symlink.
- CPACK_DMG_SLA_USE_RESOURCE_FILE_LICENSE
- New in version 3.23. Control whether CPACK_RESOURCE_FILE_LICENSE, if set to a non-default value, is used as the license agreement provided when mounting the DMG. If CPACK_DMG_SLA_USE_RESOURCE_FILE_LICENSE is not set, cpack(1) defaults to off. In a CMake project that uses the CPack module to generate CPackConfig.cmake, CPACK_DMG_SLA_USE_RESOURCE_FILE_LICENSE must be explicitly enabled by the project to activate the SLA. See policy CMP0133. NOTE:
This option was added in response to macOS
12.0's deprecation of the hdiutil udifrez command to make its use
optional. CPack 3.22 and below always use CPACK_RESOURCE_FILE_LICENSE,
if set to a non-default value, as the DMG license.
- CPACK_DMG_SLA_DIR
- New in version 3.5. Directory where license and menu files for different languages are stored. Setting this causes CPack to look for a <language>.menu.txt and <language>.license.txt or <language>.license.rtf file for every language defined in CPACK_DMG_SLA_LANGUAGES. If both this variable and CPACK_RESOURCE_FILE_LICENSE are set, CPack will only look for the menu files and use the same license file for all languages. If both <language>.license.txt and <language>.license.rtf exist, the .txt file will be used. New in version 3.17: RTF support.
- CPACK_DMG_SLA_LANGUAGES
- New in version 3.5. Languages for which a license agreement is provided when mounting the generated DMG. A menu file consists of 9 lines of text. The first line is is the name of the language itself, uppercase, in English (e.g. German). The other lines are translations of the following strings:
- •
- Agree
- •
- Disagree
- •
- •
- Save...
- •
- You agree to the terms of the License Agreement when you click the "Agree" button.
- •
- Software License Agreement
- •
- This text cannot be saved. The disk may be full or locked, or the file may be locked.
- •
- Unable to print. Make sure you have selected a printer.
- CPACK_DMG_<component>_FILE_NAME
- New in version 3.17. File name when packaging <component> as its own DMG ( CPACK_COMPONENTS_GROUPING set to IGNORE).
- •
- Default: CPACK_PACKAGE_FILE_NAME-<component>
- CPACK_DMG_FILESYSTEM
- New in version 3.21. The filesystem format. Common values are APFS and HFS+. See man hdiutil for a full list of supported formats. Defaults to HFS+.
- CPACK_COMMAND_HDIUTIL
- Path to the hdiutil(1) command used to operate on disk image files on macOS. This variable can be used to override the automatically detected command (or specify its location if the auto-detection fails to find it).
- CPACK_COMMAND_SETFILE
- Path to the SetFile(1) command used to set extended attributes on files and directories on macOS. This variable can be used to override the automatically detected command (or specify its location if the auto-detection fails to find it).
- CPACK_COMMAND_REZ
- Path to the Rez(1) command used to compile resources on macOS. This variable can be used to override the automatically detected command (or specify its location if the auto-detection fails to find it).
CPack External Generator
New in version 3.13.Integration with External Packaging Tools
The CPack External generator generates a .json file containing the CPack internal metadata, which gives external software information on how to package the software. External packaging software may itself invoke CPack, consume the generated metadata, install and package files as required.JSON Format
The JSON metadata file contains a list of CPack components and component groups, the various options passed to cpack_add_component() and cpack_add_component_group(), the dependencies between the components and component groups, and various other options passed to CPack.Version 1.0
In addition to the standard format fields, format version 1.0 provides the following fields in the root:- components
- The components field is an object with component names as the keys and objects describing the components as the values. The component objects have the following fields:
- name
- The name of the component. This is always the same as the key in the components object.
- displayName
- The value of the DISPLAY_NAME field passed to cpack_add_component().
- description
- The value of the DESCRIPTION field passed to cpack_add_component().
- isHidden
- True if HIDDEN was passed to cpack_add_component(), false if it was not.
- isRequired
- True if REQUIRED was passed to cpack_add_component(), false if it was not.
- isDisabledByDefault
- True if DISABLED was passed to cpack_add_component(), false if it was not.
- group
- Only present if GROUP was passed to cpack_add_component(). If so, this field is a string value containing the component's group.
- dependencies
- An array of components the component depends on. This contains the values in the DEPENDS argument passed to cpack_add_component(). If no DEPENDS argument was passed, this is an empty list.
- installationTypes
- An array of installation types the component is part of. This contains the values in the INSTALL_TYPES argument passed to cpack_add_component(). If no INSTALL_TYPES argument was passed, this is an empty list.
- isDownloaded
- True if DOWNLOADED was passed to cpack_add_component(), false if it was not.
- archiveFile
- The name of the archive file passed with the ARCHIVE_FILE argument to cpack_add_component(). If no ARCHIVE_FILE argument was passed, this is an empty string.
- componentGroups
- The componentGroups field is an object with component group names as the keys and objects describing the component groups as the values. The component group objects have the following fields:
- name
- The name of the component group. This is always the same as the key in the componentGroups object.
- displayName
- The value of the DISPLAY_NAME field passed to cpack_add_component_group().
- description
- The value of the DESCRIPTION field passed to cpack_add_component_group().
- parentGroup
- Only present if PARENT_GROUP was passed to cpack_add_component_group(). If so, this field is a string value containing the component group's parent group.
- isExpandedByDefault
- True if EXPANDED was passed to cpack_add_component_group(), false if it was not.
- isBold
- True if BOLD_TITLE was passed to cpack_add_component_group(), false if it was not.
- components
- An array of names of components that are direct members of the group (components that have this group as their GROUP). Components of subgroups are not included.
- subgroups
- An array of names of component groups that are subgroups of the group (groups that have this group as their PARENT_GROUP).
- installationTypes
- The installationTypes field is an object with installation type names as the keys and objects describing the installation types as the values. The installation type objects have the following fields:
- name
- The name of the installation type. This is always the same as the key in the installationTypes object.
- displayName
- The value of the DISPLAY_NAME field passed to cpack_add_install_type().
- index
- The integer index of the installation type in the list.
- projects
- The projects field is an array of objects describing CMake projects which comprise the CPack project. The values in this field are derived from CPACK_INSTALL_CMAKE_PROJECTS. In most cases, this will be only a single project. The project objects have the following fields:
- projectName
- The project name passed to CPACK_INSTALL_CMAKE_PROJECTS.
- component
- The name of the component or component set which comprises the project.
- directory
- The build directory of the CMake project. This is the directory which contains the cmake_install.cmake script.
- subDirectory
- The subdirectory to install the project into inside the CPack package.
- packageName
- The package name given in CPACK_PACKAGE_NAME. Only present if this option is set.
- packageVersion
- The package version given in CPACK_PACKAGE_VERSION. Only present if this option is set.
- packageDescriptionFile
- The package description file given in CPACK_PACKAGE_DESCRIPTION_FILE. Only present if this option is set.
- packageDescriptionSummary
- The package description summary given in CPACK_PACKAGE_DESCRIPTION_SUMMARY. Only present if this option is set.
- buildConfig
- The build configuration given to CPack with the cpack -C option. Only present if this option is set.
- defaultDirectoryPermissions
- The default directory permissions given in CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS. Only present if this option is set.
- setDestdir
- True if CPACK_SET_DESTDIR is true, false if it is not.
- packagingInstallPrefix
- The install prefix given in CPACK_PACKAGING_INSTALL_PREFIX. Only present if CPACK_SET_DESTDIR is true.
- stripFiles
- True if CPACK_STRIP_FILES is true, false if it is not.
- warnOnAbsoluteInstallDestination
- True if CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION is true, false if it is not.
- errorOnAbsoluteInstallDestination
- True if CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION is true, false if it is not.
Variables specific to CPack External generator
- CPACK_EXTERNAL_REQUESTED_VERSIONS
- This variable is used to request a specific version of the CPack External generator. It is a list of major.minor values, separated by semicolons. If this variable is set to a non-empty value, the CPack External generator will iterate through each item in the list to search for a version that it knows how to generate. Requested versions should be listed in order of descending preference by the client software, as the first matching version in the list will be generated. The generator knows how to generate the version if it has a versioned generator whose major version exactly matches the requested major version, and whose minor version is greater than or equal to the requested minor version. For example, if CPACK_EXTERNAL_REQUESTED_VERSIONS contains 1.0, and the CPack External generator knows how to generate 1.1, it will generate 1.1. If the generator doesn't know how to generate a version in the list, it skips the version and looks at the next one. If it doesn't know how to generate any of the requested versions, an error is thrown. If this variable is not set, or is empty, the CPack External generator will generate the highest major and minor version that it knows how to generate. If an invalid version is encountered in CPACK_EXTERNAL_REQUESTED_VERSIONS (one that doesn't match major.minor, where major and minor are integers), it is ignored.
- CPACK_EXTERNAL_ENABLE_STAGING
- This variable can be set to true to enable optional installation into a temporary staging area which can then be picked up and packaged by an external packaging tool. The top level directory used by CPack for the current packaging task is contained in CPACK_TOPLEVEL_DIRECTORY. It is automatically cleaned up on each run before packaging is initiated and can be used for custom temporary files required by the external packaging tool. It also contains the staging area CPACK_TEMPORARY_DIRECTORY into which CPack performs the installation when staging is enabled.
- CPACK_EXTERNAL_PACKAGE_SCRIPT
- This variable can optionally specify the full path to a CMake script file to be run as part of the CPack invocation. It is invoked after (optional) staging took place and may run an external packaging tool. The script has access to the variables defined by the CPack config file.
- CPACK_EXTERNAL_BUILT_PACKAGES
- New in version 3.19. The CPACK_EXTERNAL_PACKAGE_SCRIPT script may set this list variable to the full paths of generated package files. CPack will copy these files from the staging directory back to the top build directory and possibly produce checksum files if the CPACK_PACKAGE_CHECKSUM is set.
CPack FreeBSD Generator
New in version 3.10.Variables affecting the CPack FreeBSD (pkg) generator
- •
- New in version 3.18: CPACK_ARCHIVE_THREADS
Variables specific to CPack FreeBSD (pkg) generator
The CPack FreeBSD generator may be used to create pkg(8) packages -- these may be used on FreeBSD, DragonflyBSD, NetBSD, OpenBSD, but also on Linux or OSX, depending on the installed package-management tools -- using CPack.- CPACK_FREEBSD_PACKAGE_NAME
- Sets the package name (in the package manifest, but also affects the output filename).
- •
- Mandatory: YES
- •
- Default:
- •
- CPACK_PACKAGE_NAME (this is always set by CPack itself, based on CMAKE_PROJECT_NAME).
- CPACK_FREEBSD_PACKAGE_COMMENT
- Sets the package comment. This is the short description displayed by pkg(8) in standard "pkg info" output.
- •
- Mandatory: YES
- •
- Default:
- •
- CPACK_PACKAGE_DESCRIPTION_SUMMARY (this is always set by CPack itself, if nothing else sets it explicitly).
- CPACK_FREEBSD_PACKAGE_DESCRIPTION
- Sets the package description. This is the long description of the package, given by "pkg info" with a specific package as argument.
- •
- Mandatory: YES
- •
- Default:
- •
- CPACK_DEBIAN_PACKAGE_DESCRIPTION (this may be set already for Debian packaging, so it is used as a fallback).
- •
- CPACK_PACKAGE_DESCRIPTION_SUMMARY (this is always set by CPack itself, if nothing else sets it explicitly).
- •
- PROJECT_DESCRIPTION (this can be set with the DESCRIPTION parameter for project()).
- CPACK_FREEBSD_PACKAGE_WWW
- The URL of the web site for this package, preferably (when applicable) the site from which the original source can be obtained and any additional upstream documentation or information may be found.
- •
- Mandatory: YES
- •
- Default:
- •
- CPACK_PACKAGE_HOMEPAGE_URL, or if that is not set,
- •
- CPACK_DEBIAN_PACKAGE_HOMEPAGE (this may be set already for Debian packaging, so it is used as a fallback).
- CPACK_FREEBSD_PACKAGE_LICENSE
- The license, or licenses, which apply to this software package. This must be one or more license-identifiers that pkg recognizes as acceptable license identifiers (e.g. "GPLv2").
- •
- Mandatory: YES
- •
- Default:
- •
- CPACK_RPM_PACKAGE_LICENSE
- CPACK_FREEBSD_PACKAGE_LICENSE_LOGIC
- This variable is only of importance if there is more than one license. The default is "single", which is only applicable to a single license. Other acceptable values are determined by pkg -- those are "dual" or "multi" -- meaning choice (OR) or simultaneous (AND) application of the licenses.
- •
- Mandatory: NO
- •
- Default: single
- CPACK_FREEBSD_PACKAGE_MAINTAINER
- The FreeBSD maintainer (e.g. [email protected]) of this package.
- •
- Mandatory: YES
- •
- Default: none
- CPACK_FREEBSD_PACKAGE_ORIGIN
- The origin (ports label) of this package; for packages built by CPack outside of the ports system this is of less importance. The default puts the package somewhere under misc/, as a stopgap.
- •
- Mandatory: YES
- •
- Default: misc/<package name>
- CPACK_FREEBSD_PACKAGE_CATEGORIES
- The ports categories where this package lives (if it were to be built from ports). If none is set a single category is determined based on the package origin.
- •
- Mandatory: YES
- •
- Default: derived from ORIGIN
- CPACK_FREEBSD_PACKAGE_DEPS
- A list of package origins that should be added as package dependencies. These are in the form <category>/<packagename>, e.g. x11/libkonq. No version information needs to be provided (this is not included in the manifest).
- •
- Mandatory: NO
- •
- Default: empty
CPack IFW Generator
New in version 3.1.Overview
This cpack generator generates configuration and meta information for the Qt Installer Framework (QtIFW), and runs QtIFW tools to generate a Qt installer.Variables
You can use the following variables to change the behavior of the CPack IFW generator.Debug
- CPACK_IFW_VERBOSE
- New in version 3.3. Set to ON to enable addition debug output. By default is OFF.
Package
- CPACK_IFW_PACKAGE_TITLE
- Name of the installer as displayed on the title bar. If not specified, it defaults to CPACK_PACKAGE_DESCRIPTION_SUMMARY.
- CPACK_IFW_PACKAGE_PUBLISHER
- Publisher of the software (as shown in the Windows Control Panel). If not specified, it defaults to 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. It must be an absolute path. This should be a .icns file on macOS and a .ico file on Windows. It is ignored on other platforms.
- CPACK_IFW_PACKAGE_WINDOW_ICON
- Filename for a custom window icon in PNG format for the Installer application. It must be an absolute path.
- CPACK_IFW_PACKAGE_LOGO
- Filename for a logo image in PNG format, used as QWizard::LogoPixmap. It must be an absolute path.
- CPACK_IFW_PACKAGE_WATERMARK
- New in version 3.8. Filename for a watermark image in PNG format, used as QWizard::WatermarkPixmap. It must be an absolute path.
- CPACK_IFW_PACKAGE_BANNER
- New in version 3.8. Filename for a banner image in PNG format, used as QWizard::BannerPixmap. It must be an absolute path.
- CPACK_IFW_PACKAGE_BACKGROUND
- New in version 3.8. Filename for a background image in PNG format, used as QWizard::BackgroundPixmap (only used by MacStyle). It must be an absolute path.
- CPACK_IFW_PACKAGE_WIZARD_STYLE
- New in version 3.8. Wizard style to be used ( Modern, Mac, Aero or Classic).
- CPACK_IFW_PACKAGE_WIZARD_DEFAULT_WIDTH
- New in version 3.8. Default width of the wizard in pixels. Setting a banner image will override this.
- CPACK_IFW_PACKAGE_WIZARD_DEFAULT_HEIGHT
- New in version 3.8. Default height of the wizard in pixels. Setting a watermark image will override this.
- CPACK_IFW_PACKAGE_WIZARD_SHOW_PAGE_LIST
- New in version 3.20. Set to OFF if the widget listing installer pages on the left side of the wizard should not be shown. It is ON by default, but will only have an effect if using QtIFW 4.0 or later.
- CPACK_IFW_PACKAGE_TITLE_COLOR
- New in version 3.8. Color of the titles and subtitles (takes an HTML color code, such as #88FF33).
- CPACK_IFW_PACKAGE_STYLE_SHEET
- New in version 3.15. Filename for a stylesheet. It must be an absolute path.
- CPACK_IFW_TARGET_DIRECTORY
- Default target directory for installation. If CPACK_PACKAGE_INSTALL_DIRECTORY is set, this defaults to @ApplicationsDir@/${CPACK_PACKAGE_INSTALL_DIRECTORY}. If that variable isn't set either, the default used is @RootDir@/usr/local. Predefined variables of the form @...@ are expanded by the QtIFW scripting engine.
- CPACK_IFW_ADMIN_TARGET_DIRECTORY
- Default target directory for installation with administrator rights. You can use predefined variables.
- CPACK_IFW_PACKAGE_REMOVE_TARGET_DIR
- New in version 3.11. Set to OFF if the target directory should not be deleted when uninstalling. Is ON by default
- 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 the configuration group is not specified.
- CPACK_IFW_PACKAGE_START_MENU_DIRECTORY
- New in version 3.3. Name of the default program group for the product in the Windows Start menu. If not specified, it defaults to CPACK_IFW_PACKAGE_NAME.
- CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_NAME
- New in version 3.3. Filename of the generated maintenance tool. The platform-specific executable file extension will be appended. If not specified, QtIFW provides a default name ( maintenancetool).
- CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_INI_FILE
- New in version 3.3. Filename for the configuration of the generated maintenance tool. If not specified, QtIFW uses a default file name ( maintenancetool.ini).
- CPACK_IFW_PACKAGE_ALLOW_NON_ASCII_CHARACTERS
- New in version 3.3. Set to ON if the installation path can contain non-ASCII characters. Only supported for QtIFW 2.0 and later. Older QtIFW versions will always allow non-ASCII characters.
- CPACK_IFW_PACKAGE_ALLOW_SPACE_IN_PATH
- New in version 3.3. Set to OFF if the installation path cannot contain space characters. Is ON for QtIFW less 2.0 tools.
- CPACK_IFW_PACKAGE_DISABLE_COMMAND_LINE_INTERFACE
- New in version 3.23. Set to ON if command line interface features should be disabled. It is OFF by default and will only have an effect if using QtIFW 4.0 or later.
- CPACK_IFW_PACKAGE_CONTROL_SCRIPT
- New in version 3.3. Filename for a custom installer control script.
- CPACK_IFW_PACKAGE_RESOURCES
- New in version 3.7. List of additional resources ( .qrc files) to include in the installer binary. They should be specified as absolute paths and no two resource files can have the same file name. You can use the cpack_ifw_add_package_resources() command to resolve relative paths.
- CPACK_IFW_PACKAGE_FILE_EXTENSION
- New in version 3.10. 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 cpack_ifw_add_repository() or updated with cpack_ifw_update_repository().
- CPACK_IFW_DOWNLOAD_ALL
- If this is ON, all components will be downloaded. If not set, the behavior is determined by whether cpack_configure_downloads() has been called with the ALL option or not.
- CPACK_IFW_PACKAGE_PRODUCT_IMAGES
- New in version 3.23. A list of images to be shown on the PerformInstallationPage. These must be absolute paths and the images must be in PNG format. This feature is available for QtIFW 4.0.0 and later.
- CPACK_IFW_PACKAGE_RUN_PROGRAM
- New in version 3.23. Command executed after the installer is finished, if the user accepts the action. Provide the full path to the application, as found when installed. This typically means the path should begin with the QtIFW predefined variable @TargetDir@. This feature is available for QtIFW 4.0.0 and later.
- CPACK_IFW_PACKAGE_RUN_PROGRAM_ARGUMENTS
- New in version 3.23. List of arguments passed to the program specified in CPACK_IFW_PACKAGE_RUN_PROGRAM. This feature is available for QtIFW 4.0.0 and later.
- CPACK_IFW_PACKAGE_RUN_PROGRAM_DESCRIPTION
- New in version 3.23. Text shown next to the check box for running the program after the installation. If CPACK_IFW_PACKAGE_RUN_PROGRAM is set but no description is provided, QtIFW will use a default message like Run <Name> now. This feature is available for QtIFW 4.0.0 and later.
- CPACK_IFW_PACKAGE_SIGNING_IDENTITY
- New in version 3.23. Allows specifying a code signing identity to be used for signing the generated app bundle. Only available on macOS, ignored on other platforms.
- CPACK_IFW_ARCHIVE_FORMAT
- New in version 3.23. Set the format used when packaging new component data archives. If you omit this option, the 7z format will be used as a default. Supported formats:
- •
- 7z
- •
- zip
- •
- tar.gz
- •
- tar.bz2
- •
- tar.xz
If the Qt Installer Framework tools were built
without libarchive support, only 7z format is supported.
- CPACK_IFW_ARCHIVE_COMPRESSION
- New in version 3.23. Archive compression level. The allowable values are:
- •
- 0 (No compression)
- •
- 1 (Fastest compression)
- •
- 3 (Fast compression)
- •
- 5 (Normal compression)
- •
- 7 (Maximum compression)
- •
- 9 (Ultra compression)
Some formats do not support all the possible
values. For example zip compression only supports values from 1 to
7.
Components
- CPACK_IFW_RESOLVE_DUPLICATE_NAMES
- Resolve duplicate names when installing components with groups.
- CPACK_IFW_PACKAGES_DIRECTORIES
- Additional prepared packages directories that will be used to resolve dependent components.
- CPACK_IFW_REPOSITORIES_DIRECTORIES
- New in version 3.10. Additional prepared repository directories that will be used to resolve and repack dependent components. This feature is available for QtIFW 3.1 and later.
QtIFW Tools
- CPACK_IFW_FRAMEWORK_VERSION
- New in version 3.3. The version of the QtIFW tools that will be used. This variable is set by the CPackIFW module.
- CPACK_IFW_ARCHIVEGEN_EXECUTABLE
- New in version 3.19. The path to archivegen.
- CPACK_IFW_BINARYCREATOR_EXECUTABLE
- The path to binarycreator.
- CPACK_IFW_REPOGEN_EXECUTABLE
- The path to repogen.
- CPACK_IFW_INSTALLERBASE_EXECUTABLE
- The path to installerbase.
- CPACK_IFW_DEVTOOL_EXECUTABLE
- The path to devtool.
Hints for Finding QtIFW
Generally, the CPack IFW generator automatically finds QtIFW tools. The following (in order of precedence) can also be set to augment the locations normally searched by find_program():- CPACK_IFW_ROOT
- New in version 3.9. CMake variable
- CPACK_IFW_ROOT
- New in version 3.9. Environment variable
- QTIFWDIR
- CMake variable
- QTIFWDIR
- Environment variable
The specified path should not contain
bin at the end (for example: D:\\DevTools\\QtIFW2.0.5).
Other Settings
Online installer
By default, this generator generates an offline installer. This means that all packaged files are fully contained in the installer executable.Internationalization
New in version 3.9.set(LOCALIZABLE_VARIABLE "Default value" en "English value" en_US "American value" en_GB "Great Britain value" )
See Also
Qt Installer Framework Manual:- •
- Index page: https://doc.qt.io/qtinstallerframework/index.html
- •
- Component Scripting: https://doc.qt.io/qtinstallerframework/scripting.html
- •
- Predefined Variables: https://doc.qt.io/qtinstallerframework/scripting.html#predefined-variables
- •
- Promoting Updates: https://doc.qt.io/qtinstallerframework/ifw-updates.html
- Download Qt Installer Framework for your platform from Qt site:
- https://download.qt.io/official_releases/qt-installer-framework
CPack NSIS Generator
CPack Nullsoft Scriptable Install System (NSIS) generator specific options.Variables specific to CPack NSIS generator
The following variables are specific to the graphical installers built on Windows Nullsoft Scriptable Install System.- CPACK_NSIS_INSTALL_ROOT
- The default installation directory presented to the end user by the NSIS installer is under this root dir. The full directory presented to the end user is: ${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY}
- CPACK_NSIS_MUI_ICON
- An icon filename. The name of a *.ico file used as the main icon for the generated install program.
- CPACK_NSIS_MUI_UNIICON
- An icon filename. The name of a *.ico file used as the main icon for the generated uninstall program.
- CPACK_NSIS_INSTALLER_MUI_ICON_CODE
- undocumented.
- CPACK_NSIS_MUI_WELCOMEFINISHPAGE_BITMAP
- New in version 3.5. The filename of a bitmap to use as the NSIS MUI_WELCOMEFINISHPAGE_BITMAP.
- CPACK_NSIS_MUI_UNWELCOMEFINISHPAGE_BITMAP
- New in version 3.5. The filename of a bitmap to use as the NSIS MUI_UNWELCOMEFINISHPAGE_BITMAP.
- CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS
- Extra NSIS commands that will be added to the beginning of the install Section, before your install tree is available on the target system.
- CPACK_NSIS_EXTRA_INSTALL_COMMANDS
- Extra NSIS commands that will be added to the end of the install Section, after your install tree is available on the target system.
- CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
- Extra NSIS commands that will be added to the uninstall Section, before your install tree is removed from the target system.
- CPACK_NSIS_COMPRESSOR
- The arguments that will be passed to the NSIS SetCompressor command.
- CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL
- Ask about uninstalling previous versions first. If this is set to ON, then an installer will look for previous installed versions and if one is found, ask the user whether to uninstall it before proceeding with the install.
- CPACK_NSIS_MODIFY_PATH
- Modify PATH toggle. If this is set to ON, then an extra page will appear in the installer that will allow the user to choose whether the program directory should be added to the system PATH variable.
- CPACK_NSIS_DISPLAY_NAME
- The display name string that appears in the Windows Apps & features in Control Panel
- CPACK_NSIS_PACKAGE_NAME
- The title displayed at the top of the installer.
- CPACK_NSIS_INSTALLED_ICON_NAME
- A path to the executable that contains the installer icon.
- CPACK_NSIS_HELP_LINK
- URL to a web site providing assistance in installing your application.
- CPACK_NSIS_URL_INFO_ABOUT
- URL to a web site providing more information about your application.
- CPACK_NSIS_CONTACT
- Contact information for questions and comments about the installation process.
- CPACK_NSIS_<compName>_INSTALL_DIRECTORY
- New in version 3.7. Custom install directory for the specified component <compName> instead of $INSTDIR.
- CPACK_NSIS_CREATE_ICONS_EXTRA
- Additional NSIS commands for creating Start Menu shortcuts.
- CPACK_NSIS_DELETE_ICONS_EXTRA
- Additional NSIS commands to uninstall Start Menu shortcuts.
- CPACK_NSIS_EXECUTABLES_DIRECTORY
- Creating NSIS Start Menu links assumes that they are in bin unless this variable is set. For example, you would set this to exec if your executables are in an exec directory.
- CPACK_NSIS_MUI_FINISHPAGE_RUN
- Specify an executable to add an option to run on the finish page of the NSIS installer.
- CPACK_NSIS_MENU_LINKS
- Specify links in [application] menu. This should contain a list of pair link link name. The link may be a URL or a path relative to installation prefix. Like:
set(CPACK_NSIS_MENU_LINKS "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html" "CMake Help" "https://cmake.org" "CMake Web Site")
- CPACK_NSIS_UNINSTALL_NAME
- New in version 3.17. Specify the name of the program to uninstall the version. Default is Uninstall.
- CPACK_NSIS_WELCOME_TITLE
- New in version 3.17. The title to display on the top of the page for the welcome page.
- CPACK_NSIS_WELCOME_TITLE_3LINES
- New in version 3.17. Display the title in the welcome page on 3 lines instead of 2.
- CPACK_NSIS_FINISH_TITLE
- New in version 3.17. The title to display on the top of the page for the finish page.
- CPACK_NSIS_FINISH_TITLE_3LINES
- New in version 3.17. Display the title in the finish page on 3 lines instead of 2.
- CPACK_NSIS_MUI_HEADERIMAGE
- New in version 3.17. The image to display on the header of installers pages.
- CPACK_NSIS_MANIFEST_DPI_AWARE
- New in version 3.18. If set, declares that the installer is DPI-aware.
- CPACK_NSIS_BRANDING_TEXT
- New in version 3.20. If set, updates the text at the bottom of the install window. To set the string to blank, use a space (" ").
- CPACK_NSIS_BRANDING_TEXT_TRIM_POSITION
- New in version 3.20. If set, trim down the size of the control to the size of the branding text string. Allowed values for this variable are LEFT, CENTER or RIGHT. If not specified, the default behavior is LEFT.
- CPACK_NSIS_EXECUTABLE
- New in version 3.21. If set, specify the name of the NSIS executable. Default is makensis.
- CPACK_NSIS_IGNORE_LICENSE_PAGE
- New in version 3.22. If set, do not display the page containing the license during installation.
- CPACK_NSIS_EXECUTABLE_PRE_ARGUMENTS
- New in version 3.25. This variable is a semicolon-separated list of arguments to prepend to the nsis script to run. If the arguments do not start with a / or a -, it will add one automatically to the corresponding arguments. The command that will be run is:
makensis.exe <preArgs>... "nsisFileName.nsi" <postArgs>...
- CPACK_NSIS_EXECUTABLE_POST_ARGUMENTS
- New in version 3.25. This variable is a semicolon-separated list of arguments to append to the nsis script to run. If the arguments do not start with a / or a -, it will add one automatically to the corresponding arguments. The command that will be run is:
makensis.exe <preArgs>... "nsisFileName.nsi" <postArgs>...
CPack NuGet Generator
New in version 3.12.Variables specific to CPack NuGet generator
The CPack NuGet generator may be used to create NuGet packages using CPack. The CPack NuGet generator is a CPack generator thus it uses the CPACK_XXX variables used by CPack.- CPACK_NUGET_COMPONENT_INSTALL
- Enable component packaging for CPack NuGet generator
- •
- Mandatory : NO
- •
- Default : OFF
- CPACK_NUGET_PACKAGE_NAME
- CPACK_NUGET_<compName>_PACKAGE_NAME
- The NUGET package name. CPACK_NUGET_PACKAGE_NAME is used as the package id on nuget.org
- •
- Mandatory : YES
- •
- Default : CPACK_PACKAGE_NAME
- CPACK_NUGET_PACKAGE_VERSION
- CPACK_NUGET_<compName>_PACKAGE_VERSION
- The NuGet package version.
- •
- Mandatory : YES
- •
- Default : CPACK_PACKAGE_VERSION
- CPACK_NUGET_PACKAGE_DESCRIPTION
- CPACK_NUGET_<compName>_PACKAGE_DESCRIPTION
- A long description of the package for UI display.
- •
- Mandatory : YES
- •
- Default :
- •
- CPACK_COMPONENT_<compName>_DESCRIPTION,
- •
- CPACK_COMPONENT_GROUP_<groupName>_DESCRIPTION,
- •
- CPACK_PACKAGE_DESCRIPTION
- CPACK_NUGET_PACKAGE_AUTHORS
- CPACK_NUGET_<compName>_PACKAGE_AUTHORS
- A comma-separated list of packages authors, matching the profile names on nuget.org. These are displayed in the NuGet Gallery on nuget.org and are used to cross-reference packages by the same authors.
- •
- Mandatory : YES
- •
- Default : CPACK_PACKAGE_VENDOR
- CPACK_NUGET_PACKAGE_TITLE
- CPACK_NUGET_<compName>_PACKAGE_TITLE
- A human-friendly title of the package, typically used in UI displays as on nuget.org and the Package Manager in Visual Studio. If not specified, the package ID is used.
- •
- Mandatory : NO
- •
- Default :
- •
- CPACK_COMPONENT_<compName>_DISPLAY_NAME,
- •
- CPACK_COMPONENT_GROUP_<groupName>_DISPLAY_NAME
- CPACK_NUGET_PACKAGE_OWNERS
- CPACK_NUGET_<compName>_PACKAGE_OWNERS
- A comma-separated list of the package creators using profile names on nuget.org. This is often the same list as in authors, and is ignored when uploading the package to nuget.org.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_HOMEPAGE_URL
- CPACK_NUGET_<compName>_PACKAGE_HOMEPAGE_URL
- An URL for the package's home page, often shown in UI displays as well as nuget.org.
- •
- Mandatory : NO
- •
- Default : CPACK_PACKAGE_HOMEPAGE_URL
- CPACK_NUGET_PACKAGE_LICENSEURL
- CPACK_NUGET_<compName>_PACKAGE_LICENSEURL
- Deprecated since version 3.20: Use a local license file ( CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME) or a SPDX license identifier ( CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION) instead. An URL for the package's license, often shown in UI displays as well as on nuget.org.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION
- CPACK_NUGET_<compName>_PACKAGE_LICENSE_EXPRESSION
- New in version 3.20. A Software Package Data Exchange SPDX license identifier such as MIT, BSD-3-Clause, or LGPL-3.0-or-later. In the case of a choice of licenses or more complex restrictions, compound license expressions may be formed using boolean operators, for example MIT OR BSD-3-Clause. See the SPDX specification for guidance on forming complex license expressions. If CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME is specified, CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION is ignored.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME
- CPACK_NUGET_<compName>_PACKAGE_LICENSE_FILE_NAME
- The package's license file in .txt or .md format. If CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME is specified, CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION is ignored. New in version 3.20.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_ICONURL
- CPACK_NUGET_<compName>_PACKAGE_ICONURL
- Deprecated since version 3.20: Use a local icon file (CPACK_NUGET_PACKAGE_ICON) instead. An URL for a 64x64 image with transparency background to use as the icon for the package in UI display.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_REQUIRE_LICENSE_ACCEPTANCE
- When set to a true value, the user will be prompted to accept the license before installing the package.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_ICON
- CPACK_NUGET_<compName>_PACKAGE_ICON
- New in version 3.20. The filename of a 64x64 image with transparency background to use as the icon for the package in UI display.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_DESCRIPTION_SUMMARY
- CPACK_NUGET_<compName>_PACKAGE_DESCRIPTION_SUMMARY
- A short description of the package for UI display. If omitted, a truncated version of description is used.
- •
- Mandatory : NO
- •
- Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY
- CPACK_NUGET_PACKAGE_RELEASE_NOTES
- CPACK_NUGET_<compName>_PACKAGE_RELEASE_NOTES
- A description of the changes made in this release of the package, often used in UI like the Updates tab of the Visual Studio Package Manager in place of the package description.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_COPYRIGHT
- CPACK_NUGET_<compName>_PACKAGE_COPYRIGHT
- Copyright details for the package.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_LANGUAGE
- CPACK_NUGET_<compName>_PACKAGE_LANGUAGE
- New in version 3.20. Locale specifier for the package, for example en_CA.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_TAGS
- CPACK_NUGET_<compName>_PACKAGE_TAGS
- A space-delimited list of tags and keywords that describe the package and aid discoverability of packages through search and filtering.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_DEPENDENCIES
- CPACK_NUGET_<compName>_PACKAGE_DEPENDENCIES
- A list of package dependencies.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_DEPENDENCIES_<dependency>_VERSION
- CPACK_NUGET_<compName>_PACKAGE_DEPENDENCIES_<dependency>_VERSION
- A version specification for the particular dependency, where <dependency> is an item of the dependency list (see above) transformed with MAKE_C_IDENTIFIER function of string() command.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_NUGET_PACKAGE_DEBUG
- Enable debug messages while executing CPack NuGet generator.
- •
- Mandatory : NO
- •
- Default : OFF
CPack PackageMaker Generator
Removed. This once generated PackageMaker installers, but the generator has been removed since CMake 3.24. Xcode no longer distributes the PackageMaker tools. Use the CPack productbuild Generator instead.CPack productbuild Generator
New in version 3.7.Variables specific to CPack productbuild generator
The following variable is specific to installers built on Mac macOS using ProductBuild:- CPACK_COMMAND_PRODUCTBUILD
- Path to the productbuild(1) command used to generate a product archive for the macOS Installer or Mac App Store. This variable can be used to override the automatically detected command (or specify its location if the auto-detection fails to find it).
- CPACK_PRODUCTBUILD_IDENTIFIER
- New in version 3.23. Set the unique (non-localized) product identifier to be associated with the product (i.e., com.kitware.cmake). Any component product names will be appended to this value.
- CPACK_PRODUCTBUILD_IDENTITY_NAME
- New in version 3.8. Adds a digital signature to the resulting package.
- CPACK_PRODUCTBUILD_KEYCHAIN_PATH
- New in version 3.8. Specify a specific keychain to search for the signing identity.
- CPACK_COMMAND_PKGBUILD
- Path to the pkgbuild(1) command used to generate an macOS component package on macOS. This variable can be used to override the automatically detected command (or specify its location if the auto-detection fails to find it).
- CPACK_PKGBUILD_IDENTITY_NAME
- New in version 3.8. Adds a digital signature to the resulting package.
- CPACK_PKGBUILD_KEYCHAIN_PATH
- New in version 3.8. Specify a specific keychain to search for the signing identity.
- CPACK_PREFLIGHT_<COMP>_SCRIPT
- Full path to a file that will be used as the preinstall script for the named <COMP> component's package, where <COMP> is the uppercased component name. No preinstall script is added if this variable is not defined for a given component.
- CPACK_POSTFLIGHT_<COMP>_SCRIPT
- Full path to a file that will be used as the postinstall script for the named <COMP> component's package, where <COMP> is the uppercased component name. No postinstall script is added if this variable is not defined for a given component.
- CPACK_PRODUCTBUILD_RESOURCES_DIR
- New in version 3.9. If specified the productbuild generator copies files from this directory (including subdirectories) to the Resources directory. This is done before the CPACK_RESOURCE_FILE_WELCOME, CPACK_RESOURCE_FILE_README, and CPACK_RESOURCE_FILE_LICENSE files are copied.
- CPACK_PRODUCTBUILD_DOMAINS
- New in version 3.23. This option enables more granular control over where the product may be installed. When it is set to true, a domains element of the following form will be added to the productbuild Distribution XML:
<domains enable_anywhere="true" enable_currentUserHome="false" enable_localSystem="true"/>
- CPACK_PRODUCTBUILD_DOMAINS_ANYWHERE
- New in version 3.23. May be used to override the enable_anywhere attribute in the domains element of the Distribution XML. When set to true, the product can be installed at the root of any volume, including non-system volumes. CPACK_PRODUCTBUILD_DOMAINS must be set to true for this variable to have any effect.
- CPACK_PRODUCTBUILD_DOMAINS_USER
- New in version 3.23. May be used to override the enable_currentUserHome attribute in the domains element of the Distribution XML. When set to true, the product can be installed into the current user's home directory. Note that when installing into the user's home directory, the following additional requirements will apply:
- •
- The installer may not write outside the user's home directory.
- •
- The install will be performed as the current user rather than as root. This may have ramifications for CPACK_PREFLIGHT_<COMP>_SCRIPT and CPACK_POSTFLIGHT_<COMP>_SCRIPT.
- •
- Administrative privileges will not be needed to perform the install.
- CPACK_PRODUCTBUILD_DOMAINS_ROOT
- New in version 3.23. May be used to override the enable_localSystem attribute in the domains element of the Distribution XML. When set to true, the product can be installed in the root directory. This should normally be set to true unless the product should only be installed to the user's home directory. CPACK_PRODUCTBUILD_DOMAINS must be set to true for this variable to have any effect.
Background Image
New in version 3.17.- CPACK_PRODUCTBUILD_BACKGROUND
- Adds a background to Distribution XML if specified. The value contains the path to image in Resources directory.
- CPACK_PRODUCTBUILD_BACKGROUND_ALIGNMENT
- Adds an alignment attribute to the background in Distribution XML. Refer to Apple documentation for valid values.
- CPACK_PRODUCTBUILD_BACKGROUND_SCALING
- Adds a scaling attribute to the background in Distribution XML. Refer to Apple documentation for valid values.
- CPACK_PRODUCTBUILD_BACKGROUND_MIME_TYPE
- Adds a mime-type attribute to the background in Distribution XML. The option contains MIME type of an image.
- CPACK_PRODUCTBUILD_BACKGROUND_UTI
- Adds an uti attribute to the background in Distribution XML. The option contains UTI type of an image.
- CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA
- Adds a background for the Dark Aqua theme to Distribution XML if specified. The value contains the path to image in Resources directory.
- CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_ALIGNMENT
- Does the same as CPACK_PRODUCTBUILD_BACKGROUND_ALIGNMENT option, but for the dark theme.
- CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_SCALING
- Does the same as CPACK_PRODUCTBUILD_BACKGROUND_SCALING option, but for the dark theme.
- CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_MIME_TYPE
- Does the same as CPACK_PRODUCTBUILD_BACKGROUND_MIME_TYPE option, but for the dark theme.
- CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_UTI
- Does the same as CPACK_PRODUCTBUILD_BACKGROUND_UTI option, but for the dark theme.
Distribution XML Template
CPack uses a template file to generate the distribution.dist file used internally by this package generator. Ordinarily, CMake provides the template file, but projects may supply their own by placing a file called CPack.distribution.dist.in in one of the directories listed in the CMAKE_MODULE_PATH variable. CPack will then pick up the project's template file instead of using its own.- CPACK_RESOURCE_FILE_LICENSE_NOPATH
- Same as CPACK_RESOURCE_FILE_LICENSE except without the path. The named file will be available in the same directory as the generated distribution.dist file.
- CPACK_RESOURCE_FILE_README_NOPATH
- Same as CPACK_RESOURCE_FILE_README except without the path. The named file will be available in the same directory as the generated distribution.dist file.
- CPACK_RESOURCE_FILE_WELCOME_NOPATH
- Same as CPACK_RESOURCE_FILE_WELCOME except without the path. The named file will be available in the same directory as the generated distribution.dist file.
- CPACK_APPLE_PKG_INSTALLER_CONTENT
- New in version 3.23. This contains all the XML elements that specify installer-wide options (including domain details), default backgrounds and the choices outline.
- CPACK_PACKAGEMAKER_CHOICES
- Deprecated since version 3.23. This contains only the XML elements that specify the default backgrounds and the choices outline. It does not include the installer-wide options or any domain details. Use CPACK_APPLE_PKG_INSTALLER_CONTENT instead.
CPack RPM Generator
The built in (binary) CPack RPM generator (Unix only)Variables specific to CPack RPM generator
The CPack RPM generator may be used to create RPM packages using CPack. The CPack RPM generator is a CPack generator thus it uses the CPACK_XXX variables used by CPack.- CPACK_RPM_COMPONENT_INSTALL
- Enable component packaging for CPack RPM generator
- •
- Mandatory : NO
- •
- Default : OFF
- CPACK_RPM_PACKAGE_SUMMARY
- CPACK_RPM_<component>_PACKAGE_SUMMARY
- The RPM package summary.
- •
- Mandatory : YES
- •
- Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY
- CPACK_RPM_PACKAGE_NAME
- CPACK_RPM_<component>_PACKAGE_NAME
- The RPM package name.
- •
- Mandatory : YES
- •
- Default : CPACK_PACKAGE_NAME
- CPACK_RPM_FILE_NAME
- CPACK_RPM_<component>_FILE_NAME
- New in version 3.6. Package file name.
- •
- Mandatory : YES
- •
- Default
- <CPACK_PACKAGE_FILE_NAME>[-<component>].rpm with spaces replaced by '-'
By using user provided spec file, rpm macro
extensions such as for generating debuginfo packages or by simply using
multiple components more than one rpm file may be generated, either from a
single spec file or from multiple spec files (each component execution
produces its own spec file). In such cases duplicate file names may occur as a
result of this variable setting or spec file content structure. Duplicate
files get overwritten and it is up to the packager to set the variables in a
manner that will prevent such errors.
- CPACK_RPM_MAIN_COMPONENT
- New in version 3.8. Main component that is packaged without component suffix.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_RPM_PACKAGE_EPOCH
- New in version 3.10. The RPM package epoch
- •
- Mandatory : No
- •
- Default : -
- CPACK_RPM_PACKAGE_VERSION
- The RPM package version.
- •
- Mandatory : YES
- •
- Default : CPACK_PACKAGE_VERSION
- CPACK_RPM_PACKAGE_ARCHITECTURE
- CPACK_RPM_<component>_PACKAGE_ARCHITECTURE
- The RPM package architecture.
- •
- Mandatory : YES
- •
- Default : Native architecture output by uname -m
- CPACK_RPM_PACKAGE_RELEASE
- The RPM package release.
- •
- Mandatory : YES
- •
- Default : 1
This is the string that goes into the RPM
Release: field. Some distros (e.g. Fedora, CentOS) require
1%{?dist} format and not just a number. %{?dist} part can be
added by setting CPACK_RPM_PACKAGE_RELEASE_DIST.
- CPACK_RPM_PACKAGE_RELEASE_DIST
- New in version 3.6. The dist tag that is added RPM Release: field.
- •
- Mandatory : NO
- •
- Default : OFF
- CPACK_RPM_PACKAGE_LICENSE
- The RPM package license policy.
- •
- Mandatory : YES
- •
- Default : "unknown"
- CPACK_RPM_PACKAGE_GROUP
- CPACK_RPM_<component>_PACKAGE_GROUP
- The RPM package group.
- •
- Mandatory : YES
- •
- Default : "unknown"
- CPACK_RPM_PACKAGE_VENDOR
- The RPM package vendor.
- •
- Mandatory : YES
- •
- Default : CPACK_PACKAGE_VENDOR if set or "unknown"
- CPACK_RPM_PACKAGE_URL
- CPACK_RPM_<component>_PACKAGE_URL
- The projects URL.
- •
- Mandatory : NO
- •
- Default : CMAKE_PROJECT_HOMEPAGE_URL
- CPACK_RPM_PACKAGE_DESCRIPTION
- CPACK_RPM_<component>_PACKAGE_DESCRIPTION
- RPM package description.
- •
- Mandatory : YES
- •
- Default : CPACK_COMPONENT_<compName>_DESCRIPTION (component based installers only) if set, CPACK_PACKAGE_DESCRIPTION_FILE if set or "no package description available"
- CPACK_RPM_COMPRESSION_TYPE
- RPM compression type.
- •
- Mandatory : NO
- •
- Default : -
- •
- lzma
- •
- xz
- •
- bzip2
- •
- gzip
- CPACK_RPM_PACKAGE_AUTOREQ
- CPACK_RPM_<component>_PACKAGE_AUTOREQ
- RPM spec autoreq field.
- •
- Mandatory : NO
- •
- Default : -
By default automatic dependency detection is
enabled by rpm generator.
- CPACK_RPM_PACKAGE_AUTOPROV
- CPACK_RPM_<component>_PACKAGE_AUTOPROV
- RPM spec autoprov field.
- •
- Mandatory : NO
- •
- Default : -
By default automatic provides detection is
enabled by rpm generator.
- CPACK_RPM_PACKAGE_AUTOREQPROV
- CPACK_RPM_<component>_PACKAGE_AUTOREQPROV
- RPM spec autoreqprov field.
- •
- Mandatory : NO
- •
- Default : -
By default automatic detection feature is
enabled by rpm.
- CPACK_RPM_PACKAGE_REQUIRES
- CPACK_RPM_<component>_PACKAGE_REQUIRES
- RPM spec requires field.
- •
- Mandatory : NO
- •
- Default : -
set(CPACK_RPM_PACKAGE_REQUIRES "python >= 2.5.0, cmake >= 2.8")
rpm -qp --requires file.rpm
- CPACK_RPM_PACKAGE_CONFLICTS
- CPACK_RPM_<component>_PACKAGE_CONFLICTS
- RPM spec conflicts field.
- •
- Mandatory : NO
- •
- Default : -
set(CPACK_RPM_PACKAGE_CONFLICTS "libxml2")
rpm -qp --conflicts file.rpm
- CPACK_RPM_PACKAGE_REQUIRES_PRE
- CPACK_RPM_<component>_PACKAGE_REQUIRES_PRE
- New in version 3.2. RPM spec requires(pre) field.
- •
- Mandatory : NO
- •
- Default : -
set(CPACK_RPM_PACKAGE_REQUIRES_PRE "shadow-utils, initscripts")
- CPACK_RPM_PACKAGE_REQUIRES_POST
- CPACK_RPM_<component>_PACKAGE_REQUIRES_POST
- New in version 3.2. RPM spec requires(post) field.
- •
- Mandatory : NO
- •
- Default : -
set(CPACK_RPM_PACKAGE_REQUIRES_POST "shadow-utils, initscripts")
- CPACK_RPM_PACKAGE_REQUIRES_POSTUN
- CPACK_RPM_<component>_PACKAGE_REQUIRES_POSTUN
- New in version 3.2. RPM spec requires(postun) field.
- •
- Mandatory : NO
- •
- Default : -
set(CPACK_RPM_PACKAGE_REQUIRES_POSTUN "shadow-utils, initscripts")
- CPACK_RPM_PACKAGE_REQUIRES_PREUN
- CPACK_RPM_<component>_PACKAGE_REQUIRES_PREUN
- New in version 3.2. RPM spec requires(preun) field.
- •
- Mandatory : NO
- •
- Default : -
set(CPACK_RPM_PACKAGE_REQUIRES_PREUN "shadow-utils, initscripts")
- CPACK_RPM_PACKAGE_SUGGESTS
- CPACK_RPM_<component>_PACKAGE_SUGGESTS
- RPM spec suggest field.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_RPM_PACKAGE_PROVIDES
- CPACK_RPM_<component>_PACKAGE_PROVIDES
- RPM spec provides field.
- •
- Mandatory : NO
- •
- Default : -
rpm -qp --provides file.rpm
- CPACK_RPM_PACKAGE_OBSOLETES
- CPACK_RPM_<component>_PACKAGE_OBSOLETES
- RPM spec obsoletes field.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_RPM_PACKAGE_RELOCATABLE
- build a relocatable RPM.
- •
- Mandatory : NO
- •
- Default : CPACK_PACKAGE_RELOCATABLE
rpm --prefix or --relocate
- CPACK_RPM_SPEC_INSTALL_POST
- Deprecated - use CPACK_RPM_SPEC_MORE_DEFINE instead.
- •
- Mandatory : NO
- •
- Default : -
- •
- Deprecated: YES
- CPACK_RPM_SPEC_MORE_DEFINE
- RPM extended spec definitions lines.
- •
- Mandatory : NO
- •
- Default : -
set(CPACK_RPM_SPEC_MORE_DEFINE "%define __spec_install_post /bin/true")
- CPACK_RPM_PACKAGE_DEBUG
- Toggle CPack RPM generator debug output.
- •
- Mandatory : NO
- •
- Default : -
cpack -D CPACK_RPM_PACKAGE_DEBUG=1 -G RPM
- CPACK_RPM_USER_BINARY_SPECFILE
- CPACK_RPM_<componentName>_USER_BINARY_SPECFILE
- A user provided spec file.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE
- Spec file template.
- •
- Mandatory : NO
- •
- Default : -
cpack -D CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE=1 -G RPM
- CPACK_RPM_PRE_INSTALL_SCRIPT_FILE
- CPACK_RPM_PRE_UNINSTALL_SCRIPT_FILE
- CPACK_RPM_PRE_TRANS_SCRIPT_FILE
- Path to file containing pre install/uninstall/transaction script.
- •
- Mandatory : NO
- •
- Default : -
rpm -qp --scripts package.rpm
- CPACK_RPM_POST_INSTALL_SCRIPT_FILE
- CPACK_RPM_POST_UNINSTALL_SCRIPT_FILE
- CPACK_RPM_POST_TRANS_SCRIPT_FILE
- Path to file containing post install/uninstall/transaction script.
- •
- Mandatory : NO
- •
- Default : -
rpm -qp --scripts package.rpm
- CPACK_RPM_USER_FILELIST
- CPACK_RPM_<COMPONENT>_USER_FILELIST
- •
- Mandatory : NO
- •
- Default : -
- CPACK_RPM_CHANGELOG_FILE
- RPM changelog file.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST
- list of path to be excluded.
- •
- Mandatory : NO
- •
- Default
- /etc /etc/init.d /usr /usr/bin /usr/include /usr/lib /usr/libx32 /usr/lib64 /usr/share /usr/share/aclocal /usr/share/doc
- CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION
- additional list of path to be excluded.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_RPM_RELOCATION_PATHS
- New in version 3.2. Packages relocation paths list.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_RPM_<COMPONENT>_PACKAGE_PREFIX
- New in version 3.2. Per component relocation path install prefix.
- •
- Mandatory : NO
- •
- Default : CPACK_PACKAGING_INSTALL_PREFIX
- CPACK_RPM_NO_INSTALL_PREFIX_RELOCATION
- CPACK_RPM_NO_<COMPONENT>_INSTALL_PREFIX_RELOCATION
- New in version 3.3. Removal of default install prefix from relocation paths list.
- •
- Mandatory : NO
- •
- Default
- CPACK_PACKAGING_INSTALL_PREFIX or CPACK_RPM_<COMPONENT>_PACKAGE_PREFIX are treated as one of relocation paths
- CPACK_RPM_ADDITIONAL_MAN_DIRS
- New in version 3.3.
- •
- Mandatory : NO
- •
- Default : -
- •
- /usr/man/man.*
- •
- /usr/man/.*/man.*
- •
- /usr/info.*
- •
- /usr/share/man/man.*
- •
- /usr/share/man/.*/man.*
- •
- /usr/share/info.*
- •
- /usr/kerberos/man.*
- •
- /usr/X11R6/man/man.*
- •
- /usr/lib/perl5/man/man.*
- •
- /usr/share/doc/.*/man/man.*
- •
- /usr/lib/.*/man/man.*
- CPACK_RPM_DEFAULT_USER
- CPACK_RPM_<compName>_DEFAULT_USER
- New in version 3.6. default user ownership of RPM content
- •
- Mandatory : NO
- •
- Default : root
- CPACK_RPM_DEFAULT_GROUP
- CPACK_RPM_<compName>_DEFAULT_GROUP
- New in version 3.6. default group ownership of RPM content
- •
- Mandatory : NO
- •
- Default : root
- CPACK_RPM_DEFAULT_FILE_PERMISSIONS
- CPACK_RPM_<compName>_DEFAULT_FILE_PERMISSIONS
- New in version 3.6. default permissions used for packaged files
- •
- Mandatory : NO
- •
- Default : - (system default)
- •
- OWNER_READ
- •
- OWNER_WRITE
- •
- OWNER_EXECUTE
- •
- GROUP_READ
- •
- GROUP_WRITE
- •
- GROUP_EXECUTE
- •
- WORLD_READ
- •
- WORLD_WRITE
- •
- WORLD_EXECUTE
- CPACK_RPM_DEFAULT_DIR_PERMISSIONS
- CPACK_RPM_<compName>_DEFAULT_DIR_PERMISSIONS
- New in version 3.6. default permissions used for packaged directories
- •
- Mandatory : NO
- •
- Default : - (system default)
- CPACK_RPM_INSTALL_WITH_EXEC
- New in version 3.11. force execute permissions on programs and shared libraries
- •
- Mandatory : NO
- •
- Default : - (system default)
Programs and shared libraries without execute
permissions are ignored during separation of debug symbols from the binary for
debuginfo packages.
Packaging of Symbolic Links
New in version 3.3.execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink <relative_path_location> <symlink_name>) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/<symlink_name> DESTINATION <symlink_location> COMPONENT libraries)
- •
- For component based packaging component interdependency is not checked when processing symbolic links. Symbolic links pointing to content of a different component are treated the same way as if pointing to location that will not be packaged.
- •
- Symbolic links pointing to a location through one or more intermediate symbolic links will not be handled differently - if the intermediate symbolic link(s) is also on a relocatable path, relocating it during package installation may cause initial symbolic link to point to an invalid location.
Packaging of debug information
New in version 3.7.- CPACK_RPM_DEBUGINFO_PACKAGE
- CPACK_RPM_<component>_DEBUGINFO_PACKAGE
- Enable generation of debuginfo RPM package(s).
- •
- Mandatory : NO
- •
- Default : OFF
Binaries must contain debug symbols before
packaging so use either Debug or RelWithDebInfo for
CMAKE_BUILD_TYPE variable value.
Additionally, if CPACK_STRIP_FILES is set, the files will be stripped
before they get to the RPM generator, so will not contain debug symbols and a
debuginfo package will not get built. Do not use with
CPACK_STRIP_FILES.
Packages generated from packages without
binary files, with binary files but without execute permissions or without
debug symbols will cause packaging termination.
- CPACK_BUILD_SOURCE_DIRS
- Provides locations of root directories of source files from which binaries were built.
- •
- Mandatory : YES if CPACK_RPM_DEBUGINFO_PACKAGE is set
- •
- Default : -
For CMake project
CPACK_BUILD_SOURCE_DIRS is set by default to point to
CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR paths.
Sources with path prefixes that do not fall
under any location provided with CPACK_BUILD_SOURCE_DIRS will not be
present in debuginfo package.
- CPACK_RPM_BUILD_SOURCE_DIRS_PREFIX
- CPACK_RPM_<component>_BUILD_SOURCE_DIRS_PREFIX
- Prefix of location where sources will be placed during package installation.
- •
- Mandatory : YES if CPACK_RPM_DEBUGINFO_PACKAGE is set
- •
- Default
- "/usr/src/debug/<CPACK_PACKAGE_FILE_NAME>" and for component packaging "/usr/src/debug/<CPACK_PACKAGE_FILE_NAME>-<component>"
Each source path prefix is additionally
suffixed by src_<index> where index is index of the path used
from CPACK_BUILD_SOURCE_DIRS variable. This produces
<CPACK_RPM_BUILD_SOURCE_DIRS_PREFIX>/src_<index>
replacement path. Limitation is that replaced path part must be shorter or of
equal length than the length of its replacement. If that is not the case
either CPACK_RPM_BUILD_SOURCE_DIRS_PREFIX variable has to be set to a
shorter path or source directories must be placed on a longer path.
- CPACK_RPM_DEBUGINFO_EXCLUDE_DIRS
- Directories containing sources that should be excluded from debuginfo packages.
- •
- Mandatory : NO
- •
- Default : "/usr /usr/src /usr/src/debug"
- CPACK_RPM_DEBUGINFO_EXCLUDE_DIRS_ADDITION
- Paths that should be appended to CPACK_RPM_DEBUGINFO_EXCLUDE_DIRS for exclusion.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_RPM_DEBUGINFO_SINGLE_PACKAGE
- New in version 3.8. Create a single debuginfo package even if components packaging is set.
- •
- Mandatory : NO
- •
- Default : OFF
If none of the
CPACK_RPM_<component>_DEBUGINFO_PACKAGE variables is set then
CPACK_RPM_DEBUGINFO_PACKAGE is automatically set to ON when
CPACK_RPM_DEBUGINFO_SINGLE_PACKAGE is set.
- CPACK_RPM_DEBUGINFO_FILE_NAME
- CPACK_RPM_<component>_DEBUGINFO_FILE_NAME
- New in version 3.9. Debuginfo package file name.
- •
- Mandatory : NO
- •
- Default : rpmbuild tool generated package file name
CPACK_RPM_FILE_NAME also supports
rpmbuild tool generated package file name - disabled by default but can be
enabled by setting the variable to RPM-DEFAULT.
Packaging of sources (SRPM)
New in version 3.7.cpack -G RPM --config ./CPackSourceConfig.cmake
Produced SRPM package is expected to be built
with cmake(1) executable and packaged with cpack(1) executable
so CMakeLists.txt has to be located in root source directory and must be able
to generate binary rpm packages by executing cpack -G command. The two
executables as well as rpmbuild must also be present when generating binary
rpm packages from the produced SRPM package.
mkdir -p build_dir/{BUILD,BUILDROOT,RPMS,SOURCES,SPECS,SRPMS} rpmbuild --define "_topdir <path_to_build_dir>" --rebuild <SRPM_file_name>
SRPM package internally uses CPack/RPM
generator to generate binary packages so CMakeScripts.txt can decide during
the SRPM to binary rpm generation step what content the package(s) should have
as well as how they should be packaged (monolithic or components). CMake can
decide this for e.g. by reading environment variables set by the package
manager before starting the process of generating binary rpm packages. This
way a single SRPM package can be used to produce different binary rpm packages
on different platforms depending on the platform's packaging rules.
- CPACK_RPM_PACKAGE_SOURCES
- Should the content be packaged as a source rpm (default is binary rpm).
- •
- Mandatory : NO
- •
- Default : OFF
For cmake projects
CPACK_RPM_PACKAGE_SOURCES variable is set to OFF in
CPackConfig.cmake and ON in CPackSourceConfig.cmake generated
files.
- CPACK_RPM_SOURCE_PKG_BUILD_PARAMS
- Additional command-line parameters provided to cmake(1) executable.
- •
- Mandatory : NO
- •
- Default : -
- CPACK_RPM_SOURCE_PKG_PACKAGING_INSTALL_PREFIX
- Packaging install prefix that would be provided in CPACK_PACKAGING_INSTALL_PREFIX variable for producing binary RPM packages.
- •
- Mandatory : YES
- •
- Default : "/"
- CPACK_RPM_BUILDREQUIRES
- List of source rpm build dependencies.
- •
- Mandatory : NO
- •
- Default : -
set(CPACK_RPM_BUILDREQUIRES "python >= 2.5.0, cmake >= 2.8")
- CPACK_RPM_REQUIRES_EXCLUDE_FROM
- New in version 3.22.
- •
- Mandatory : NO
- •
- Default : -
set(CPACK_RPM_REQUIRES_EXCLUDE_FROM "bin/libqsqloci.*\\.so.*")
CPack WIX Generator
CPack WIX generator specific optionsVariables specific to CPack WIX generator
The following variables are specific to the installers built on Windows using WiX.- CPACK_WIX_UPGRADE_GUID
- Upgrade GUID (Product/@UpgradeCode) Will be automatically generated unless explicitly provided. It should be explicitly set to a constant generated globally unique identifier (GUID) to allow your installers to replace existing installations that use the same GUID. You may for example explicitly set this variable in your CMakeLists.txt to the value that has been generated per default. You should not use GUIDs that you did not generate yourself or which may belong to other projects. A GUID shall have the following fixed length syntax:
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
- CPACK_WIX_PRODUCT_GUID
- Product GUID (Product/@Id) Will be automatically generated unless explicitly provided. If explicitly provided this will set the Product Id of your installer. The installer will abort if it detects a pre-existing installation that uses the same GUID. The GUID shall use the syntax described for CPACK_WIX_UPGRADE_GUID.
- CPACK_WIX_LICENSE_RTF
- RTF License File If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension it is used as-is. If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is implicitly converted to RTF by the WIX Generator. The expected encoding of the .txt file is UTF-8. With CPACK_WIX_LICENSE_RTF you can override the license file used by the WIX Generator in case CPACK_RESOURCE_FILE_LICENSE is in an unsupported format or the .txt -> .rtf conversion does not work as expected.
- CPACK_WIX_PRODUCT_ICON
- The Icon shown next to the program name in Add/Remove programs. If set, this icon is used in place of the default icon.
- CPACK_WIX_UI_REF
- This variable allows you to override the Id of the <UIRef> element in the WiX template. The default is WixUI_InstallDir in case no CPack components have been defined and WixUI_FeatureTree otherwise.
- CPACK_WIX_UI_BANNER
- The bitmap will appear at the top of all installer pages other than the welcome and completion dialogs. If set, this image will replace the default banner image. This image must be 493 by 58 pixels.
- CPACK_WIX_UI_DIALOG
- Background bitmap used on the welcome and completion dialogs. If this variable is set, the installer will replace the default dialog image. This image must be 493 by 312 pixels.
- CPACK_WIX_PROGRAM_MENU_FOLDER
- Start menu folder name for launcher. If this variable is not set, it will be initialized with CPACK_PACKAGE_NAME New in version 3.16: If this variable is set to ., then application shortcuts will be created directly in the start menu and the uninstaller shortcut will be omitted.
- CPACK_WIX_CULTURES
- Language(s) of the installer Languages are compiled into the WixUI extension library. To use them, simply provide the name of the culture. If you specify more than one culture identifier in a comma or semicolon delimited list, the first one that is found will be used. You can find a list of supported languages at: https://wixtoolset.org//documentation/manual/v3/wixui/wixui_localization.html
- CPACK_WIX_TEMPLATE
- Template file for WiX generation If this variable is set, the specified template will be used to generate the WiX wxs file. This should be used if further customization of the output is required. If this variable is not set, the default MSI template included with CMake will be used.
- CPACK_WIX_PATCH_FILE
- Optional list of XML files with fragments to be inserted into generated WiX sources. New in version 3.5: Support listing multiple patch files. This optional variable can be used to specify an XML file that the WIX generator will use to inject fragments into its generated source files. Patch files understood by the CPack WIX generator roughly follow this RELAX NG compact schema:
start = CPackWiXPatch CPackWiXPatch = element CPackWiXPatch { CPackWiXFragment* } CPackWiXFragment = element CPackWiXFragment { attribute Id { string }, fragmentContent* } fragmentContent = element * - CPackWiXFragment { (attribute * { text } | text | fragmentContent)* }
- •
- #PRODUCT for the <Product> element.
- •
- #PRODUCTFEATURE for the root <Feature> element.
<Component Id="CM_CP_applications.bin.my_libapp.exe" Guid="*"/>
<CPackWiXPatch> <CPackWiXFragment Id="CM_CP_applications.bin.my_libapp.exe"> <Environment Id="MyEnvironment" Action="set" Name="MyVariableName" Value="MyVariableValue"/> </CPackWiXFragment> </CPackWiXPatch>
- CPACK_WIX_EXTRA_SOURCES
- Extra WiX source files This variable provides an optional list of extra WiX source files (.wxs) that should be compiled and linked. The full path to source files is required.
- CPACK_WIX_EXTRA_OBJECTS
- Extra WiX object files or libraries This variable provides an optional list of extra WiX object (.wixobj) and/or WiX library (.wixlib) files. The full path to objects and libraries is required.
- CPACK_WIX_EXTENSIONS
- This variable provides a list of additional extensions for the WiX tools light and candle.
- CPACK_WIX_<TOOL>_EXTENSIONS
- This is the tool specific version of CPACK_WIX_EXTENSIONS. <TOOL> can be either LIGHT or CANDLE.
- CPACK_WIX_<TOOL>_EXTRA_FLAGS
- This list variable allows you to pass additional flags to the WiX tool <TOOL>. Use it at your own risk. Future versions of CPack may generate flags which may be in conflict with your own flags. <TOOL> can be either LIGHT or CANDLE.
- CPACK_WIX_CMAKE_PACKAGE_REGISTRY
- If this variable is set the generated installer will create an entry in the windows registry key HKEY_LOCAL_MACHINE\Software\Kitware\CMake\Packages\<PackageName> The value for <PackageName> is provided by this variable. Assuming you also install a CMake configuration file this will allow other CMake projects to find your package with the find_package() command.
- CPACK_WIX_PROPERTY_<PROPERTY>
- New in version 3.1. This variable can be used to provide a value for the Windows Installer property <PROPERTY> The following list contains some example properties that can be used to customize information under "Programs and Features" (also known as "Add or Remove Programs")
- •
- ARPCOMMENTS - Comments
- •
- ARPHELPLINK - Help and support information URL
- •
- ARPURLINFOABOUT - General information URL
- •
- ARPURLUPDATEINFO - Update information URL
- •
- ARPHELPTELEPHONE - Help and support telephone number
- •
- ARPSIZE - Size (in kilobytes) of the application
- CPACK_WIX_ROOT_FEATURE_TITLE
- New in version 3.7. Sets the name of the root install feature in the WIX installer. Same as CPACK_COMPONENT_<compName>_DISPLAY_NAME for components.
- CPACK_WIX_ROOT_FEATURE_DESCRIPTION
- New in version 3.7. Sets the description of the root install feature in the WIX installer. Same as CPACK_COMPONENT_<compName>_DESCRIPTION for components.
- CPACK_WIX_SKIP_PROGRAM_FOLDER
- New in version 3.7. If this variable is set to true, the default install location of the generated package will be CPACK_PACKAGE_INSTALL_DIRECTORY directly. The install location will not be located relatively below ProgramFiles or ProgramFiles64.
Installers created with this feature do not
take differences between the system on which the installer is created and the
system on which the installer might be used into account.
It is therefore possible that the installer e.g. might try to install onto a
drive that is unavailable or unintended or a path that does not follow the
localization or convention of the system on which the installation is
performed.
- CPACK_WIX_ROOT_FOLDER_ID
- New in version 3.9. This variable allows specification of a custom root folder ID. The generator specific <64> token can be used for folder IDs that come in 32-bit and 64-bit variants. In 32-bit builds the token will expand empty while in 64-bit builds it will expand to 64. When unset generated installers will default installing to ProgramFiles<64>Folder.
- CPACK_WIX_ROOT
- This variable can optionally be set to the root directory of a custom WiX Toolset installation. When unspecified CPack will try to locate a WiX Toolset installation via the WIX environment variable instead.
- CPACK_WIX_CUSTOM_XMLNS
- New in version 3.19. This variable provides a list of custom namespace declarations that are necessary for using WiX extensions. Each declaration should be in the form name=url, where name is the plain namespace without the usual xmlns: prefix and url is an unquoted namespace url. A list of commonly known WiX schemata can be found here: https://wixtoolset.org/documentation/manual/v3/xsd/
- CPACK_WIX_SKIP_WIX_UI_EXTENSION
- New in version 3.23. If this variable is set then the inclusion of WixUIExtensions is skipped, i.e. the -ext "WixUIExtension" command line is not included during the execution of the WiX light tool.
- CPACK_WIX_ARCHITECTURE
- New in version 3.24. This variable can be optionally set to specify the target architecture of the installer. May for example be set to x64 or arm64. When unspecified, CPack will default to x64 or x86.
COPYRIGHT
2000-2022 Kitware, Inc. and ContributorsNovember 30, 2022 | 3.25.1 |