cpack-generators7

Name of the appimagetool executable. If not given as an absolute path, logic based on find_program() <#command:find_program> will be used internally with this value to find the executable.

Name of the patchelf executable. If not given as an absolute path, logic based on find_program() <#command:find_program> will be used internally with this value to find the executable.

Name of the freedesktop.org desktop file to be installed. If not specified, the first .desktop file found in the list of files to be installed will be used. There must be a valid .desktop file for the package, and it must include an Icon entry that matches CPACK_PACKAGE_ICON <#variable:CPACK_PACKAGE_ICON> without the file extension. The actual installed location of the icon should follow the freedesktop.org specification.

Embed the value of this variable as the update information. See the appimagetool source code for the supported values and formats of the --updateinformation option. It is highly recommended to have the zsyncmake tool installed if using zsync update information.

When this variable is true, add the --guess option to the appimagetool invocation. This directs the tool to try to guess appropriate update information based on GitHub or GitLab environment variables.

Override the appimagetool's default type of squashfs compression (zstd). This corresponds to the appimagetool --comp option.

List of arguments to pass through to mksquashfs. Each of these will be preceded by --mksquashfs-opt on the appimagetool command line.

If set to true, do not check AppStream metadata. This passes the --no-appstream option to appimagetool.

Use the specified file as an exclude file for mksquashfs, in addition to .appimageignore. This uses the --exclude-file option to appimagetool.

Specify a runtime file to use instead of letting the appimagetool download a runtime to embed in the generated AppImage.

When set to true, sign the generated AppImage with gpg[2]. CPACK_APPIMAGE_SIGN_KEY should also be specified if using this option.

Key ID to use for gpg[2] signatures when signing is enabled with CPACK_APPIMAGE_SIGN.

7Z - 7zip - (.7z) - LZMA compressed

Added in version 3.1.

This is an alias for 7Z_LZMA

7Z_BZ2 - 7zip - (.7z) - BZip2 compressed

Added in version 4.3.

7Z_DEFLATE - 7zip - (.7z) - Deflate compressed

Added in version 4.3.

7Z_LZMA - 7zip - (.7z) - LZMA compressed

Added in version 4.3.

7Z_LZMA2 - 7zip - (.7z) - LZMA2 compressed

Added in version 4.3.

7Z_PPMD - 7zip - (.7z) - PPMd compressed

Added in version 4.3.

7Z_STORE - 7zip - (.7z) - no compression is used

Added in version 4.3.

7Z_ZSTD - 7zip - (.7z) - Zstandard compressed

Added in version 4.3.

TAR (.tar) - no compression is used

Added in version 4.0.

TBZ2 (.tar.bz2) - BZip2 compressed

TGZ (.tar.gz) - Deflate compressed

TXZ (.tar.xz) - LZMA2 compressed

Added in version 3.1.

TZ (.tar.Z) - LZW compressed

TZST (.tar.zst) - Zstandard compressed

Added in version 3.16.

ZIP (.zip) - Deflate compressed

This is an alias for ZIP_DEFLATE

ZIP_BZ2 (.zip) - BZip2 compressed

Added in version 4.3.

ZIP_DEFLATE (.zip) - Deflate compressed

Added in version 4.3.

ZIP_LZMA (.zip) - LZMA compressed

Added in version 4.3.

ZIP_LZMA2 (.zip) - LZMA2 compressed

Added in version 4.3.

ZIP_STORE (.zip) - no compression is used

Added in version 4.3.

ZIP_ZSTD (.zip) - Zstandard compressed

Added in version 4.3.

Added in version 3.9.

Archive name for component-based packages, without extension.

The extension is appended automatically.

If CPACK_COMPONENTS_GROUPING <#variable:CPACK_COMPONENTS_GROUPING> is set to ALL_COMPONENTS_IN_ONE, this will be the name of the one output archive.

Changed in version 4.0: This variable also works for non-component packages.

Added in version 3.9.

Component archive name without extension.

The extension is appended automatically. Note that <component> is all uppercase in the variable name.

Added in version 3.25.

Archive file extension.

Enable component packaging.

If enabled (ON) multiple packages are generated. By default a single package containing files of all components is generated.

Set the UID of entries contained in the archive. Specify -1 to use the UID of the current user.

Set the GID of entries contained in the archive. Specify -1 to use the GID of the current user.

Added 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. Note that not all compression modes support threading in all environments.

Added in version 3.21: Official CMake binaries available on cmake.org now ship with a liblzma that supports parallel compression. Older versions did not.

Added in version 4.3.

The compression level to use when compressing the archive.

The compression level should be between 0 and 9.

The compression level of the Zstandard-based algorithm can be set between 0 and 19, except for the ZIP_ZSTD mode.

The value 0 is used to specify the default compression level. It is selected automatically by the archive library backend and not directly set by CMake itself. The default compression level may vary between archive formats, platforms, etc.

Added in version 4.4.

Specify the pathname character encoding used in package archives.

See the cmake -E tar <#cmdoption-cmake-E-arg-tar> tool's --cmake-tar-encoding <#cmdoption-cmake-E_tar-cmake-tar-encoding> flag for supported encoding names.

In CMake 4.3 and below, the OEM encoding (current locale) was always used.

The name of the generated bundle. This appears in the macOS Finder as the bundle name. Required.

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.

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.

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.

Added 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.

Added 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.

Added 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.

Added in version 3.3.

Additional parameter that will passed to codesign. Default value: --deep -f

Added 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).

Added in version 3.18: CPACK_ARCHIVE_THREADS <#variable:CPACK_ARCHIVE_THREADS>

The Cygwin patch number. FIXME: This documentation is incomplete.

The Cygwin patch file. FIXME: This documentation is incomplete.

The Cygwin build script. FIXME: This documentation is incomplete.

<https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/Configuration>

<https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/PackageGenerators#deb-unix-only>

Enable component packaging for CPackDEB

If enabled (ON) multiple packages are generated. By default a single package containing files of all components is generated.

Set Package control field (variable is automatically transformed to lower case).

Added in version 3.5: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_NAME variables.

See <https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-source>

Added in version 3.6.

Package file name.

This may be set to:

Added in version 3.10.

The Debian package epoch

Optional number that should be incremented when changing versioning schemas or fixing mistakes in the version numbers of older packages.

The Debian package version

This variable may contain only alphanumerics (A-Za-z0-9) and the characters . + - ~ (full stop, plus, hyphen, tilde) and should start with a digit. If CPACK_DEBIAN_PACKAGE_RELEASE is not set then hyphens are not allowed.

Note:

Added in version 3.6.

The Debian package release - Debian revision number.

This is the numbering of the DEB package itself, i.e. the version of the packaging and not the version of the content (see CPACK_DEBIAN_PACKAGE_VERSION). One may change the default value if the previous packaging was buggy and/or you want to put here a fancy Linux distro specific numbering.

The Debian package architecture

Added in version 3.6: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_ARCHITECTURE variables.

Sets the Debian dependencies of this package.

Added in version 3.3: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_DEPENDS variables.

Note:

Changed in version 3.31: The variable is always expanded as a list. Before it was expanded only if used in cooperation with CPACK_DEB_COMPONENT_INSTALL, CPACK_DEBIAN_PACKAGE_SHLIBDEPS or CPACK_DEBIAN_<COMPONENT>_PACKAGE_SHLIBDEPS. This meant that if a component had no shared libraries discovered (e.g. a package composed only of scripts) you had to join the list by yourself to obtain a valid Depends field.

Example:

set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6 (>= 2.3.1-6), libc6 (< 2.4)")
list(APPEND CPACK_DEBIAN_PACKAGE_DEPENDS cmake)

Added in version 3.6.

Sets inter-component dependencies if listed with CPACK_COMPONENT_<compName>_DEPENDS <#variable:CPACK_COMPONENT_<compName>_DEPENDS> variables.

The Debian package maintainer

The Debian package description

If after that description is not set, CPACK_PACKAGE_DESCRIPTION_SUMMARY <#variable:CPACK_PACKAGE_DESCRIPTION_SUMMARY> going to be used if set. Otherwise, CPACK_PACKAGE_DESCRIPTION_SUMMARY <#variable:CPACK_PACKAGE_DESCRIPTION_SUMMARY> will be added as the first line of description as defined in Debian Policy Manual <https://www.debian.org/doc/debian-policy/ch-controlfields.html#description>.

Added in version 3.3: Per-component CPACK_COMPONENT_<compName>_DESCRIPTION variables.

Added in version 3.16: Per-component CPACK_DEBIAN_<COMPONENT>_DESCRIPTION variables.

Added in version 3.16: The CPACK_PACKAGE_DESCRIPTION_FILE variable.

Set Section control field e.g. admin, devel, doc, ...

Added in version 3.5: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_SECTION variables.

See <https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections>

Added in version 3.7.

Deprecated since version 3.14.

The archive format used for creating the Debian package.

Possible value is: gnutar

Note:

Added in version 3.1.

The compression used for creating the Debian package.

Possible values are:

Added in version 4.3.

The compression level used for creating the Debian package.

This variable allows fine-tuning of the compression ratio and speed for the Debian package archive. It controls the numeric compression level passed to the compressor defined by CPACK_DEBIAN_COMPRESSION_TYPE. If CPACK_DEBIAN_COMPRESSION_LEVEL is not set, or is set to 0, the default value will be used.

The valid range and interpretation depend on the selected compression type:

Example usage:

set(CPACK_DEBIAN_COMPRESSION_TYPE "xz")
set(CPACK_DEBIAN_COMPRESSION_LEVEL 9)
include(CPack)

Set Priority control field e.g. required, important, standard, optional, extra

Added in version 3.5: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_PRIORITY variables.

See <https://www.debian.org/doc/debian-policy/ch-archive.html#s-priorities>

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.

Added in version 3.12: The CMAKE_PROJECT_HOMEPAGE_URL variable.

Note:

May be set to ON in order to use dpkg-shlibdeps to generate better package dependency list.

Note:

Note:

Added in version 3.3: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_SHLIBDEPS variables.

Added in version 3.6: Correct handling of $ORIGIN in CMAKE_INSTALL_RPATH <#variable:CMAKE_INSTALL_RPATH>.

Added 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.

Note:

May be set when invoking cpack in order to trace debug information during the CPack DEB generator run.

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.

Added in version 3.4: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_PREDEPENDS variables.

See <https://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps>

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.

Added in version 3.4: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_ENHANCES variables.

See <https://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps>

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.

Added in version 3.4: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_BREAKS variables.

See <https://www.debian.org/doc/debian-policy/ch-relationships.html#s-breaks>

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.

Added in version 3.4: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_CONFLICTS variables.

See <https://www.debian.org/doc/debian-policy/ch-relationships.html#s-conflicts>

Note:

Sets the Provides field of the Debian package. A virtual package is one which appears in the Provides control field of another package.

Added in version 3.4: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_PROVIDES variables.

See <https://www.debian.org/doc/debian-policy/ch-relationships.html#s-virtual>

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.

Added in version 3.4: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_REPLACES variables.

See <https://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps>

Sets the Recommends field of the Debian package. Allows packages to declare a strong, but not absolute, dependency on other packages.

Added in version 3.4: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_RECOMMENDS variables.

See <https://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps>

Sets the Suggests field of the Debian package. Allows packages to declare a suggested package install grouping.

Added in version 3.4: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_SUGGESTS variables.

See <https://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps>

Added in version 3.6.

Allows to generate shlibs control file automatically. Compatibility is defined by CPACK_DEBIAN_PACKAGE_GENERATE_SHLIBS_POLICY variable value.

Note:

Added in version 3.6.

Compatibility policy for auto-generated shlibs control file.

Defines compatibility policy for auto-generated shlibs control file. Possible values: =, >=

See <https://www.debian.org/doc/debian-policy/ch-sharedlibs.html#s-sharedlibs-shlibdeps>

This variable allow advanced user to add custom script to the control.tar.gz. Typical usage is for conffiles, postinst, postrm, prerm.

Usage:

set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA
    "${CMAKE_CURRENT_SOURCE_DIR}/prerm;${CMAKE_CURRENT_SOURCE_DIR}/postrm")

Added in version 3.4: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_CONTROL_EXTRA variables.

Added in version 3.4.

This variable indicates if the Debian policy on control files should be strictly followed.

Usage:

set(CPACK_DEBIAN_PACKAGE_CONTROL_STRICT_PERMISSION TRUE)

This overrides the permissions on the original files, following the rules set by Debian policy <https://www.debian.org/doc/debian-policy/ch-files.html#s-permissions-owners>

Note:

Added 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.

See <https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-source>

Note:

Sets the Multi-Arch field of the Debian package. Packages can declare in their control file how they should handle situations, where packages for different architectures are being installed on the same machine.

Added in version 3.31: Per-component CPACK_DEBIAN_<COMPONENT>_PACKAGE_MULTIARCH variables.

See <https://wiki.debian.org/MultiArch/Hints>

Note:

Enable generation of dbgsym .ddeb package(s).

The volume name of the generated disk image.

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.

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.

Added 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.

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.

Added 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.

Added in version 3.23.

Control whether CPACK_RESOURCE_FILE_LICENSE <#variable: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) <#manual:cpack(1)> defaults to off.

In a CMake project that uses the CPack <#module: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 <#policy:CMP0133>.

Note:

Added 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 <#variable: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.

Added in version 3.17: RTF support.

Added 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:

For every language in this list, CPack will try to find files <language>.menu.txt and <language>.license.txt in the directory specified by the CPACK_DMG_SLA_DIR variable.

Added in version 3.17.

File name when packaging <component> as its own DMG (CPACK_COMPONENTS_GROUPING <#variable:CPACK_COMPONENTS_GROUPING> set to IGNORE).

Added in version 3.21.

The filesystem format. Common values are APFS and HFS+. See man hdiutil for a full list of supported formats.

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).

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).

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).

Added in version 4.2.

Path to the sync(8) command used to force completion of pending disk writes 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).

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:

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:

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:

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 <#variable:CPACK_INSTALL_CMAKE_PROJECTS>. In most cases, this will be only a single project. The project objects have the following fields:

The package name given in CPACK_PACKAGE_NAME <#variable:CPACK_PACKAGE_NAME>. Only present if this option is set.

The package version given in CPACK_PACKAGE_VERSION <#variable:CPACK_PACKAGE_VERSION>. Only present if this option is set.

The package description file given in CPACK_PACKAGE_DESCRIPTION_FILE <#variable:CPACK_PACKAGE_DESCRIPTION_FILE>. Only present if this option is set.

The package description summary given in CPACK_PACKAGE_DESCRIPTION_SUMMARY <#variable:CPACK_PACKAGE_DESCRIPTION_SUMMARY>. Only present if this option is set.

The build configuration given to CPack with the cpack -C <#cmdoption-cpack-C> option. Only present if this option is set.

The default directory permissions given in CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS <#variable:CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS>. Only present if this option is set.

True if CPACK_SET_DESTDIR <#variable:CPACK_SET_DESTDIR> is true, false if it is not.

The install prefix given in CPACK_PACKAGING_INSTALL_PREFIX <#variable:CPACK_PACKAGING_INSTALL_PREFIX>. Only present if CPACK_SET_DESTDIR <#variable:CPACK_SET_DESTDIR> is true.

True if CPACK_STRIP_FILES <#variable:CPACK_STRIP_FILES> is true, false if it is not.

True if CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION <#variable:CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION> is true, false if it is not.

True if CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION <#variable:CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION> is true, false if it is not.

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.

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.

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.

Added 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 <#variable:CPACK_PACKAGE_CHECKSUM> is set.

Added in version 3.18: CPACK_ARCHIVE_THREADS <#variable:CPACK_ARCHIVE_THREADS>

Sets the package name (in the package manifest, but also affects the output filename).

Sets the package comment. This is the short description displayed by pkg(8) in standard "pkg info" output.

Sets the package description. This is the long description of the package, given by "pkg info" with a specific package as argument.

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.

Added in version 3.12: The CPACK_PACKAGE_HOMEPAGE_URL variable.

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").

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.

The FreeBSD maintainer (e.g. [email protected]) of this package.

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.

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.

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).

Inno Setup only uses yes or no as boolean formats meanwhile CMake uses a lot of alternative formats like ON or OFF. Having this option turned on enables an automatic conversion.

Consider the following example:

set(CMAKE_INNOSETUP_SETUP_AllowNoIcons OFF)

If this option is turned on, the following line will be created in the output script: AllowNoIcons=no. Else, the following erroneous line will be created: AllowNoIcons=OFF

The conversion is enabled in every Inno Setup specific variable.

One of x86, x64, arm64 or ia64. This variable specifies the target architecture of the installer. This also affects the Program Files folder or registry keys being used.

CPack tries to determine the correct value with a try compile (see CMAKE_SIZEOF_VOID_P <#variable:CMAKE_SIZEOF_VOID_P>), but this option can be manually specified too (especially when using ia64 or cross-platform compilation).

If you don't want the installer to create the installation directory under Program Files, you've to specify the installation root here.

The full directory of the installation will be: ${CPACK_INNOSETUP_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY}.

If turned on, the installer allows the user to change the installation directory providing an extra wizard page.

The initial name of the start menu folder being created.

If this variable is set to ., then no separate folder is created, application shortcuts will appear in the top-level start menu folder.

A semicolon-separated list <#cmake-language-lists> of languages you want Inno Setup to include.

Currently available: armenian, brazilianPortuguese, bulgarian, catalan, corsican, czech, danish, dutch, english, finnish, french, german, hebrew, icelandic, italian, japanese, norwegian, polish, portuguese, russian, slovak, slovenian, spanish, turkish and ukrainian. This list might differ depending on the version of Inno Setup.

If you don't specify a license file using CPACK_RESOURCE_FILE_LICENSE <#variable:CPACK_RESOURCE_FILE_LICENSE>, CPack uses a file for demonstration purposes. If you want the installer to ignore license files at all, you can enable this option.

If you don't specify a readme file using CPACK_RESOURCE_FILE_README <#variable:CPACK_RESOURCE_FILE_README>, CPack uses a file for demonstration purposes. If you want the installer to ignore readme files at all, you can enable this option. Make sure the option is disabled when using a custom readme file.

Enables password protection and file encryption with the given password.

Enables the modern look and feel provided by Inno Setup. If this option is turned off, the classic style is used instead. Images and icon files are also affected.

The path to a custom installer .ico file.

Use CPACK_PACKAGE_ICON <#variable:CPACK_PACKAGE_ICON> to customize the bitmap file being shown in the wizard.

This group allows adapting any of the [Setup] section directives provided by Inno Setup where directive is its name.

Here are some examples:

set(CPACK_INNOSETUP_SETUP_WizardSmallImageFile "my_bitmap.bmp")
set(CPACK_INNOSETUP_SETUP_AllowNoIcons OFF) # This requires CPACK_INNOSETUP_USE_CMAKE_BOOL_FORMAT to be on

All of these variables have higher priority than the others. Consider the following example:

set(CPACK_INNOSETUP_SETUP_Password "admin")
set(CPACK_INNOSETUP_PASSWORD "secret")

The password will be admin at the end because CPACK_INNOSETUP_PASSWORD has less priority than CPACK_INNOSETUP_SETUP_Password.

This variable should contain a semicolon-separated list <#cmake-language-lists> of pairs path, instruction and can be used to customize the install command being automatically created for each file or directory.

CPack creates the following Inno Setup instruction for every file...

Source: "absolute\path\to\my_file.txt"; DestDir: "{app}"; Flags: ignoreversion

...and the following line for every directory:

Name: "{app}\my_folder"

You might want to change the destination directory or the flags of my_file.txt. Since we can also provide a relative path, the line you'd like to have, is the following:

Source: "my_file.txt"; DestDir: "{userdocs}"; Flags: ignoreversion uninsneveruninstall

You would do this by using my_file.txt as path and Source: "my_file.txt"; DestDir: "{userdocs}"; Flags: ignoreversion uninsneveruninstall as instruction.

You've to take care of the escaping problem <https://cmake.org/cmake/help/book/mastering-cmake/chapter/Packaging%20With%20CPack.html#adding-custom-cpack-options>. So the CMake command would be:

set(CPACK_INNOSETUP_CUSTOM_INSTALL_INSTRUCTIONS "my_file.txt;Source: \\\"my_file.txt\\\"\\; DestDir: \\\"{userdocs}\\\"\\; Flags: ignoreversion uninsneveruninstall")

To improve readability, you should go around the escaping problem by using CPACK_VERBATIM_VARIABLES <#variable:CPACK_VERBATIM_VARIABLES> or by placing the instruction into a separate CPack project config file.

If you customize the install instruction of a specific file, you lose the connection to its component. To go around, manually add Components: <component>. You also need to add its shortcuts and [Run] entries by yourself in a custom section, since the executable won't be found anymore by CPACK_PACKAGE_EXECUTABLES <#variable:CPACK_PACKAGE_EXECUTABLES>.

Here's another example (Note: You've to go around the escaping problem for the example to work):

set(CPACK_INNOSETUP_CUSTOM_INSTALL_INSTRUCTIONS
    "component1/my_folder" "Name: \"{userdocs}\\my_folder\"\; Components: component1"
    "component2/my_folder2/my_file.txt" "Source: \"component2\\my_folder2\\my_file.txt\"\; DestDir: \"{app}\\my_folder2\\my_file.txt\"\; Flags: ignoreversion uninsneveruninstall\; Components: component2")

This variable should contain a semicolon-separated list <#cmake-language-lists> of pairs link, link name and can be used to add shortcuts into the start menu folder beside those of the executables (see CPACK_PACKAGE_EXECUTABLES <#variable:CPACK_PACKAGE_EXECUTABLES>). While link name is the label, link can be a URL or a path relative to the installation directory.

Here's an example:

set(CPACK_INNOSETUP_MENU_LINKS
    "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html"
    "CMake Help" "https://cmake.org" "CMake Web Site")

If this option is turned on, a shortcut to the application's uninstaller is automatically added to the start menu folder.

A semicolon-separated list <#cmake-language-lists> of executables being specified in CPACK_PACKAGE_EXECUTABLES <#variable:CPACK_PACKAGE_EXECUTABLES> which the user can run when the installer finishes.

They're internally added to the [Run] section.

If you don't want the component compName to be installed under {app}, you've to specify its installation directory here.

This option only affects downloaded components.

If this option is turned on, the hashes of the downloaded archives are calculated during compile and download time. The installer will only proceed if they match.

The filename of the Inno Setup Script Compiler command.

A semicolon-separated list <#cmake-language-lists> of extra command-line options for the Inno Setup Script Compiler command.

For example: /Qp;/Smysigntool=$p

Take care of the escaping problem <https://cmake.org/cmake/help/book/mastering-cmake/chapter/Packaging%20With%20CPack.html#adding-custom-cpack-options>.

This group allows to add custom define directives as command-line options to the Inno Setup Preprocessor command. Each entry emulates a #define public <macro> directive. Its macro is accessible from anywhere (public), so it can also be used in extra script files.

Macro names must not contain any special characters. Refer to the Inno Setup Preprocessor documentation for the detailed rules.

Consider the following example:

# The following line emulates: #define public MyMacro "Hello, World!"
set(CPACK_INNOSETUP_DEFINE_MyMacro "Hello, World!")

At this point, you can use MyMacro anywhere. For example in the following extra script:

AppComments={#emit "'My Macro' has the value: " + MyMacro}

Take care of the escaping problem <https://cmake.org/cmake/help/book/mastering-cmake/chapter/Packaging%20With%20CPack.html#adding-custom-cpack-options>.

A semicolon-separated list <#cmake-language-lists> of paths to additional .iss script files to be processed.

They're internally included at the top of the output script file using a #include directive.

You can add any section in your file to extend the installer (e.g. adding additional tasks or registry keys). Prefer using CPACK_INNOSETUP_SETUP_<directive> when extending the [Setup] section.

A semicolon-separated list <#cmake-language-lists> of paths to additional Pascal files to be processed.

This variable is actually the same as CPACK_INNOSETUP_EXTRA_SCRIPTS, except you don't have to add [Code] at the top of your file. Never change the current section in a code file. This will result in undefined behavior! Treat them as normal Pascal scripts instead.

Code files are included at the very bottom of the output script.

Added in version 3.3.

Set to ON to enable addition debug output. By default is OFF.

Name of the installer as displayed on the title bar. If not specified, it defaults to CPACK_PACKAGE_DESCRIPTION_SUMMARY <#variable:CPACK_PACKAGE_DESCRIPTION_SUMMARY>.

Publisher of the software (as shown in the Windows Control Panel). If not specified, it defaults to CPACK_PACKAGE_VENDOR <#variable:CPACK_PACKAGE_VENDOR>.

URL to a page that contains product information on your web site.

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.

Filename for a custom window icon in PNG format for the Installer application. It must be an absolute path.

Filename for a logo image in PNG format, used as QWizard::LogoPixmap. It must be an absolute path.

Added in version 3.8.

Filename for a watermark image in PNG format, used as QWizard::WatermarkPixmap. It must be an absolute path.

Added in version 3.8.

Filename for a banner image in PNG format, used as QWizard::BannerPixmap. It must be an absolute path.

Added 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.

Added in version 3.8.

Wizard style to be used (Modern, Mac, Aero or Classic).

Added in version 3.8.

Default width of the wizard in pixels. Setting a banner image will override this.

Added in version 3.8.

Default height of the wizard in pixels. Setting a watermark image will override this.

Added 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.

Added in version 3.8.

Color of the titles and subtitles (takes an HTML color code, such as #88FF33).

Added in version 3.15.

Filename for a stylesheet. It must be an absolute path.

Default target directory for installation. If CPACK_PACKAGE_INSTALL_DIRECTORY <#variable: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 <https://doc.qt.io/qtinstallerframework/scripting.html>.

Default target directory for installation with administrator rights.

You can use predefined variables.

Added in version 3.11.

Set to OFF if the target directory should not be deleted when uninstalling.

Is ON by default

The group, which will be used to configure the root package.

The root package name, which will be used if the configuration group is not specified.

Added 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.

Added 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).

Added in version 3.3.

Filename for the configuration of the generated maintenance tool.

If not specified, QtIFW uses a default file name (maintenancetool.ini).

Added 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.

Added in version 3.3.

Set to OFF if the installation path cannot contain space characters.

Is ON for QtIFW less 2.0 tools.

Added 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.

Added in version 3.3.

Filename for a custom installer control script.

Added 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:cpack_ifw_add_package_resources> command to resolve relative paths.

Added 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.

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() <#command:cpack_ifw_add_repository> or updated with cpack_ifw_update_repository() <#command:cpack_ifw_update_repository>.

If this is ON, all components will be downloaded. If not set, the behavior is determined by whether cpack_configure_downloads() <#command:cpack_configure_downloads> has been called with the ALL option or not.

Added 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.

Added in version 3.31.

A list of URLs associated with the ProductImages. Only used if CPACK_IFW_PACKAGE_PRODUCT_IMAGES is defined and it has the same size.

This feature is available for QtIFW 4.0.0 and later.

Added 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.

Added 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.

Added 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.

Added 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.

Added 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:

Note:

This feature is available for QtIFW 4.2.0 and later.

Added in version 3.23.

Archive compression level. The allowable values are:

If this variable is not set, QtIFW will use a default compression level, which will typically be 5 (Normal compression).

Note:

This feature is available for QtIFW 4.2.0 and later.

Resolve duplicate names when installing components with groups.

Additional prepared packages directories that will be used to resolve dependent components.

Added 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.

Added in version 3.3.

The version of the QtIFW tools that will be used. This variable is set by the CPackIFW <#module:CPackIFW> module.

Added in version 3.19.

The path to archivegen.

The path to binarycreator.

The path to repogen.

The path to installerbase.

The path to devtool.

Added in version 3.9.

CMake variable

Added in version 3.9.

Environment variable

CMake variable

Environment variable

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>

<https://download.qt.io/official_releases/qt-installer-framework>

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}

An icon filename. The name of a *.ico file used as the main icon for the generated install program.

An icon filename. The name of a *.ico file used as the main icon for the generated uninstall program.

undocumented.

Added in version 3.5.

The filename of a bitmap to use as the NSIS MUI_WELCOMEFINISHPAGE_BITMAP.

Added in version 3.5.

The filename of a bitmap to use as the NSIS MUI_UNWELCOMEFINISHPAGE_BITMAP.

Extra NSIS commands that will be added to the beginning of the install Section, before your install tree is available on the target system.

Extra NSIS commands that will be added to the end of the install Section, after your install tree is available on the target system.

Extra NSIS commands that will be added to the uninstall Section, before your install tree is removed from the target system.

The arguments that will be passed to the NSIS SetCompressor command.

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.

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.

The display name string that appears in the Windows Apps & features in Control Panel

The title displayed at the top of the installer.

A path to the executable that contains the installer icon.

URL to a web site providing assistance in installing your application.

URL to a web site providing more information about your application.

Contact information for questions and comments about the installation process.

Added in version 3.7.

Custom install directory for the specified component <compName> instead of $INSTDIR.

Additional NSIS commands for creating Start Menu shortcuts.

Additional NSIS commands to uninstall Start Menu shortcuts.

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.

Specify an executable to add an option to run on the finish page of the NSIS installer.

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")

Added in version 3.17.

Specify the name of the program to uninstall the version. Default is Uninstall.

Added in version 3.17.

The title to display on the top of the page for the welcome page.

Added in version 3.17.

Display the title in the welcome page on 3 lines instead of 2.

Added in version 3.17.

The title to display on the top of the page for the finish page.

Added in version 3.17.

Display the title in the finish page on 3 lines instead of 2.

Added in version 3.17.

The image to display on the header of installers pages.

Added in version 3.18.

If set, declares that the installer is DPI-aware.

Added 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 (" ").

Added 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.

Added in version 3.21.

If set, specify the name of the NSIS executable. Default is makensis.

Added in version 3.22.

If set, do not display the page containing the license during installation.

Added in version 3.25.

This variable is a semicolon-separated list <#cmake-language-lists> 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>...

where <preArgs>... is constructed from CPACK_NSIS_EXECUTABLE_PRE_ARGUMENTS and <postArgs>... is constructed from CPACK_NSIS_EXECUTABLE_POST_ARGUMENTS.

Added in version 3.25.

This variable is a semicolon-separated list <#cmake-language-lists> 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>...

where <preArgs>... is constructed from CPACK_NSIS_EXECUTABLE_PRE_ARGUMENTS and <postArgs>... is constructed from CPACK_NSIS_EXECUTABLE_POST_ARGUMENTS.

Added in version 4.2.

Specifies whether or not the installer will perform a CRC on itself before allowing an install. Allowed values for this variable are on, off, and force. If not specified, the default behavior is on.

Added in version 4.4.

If set, do not display the page containing the license during installation.

Enable component packaging for CPack NuGet generator

Enable debug messages while executing CPack NuGet generator.

Added in version 4.1.

Generate a Nuget symbol package (.snupkg).

The NUGET package name. CPACK_NUGET_PACKAGE_NAME is used as the package id on nuget.org <https://www.nuget.org>

The NuGet package version.

A long description of the package for UI display.

A comma-separated list of packages authors, matching the profile names on nuget.org <https://www.nuget.org>. These are displayed in the NuGet Gallery on nuget.org <https://www.nuget.org> and are used to cross-reference packages by the same authors.

Deprecated since version 3.30: Use authors (CPACK_NUGET_PACKAGE_AUTHORS) instead.

A comma-separated list of the package creators using profile names on nuget.org <https://www.nuget.org>. This is often the same list as in authors, and is ignored when uploading the package to nuget.org <https://www.nuget.org>.

An URL for the package's home page, often shown in UI displays as well as nuget.org <https://www.nuget.org>.

Deprecated since version 3.20: Use a local license file (CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME) or a SPDX license identifier <https://spdx.org/licenses> (CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION) instead.

An URL for the package's license, often shown in UI displays as well as on nuget.org <https://www.nuget.org>.

Added in version 3.20.

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.

Added in version 3.20.

A Software Package Data Exchange SPDX license identifier <https://spdx.org/licenses> 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 <https://spdx.github.io/spdx-spec/v2.3/SPDX-license-expressions> for guidance on forming complex license expressions.

If CPACK_NUGET_PACKAGE_LICENSE_FILE_NAME is specified, CPACK_NUGET_PACKAGE_LICENSE_EXPRESSION is ignored.

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.

Added in version 3.20.

The filename of a 64x64 image with transparency background to use as the icon for the package in UI display.

Added in version 3.30.

The package path relative to the root of the package to a readme file. Supported file formats include only Markdown (*.md).

When set to a true value, the user will be prompted to accept the license before installing the package.

Deprecated since version 3.30: Summary is being deprecated. Use description (CPACK_NUGET_PACKAGE_DESCRIPTION) instead.

A short description of the package for UI display. If omitted, a truncated version of description is used.

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.

Copyright details for the package.

Added in version 3.20.

Locale specifier for the package, for example en_CA.

A space-delimited list of tags and keywords that describe the package and aid discoverability of packages through search and filtering.

Repository metadata allows you to map the *.nupkg to the repository that built it. This should be a publicly available URL that can be invoked directly by a version control software. It should not be an HTML page as this is meant for the computer.

A type of the VCS repository. When uploading a package to nuget.org <https://www.nuget.org>, the type is limited to 100 characters.

A VSC branch name to build the package.

A SHA-1 hash of the commit to build the package.

A human-friendly title of the package, typically used in UI displays as on nuget.org <https://www.nuget.org> and the Package Manager in Visual Studio. If not specified, the package ID is used.

A list of default (not framework-specific) package dependencies.

A version specification <https://learn.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges> for the particular dependency, where <dependency> is an item of the dependency list (see above).

Added in version 3.30.

A list of Target Framework Monikers (TFMs) for the package, e.g., "net47;netcoreapp21". For each of these TFMs a dependency group <https://learn.microsoft.com/en-us/nuget/reference/nuspec#dependency-groups> will be generated in the dependencies block of the NuGet package. Framework-specific dependencies can be added to these groups with the TFM dependency lists (see below).

This variable is particularly useful for fixing warnings NU5128 <https://learn.microsoft.com/en-us/nuget/reference/errors-and-warnings/nu5128>.

Added in version 3.30.

A list of package dependencies that apply specifically to the <tfm> framework, where <tfm> is an item from the TFMs list (see above).

Added in version 3.30.

A version specification <https://learn.microsoft.com/en-us/nuget/concepts/package-versioning#version-ranges> for the particular framework-specific dependency, where <dependency> is an item of the <tfm>-specific dependency list (see above).

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).

Added 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.

Added in version 3.8.

Adds a digital signature to the resulting package.

Added in version 3.8.

Specify a specific keychain to search for the signing identity.

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).

Added in version 3.8.

Adds a digital signature to the resulting package.

Added in version 3.8.

Specify a specific keychain to search for the signing identity.

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.

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.

Added 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 <#variable:CPACK_RESOURCE_FILE_WELCOME>, CPACK_RESOURCE_FILE_README <#variable:CPACK_RESOURCE_FILE_README>, and CPACK_RESOURCE_FILE_LICENSE <#variable:CPACK_RESOURCE_FILE_LICENSE> files are copied.

Added in version 3.23.

This option enables more granular control over where the product may be installed. When it is set to true (see policy CMP0161 <#policy:CMP0161>), 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"/>

The default values are as shown above, but can be overridden with CPACK_PRODUCTBUILD_DOMAINS_ANYWHERE, CPACK_PRODUCTBUILD_DOMAINS_USER, and CPACK_PRODUCTBUILD_DOMAINS_ROOT.

Added 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.

Added 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:

CPACK_PRODUCTBUILD_DOMAINS must be set to true for this variable to have any effect.

Added 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.

Adds a background to Distribution XML if specified. The value contains the path to image in Resources directory.

Adds an alignment attribute to the background in Distribution XML. Refer to Apple documentation for valid values.

Adds a scaling attribute to the background in Distribution XML. Refer to Apple documentation for valid values.

Adds a mime-type attribute to the background in Distribution XML. The option contains MIME type of an image.

Adds an uti attribute to the background in Distribution XML. The option contains UTI type of an image.

Adds a background for the Dark Aqua theme to Distribution XML if specified. The value contains the path to image in Resources directory.

Does the same as CPACK_PRODUCTBUILD_BACKGROUND_ALIGNMENT option, but for the dark theme.

Does the same as CPACK_PRODUCTBUILD_BACKGROUND_SCALING option, but for the dark theme.

Does the same as CPACK_PRODUCTBUILD_BACKGROUND_MIME_TYPE option, but for the dark theme.

Does the same as CPACK_PRODUCTBUILD_BACKGROUND_UTI option, but for the dark theme.

Same as CPACK_RESOURCE_FILE_LICENSE <#variable:CPACK_RESOURCE_FILE_LICENSE> except without the path. The named file will be available in the same directory as the generated distribution.dist file.

Same as CPACK_RESOURCE_FILE_README <#variable:CPACK_RESOURCE_FILE_README> except without the path. The named file will be available in the same directory as the generated distribution.dist file.

Same as CPACK_RESOURCE_FILE_WELCOME <#variable:CPACK_RESOURCE_FILE_WELCOME> except without the path. The named file will be available in the same directory as the generated distribution.dist file.

Added in version 3.23.

This contains all the XML elements that specify installer-wide options (including domain details), default backgrounds and the choices outline.

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.

<https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/Configuration>

<https://gitlab.kitware.com/cmake/community/-/wikis/doc/cpack/PackageGenerators#rpm-unix-only>

Enable component packaging for CPack RPM generator

If enabled (ON) multiple packages are generated. By default a single package containing files of all components is generated.

The RPM package summary.

Added in version 3.2: Per-component CPACK_RPM_<component>_PACKAGE_SUMMARY variables.

The RPM package name.

Added in version 3.5: Per-component CPACK_RPM_<component>_PACKAGE_NAME variables.

Added in version 3.6.

Package file name.

This may be set to:

Note:

Added in version 3.8.

Main component that is packaged without component suffix.

This variable can be set to any component or group name so that component or group rpm package is generated without component suffix in filename and package name.

Added in version 3.10.

The RPM package epoch

Optional number that should be incremented when changing versioning schemas or fixing mistakes in the version numbers of older packages.

The RPM package version.

The RPM package architecture.

This may be set to noarch if you know you are building a noarch package.

Added in version 3.3: Per-component CPACK_RPM_<component>_PACKAGE_ARCHITECTURE variables.

The RPM package release.

This is the numbering of the RPM package itself, i.e. the version of the packaging and not the version of the content (see CPACK_RPM_PACKAGE_VERSION). One may change the default value if the previous packaging was buggy and/or you want to put here a fancy Linux distro specific numbering.

Added in version 3.6.

The dist tag that is added RPM Release: field.

This is the reported %{dist} tag from the current distribution or empty %{dist} if RPM macro is not set. If this variable is set then RPM Release: field value is set to ${CPACK_RPM_PACKAGE_RELEASE}%{?dist}.

The RPM package license policy.

The RPM package group.

Added in version 3.5: Per-component CPACK_RPM_<component>_PACKAGE_GROUP variables.

The RPM package vendor.

The projects URL.

Added in version 3.12: The CMAKE_PROJECT_HOMEPAGE_URL variable.

RPM package description.

Added in version 3.2: Per-component CPACK_RPM_<component>_PACKAGE_DESCRIPTION variables.

RPM compression type.

May be used to override RPM compression type to be used to build the RPM. For example some Linux distributions default to xz or zstd. Using this, one can specify a specific compression type to be used.

Possible values are:

RPM spec autoreq field.

May be used to enable (1, yes) or disable (0, no) automatic shared libraries dependency detection. Dependencies are added to requires list.

Note:

RPM spec autoprov field.

May be used to enable (1, yes) or disable (0, no) automatic listing of shared libraries that are provided by the package. Shared libraries are added to provides list.

Note:

RPM spec autoreqprov field.

Variable enables/disables autoreq and autoprov at the same time. See CPACK_RPM_PACKAGE_AUTOREQ and CPACK_RPM_PACKAGE_AUTOPROV for more details.

Note:

RPM spec requires field.

May be used to set RPM dependencies (requires). Note that you must enclose the entire value between quotes when setting this variable, for example:

set(CPACK_RPM_PACKAGE_REQUIRES "python >= 2.5.0, cmake >= 2.8")

The required package list of an RPM file could be printed with:

rpm -qp --requires file.rpm

RPM spec conflicts field.

May be used to set negative RPM dependencies (conflicts). Note that you must enclose the entire value between quotes when setting this variable, for example:

set(CPACK_RPM_PACKAGE_CONFLICTS "libxml2")

The conflicting package list of an RPM file could be printed with:

rpm -qp --conflicts file.rpm

Added in version 3.2.

RPM spec requires(pre) field.

May be used to set RPM preinstall dependencies (requires(pre)). Note that you must enclose the entire value between quotes when setting this variable, for example:

set(CPACK_RPM_PACKAGE_REQUIRES_PRE "shadow-utils, initscripts")

Added in version 3.2.

RPM spec requires(post) field.

May be used to set RPM postinstall dependencies (requires(post)). Note that you must enclose the entire value between quotes when setting this variable, for example:

set(CPACK_RPM_PACKAGE_REQUIRES_POST "shadow-utils, initscripts")

Added in version 3.2.

RPM spec requires(postun) field.

May be used to set RPM postuninstall dependencies (requires(postun)). Note that you must enclose the entire value between quotes when setting this variable, for example:

set(CPACK_RPM_PACKAGE_REQUIRES_POSTUN "shadow-utils, initscripts")

Added in version 3.2.

RPM spec requires(preun) field.

May be used to set RPM preuninstall dependencies (requires(preun)). Note that you must enclose the entire value between quotes when setting this variable, for example:

set(CPACK_RPM_PACKAGE_REQUIRES_PREUN "shadow-utils, initscripts")

RPM spec suggests field.

May be used to set weak RPM dependencies (suggests). If rpmbuild doesn't support the Suggests tag, CPack will emit a warning and ignore this variable. Note that you must enclose the entire value between quotes when setting this variable.

Added in version 4.1.

RPM spec recommends field.

May be used to set weak RPM dependencies (recommends). If rpmbuild doesn't support the Recommends tag, CPack will emit a warning and ignore this variable. Note that you must enclose the entire value between quotes when setting this variable.

Added in version 4.1.

RPM spec supplements field.

May be used to set weak RPM dependencies (supplements). If rpmbuild doesn't support the Supplements tag, CPack will emit a warning and ignore this variable. Note that you must enclose the entire value between quotes when setting this variable.

Added in version 4.1.

RPM spec enhances field.

May be used to set weak RPM dependencies (enhances). If rpmbuild doesn't support the Enhances tag, CPack will emit a warning and ignore this variable. Note that you must enclose the entire value between quotes when setting this variable.

RPM spec provides field.

May be used to set RPM dependencies (provides). The provided package list of an RPM file could be printed with:

rpm -qp --provides file.rpm

RPM spec obsoletes field.

May be used to set RPM packages that are obsoleted by this one.

build a relocatable RPM.

If this variable is set to TRUE or ON, the CPack RPM generator will try to build a relocatable RPM package. A relocatable RPM may be installed using:

rpm --prefix or --relocate

in order to install it at an alternate place see rpm(8). Note that currently this may fail if CPACK_SET_DESTDIR <#variable:CPACK_SET_DESTDIR> is set to ON. If CPACK_SET_DESTDIR <#variable:CPACK_SET_DESTDIR> is set then you will get a warning message but if there is file installed with absolute path you'll get unexpected behavior.

Deprecated since version 2.8.12: Use CPACK_RPM_SPEC_MORE_DEFINE instead.

May be used to override the __spec_install_post section within the generated spec file. This affects the install step during package creation, not during package installation. For adding operations to be performed during package installation, use CPACK_RPM_POST_INSTALL_SCRIPT_FILE instead.

RPM extended spec definitions lines.

May be used to add any %define lines to the generated spec file. An example of its use is to prevent stripping of executables (but note that this may also disable other default post install processing):

set(CPACK_RPM_SPEC_MORE_DEFINE "%define __spec_install_post /bin/true")

Added in version 4.4: If the variable is a list, its string elements will be concatenated using \n before being substituted into the spec template.

Toggle CPack RPM generator debug output.

May be set when invoking cpack in order to trace debug information during CPack RPM run. For example you may launch CPack like this:

cpack -D CPACK_RPM_PACKAGE_DEBUG=1 -G RPM

A user provided spec file.

May be set by the user in order to specify a USER binary spec file to be used by the CPack RPM generator instead of generating the file. The specified file will be processed by configure_file(@ONLY).

Spec file template.

If set CPack will generate a template for USER specified binary spec file and stop with an error. For example launch CPack like this:

cpack -D CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE=1 -G RPM

The user may then use this file in order to hand-craft is own binary spec file which may be used with CPACK_RPM_USER_BINARY_SPECFILE.

Path to file containing pre install/uninstall/transaction script.

May be used to embed a pre installation/uninstallation/transaction script in the spec file. The referred script file (or both) will be read and directly put after the %pre or %preun section If CPACK_RPM_COMPONENT_INSTALL is set to ON the install/uninstall/transaction script for each component can be overridden with CPACK_RPM_<COMPONENT>_PRE_INSTALL_SCRIPT_FILE, CPACK_RPM_<COMPONENT>_PRE_UNINSTALL_SCRIPT_FILE, and CPACK_RPM_<COMPONENT>_PRE_TRANS_SCRIPT_FILE One may verify which scriptlet has been included with:

rpm -qp --scripts  package.rpm

Added in version 3.18: The CPACK_RPM_PRE_TRANS_SCRIPT_FILE variable.

Path to file containing post install/uninstall/transaction script.

May be used to embed a post installation/uninstallation/transaction script in the spec file. The referred script file (or both) will be read and directly put after the %post or %postun section. If CPACK_RPM_COMPONENT_INSTALL is set to ON the install/uninstall/transaction script for each component can be overridden with CPACK_RPM_<COMPONENT>_POST_INSTALL_SCRIPT_FILE, CPACK_RPM_<COMPONENT>_POST_UNINSTALL_SCRIPT_FILE, and CPACK_RPM_<COMPONENT>_POST_TRANS_SCRIPT_FILE One may verify which scriptlet has been included with:

rpm -qp --scripts  package.rpm

Added in version 3.18: The CPACK_RPM_POST_TRANS_SCRIPT_FILE variable.

May be used to explicitly specify %(<directive>) file line in the spec file. Like %config(noreplace) or any other directive that be found in the %files section. Since the CPack RPM generator is generating the list of files (and directories) the user specified files of the CPACK_RPM_<COMPONENT>_USER_FILELIST list will be removed from the generated list. If referring to directories do not add a trailing slash.

Added in version 3.8: You can have multiple directives per line, as in %attr(600,root,root) %config(noreplace).

RPM changelog file.

May be used to embed a changelog in the spec file. The referred file will be read and directly put after the %changelog section.

list of path to be excluded.

May be used to exclude path (directories or files) from the auto-generated list of paths discovered by CPack RPM. The default value contains a reasonable set of values if the variable is not defined by the user. If the variable is defined by the user then the CPack RPM generator will NOT any of the default path. If you want to add some path to the default list then you can use CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION variable.

Added in version 3.10: Added /usr/share/aclocal to the default list of excludes.

additional list of path to be excluded.

May be used to add more exclude path (directories or files) from the initial default list of excluded paths. See CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST.

Added in version 3.2.

Packages relocation paths list.

May be used to specify more than one relocation path per relocatable RPM. Variable contains a list of relocation paths that if relative are prefixed by the value of CPACK_RPM_<COMPONENT>_PACKAGE_PREFIX or by the value of CPACK_PACKAGING_INSTALL_PREFIX <#variable:CPACK_PACKAGING_INSTALL_PREFIX> if the component version is not provided. Variable is not component based as its content can be used to set a different path prefix for e.g. binary dir and documentation dir at the same time. Only prefixes that are required by a certain component are added to that component - component must contain at least one file/directory/symbolic link with CPACK_RPM_RELOCATION_PATHS prefix for a certain relocation path to be added. Package will not contain any relocation paths if there are no files/directories/symbolic links on any of the provided prefix locations. Packages that either do not contain any relocation paths or contain files/directories/symbolic links that are outside relocation paths print out an AUTHOR_WARNING <#command:message> that RPM will be partially relocatable.

Added in version 3.2.

Per component relocation path install prefix.

May be used to set per component CPACK_PACKAGING_INSTALL_PREFIX <#variable:CPACK_PACKAGING_INSTALL_PREFIX> for relocatable RPM packages.

Added in version 3.3.

Removal of default install prefix from relocation paths list.

May be used to remove CPACK_PACKAGING_INSTALL_PREFIX <#variable:CPACK_PACKAGING_INSTALL_PREFIX> and CPACK_RPM_<COMPONENT>_PACKAGE_PREFIX from relocatable RPM prefix paths.

Added in version 3.3.

May be used to set additional man dirs that could potentially be compressed by brp-compress RPM macro. Variable content must be a list of regular expressions that point to directories containing man files or to man files directly. Note that in order to compress man pages a path must also be present in brp-compress RPM script and that brp-compress script must be added to RPM configuration by the operating system.

Added in version 3.6.

default user ownership of RPM content

Value should be user name and not UID. Note that <compName> must be in upper-case.

Added in version 3.6.

default group ownership of RPM content

Value should be group name and not GID. Note that <compName> must be in upper-case.

Added in version 3.6.

default permissions used for packaged files

Accepted values are lists with PERMISSIONS. Valid permissions are:

Note that <compName> must be in upper-case.

Added in version 3.6.

default permissions used for packaged directories

Accepted values are lists with PERMISSIONS. Valid permissions are the same as for CPACK_RPM_DEFAULT_FILE_PERMISSIONS. Note that <compName> must be in upper-case.

Added in version 3.11.

force execute permissions on programs and shared libraries

Force set owner, group and world execute permissions on programs and shared libraries. This can be used for creating valid rpm packages on systems such as Debian where shared libraries do not have execute permissions set.

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.

Enable generation of debuginfo RPM package(s).

Provides locations of root directories of source files from which binaries were built.

Prefix of location where sources will be placed during package installation.

Directories containing sources that should be excluded from debuginfo packages.

Listed paths are owned by other RPM packages and should therefore not be deleted on debuginfo package uninstallation.

Paths that should be appended to CPACK_RPM_DEBUGINFO_EXCLUDE_DIRS for exclusion.

Added in version 3.8.

Create a single debuginfo package even if components packaging is set.

When this variable is enabled it produces a single debuginfo package even if component packaging is enabled.

When using this feature in combination with components packaging and there is more than one component this variable requires CPACK_RPM_MAIN_COMPONENT to be set.

Added in version 3.9.

Debuginfo package file name.

Alternatively provided debuginfo package file name must end with .rpm suffix and should differ from file names of other generated packages.

Variable may contain @cpack_component@ placeholder which will be replaced by component name if component packaging is enabled otherwise it deletes the placeholder.

Setting the variable to RPM-DEFAULT may be used to explicitly set filename generation to default.

Should the content be packaged as a source rpm (default is binary rpm).

Additional command-line parameters provided to cmake(1) <#manual:cmake(1)> executable.

Packaging install prefix that would be provided in CPACK_PACKAGING_INSTALL_PREFIX <#variable:CPACK_PACKAGING_INSTALL_PREFIX> variable for producing binary RPM packages.

List of source rpm build dependencies.

May be used to set source RPM build dependencies (BuildRequires). Note that you must enclose the entire value between quotes when setting this variable, for example:

set(CPACK_RPM_BUILDREQUIRES "python >= 2.5.0, cmake >= 2.8")