1CPACK-GENERATORS(7) CMake CPACK-GENERATORS(7)
2
6 cpack-generators - CPack Generator Reference
7
9 CPack Archive Generator
10 Archive CPack generator that supports packaging of sources and binaries
11 in different formats:
12 · 7Z - 7zip - (.7z)
14 · TBZ2 (.tar.bz2)
16 · TGZ (.tar.gz)
18 · TXZ (.tar.xz)
20 · TZ (.tar.Z)
22 · TZST (.tar.zst)
24 · ZIP (.zip)
26 Variables specific to CPack Archive generator
28 CPACK_ARCHIVE_FILE_NAME
29 CPACK_ARCHIVE_<component>_FILE_NAME
31 Package file name without extension which is added automatically
32 depending on the archive format.
33 · Mandatory : YES
35 ·
37 Default
39 <CPACK_PACKAGE_FILE_NAME>[-<component>].<extension>
40 with spaces replaced by ‘-‘
41 CPACK_ARCHIVE_COMPONENT_INSTALL
43 Enable component packaging for CPackArchive
44 · Mandatory : NO
46 · Default : OFF
48 If enabled (ON) multiple packages are generated. By default a
50 single package containing files of all components is generated.
51 CPack Bundle Generator
53 CPack Bundle generator (macOS) specific options
54 Variables specific to CPack Bundle generator
56 Installers built on macOS using the Bundle generator use the aforemen‐
57 tioned DragNDrop (CPACK_DMG_xxx) variables, plus the following Bun‐
58 dle-specific parameters (CPACK_BUNDLE_xxx).
59 CPACK_BUNDLE_NAME
61 The name of the generated bundle. This appears in the macOS
62 Finder as the bundle name. Required.
63 CPACK_BUNDLE_PLIST
65 Path to an macOS Property List (.plist) file that will be used
66 for the generated bundle. This assumes that the caller has gen‐
67 erated or specified their own Info.plist file. Required.
68 CPACK_BUNDLE_ICON
70 Path to an macOS icon file that will be used as the icon for the
71 generated bundle. This is the icon that appears in the macOS
72 Finder for the bundle, and in the macOS dock when the bundle is
73 opened. Required.
74 CPACK_BUNDLE_STARTUP_COMMAND
76 Path to a startup script. This is a path to an executable or
77 script that will be run whenever an end-user double-clicks the
78 generated bundle in the macOS Finder. Optional.
79 CPACK_BUNDLE_APPLE_CERT_APP
81 The name of your Apple supplied code signing certificate for the
82 application. The name usually takes the form Developer ID
83 Application: [Name] or 3rd Party Mac Developer Application:
84 [Name]. If this variable is not set the application will not be
85 signed.
86 CPACK_BUNDLE_APPLE_ENTITLEMENTS
88 The name of the Property List (.plist) file that contains your
89 Apple entitlements for sandboxing your application. This file is
90 required for submission to the macOS App Store.
91 CPACK_BUNDLE_APPLE_CODESIGN_FILES
93 A list of additional files that you wish to be signed. You do
94 not need to list the main application folder, or the main exe‐
95 cutable. You should list any frameworks and plugins that are
96 included in your app bundle.
97 CPACK_BUNDLE_APPLE_CODESIGN_PARAMETER
99 Additional parameter that will passed to codesign. Default
100 value: --deep -f
101 CPACK_COMMAND_CODESIGN
103 Path to the codesign(1) command used to sign applications with
104 an Apple cert. This variable can be used to override the auto‐
105 matically detected command (or specify its location if the
106 auto-detection fails to find it).
107 CPack Cygwin Generator
109 Cygwin CPack generator (Cygwin).
110 Variables specific to CPack Cygwin generator
112 The following variable is specific to installers build on and/or for
113 Cygwin:
114 CPACK_CYGWIN_PATCH_NUMBER
116 The Cygwin patch number. FIXME: This documentation is incom‐
117 plete.
118 CPACK_CYGWIN_PATCH_FILE
120 The Cygwin patch file. FIXME: This documentation is incomplete.
121 CPACK_CYGWIN_BUILD_SCRIPT
123 The Cygwin build script. FIXME: This documentation is incom‐
124 plete.
125 CPack DEB Generator
127 The built in (binary) CPack DEB generator (Unix only)
128 Variables specific to CPack Debian (DEB) generator
130 The CPack DEB generator may be used to create DEB package using CPack.
131 The CPack DEB generator is a CPack generator thus it uses the CPACK_XXX
132 variables used by CPack.
133 The CPack DEB generator should work on any Linux host but it will pro‐
135 duce better deb package when Debian specific tools dpkg-xxx are usable
136 on the build system.
137 The CPack DEB generator has specific features which are controlled by
139 the specifics CPACK_DEBIAN_XXX variables.
140 CPACK_DEBIAN_<COMPONENT>_XXXX variables may be used in order to have
142 component specific values. Note however that <COMPONENT> refers to the
143 grouping name written in upper case. It may be either a component name
144 or a component GROUP name.
145 Here are some CPack DEB generator wiki resources that are here for his‐
147 toric reasons and are no longer maintained but may still prove useful:
148 · https://gitlab.kitware.com/cmake/community/wikis/doc/cpack/Configuration
150 · https://gitlab.kitware.com/cmake/community/wikis/doc/cpack/PackageGenerators#deb-unix-only
152 List of CPack DEB generator specific variables:
154 CPACK_DEB_COMPONENT_INSTALL
156 Enable component packaging for CPackDEB
157 · Mandatory : NO
159 · Default : OFF
161 If enabled (ON) multiple packages are generated. By default a
163 single package containing files of all components is generated.
164 CPACK_DEBIAN_PACKAGE_NAME
166 CPACK_DEBIAN_<COMPONENT>_PACKAGE_NAME
168 Set Package control field (variable is automatically transformed
169 to lower case).
170 · Mandatory : YES
172 · Default :
174 · CPACK_PACKAGE_NAME for non-component based installations
176 · CPACK_DEBIAN_PACKAGE_NAME suffixed with -<COMPONENT> for
178 component-based installations.
179 See
181 https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Source
182 CPACK_DEBIAN_FILE_NAME
184 CPACK_DEBIAN_<COMPONENT>_FILE_NAME
186 Package file name.
187 · Mandatory : YES
189 · Default : <CPACK_PACKAGE_FILE_NAME>[-<component>].deb
191 This may be set to DEB-DEFAULT to allow the CPack DEB generator
193 to generate package file name by itself in deb format:
194 <PackageName>_<VersionNumber>-<DebianRevisionNumber>_<DebianArchitecture>.deb
196 Alternatively provided package file name must end with either
198 .deb or .ipk suffix.
199 NOTE:
201 Preferred setting of this variable is DEB-DEFAULT but for
202 backward compatibility with the CPack DEB generator in CMake
203 prior to version 3.6 this feature is disabled by default.
204 NOTE:
206 By using non default filenames duplicate names may occur.
207 Duplicate files get overwritten and it is up to the packager
208 to set the variables in a manner that will prevent such
209 errors.
210 CPACK_DEBIAN_PACKAGE_EPOCH
212 The Debian package epoch
213 · Mandatory : No
215 · Default : -
217 Optional number that should be incremented when changing ver‐
219 sioning schemas or fixing mistakes in the version numbers of
220 older packages.
221 CPACK_DEBIAN_PACKAGE_VERSION
223 The Debian package version
224 · Mandatory : YES
226 · Default : CPACK_PACKAGE_VERSION
228 This variable may contain only alphanumerics (A-Za-z0-9) and the
230 characters CPACK_DEBIAN_PACKAGE_RELEASE is not set then hyphens
231 are not allowed.
232 NOTE:
234 For backward compatibility with CMake 3.9 and lower a failed
235 test of this variable’s content is not a hard error when both
236 CPACK_DEBIAN_PACKAGE_RELEASE and CPACK_DEBIAN_PACKAGE_EPOCH
237 variables are not set. An author warning is reported instead.
238 CPACK_DEBIAN_PACKAGE_RELEASE
240 The Debian package release - Debian revision number.
241 · Mandatory : No
243 · Default : -
245 This is the numbering of the DEB package itself, i.e. the ver‐
247 sion of the packaging and not the version of the content (see
248 CPACK_DEBIAN_PACKAGE_VERSION). One may change the default value
249 if the previous packaging was buggy and/or you want to put here
250 a fancy Linux distro specific numbering.
251 CPACK_DEBIAN_PACKAGE_ARCHITECTURE
253 CPACK_DEBIAN_<COMPONENT>_PACKAGE_ARCHITECTURE
255 The Debian package architecture
256 · Mandatory : YES
258 · Default : Output of dpkg --print-architecture (or i386 if
260 dpkg is not found)
261 CPACK_DEBIAN_PACKAGE_DEPENDS
263 CPACK_DEBIAN_<COMPONENT>_PACKAGE_DEPENDS
265 Sets the Debian dependencies of this package.
266 · Mandatory : NO
268 · Default :
270 · An empty string for non-component based installations
272 · CPACK_DEBIAN_PACKAGE_DEPENDS for component-based installa‐
274 tions.
275 NOTE:
277 If CPACK_DEBIAN_PACKAGE_SHLIBDEPS or more specifically
278 CPACK_DEBIAN_<COMPONENT>_PACKAGE_SHLIBDEPS is set for this
279 component, the discovered dependencies will be appended to
280 CPACK_DEBIAN_<COMPONENT>_PACKAGE_DEPENDS instead of
281 CPACK_DEBIAN_PACKAGE_DEPENDS. If
282 CPACK_DEBIAN_<COMPONENT>_PACKAGE_DEPENDS is an empty string,
283 only the automatically discovered dependencies will be set
284 for this component.
285 Example:
287 set(CPACK_DEBIAN_PACKAGE_DEPENDS "libc6 (>= 2.3.1-6), libc6 (< 2.4)")
289 CPACK_DEBIAN_ENABLE_COMPONENT_DEPENDS
291 Sets inter component dependencies if listed with CPACK_COMPO‐
292 NENT_<compName>_DEPENDS variables.
293 · Mandatory : NO
295 · Default : -
297 CPACK_DEBIAN_PACKAGE_MAINTAINER
299 The Debian package maintainer
300 · Mandatory : YES
302 · Default : CPACK_PACKAGE_CONTACT
304 CPACK_DEBIAN_PACKAGE_DESCRIPTION
306 CPACK_DEBIAN_<COMPONENT>_DESCRIPTION
308 The Debian package description
309 · Mandatory : YES
311 · Default :
313 · CPACK_DEBIAN_<COMPONENT>_DESCRIPTION (component based in‐
315 stallers only) if set, or CPACK_DEBIAN_PACKAGE_DESCRIPTION
316 if set, or
317 · CPACK_COMPONENT_<compName>_DESCRIPTION (component based in‐
319 stallers only) if set, or CPACK_PACKAGE_DESCRIPTION if set,
320 or
321 · content of the file specified in CPACK_PACKAGE_DESCRIP‐
323 TION_FILE if set
324 If after that description is not set, CPACK_PACKAGE_DESCRIP‐
326 TION_SUMMARY going to be used if set. Otherwise, CPACK_PACK‐
327 AGE_DESCRIPTION_SUMMARY will be added as the first line of
328 description as defined in Debian Policy Manual.
329 CPACK_DEBIAN_PACKAGE_SECTION
331 CPACK_DEBIAN_<COMPONENT>_PACKAGE_SECTION
333 Set Section control field e.g. admin, devel, doc, …
334 · Mandatory : YES
336 · Default : “devel”
338 See
340 https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections
341 CPACK_DEBIAN_ARCHIVE_TYPE
343 The archive format used for creating the Debian package.
344 · Mandatory : YES
346 · Default : “gnutar”
348 Possible value is:
350 · gnutar
352 NOTE:
354 This variable previously defaulted to the paxr value, but
355 dpkg has never supported that tar format. For backwards com‐
356 patibility the paxr value will be mapped to gnutar and a dep‐
357 recation message will be emitted.
358 CPACK_DEBIAN_COMPRESSION_TYPE
360 The compression used for creating the Debian package.
361 · Mandatory : YES
363 · Default : “gzip”
365 Possible values are:
367 · lzma
369 · xz
371 · bzip2
373 · gzip
375 CPACK_DEBIAN_PACKAGE_PRIORITY
377 CPACK_DEBIAN_<COMPONENT>_PACKAGE_PRIORITY
379 Set Priority control field e.g. required, important, standard,
380 optional, extra
381 · Mandatory : YES
383 · Default : “optional”
385 See
387 https://www.debian.org/doc/debian-policy/ch-archive.html#s-priorities
388 CPACK_DEBIAN_PACKAGE_HOMEPAGE
390 The URL of the web site for this package, preferably (when
391 applicable) the site from which the original source can be
392 obtained and any additional upstream documentation or informa‐
393 tion may be found.
394 · Mandatory : NO
396 · Default : CMAKE_PROJECT_HOMEPAGE_URL
398 NOTE:
400 The content of this field is a simple URL without any sur‐
401 rounding characters such as <>.
402 CPACK_DEBIAN_PACKAGE_SHLIBDEPS
404 CPACK_DEBIAN_<COMPONENT>_PACKAGE_SHLIBDEPS
406 May be set to ON in order to use dpkg-shlibdeps to generate bet‐
407 ter package dependency list.
408 · Mandatory : NO
410 · Default :
412 · CPACK_DEBIAN_PACKAGE_SHLIBDEPS if set or
414 · OFF
416 NOTE:
418 You may need set CMAKE_INSTALL_RPATH to an appropriate value
419 if you use this feature, because if you don’t dpkg-shlibdeps
420 may fail to find your own shared libs. See
421 https://gitlab.kitware.com/cmake/community/wikis/doc/cmake/RPATH-handling
422 CPACK_DEBIAN_PACKAGE_DEBUG
424 May be set when invoking cpack in order to trace debug informa‐
425 tion during the CPack DEB generator run.
426 · Mandatory : NO
428 · Default : -
430 CPACK_DEBIAN_PACKAGE_PREDEPENDS
432 CPACK_DEBIAN_<COMPONENT>_PACKAGE_PREDEPENDS
434 Sets the Pre-Depends field of the Debian package. Like Depends,
435 except that it also forces dpkg to complete installation of the
436 packages named before even starting the installation of the
437 package which declares the pre-dependency.
438 · Mandatory : NO
440 · Default :
442 · An empty string for non-component based installations
444 · CPACK_DEBIAN_PACKAGE_PREDEPENDS for component-based instal‐
446 lations.
447 See
449 http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
450 CPACK_DEBIAN_PACKAGE_ENHANCES
452 CPACK_DEBIAN_<COMPONENT>_PACKAGE_ENHANCES
454 Sets the Enhances field of the Debian package. Similar to
455 Suggests but works in the opposite direction: declares that a
456 package can enhance the functionality of another package.
457 · Mandatory : NO
459 · Default :
461 · An empty string for non-component based installations
463 · CPACK_DEBIAN_PACKAGE_ENHANCES for component-based installa‐
465 tions.
466 See
468 http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
469 CPACK_DEBIAN_PACKAGE_BREAKS
471 CPACK_DEBIAN_<COMPONENT>_PACKAGE_BREAKS
473 Sets the Breaks field of the Debian package. When a binary
474 package (P) declares that it breaks other packages (B), dpkg
475 will not allow the package (P) which declares Breaks be unpacked
476 unless the packages that will be broken (B) are deconfigured
477 first. As long as the package (P) is configured, the previously
478 deconfigured packages (B) cannot be reconfigured again.
479 · Mandatory : NO
481 · Default :
483 · An empty string for non-component based installations
485 · CPACK_DEBIAN_PACKAGE_BREAKS for component-based installa‐
487 tions.
488 See
490 https://www.debian.org/doc/debian-policy/ch-relationships.html#s-breaks
491 CPACK_DEBIAN_PACKAGE_CONFLICTS
493 CPACK_DEBIAN_<COMPONENT>_PACKAGE_CONFLICTS
495 Sets the Conflicts field of the Debian package. When one binary
496 package declares a conflict with another using a Conflicts
497 field, dpkg will not allow them to be unpacked on the system at
498 the same time.
499 · Mandatory : NO
501 · Default :
503 · An empty string for non-component based installations
505 · CPACK_DEBIAN_PACKAGE_CONFLICTS for component-based installa‐
507 tions.
508 See
510 https://www.debian.org/doc/debian-policy/ch-relationships.html#s-conflicts
511 NOTE:
513 This is a stronger restriction than Breaks, which prevents
514 the broken package from being configured while the breaking
515 package is in the “Unpacked” state but allows both packages
516 to be unpacked at the same time.
517 CPACK_DEBIAN_PACKAGE_PROVIDES
519 CPACK_DEBIAN_<COMPONENT>_PACKAGE_PROVIDES
521 Sets the Provides field of the Debian package. A virtual pack‐
522 age is one which appears in the Provides control field of
523 another package.
524 · Mandatory : NO
526 · Default :
528 · An empty string for non-component based installations
530 · CPACK_DEBIAN_PACKAGE_PROVIDES for component-based installa‐
532 tions.
533 See
535 https://www.debian.org/doc/debian-policy/ch-relationships.html#s-virtual
536 CPACK_DEBIAN_PACKAGE_REPLACES
538 CPACK_DEBIAN_<COMPONENT>_PACKAGE_REPLACES
540 Sets the Replaces field of the Debian package. Packages can
541 declare in their control file that they should overwrite files
542 in certain other packages, or completely replace other packages.
543 · Mandatory : NO
545 · Default :
547 · An empty string for non-component based installations
549 · CPACK_DEBIAN_PACKAGE_REPLACES for component-based installa‐
551 tions.
552 See
554 http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
555 CPACK_DEBIAN_PACKAGE_RECOMMENDS
557 CPACK_DEBIAN_<COMPONENT>_PACKAGE_RECOMMENDS
559 Sets the Recommends field of the Debian package. Allows pack‐
560 ages to declare a strong, but not absolute, dependency on other
561 packages.
562 · Mandatory : NO
564 · Default :
566 · An empty string for non-component based installations
568 · CPACK_DEBIAN_PACKAGE_RECOMMENDS for component-based instal‐
570 lations.
571 See
573 http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
574 CPACK_DEBIAN_PACKAGE_SUGGESTS
576 CPACK_DEBIAN_<COMPONENT>_PACKAGE_SUGGESTS
578 Sets the Suggests field of the Debian package. Allows packages
579 to declare a suggested package install grouping.
580 · Mandatory : NO
582 · Default :
584 · An empty string for non-component based installations
586 · CPACK_DEBIAN_PACKAGE_SUGGESTS for component-based installa‐
588 tions.
589 See
591 http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps
592 CPACK_DEBIAN_PACKAGE_GENERATE_SHLIBS
594 · Mandatory : NO
596 · Default : OFF
598 Allows to generate shlibs control file automatically. Compati‐
600 bility is defined by CPACK_DEBIAN_PACKAGE_GENERATE_SHLIBS_POLICY
601 variable value.
602 NOTE:
604 Libraries are only considered if they have both library name
605 and version set. This can be done by setting SOVERSION prop‐
606 erty with set_target_properties() command.
607 CPACK_DEBIAN_PACKAGE_GENERATE_SHLIBS_POLICY
609 Compatibility policy for auto-generated shlibs control file.
610 · Mandatory : NO
612 · Default : “=”
614 Defines compatibility policy for auto-generated shlibs control
616 file. Possible values: “=”, “>=”
617 See
619 https://www.debian.org/doc/debian-policy/ch-sharedlibs.html#s-sharedlibs-shlibdeps
620 CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA
622 CPACK_DEBIAN_<COMPONENT>_PACKAGE_CONTROL_EXTRA
624 This variable allow advanced user to add custom script to the
625 control.tar.gz. Typical usage is for conffiles, postinst,
626 postrm, prerm.
627 · Mandatory : NO
629 · Default : -
631 Usage:
633 set(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA
635 "${CMAKE_CURRENT_SOURCE_DIR}/prerm;${CMAKE_CURRENT_SOURCE_DIR}/postrm")
636 NOTE:
638 The original permissions of the files will be used in the
639 final package unless the variable
640 CPACK_DEBIAN_PACKAGE_CONTROL_STRICT_PERMISSION is set. In
641 particular, the scripts should have the proper executable
642 flag prior to the generation of the package.
643 CPACK_DEBIAN_PACKAGE_CONTROL_STRICT_PERMISSION
645 CPACK_DEBIAN_<COMPONENT>_PACKAGE_CONTROL_STRICT_PERMISSION
647 This variable indicates if the Debian policy on control files
648 should be strictly followed.
649 · Mandatory : NO
651 · Default : FALSE
653 Usage:
655 set(CPACK_DEBIAN_PACKAGE_CONTROL_STRICT_PERMISSION TRUE)
657 NOTE:
659 This overrides the permissions on the original files, follow‐
660 ing the rules set by Debian policy
661 https://www.debian.org/doc/debian-policy/ch-files.html#s-permissions-owners
662 CPACK_DEBIAN_PACKAGE_SOURCE
664 CPACK_DEBIAN_<COMPONENT>_PACKAGE_SOURCE
666 Sets the Source field of the binary Debian package. When the
667 binary package name is not the same as the source package name
668 (in particular when several components/binaries are generated
669 from one source) the source from which the binary has been gen‐
670 erated should be indicated with the field Source.
671 · Mandatory : NO
673 · Default :
675 · An empty string for non-component based installations
677 · CPACK_DEBIAN_PACKAGE_SOURCE for component-based installa‐
679 tions.
680 See
682 https://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Source
683 NOTE:
685 This value is not interpreted. It is possible to pass an
686 optional revision number of the referenced source package as
687 well.
688 Packaging of debug information
690 Dbgsym packages contain debug symbols for debugging packaged binaries.
691 Dbgsym packaging has its own set of variables:
693 CPACK_DEBIAN_DEBUGINFO_PACKAGE
695 CPACK_DEBIAN_<component>_DEBUGINFO_PACKAGE
697 Enable generation of dbgsym .ddeb package(s).
698 · Mandatory : NO
700 · Default : OFF
702 NOTE:
704 Binaries must contain debug symbols before packaging so use either
705 Debug or RelWithDebInfo for CMAKE_BUILD_TYPE variable value.
706 Building Debian packages on Windows
708 To communicate UNIX file permissions from the install stage to the
709 CPack DEB generator the “cmake_mode_t” NTFS alternate data stream (ADT)
710 is used.
711 When a filesystem without ADT support is used only owner read/write
713 permissions can be preserved.
714 Reproducible packages
716 The environment variable SOURCE_DATE_EPOCH may be set to a UNIX time‐
717 stamp, defined as the number of seconds, excluding leap seconds, since
718 01 Jan 1970 00:00:00 UTC. If set, the CPack DEB generator will use its
719 value for timestamps in the package.
720 CPack DragNDrop Generator
722 The DragNDrop CPack generator (macOS) creates a DMG image.
723 Variables specific to CPack DragNDrop generator
725 The following variables are specific to the DragNDrop installers built
726 on macOS:
727 CPACK_DMG_VOLUME_NAME
729 The volume name of the generated disk image. Defaults to
730 CPACK_PACKAGE_FILE_NAME.
731 CPACK_DMG_FORMAT
733 The disk image format. Common values are UDRO (UDIF read-only),
734 UDZO (UDIF zlib-compressed) or UDBZ (UDIF bzip2-compressed).
735 Refer to hdiutil(1) for more information on other available for‐
736 mats. Defaults to UDZO.
737 CPACK_DMG_DS_STORE
739 Path to a custom .DS_Store file. This .DS_Store file can be used
740 to specify the Finder window position/geometry and layout (such
741 as hidden toolbars, placement of the icons etc.). This file has
742 to be generated by the Finder (either manually or through Apple‐
743 Script) using a normal folder from which the .DS_Store file can
744 then be extracted.
745 CPACK_DMG_DS_STORE_SETUP_SCRIPT
747 Path to a custom AppleScript file. This AppleScript is used to
748 generate a .DS_Store file which specifies the Finder window
749 position/geometry and layout (such as hidden toolbars, placement
750 of the icons etc.). By specifying a custom AppleScript there is
751 no need to use CPACK_DMG_DS_STORE, as the .DS_Store that is gen‐
752 erated by the AppleScript will be packaged.
753 CPACK_DMG_BACKGROUND_IMAGE
755 Path to an image file to be used as the background. This file
756 will be copied to .background/background.<ext>, where <ext> is
757 the original image file extension. The background image is
758 installed into the image before CPACK_DMG_DS_STORE_SETUP_SCRIPT
759 is executed or CPACK_DMG_DS_STORE is installed. By default no
760 background image is set.
761 CPACK_DMG_DISABLE_APPLICATIONS_SYMLINK
763 Default behaviour is to include a symlink to /Applications in
764 the DMG. Set this option to ON to avoid adding the symlink.
765 CPACK_DMG_SLA_DIR
767 Directory where license and menu files for different languages
768 are stored. Setting this causes CPack to look for a <lan‐
769 guage>.menu.txt and <language>.license.txt file for every lan‐
770 guage defined in CPACK_DMG_SLA_LANGUAGES. If both this variable
771 and CPACK_RESOURCE_FILE_LICENSE are set, CPack will only look
772 for the menu files and use the same license file for all lan‐
773 guages.
774 CPACK_DMG_SLA_LANGUAGES
776 Languages for which a license agreement is provided when mount‐
777 ing the generated DMG. A menu file consists of 9 lines of text.
778 The first line is is the name of the language itself, uppercase,
779 in English (e.g. German). The other lines are translations of
780 the following strings:
781 · Agree
783 · Disagree
785 · Print
787 · Save…
789 · You agree to the terms of the License Agreement when you click
791 the “Agree” button.
792 · Software License Agreement
794 · This text cannot be saved. The disk may be full or locked, or
796 the file may be locked.
797 · Unable to print. Make sure you have selected a printer.
799 For every language in this list, CPack will try to find files
801 <language>.menu.txt and <language>.license.txt in the directory
802 specified by the CPACK_DMG_SLA_DIR variable.
803 CPACK_COMMAND_HDIUTIL
805 Path to the hdiutil(1) command used to operate on disk image
806 files on macOS. This variable can be used to override the auto‐
807 matically detected command (or specify its location if the
808 auto-detection fails to find it).
809 CPACK_COMMAND_SETFILE
811 Path to the SetFile(1) command used to set extended attributes
812 on files and directories on macOS. This variable can be used to
813 override the automatically detected command (or specify its
814 location if the auto-detection fails to find it).
815 CPACK_COMMAND_REZ
817 Path to the Rez(1) command used to compile resources on macOS.
818 This variable can be used to override the automatically detected
819 command (or specify its location if the auto-detection fails to
820 find it).
821 CPack External Generator
823 CPack provides many generators to create packages for a variety of
824 platforms and packaging systems. The intention is for CMake/CPack to be
825 a complete end-to-end solution for building and packaging a software
826 project. However, it may not always be possible to use CPack for the
827 entire packaging process, due to either technical limitations or poli‐
828 cies that require the use of certain tools. For this reason, CPack pro‐
829 vides the “External” generator, which allows external packaging soft‐
830 ware to take advantage of some of the functionality provided by CPack,
831 such as component installation and the dependency graph.
832 Integration with External Packaging Tools
834 The CPack External generator generates a .json file containing the
835 CPack internal metadata, which gives external software information on
836 how to package the software. External packaging software may itself
837 invoke CPack, consume the generated metadata, install and package files
838 as required.
839 Alternatively CPack can invoke an external packaging software through
841 an optional custom CMake script in CPACK_EXTERNAL_PACKAGE_SCRIPT
842 instead.
843 Staging of installation files may also optionally be taken care of by
845 the generator when enabled through the CPACK_EXTERNAL_ENABLE_STAGING
846 variable.
847 JSON Format
849 The JSON metadata file contains a list of CPack components and compo‐
850 nent groups, the various options passed to cpack_add_component() and
851 cpack_add_component_group(), the dependencies between the components
852 and component groups, and various other options passed to CPack.
853 The JSON’s root object will always provide two fields: formatVersionMa‐
855 jor and formatVersionMinor, which are always integers that describe the
856 output format of the generator. Backwards-compatible changes to the
857 output format (for example, adding a new field that didn’t exist
858 before) cause the minor version to be incremented, and backwards-incom‐
859 patible changes (for example, deleting a field or changing its meaning)
860 cause the major version to be incremented and the minor version reset
861 to 0. The format version is always of the format major.minor. In other
862 words, it always has exactly two parts, separated by a period.
863 You can request one or more specific versions of the output format as
865 described below with CPACK_EXTERNAL_REQUESTED_VERSIONS. The output for‐
866 mat will have a major version that exactly matches the requested major
867 version, and a minor version that is greater than or equal to the
868 requested minor version. If no version is requested with
869 CPACK_EXTERNAL_REQUESTED_VERSIONS, the latest known major version is
870 used by default. Currently, the only supported format is 1.0, which is
871 described below.
872 Version 1.0
874 In addition to the standard format fields, format version 1.0 provides
875 the following fields in the root:
876 components
878 The components field is an object with component names as the
879 keys and objects describing the components as the values. The
880 component objects have the following fields:
881 name The name of the component. This is always the same as the
883 key in the components object.
884 displayName
886 The value of the DISPLAY_NAME field passed to
887 cpack_add_component().
888 description
890 The value of the DESCRIPTION field passed to
891 cpack_add_component().
892 isHidden
894 True if HIDDEN was passed to cpack_add_component(), false
895 if it was not.
896 isRequired
898 True if REQUIRED was passed to cpack_add_component(),
899 false if it was not.
900 isDisabledByDefault
902 True if DISABLED was passed to cpack_add_component(),
903 false if it was not.
904 group Only present if GROUP was passed to cpack_add_compo‐
906 nent(). If so, this field is a string value containing
907 the component’s group.
908 dependencies
910 An array of components the component depends on. This
911 contains the values in the DEPENDS argument passed to
912 cpack_add_component(). If no DEPENDS argument was passed,
913 this is an empty list.
914 installationTypes
916 An array of installation types the component is part of.
917 This contains the values in the INSTALL_TYPES argument
918 passed to cpack_add_component(). If no INSTALL_TYPES
919 argument was passed, this is an empty list.
920 isDownloaded
922 True if DOWNLOADED was passed to cpack_add_component(),
923 false if it was not.
924 archiveFile
926 The name of the archive file passed with the ARCHIVE_FILE
927 argument to cpack_add_component(). If no ARCHIVE_FILE
928 argument was passed, this is an empty string.
929 componentGroups
931 The componentGroups field is an object with component group
932 names as the keys and objects describing the component groups as
933 the values. The component group objects have the following
934 fields:
935 name The name of the component group. This is always the same
937 as the key in the componentGroups object.
938 displayName
940 The value of the DISPLAY_NAME field passed to
941 cpack_add_component_group().
942 description
944 The value of the DESCRIPTION field passed to
945 cpack_add_component_group().
946 parentGroup
948 Only present if PARENT_GROUP was passed to cpack_add_com‐
949 ponent_group(). If so, this field is a string value con‐
950 taining the component group’s parent group.
951 isExpandedByDefault
953 True if EXPANDED was passed to cpack_add_compo‐
954 nent_group(), false if it was not.
955 isBold True if BOLD_TITLE was passed to cpack_add_compo‐
957 nent_group(), false if it was not.
958 components
960 An array of names of components that are direct members
961 of the group (components that have this group as their
962 GROUP). Components of subgroups are not included.
963 subgroups
965 An array of names of component groups that are subgroups
966 of the group (groups that have this group as their PAR‐
967 ENT_GROUP).
968 installationTypes
970 The installationTypes field is an object with installation type
971 names as the keys and objects describing the installation types
972 as the values. The installation type objects have the following
973 fields:
974 name The name of the installation type. This is always the
976 same as the key in the installationTypes object.
977 displayName
979 The value of the DISPLAY_NAME field passed to
980 cpack_add_install_type().
981 index The integer index of the installation type in the list.
983 projects
985 The projects field is an array of objects describing CMake
986 projects which comprise the CPack project. The values in this
987 field are derived from CPACK_INSTALL_CMAKE_PROJECTS. In most
988 cases, this will be only a single project. The project objects
989 have the following fields:
990 projectName
992 The project name passed to CPACK_INSTALL_CMAKE_PROJECTS.
993 component
995 The name of the component or component set which com‐
996 prises the project.
997 directory
999 The build directory of the CMake project. This is the
1000 directory which contains the cmake_install.cmake script.
1001 subDirectory
1003 The subdirectory to install the project into inside the
1004 CPack package.
1005 packageName
1007 The package name given in CPACK_PACKAGE_NAME. Only present if
1008 this option is set.
1009 packageVersion
1011 The package version given in CPACK_PACKAGE_VERSION. Only present
1012 if this option is set.
1013 packageDescriptionFile
1015 The package description file given in CPACK_PACKAGE_DESCRIP‐
1016 TION_FILE. Only present if this option is set.
1017 packageDescriptionSummary
1019 The package description summary given in CPACK_PACKAGE_DESCRIP‐
1020 TION_SUMMARY. Only present if this option is set.
1021 buildConfig
1023 The build configuration given to CPack with the -C option. Only
1024 present if this option is set.
1025 defaultDirectoryPermissions
1027 The default directory permissions given in
1028 CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS. Only present if
1029 this option is set.
1030 setDestdir
1032 True if CPACK_SET_DESTDIR is true, false if it is not.
1033 packagingInstallPrefix
1035 The install prefix given in CPACK_PACKAGING_INSTALL_PREFIX. Only
1036 present if CPACK_SET_DESTDIR is true.
1037 stripFiles
1039 True if CPACK_STRIP_FILES is true, false if it is not.
1040 warnOnAbsoluteInstallDestination
1042 True if CPACK_WARN_ON_ABSOLUTE_INSTALL_DESTINATION is true,
1043 false if it is not.
1044 errorOnAbsoluteInstallDestination
1046 True if CPACK_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION is true,
1047 false if it is not.
1048 Variables specific to CPack External generator
1050 CPACK_EXTERNAL_REQUESTED_VERSIONS
1051 This variable is used to request a specific version of the CPack
1052 External generator. It is a list of major.minor values, sepa‐
1053 rated by semicolons.
1054 If this variable is set to a non-empty value, the CPack External
1056 generator will iterate through each item in the list to search
1057 for a version that it knows how to generate. Requested versions
1058 should be listed in order of descending preference by the client
1059 software, as the first matching version in the list will be gen‐
1060 erated.
1061 The generator knows how to generate the version if it has a ver‐
1063 sioned generator whose major version exactly matches the
1064 requested major version, and whose minor version is greater than
1065 or equal to the requested minor version. For example, if
1066 CPACK_EXTERNAL_REQUESTED_VERSIONS contains 1.0, and the CPack
1067 External generator knows how to generate 1.1, it will generate
1068 1.1. If the generator doesn’t know how to generate a version in
1069 the list, it skips the version and looks at the next one. If it
1070 doesn’t know how to generate any of the requested versions, an
1071 error is thrown.
1072 If this variable is not set, or is empty, the CPack External
1074 generator will generate the highest major and minor version that
1075 it knows how to generate.
1076 If an invalid version is encountered in CPACK_EXTER‐
1078 NAL_REQUESTED_VERSIONS (one that doesn’t match major.minor,
1079 where major and minor are integers), it is ignored.
1080 CPACK_EXTERNAL_ENABLE_STAGING
1082 This variable can be set to true to enable optional installation
1083 into a temporary staging area which can then be picked up and
1084 packaged by an external packaging tool. The top level directory
1085 used by CPack for the current packaging task is contained in
1086 CPACK_TOPLEVEL_DIRECTORY. It is automatically cleaned up on
1087 each run before packaging is initiated and can be used for cus‐
1088 tom temporary files required by the external packaging tool. It
1089 also contains the staging area CPACK_TEMPORARY_DIRECTORY into
1090 which CPack performs the installation when staging is enabled.
1091 CPACK_EXTERNAL_PACKAGE_SCRIPT
1093 This variable can optionally specify the full path to a CMake
1094 script file to be run as part of the CPack invocation. It is
1095 invoked after (optional) staging took place and may run an
1096 external packaging tool. The script has access to the variables
1097 defined by the CPack config file.
1098 CPack FreeBSD Generator
1100 The built in (binary) CPack FreeBSD (pkg) generator (Unix only)
1101 Variables specific to CPack FreeBSD (pkg) generator
1103 The CPack FreeBSD generator may be used to create pkg(8) packages –
1104 these may be used on FreeBSD, DragonflyBSD, NetBSD, OpenBSD, but also
1105 on Linux or OSX, depending on the installed package-management tools –
1106 using CPack.
1107 The CPack FreeBSD generator is a CPack generator and uses the CPACK_XXX
1109 variables used by CPack. It tries to re-use packaging information that
1110 may already be specified for Debian packages for the CPack DEB Genera‐
1111 tor. It also tries to re-use RPM packaging information when Debian does
1112 not specify.
1113 The CPack FreeBSD generator should work on any host with libpkg
1115 installed. The packages it produces are specific to the host architec‐
1116 ture and ABI.
1117 The CPack FreeBSD generator sets package-metadata through CPACK_FREE‐
1119 BSD_XXX variables. The CPack FreeBSD generator, unlike the CPack Deb
1120 generator, does not specially support componentized packages; a single
1121 package is created from all the software artifacts created through
1122 CMake.
1123 All of the variables can be set specifically for FreeBSD packaging in
1125 the CPackConfig file or in CMakeLists.txt, but most of them have
1126 defaults that use general settings (e.g. CMAKE_PROJECT_NAME) or
1127 Debian-specific variables when those make sense (e.g. the homepage of
1128 an upstream project is usually unchanged by the flavor of packaging).
1129 When there is no Debian information to fall back on, but the RPM pack‐
1130 aging has it, fall back to the RPM information (e.g. package license).
1131 CPACK_FREEBSD_PACKAGE_NAME
1133 Sets the package name (in the package manifest, but also affects
1134 the output filename).
1135 · Mandatory: YES
1137 · Default:
1139 · CPACK_PACKAGE_NAME (this is always set by CPack itself,
1141 based on CMAKE_PROJECT_NAME).
1142 CPACK_FREEBSD_PACKAGE_COMMENT
1144 Sets the package comment. This is the short description dis‐
1145 played by pkg(8) in standard “pkg info” output.
1146 · Mandatory: YES
1148 · Default:
1150 · CPACK_PACKAGE_DESCRIPTION_SUMMARY (this is always set by
1152 CPack itself, if nothing else sets it explicitly).
1153 · PROJECT_DESCRIPTION (this can be set with the DESCRIPTION
1155 parameter for project()).
1156 CPACK_FREEBSD_PACKAGE_DESCRIPTION
1158 Sets the package description. This is the long description of
1159 the package, given by “pkg info” with a specific package as
1160 argument.
1161 · Mandatory: YES
1163 · Default:
1165 · CPACK_DEBIAN_PACKAGE_DESCRIPTION (this may be set already
1167 for Debian packaging, so we may as well re-use it).
1168 CPACK_FREEBSD_PACKAGE_WWW
1170 The URL of the web site for this package, preferably (when
1171 applicable) the site from which the original source can be
1172 obtained and any additional upstream documentation or informa‐
1173 tion may be found.
1174 · Mandatory: YES
1176 · Default:
1178 · CMAKE_PROJECT_HOMEPAGE_URL, or if that is not set,
1180 CPACK_DEBIAN_PACKAGE_HOMEPAGE (this may be set already for
1181 Debian packaging, so we may as well re-use it).
1182 CPACK_FREEBSD_PACKAGE_LICENSE
1184 The license, or licenses, which apply to this software package.
1185 This must be one or more license-identifiers that pkg recognizes
1186 as acceptable license identifiers (e.g. “GPLv2”).
1187 · Mandatory: YES
1189 · Default:
1191 · CPACK_RPM_PACKAGE_LICENSE
1193 CPACK_FREEBSD_PACKAGE_LICENSE_LOGIC
1195 This variable is only of importance if there is more than one
1196 license. The default is “single”, which is only applicable to a
1197 single license. Other acceptable values are determined by pkg –
1198 those are “dual” or “multi” – meaning choice (OR) or simultane‐
1199 ous (AND) application of the licenses.
1200 · Mandatory: NO
1202 · Default: single
1204 CPACK_FREEBSD_PACKAGE_MAINTAINER
1206 The FreeBSD maintainer (e.g. kde@freebsd.org) of this package.
1207 · Mandatory: YES
1209 · Default: none
1211 CPACK_FREEBSD_PACKAGE_ORIGIN
1213 The origin (ports label) of this package; for packages built by
1214 CPack outside of the ports system this is of less importance.
1215 The default puts the package somewhere under misc/, as a stop‐
1216 gap.
1217 · Mandatory: YES
1219 · Default: misc/<package name>
1221 CPACK_FREEBSD_PACKAGE_CATEGORIES
1223 The ports categories where this package lives (if it were to be
1224 built from ports). If none is set a single category is deter‐
1225 mined based on the package origin.
1226 · Mandatory: YES
1228 · Default: derived from ORIGIN
1230 CPACK_FREEBSD_PACKAGE_DEPS
1232 A list of package origins that should be added as package depen‐
1233 dencies. These are in the form <category>/<packagename>, e.g.
1234 x11/libkonq. No version information needs to be provided (this
1235 is not included in the manifest).
1236 · Mandatory: NO
1238 · Default: empty
1240 CPack IFW Generator
1242 See CPackIFW for details on the CPackIFW module.
1243 Overview
1245 CPack IFW generator helps you to create online and offline binary
1246 cross-platform installers with a graphical user interface.
1247 CPack IFW generator prepares project installation and generates config‐
1249 uration and meta information for QtIFW tools.
1250 The QtIFW provides a set of tools and utilities to create installers
1252 for the supported desktop Qt platforms: Linux, Microsoft Windows, and
1253 macOS.
1254 You should also install QtIFW to use CPack IFW generator.
1256 Hints
1258 Generally, the CPack IFW generator automatically finds QtIFW tools, but
1259 if you don’t use a default path for installation of the QtIFW tools,
1260 the path may be specified in either a CMake or an environment variable:
1261 CPACK_IFW_ROOT
1263 An CMake variable which specifies the location of the QtIFW tool
1264 suite.
1265 The variable will be cached in the CPackConfig.cmake file and
1267 used at CPack runtime.
1268 QTIFWDIR
1270 An environment variable which specifies the location of the
1271 QtIFW tool suite.
1272 NOTE:
1274 The specified path should not contain “bin” at the end (for example:
1275 “D:\DevTools\QtIFW2.0.5”).
1276 The CPACK_IFW_ROOT variable has a higher priority and overrides the
1278 value of the QTIFWDIR variable.
1279 Internationalization
1281 Some variables and command arguments support internationalization via
1282 CMake script. This is an optional feature.
1283 Installers created by QtIFW tools have built-in support for interna‐
1285 tionalization and many phrases are localized to many languages, but
1286 this does not apply to the description of the your components and
1287 groups that will be distributed.
1288 Localization of the description of your components and groups is useful
1290 for users of your installers.
1291 A localized variable or argument can contain a single default value,
1293 and a set of pairs the name of the locale and the localized value.
1294 For example:
1296 set(LOCALIZABLE_VARIABLE "Default value"
1298 en "English value"
1299 en_US "American value"
1300 en_GB "Great Britain value"
1301 )
1302 Variables
1304 You can use the following variables to change behavior of CPack IFW
1305 generator.
1306 Debug
1308 CPACK_IFW_VERBOSE
1309 Set to ON to enable addition debug output. By default is OFF.
1310 Package
1312 CPACK_IFW_PACKAGE_TITLE
1313 Name of the installer as displayed on the title bar. By default
1314 used CPACK_PACKAGE_DESCRIPTION_SUMMARY.
1315 CPACK_IFW_PACKAGE_PUBLISHER
1317 Publisher of the software (as shown in the Windows Control
1318 Panel). By default used CPACK_PACKAGE_VENDOR.
1319 CPACK_IFW_PRODUCT_URL
1321 URL to a page that contains product information on your web
1322 site.
1323 CPACK_IFW_PACKAGE_ICON
1325 Filename for a custom installer icon. The actual file is ‘.icns’
1326 (macOS), ‘.ico’ (Windows). No functionality on Unix.
1327 CPACK_IFW_PACKAGE_WINDOW_ICON
1329 Filename for a custom window icon in PNG format for the Install‐
1330 er application.
1331 CPACK_IFW_PACKAGE_LOGO
1333 Filename for a logo is used as QWizard::LogoPixmap.
1334 CPACK_IFW_PACKAGE_WATERMARK
1336 Filename for a watermark is used as QWizard::WatermarkPixmap.
1337 CPACK_IFW_PACKAGE_BANNER
1339 Filename for a banner is used as QWizard::BannerPixmap.
1340 CPACK_IFW_PACKAGE_BACKGROUND
1342 Filename for an image used as QWizard::BackgroundPixmap (only
1343 used by MacStyle).
1344 CPACK_IFW_PACKAGE_WIZARD_STYLE
1346 Wizard style to be used (“Modern”, “Mac”, “Aero” or “Classic”).
1347 CPACK_IFW_PACKAGE_STYLE_SHEET
1349 Filename for a stylesheet.
1350 CPACK_IFW_PACKAGE_WIZARD_DEFAULT_WIDTH
1352 Default width of the wizard in pixels. Setting a banner image
1353 will override this.
1354 CPACK_IFW_PACKAGE_WIZARD_DEFAULT_HEIGHT
1356 Default height of the wizard in pixels. Setting a watermark
1357 image will override this.
1358 CPACK_IFW_PACKAGE_TITLE_COLOR
1360 Color of the titles and subtitles (takes an HTML color code,
1361 such as “#88FF33”).
1362 CPACK_IFW_PACKAGE_START_MENU_DIRECTORY
1364 Name of the default program group for the product in the Windows
1365 Start menu.
1366 By default used CPACK_IFW_PACKAGE_NAME.
1368 CPACK_IFW_TARGET_DIRECTORY
1370 Default target directory for installation. By default used
1371 “@ApplicationsDir@/CPACK_PACKAGE_INSTALL_DIRECTORY”
1372 You can use predefined variables.
1374 CPACK_IFW_ADMIN_TARGET_DIRECTORY
1376 Default target directory for installation with administrator
1377 rights.
1378 You can use predefined variables.
1380 CPACK_IFW_PACKAGE_GROUP
1382 The group, which will be used to configure the root package
1383 CPACK_IFW_PACKAGE_NAME
1385 The root package name, which will be used if configuration group
1386 is not specified
1387 CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_NAME
1389 Filename of the generated maintenance tool. The platform-spe‐
1390 cific executable file extension is appended.
1391 By default used QtIFW defaults (maintenancetool).
1393 CPACK_IFW_PACKAGE_REMOVE_TARGET_DIR
1395 Set to OFF if the target directory should not be deleted when
1396 uninstalling.
1397 Is ON by default
1399 CPACK_IFW_PACKAGE_MAINTENANCE_TOOL_INI_FILE
1401 Filename for the configuration of the generated maintenance
1402 tool.
1403 By default used QtIFW defaults (maintenancetool.ini).
1405 CPACK_IFW_PACKAGE_ALLOW_NON_ASCII_CHARACTERS
1407 Set to ON if the installation path can contain non-ASCII charac‐
1408 ters.
1409 Is ON for QtIFW less 2.0 tools.
1411 CPACK_IFW_PACKAGE_ALLOW_SPACE_IN_PATH
1413 Set to OFF if the installation path cannot contain space charac‐
1414 ters.
1415 Is ON for QtIFW less 2.0 tools.
1417 CPACK_IFW_PACKAGE_CONTROL_SCRIPT
1419 Filename for a custom installer control script.
1420 CPACK_IFW_PACKAGE_RESOURCES
1422 List of additional resources (‘.qrc’ files) to include in the
1423 installer binary.
1424 You can use cpack_ifw_add_package_resources() command to resolve
1426 relative paths.
1427 CPACK_IFW_PACKAGE_FILE_EXTENSION
1429 The target binary extension.
1430 On Linux, the name of the target binary is automatically
1432 extended with ‘.run’, if you do not specify the extension.
1433 On Windows, the target is created as an application with the
1435 extension ‘.exe’, which is automatically added, if not supplied.
1436 On Mac, the target is created as an DMG disk image with the
1438 extension ‘.dmg’, which is automatically added, if not supplied.
1439 CPACK_IFW_REPOSITORIES_ALL
1441 The list of remote repositories.
1442 The default value of this variable is computed by CPack and con‐
1444 tains all repositories added with command cpack_ifw_add_reposi‐
1445 tory() or updated with command cpack_ifw_update_repository().
1446 CPACK_IFW_DOWNLOAD_ALL
1448 If this is ON all components will be downloaded. By default is
1449 OFF or used value from CPACK_DOWNLOAD_ALL if set
1450 Components
1452 CPACK_IFW_RESOLVE_DUPLICATE_NAMES
1453 Resolve duplicate names when installing components with groups.
1454 CPACK_IFW_PACKAGES_DIRECTORIES
1456 Additional prepared packages dirs that will be used to resolve
1457 dependent components.
1458 CPACK_IFW_REPOSITORIES_DIRECTORIES
1460 Additional prepared repository dirs that will be used to resolve
1461 and repack dependent components. This feature available only
1462 since QtIFW 3.1.
1463 Tools
1465 CPACK_IFW_FRAMEWORK_VERSION
1466 The version of used QtIFW tools.
1467 CPACK_IFW_BINARYCREATOR_EXECUTABLE
1469 The path to “binarycreator” command line client.
1470 This variable is cached and may be configured if needed.
1472 CPACK_IFW_REPOGEN_EXECUTABLE
1474 The path to “repogen” command line client.
1475 This variable is cached and may be configured if needed.
1477 CPACK_IFW_INSTALLERBASE_EXECUTABLE
1479 The path to “installerbase” installer executable base.
1480 This variable is cached and may be configured if needed.
1482 CPACK_IFW_DEVTOOL_EXECUTABLE
1484 The path to “devtool” command line client.
1485 This variable is cached and may be configured if needed.
1487 Online installer
1489 By default CPack IFW generator makes offline installer. This means that
1490 all components will be packaged into a binary file.
1491 To make a component downloaded, you must set the DOWNLOADED option in
1493 cpack_add_component().
1494 Then you would use the command cpack_configure_downloads(). If you set
1496 ALL option all components will be downloaded.
1497 You also can use command cpack_ifw_add_repository() and variable
1499 CPACK_IFW_DOWNLOAD_ALL for more specific configuration.
1500 CPack IFW generator creates “repository” dir in current binary dir. You
1502 would copy content of this dir to specified site (url).
1503 See Also
1505 Qt Installer Framework Manual:
1506 · Index page: http://doc.qt.io/qtinstallerframework/index.html
1508 · Component Scripting:
1510 http://doc.qt.io/qtinstallerframework/scripting.html
1511 · Predefined Variables:
1513 http://doc.qt.io/qtinstallerframework/scripting.html#predefined-variables
1514 · Promoting Updates:
1516 http://doc.qt.io/qtinstallerframework/ifw-updates.html
1517 Download Qt Installer Framework for you platform from Qt site:
1519 http://download.qt.io/official_releases/qt-installer-framework
1520 CPack NSIS Generator
1522 CPack Nullsoft Scriptable Install System (NSIS) generator specific
1523 options
1524 Variables specific to CPack NSIS generator
1526 The following variables are specific to the graphical installers built
1527 on Windows Nullsoft Scriptable Install System.
1528 CPACK_NSIS_INSTALL_ROOT
1530 The default installation directory presented to the end user by
1531 the NSIS installer is under this root dir. The full directory
1532 presented to the end user is:
1533 ${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY}
1534 CPACK_NSIS_MUI_ICON
1536 An icon filename. The name of a *.ico file used as the main
1537 icon for the generated install program.
1538 CPACK_NSIS_MUI_UNIICON
1540 An icon filename. The name of a *.ico file used as the main
1541 icon for the generated uninstall program.
1542 CPACK_NSIS_INSTALLER_MUI_ICON_CODE
1544 undocumented.
1545 CPACK_NSIS_MUI_WELCOMEFINISHPAGE_BITMAP
1547 The filename of a bitmap to use as the NSIS MUI_WELCOMEFINISH‐
1548 PAGE_BITMAP.
1549 CPACK_NSIS_MUI_UNWELCOMEFINISHPAGE_BITMAP
1551 The filename of a bitmap to use as the NSIS MUI_UNWELCOMEFINISH‐
1552 PAGE_BITMAP.
1553 CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS
1555 Extra NSIS commands that will be added to the beginning of the
1556 install Section, before your install tree is available on the
1557 target system.
1558 CPACK_NSIS_EXTRA_INSTALL_COMMANDS
1560 Extra NSIS commands that will be added to the end of the install
1561 Section, after your install tree is available on the target sys‐
1562 tem.
1563 CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
1565 Extra NSIS commands that will be added to the uninstall Section,
1566 before your install tree is removed from the target system.
1567 CPACK_NSIS_COMPRESSOR
1569 The arguments that will be passed to the NSIS SetCompressor com‐
1570 mand.
1571 CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL
1573 Ask about uninstalling previous versions first. If this is set
1574 to ON, then an installer will look for previous installed ver‐
1575 sions and if one is found, ask the user whether to uninstall it
1576 before proceeding with the install.
1577 CPACK_NSIS_MODIFY_PATH
1579 Modify PATH toggle. If this is set to ON, then an extra page
1580 will appear in the installer that will allow the user to choose
1581 whether the program directory should be added to the system PATH
1582 variable.
1583 CPACK_NSIS_DISPLAY_NAME
1585 The display name string that appears in the Windows Apps & fea‐
1586 tures in Control Panel
1587 CPACK_NSIS_PACKAGE_NAME
1589 The title displayed at the top of the installer.
1590 CPACK_NSIS_INSTALLED_ICON_NAME
1592 A path to the executable that contains the installer icon.
1593 CPACK_NSIS_HELP_LINK
1595 URL to a web site providing assistance in installing your appli‐
1596 cation.
1597 CPACK_NSIS_URL_INFO_ABOUT
1599 URL to a web site providing more information about your applica‐
1600 tion.
1601 CPACK_NSIS_CONTACT
1603 Contact information for questions and comments about the instal‐
1604 lation process.
1605 CPACK_NSIS_<compName>_INSTALL_DIRECTORY
1607 Custom install directory for the specified component <compName>
1608 instead of $INSTDIR.
1609 CPACK_NSIS_CREATE_ICONS_EXTRA
1611 Additional NSIS commands for creating Start Menu shortcuts.
1612 CPACK_NSIS_DELETE_ICONS_EXTRA
1614 Additional NSIS commands to uninstall Start Menu shortcuts.
1615 CPACK_NSIS_EXECUTABLES_DIRECTORY
1617 Creating NSIS Start Menu links assumes that they are in bin
1618 unless this variable is set. For example, you would set this to
1619 exec if your executables are in an exec directory.
1620 CPACK_NSIS_MUI_FINISHPAGE_RUN
1622 Specify an executable to add an option to run on the finish page
1623 of the NSIS installer.
1624 CPACK_NSIS_MENU_LINKS
1626 Specify links in [application] menu. This should contain a list
1627 of pair link link name. The link may be a URL or a path relative
1628 to installation prefix. Like:
1629 set(CPACK_NSIS_MENU_LINKS
1631 "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html"
1632 "CMake Help" "https://cmake.org" "CMake Web Site")
1633 CPack NuGet Generator
1635 When build a NuGet package there is no direct way to control an output
1636 filename due a lack of the corresponding CLI option of NuGet, so there
1637 is no CPACK_NUGET_PACKAGE_FILENAME variable. To form the output file‐
1638 name NuGet uses the package name and the version according to its
1639 built-in rules.
1640 Also, be aware that including a top level directory
1642 (CPACK_INCLUDE_TOPLEVEL_DIRECTORY) is ignored by this generator.
1643 Variables specific to CPack NuGet generator
1645 The CPack NuGet generator may be used to create NuGet packages using
1646 CPack. The CPack NuGet generator is a CPack generator thus it uses the
1647 CPACK_XXX variables used by CPack.
1648 The CPack NuGet generator has specific features which are controlled by
1650 the specifics CPACK_NUGET_XXX variables. In the “one per group” mode
1651 (see CPACK_COMPONENTS_GROUPING), <compName> placeholder in the vari‐
1652 ables below would contain a group name (uppercased and turned into a
1653 “C” identifier).
1654 List of CPack NuGet generator specific variables:
1656 CPACK_NUGET_COMPONENT_INSTALL
1658 Enable component packaging for CPack NuGet generator
1659 · Mandatory : NO
1661 · Default : OFF
1663 CPACK_NUGET_PACKAGE_NAME
1665 CPACK_NUGET_<compName>_PACKAGE_NAME
1667 The NUGET package name.
1668 · Mandatory : YES
1670 · Default : CPACK_PACKAGE_NAME
1672 CPACK_NUGET_PACKAGE_VERSION
1674 CPACK_NUGET_<compName>_PACKAGE_VERSION
1676 The NuGet package version.
1677 · Mandatory : YES
1679 · Default : CPACK_PACKAGE_VERSION
1681 CPACK_NUGET_PACKAGE_DESCRIPTION
1683 CPACK_NUGET_<compName>_PACKAGE_DESCRIPTION
1685 A long description of the package for UI display.
1686 · Mandatory : YES
1688 ·
1690 Default :
1692 · CPACK_COMPONENT_<compName>_DESCRIPTION,
1694 · CPACK_COMPONENT_GROUP_<groupName>_DESCRIPTION,
1696 · CPACK_PACKAGE_DESCRIPTION
1698 CPACK_NUGET_PACKAGE_AUTHORS
1700 CPACK_NUGET_<compName>_PACKAGE_AUTHORS
1702 A comma-separated list of packages authors, matching the profile
1703 names on nuget.org. These are displayed in the NuGet Gallery on
1704 nuget.org and are used to cross-reference packages by the same
1705 authors.
1706 · Mandatory : YES
1708 · Default : CPACK_PACKAGE_VENDOR
1710 CPACK_NUGET_PACKAGE_TITLE
1712 CPACK_NUGET_<compName>_PACKAGE_TITLE
1714 A human-friendly title of the package, typically used in UI dis‐
1715 plays as on nuget.org and the Package Manager in Visual Studio.
1716 If not specified, the package ID is used.
1717 · Mandatory : NO
1719 ·
1721 Default :
1723 · CPACK_COMPONENT_<compName>_DISPLAY_NAME,
1725 · CPACK_COMPONENT_GROUP_<groupName>_DISPLAY_NAME
1727 CPACK_NUGET_PACKAGE_OWNERS
1729 CPACK_NUGET_<compName>_PACKAGE_OWNERS
1731 A comma-separated list of the package creators using profile
1732 names on nuget.org. This is often the same list as in authors,
1733 and is ignored when uploading the package to nuget.org.
1734 · Mandatory : NO
1736 · Default : -
1738 CPACK_NUGET_PACKAGE_HOMEPAGE_URL
1740 CPACK_NUGET_<compName>_PACKAGE_HOMEPAGE_URL
1742 A URL for the package’s home page, often shown in UI displays as
1743 well as nuget.org.
1744 · Mandatory : NO
1746 · Default : CPACK_PACKAGE_HOMEPAGE_URL
1748 CPACK_NUGET_PACKAGE_LICENSEURL
1750 CPACK_NUGET_<compName>_PACKAGE_LICENSEURL
1752 A URL for the package’s license, often shown in UI displays as
1753 well as nuget.org.
1754 · Mandatory : NO
1756 · Default : -
1758 CPACK_NUGET_PACKAGE_ICONURL
1760 CPACK_NUGET_<compName>_PACKAGE_ICONURL
1762 A URL for a 64x64 image with transparency background to use as
1763 the icon for the package in UI display.
1764 · Mandatory : NO
1766 · Default : -
1768 CPACK_NUGET_PACKAGE_DESCRIPTION_SUMMARY
1770 CPACK_NUGET_<compName>_PACKAGE_DESCRIPTION_SUMMARY
1772 A short description of the package for UI display. If omitted, a
1773 truncated version of description is used.
1774 · Mandatory : NO
1776 · Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY
1778 CPACK_NUGET_PACKAGE_RELEASE_NOTES
1780 CPACK_NUGET_<compName>_PACKAGE_RELEASE_NOTES
1782 A description of the changes made in this release of the pack‐
1783 age, often used in UI like the Updates tab of the Visual Studio
1784 Package Manager in place of the package description.
1785 · Mandatory : NO
1787 · Default : -
1789 CPACK_NUGET_PACKAGE_COPYRIGHT
1791 CPACK_NUGET_<compName>_PACKAGE_COPYRIGHT
1793 Copyright details for the package.
1794 · Mandatory : NO
1796 · Default : -
1798 CPACK_NUGET_PACKAGE_TAGS
1800 CPACK_NUGET_<compName>_PACKAGE_TAGS
1802 A space-delimited list of tags and keywords that describe the
1803 package and aid discoverability of packages through search and
1804 filtering.
1805 · Mandatory : NO
1807 · Default : -
1809 CPACK_NUGET_PACKAGE_DEPENDENCIES
1811 CPACK_NUGET_<compName>_PACKAGE_DEPENDENCIES
1813 A list of package dependencies.
1814 · Mandatory : NO
1816 · Default : -
1818 CPACK_NUGET_PACKAGE_DEPENDENCIES_<dependency>_VERSION
1820 CPACK_NUGET_<compName>_PACKAGE_DEPENDENCIES_<dependency>_VERSION
1822 A version specification for the particular dependency, where
1823 <dependency> is an item of the dependency list (see above)
1824 transformed with MAKE_C_IDENTIFIER function of string() command.
1825 · Mandatory : NO
1827 · Default : -
1829 CPACK_NUGET_PACKAGE_DEBUG
1831 Enable debug messages while executing CPack NuGet generator.
1832 · Mandatory : NO
1834 · Default : OFF
1836 CPack PackageMaker Generator
1838 PackageMaker CPack generator (macOS).
1839 Variables specific to CPack PackageMaker generator
1841 The following variable is specific to installers built on Mac macOS
1842 using PackageMaker:
1843 CPACK_OSX_PACKAGE_VERSION
1845 The version of macOS that the resulting PackageMaker archive
1846 should be compatible with. Different versions of macOS support
1847 different features. For example, CPack can only build compo‐
1848 nent-based installers for macOS 10.4 or newer, and can only
1849 build installers that download component son-the-fly for macOS
1850 10.5 or newer. If left blank, this value will be set to the min‐
1851 imum version of macOS that supports the requested features. Set
1852 this variable to some value (e.g., 10.4) only if you want to
1853 guarantee that your installer will work on that version of mac‐
1854 OS, and don’t mind missing extra features available in the in‐
1855 staller shipping with later versions of macOS.
1856 CPack productbuild Generator
1858 productbuild CPack generator (macOS).
1859 Variables specific to CPack productbuild generator
1861 The following variable is specific to installers built on Mac macOS
1862 using ProductBuild:
1863 CPACK_COMMAND_PRODUCTBUILD
1865 Path to the productbuild(1) command used to generate a product
1866 archive for the macOS Installer or Mac App Store. This variable
1867 can be used to override the automatically detected command (or
1868 specify its location if the auto-detection fails to find it).
1869 CPACK_PRODUCTBUILD_IDENTITY_NAME
1871 Adds a digital signature to the resulting package.
1872 CPACK_PRODUCTBUILD_KEYCHAIN_PATH
1874 Specify a specific keychain to search for the signing identity.
1875 CPACK_COMMAND_PKGBUILD
1877 Path to the pkgbuild(1) command used to generate an macOS compo‐
1878 nent package on macOS. This variable can be used to override
1879 the automatically detected command (or specify its location if
1880 the auto-detection fails to find it).
1881 CPACK_PKGBUILD_IDENTITY_NAME
1883 Adds a digital signature to the resulting package.
1884 CPACK_PKGBUILD_KEYCHAIN_PATH
1886 Specify a specific keychain to search for the signing identity.
1887 CPACK_PREFLIGHT_<COMP>_SCRIPT
1889 Full path to a file that will be used as the preinstall script
1890 for the named <COMP> component’s package, where <COMP> is the
1891 uppercased component name. No preinstall script is added if
1892 this variable is not defined for a given component.
1893 CPACK_POSTFLIGHT_<COMP>_SCRIPT
1895 Full path to a file that will be used as the postinstall script
1896 for the named <COMP> component’s package, where <COMP> is the
1897 uppercased component name. No postinstall script is added if
1898 this variable is not defined for a given component.
1899 CPACK_PRODUCTBUILD_RESOURCES_DIR
1901 If specified the productbuild generator copies files from this
1902 directory (including subdirectories) to the Resources directory.
1903 This is done before the CPACK_RESOURCE_FILE_WELCOME,
1904 CPACK_RESOURCE_FILE_README, and CPACK_RESOURCE_FILE_LICENSE
1905 files are copied.
1906 CPack RPM Generator
1908 The built in (binary) CPack RPM generator (Unix only)
1909 Variables specific to CPack RPM generator
1911 The CPack RPM generator may be used to create RPM packages using CPack.
1912 The CPack RPM generator is a CPack generator thus it uses the CPACK_XXX
1913 variables used by CPack.
1914 The CPack RPM generator has specific features which are controlled by
1916 the specifics CPACK_RPM_XXX variables.
1917 CPACK_RPM_<COMPONENT>_XXXX variables may be used in order to have com‐
1919 ponent specific values. Note however that <COMPONENT> refers to the
1920 grouping name written in upper case. It may be either a component name
1921 or a component GROUP name. Usually those variables correspond to RPM
1922 spec file entities. One may find information about spec files here
1923 http://www.rpm.org/wiki/Docs
1924 NOTE:
1926 <COMPONENT> part of variables is preferred to be in upper case (e.g.
1927 if component is named foo then use CPACK_RPM_FOO_XXXX variable name
1928 format) as is with other CPACK_<COMPONENT>_XXXX variables. For the
1929 purposes of back compatibility (CMake/CPack version 3.5 and lower)
1930 support for same cased component (e.g. fOo would be used as
1931 CPACK_RPM_fOo_XXXX) is still supported for variables defined in
1932 older versions of CMake/CPack but is not guaranteed for variables
1933 that will be added in the future. For the sake of back compatibility
1934 same cased component variables also override upper cased versions
1935 where both are present.
1936 Here are some CPack RPM generator wiki resources that are here for his‐
1938 toric reasons and are no longer maintained but may still prove useful:
1939 · https://gitlab.kitware.com/cmake/community/wikis/doc/cpack/Configuration
1941 · https://gitlab.kitware.com/cmake/community/wikis/doc/cpack/PackageGenerators#rpm-unix-only
1943 List of CPack RPM generator specific variables:
1945 CPACK_RPM_COMPONENT_INSTALL
1947 Enable component packaging for CPack RPM generator
1948 · Mandatory : NO
1950 · Default : OFF
1952 If enabled (ON) multiple packages are generated. By default a
1954 single package containing files of all components is generated.
1955 CPACK_RPM_PACKAGE_SUMMARY
1957 CPACK_RPM_<component>_PACKAGE_SUMMARY
1959 The RPM package summary.
1960 · Mandatory : YES
1962 · Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY
1964 CPACK_RPM_PACKAGE_NAME
1966 CPACK_RPM_<component>_PACKAGE_NAME
1968 The RPM package name.
1969 · Mandatory : YES
1971 · Default : CPACK_PACKAGE_NAME
1973 CPACK_RPM_FILE_NAME
1975 CPACK_RPM_<component>_FILE_NAME
1977 Package file name.
1978 · Mandatory : YES
1980 ·
1982 Default
1984 <CPACK_PACKAGE_FILE_NAME>[-<component>].rpm with spaces
1985 replaced by ‘-‘
1986 This may be set to RPM-DEFAULT to allow rpmbuild tool to gener‐
1988 ate package file name by itself. Alternatively provided package
1989 file name must end with .rpm suffix.
1990 NOTE:
1992 By using user provided spec file, rpm macro extensions such
1993 as for generating debuginfo packages or by simply using mul‐
1994 tiple components more than one rpm file may be generated,
1995 either from a single spec file or from multiple spec files
1996 (each component execution produces its own spec file). In
1997 such cases duplicate file names may occur as a result of this
1998 variable setting or spec file content structure. Duplicate
1999 files get overwritten and it is up to the packager to set the
2000 variables in a manner that will prevent such errors.
2001 CPACK_RPM_MAIN_COMPONENT
2003 Main component that is packaged without component suffix.
2004 · Mandatory : NO
2006 · Default : -
2008 This variable can be set to any component or group name so that
2010 component or group rpm package is generated without component
2011 suffix in filename and package name.
2012 CPACK_RPM_PACKAGE_EPOCH
2014 The RPM package epoch
2015 · Mandatory : No
2017 · Default : -
2019 Optional number that should be incremented when changing ver‐
2021 sioning schemas or fixing mistakes in the version numbers of
2022 older packages.
2023 CPACK_RPM_PACKAGE_VERSION
2025 The RPM package version.
2026 · Mandatory : YES
2028 · Default : CPACK_PACKAGE_VERSION
2030 CPACK_RPM_PACKAGE_ARCHITECTURE
2032 CPACK_RPM_<component>_PACKAGE_ARCHITECTURE
2034 The RPM package architecture.
2035 · Mandatory : YES
2037 · Default : Native architecture output by uname -m
2039 This may be set to noarch if you know you are building a noarch
2041 package.
2042 CPACK_RPM_PACKAGE_RELEASE
2044 The RPM package release.
2045 · Mandatory : YES
2047 · Default : 1
2049 This is the numbering of the RPM package itself, i.e. the ver‐
2051 sion of the packaging and not the version of the content (see
2052 CPACK_RPM_PACKAGE_VERSION). One may change the default value if
2053 the previous packaging was buggy and/or you want to put here a
2054 fancy Linux distro specific numbering.
2055 NOTE:
2057 This is the string that goes into the RPM Release: field. Some dis‐
2058 tros (e.g. Fedora, CentOS) require 1%{?dist} format and not just a
2059 number. %{?dist} part can be added by setting
2060 CPACK_RPM_PACKAGE_RELEASE_DIST.
2061 CPACK_RPM_PACKAGE_RELEASE_DIST
2063 The dist tag that is added RPM Release: field.
2064 · Mandatory : NO
2066 · Default : OFF
2068 This is the reported %{dist} tag from the current distribution
2070 or empty %{dist} if RPM macro is not set. If this variable is
2071 set then RPM Release: field value is set to ${CPACK_RPM_PACK‐
2072 AGE_RELEASE}%{?dist}.
2073 CPACK_RPM_PACKAGE_LICENSE
2075 The RPM package license policy.
2076 · Mandatory : YES
2078 · Default : “unknown”
2080 CPACK_RPM_PACKAGE_GROUP
2082 CPACK_RPM_<component>_PACKAGE_GROUP
2084 The RPM package group.
2085 · Mandatory : YES
2087 · Default : “unknown”
2089 CPACK_RPM_PACKAGE_VENDOR
2091 The RPM package vendor.
2092 · Mandatory : YES
2094 · Default : CPACK_PACKAGE_VENDOR if set or “unknown”
2096 CPACK_RPM_PACKAGE_URL
2098 CPACK_RPM_<component>_PACKAGE_URL
2100 The projects URL.
2101 · Mandatory : NO
2103 · Default : CMAKE_PROJECT_HOMEPAGE_URL
2105 CPACK_RPM_PACKAGE_DESCRIPTION
2107 CPACK_RPM_<component>_PACKAGE_DESCRIPTION
2109 RPM package description.
2110 · Mandatory : YES
2112 · Default : CPACK_COMPONENT_<compName>_DESCRIPTION (component
2114 based installers only) if set, CPACK_PACKAGE_DESCRIPTION_FILE
2115 if set or “no package description available”
2116 CPACK_RPM_COMPRESSION_TYPE
2118 RPM compression type.
2119 · Mandatory : NO
2121 · Default : -
2123 May be used to override RPM compression type to be used to build
2125 the RPM. For example some Linux distribution now default to lzma
2126 or xz compression whereas older cannot use such RPM. Using this
2127 one can enforce compression type to be used.
2128 Possible values are:
2130 · lzma
2132 · xz
2134 · bzip2
2136 · gzip
2138 CPACK_RPM_PACKAGE_AUTOREQ
2140 CPACK_RPM_<component>_PACKAGE_AUTOREQ
2142 RPM spec autoreq field.
2143 · Mandatory : NO
2145 · Default : -
2147 May be used to enable (1, yes) or disable (0, no) automatic
2149 shared libraries dependency detection. Dependencies are added to
2150 requires list.
2151 NOTE:
2153 By default automatic dependency detection is enabled by rpm
2154 generator.
2155 CPACK_RPM_PACKAGE_AUTOPROV
2157 CPACK_RPM_<component>_PACKAGE_AUTOPROV
2159 RPM spec autoprov field.
2160 · Mandatory : NO
2162 · Default : -
2164 May be used to enable (1, yes) or disable (0, no) automatic
2166 listing of shared libraries that are provided by the package.
2167 Shared libraries are added to provides list.
2168 NOTE:
2170 By default automatic provides detection is enabled by rpm
2171 generator.
2172 CPACK_RPM_PACKAGE_AUTOREQPROV
2174 CPACK_RPM_<component>_PACKAGE_AUTOREQPROV
2176 RPM spec autoreqprov field.
2177 · Mandatory : NO
2179 · Default : -
2181 Variable enables/disables autoreq and autoprov at the same time.
2183 See CPACK_RPM_PACKAGE_AUTOREQ and CPACK_RPM_PACKAGE_AUTOPROV for
2184 more details.
2185 NOTE:
2187 By default automatic detection feature is enabled by rpm.
2188 CPACK_RPM_PACKAGE_REQUIRES
2190 CPACK_RPM_<component>_PACKAGE_REQUIRES
2192 RPM spec requires field.
2193 · Mandatory : NO
2195 · Default : -
2197 May be used to set RPM dependencies (requires). Note that you
2199 must enclose the complete requires string between quotes, for
2200 example:
2201 set(CPACK_RPM_PACKAGE_REQUIRES "python >= 2.5.0, cmake >= 2.8")
2203 The required package list of an RPM file could be printed with:
2205 rpm -qp --requires file.rpm
2207 CPACK_RPM_PACKAGE_CONFLICTS
2209 CPACK_RPM_<component>_PACKAGE_CONFLICTS
2211 RPM spec conflicts field.
2212 · Mandatory : NO
2214 · Default : -
2216 May be used to set negative RPM dependencies (conflicts). Note
2218 that you must enclose the complete requires string between
2219 quotes, for example:
2220 set(CPACK_RPM_PACKAGE_CONFLICTS "libxml2")
2222 The conflicting package list of an RPM file could be printed
2224 with:
2225 rpm -qp --conflicts file.rpm
2227 CPACK_RPM_PACKAGE_REQUIRES_PRE
2229 CPACK_RPM_<component>_PACKAGE_REQUIRES_PRE
2231 RPM spec requires(pre) field.
2232 · Mandatory : NO
2234 · Default : -
2236 May be used to set RPM preinstall dependencies (requires(pre)).
2238 Note that you must enclose the complete requires string between
2239 quotes, for example:
2240 set(CPACK_RPM_PACKAGE_REQUIRES_PRE "shadow-utils, initscripts")
2242 CPACK_RPM_PACKAGE_REQUIRES_POST
2244 CPACK_RPM_<component>_PACKAGE_REQUIRES_POST
2246 RPM spec requires(post) field.
2247 · Mandatory : NO
2249 · Default : -
2251 May be used to set RPM postinstall dependencies
2253 (requires(post)). Note that you must enclose the complete
2254 requires string between quotes, for example:
2255 set(CPACK_RPM_PACKAGE_REQUIRES_POST "shadow-utils, initscripts")
2257 CPACK_RPM_PACKAGE_REQUIRES_POSTUN
2259 CPACK_RPM_<component>_PACKAGE_REQUIRES_POSTUN
2261 RPM spec requires(postun) field.
2262 · Mandatory : NO
2264 · Default : -
2266 May be used to set RPM postuninstall dependencies (requires(pos‐
2268 tun)). Note that you must enclose the complete requires string
2269 between quotes, for example:
2270 set(CPACK_RPM_PACKAGE_REQUIRES_POSTUN "shadow-utils, initscripts")
2272 CPACK_RPM_PACKAGE_REQUIRES_PREUN
2274 CPACK_RPM_<component>_PACKAGE_REQUIRES_PREUN
2276 RPM spec requires(preun) field.
2277 · Mandatory : NO
2279 · Default : -
2281 May be used to set RPM preuninstall dependencies
2283 (requires(preun)). Note that you must enclose the complete
2284 requires string between quotes, for example:
2285 set(CPACK_RPM_PACKAGE_REQUIRES_PREUN "shadow-utils, initscripts")
2287 CPACK_RPM_PACKAGE_SUGGESTS
2289 CPACK_RPM_<component>_PACKAGE_SUGGESTS
2291 RPM spec suggest field.
2292 · Mandatory : NO
2294 · Default : -
2296 May be used to set weak RPM dependencies (suggests). Note that
2298 you must enclose the complete requires string between quotes.
2299 CPACK_RPM_PACKAGE_PROVIDES
2301 CPACK_RPM_<component>_PACKAGE_PROVIDES
2303 RPM spec provides field.
2304 · Mandatory : NO
2306 · Default : -
2308 May be used to set RPM dependencies (provides). The provided
2310 package list of an RPM file could be printed with:
2311 rpm -qp --provides file.rpm
2313 CPACK_RPM_PACKAGE_OBSOLETES
2315 CPACK_RPM_<component>_PACKAGE_OBSOLETES
2317 RPM spec obsoletes field.
2318 · Mandatory : NO
2320 · Default : -
2322 May be used to set RPM packages that are obsoleted by this one.
2324 CPACK_RPM_PACKAGE_RELOCATABLE
2326 build a relocatable RPM.
2327 · Mandatory : NO
2329 · Default : CPACK_PACKAGE_RELOCATABLE
2331 If this variable is set to TRUE or ON, the CPack RPM generator
2333 will try to build a relocatable RPM package. A relocatable RPM
2334 may be installed using:
2335 rpm --prefix or --relocate
2337 in order to install it at an alternate place see rpm(8). Note
2339 that currently this may fail if CPACK_SET_DESTDIR is set to ON.
2340 If CPACK_SET_DESTDIR is set then you will get a warning message
2341 but if there is file installed with absolute path you’ll get
2342 unexpected behavior.
2343 CPACK_RPM_SPEC_INSTALL_POST
2345 Deprecated - use CPACK_RPM_SPEC_MORE_DEFINE instead.
2346 · Mandatory : NO
2348 · Default : -
2350 · Deprecated: YES
2352 May be used to override the __spec_install_post section within
2354 the generated spec file. This affects the install step during
2355 package creation, not during package installation. For adding
2356 operations to be performed during package installation, use
2357 CPACK_RPM_POST_INSTALL_SCRIPT_FILE instead.
2358 CPACK_RPM_SPEC_MORE_DEFINE
2360 RPM extended spec definitions lines.
2361 · Mandatory : NO
2363 · Default : -
2365 May be used to add any %define lines to the generated spec file.
2367 An example of its use is to prevent stripping of executables
2368 (but note that this may also disable other default post install
2369 processing):
2370 set(CPACK_RPM_SPEC_MORE_DEFINE "%define __spec_install_post /bin/true")
2372 CPACK_RPM_PACKAGE_DEBUG
2374 Toggle CPack RPM generator debug output.
2375 · Mandatory : NO
2377 · Default : -
2379 May be set when invoking cpack in order to trace debug informa‐
2381 tion during CPack RPM run. For example you may launch CPack like
2382 this:
2383 cpack -D CPACK_RPM_PACKAGE_DEBUG=1 -G RPM
2385 CPACK_RPM_USER_BINARY_SPECFILE
2387 CPACK_RPM_<componentName>_USER_BINARY_SPECFILE
2389 A user provided spec file.
2390 · Mandatory : NO
2392 · Default : -
2394 May be set by the user in order to specify a USER binary spec
2396 file to be used by the CPack RPM generator instead of generating
2397 the file. The specified file will be processed by config‐
2398 ure_file( @ONLY).
2399 CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE
2401 Spec file template.
2402 · Mandatory : NO
2404 · Default : -
2406 If set CPack will generate a template for USER specified binary
2408 spec file and stop with an error. For example launch CPack like
2409 this:
2410 cpack -D CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE=1 -G RPM
2412 The user may then use this file in order to hand-craft is own
2414 binary spec file which may be used with
2415 CPACK_RPM_USER_BINARY_SPECFILE.
2416 CPACK_RPM_PRE_INSTALL_SCRIPT_FILE
2418 CPACK_RPM_PRE_UNINSTALL_SCRIPT_FILE
2420 Path to file containing pre (un)install script.
2421 · Mandatory : NO
2423 · Default : -
2425 May be used to embed a pre (un)installation script in the spec
2427 file. The referred script file (or both) will be read and
2428 directly put after the %pre or %preun section If
2429 CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script
2430 for each component can be overridden with CPACK_RPM_<COMPO‐
2431 NENT>_PRE_INSTALL_SCRIPT_FILE and CPACK_RPM_<COMPO‐
2432 NENT>_PRE_UNINSTALL_SCRIPT_FILE. One may verify which scriptlet
2433 has been included with:
2434 rpm -qp --scripts package.rpm
2436 CPACK_RPM_POST_INSTALL_SCRIPT_FILE
2438 CPACK_RPM_POST_UNINSTALL_SCRIPT_FILE
2440 Path to file containing post (un)install script.
2441 · Mandatory : NO
2443 · Default : -
2445 May be used to embed a post (un)installation script in the spec
2447 file. The referred script file (or both) will be read and
2448 directly put after the %post or %postun section. If
2449 CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script
2450 for each component can be overridden with CPACK_RPM_<COMPO‐
2451 NENT>_POST_INSTALL_SCRIPT_FILE and CPACK_RPM_<COMPO‐
2452 NENT>_POST_UNINSTALL_SCRIPT_FILE. One may verify which script‐
2453 let has been included with:
2454 rpm -qp --scripts package.rpm
2456 CPACK_RPM_USER_FILELIST
2458 CPACK_RPM_<COMPONENT>_USER_FILELIST
2460 · Mandatory : NO
2462 · Default : -
2464 May be used to explicitly specify %(<directive>) file line in
2466 the spec file. Like %config(noreplace) or any other directive
2467 that be found in the %files section. You can have multiple
2468 directives per line, as in %attr(600,root,root) %config(nore‐
2469 place). Since the CPack RPM generator is generating the list of
2470 files (and directories) the user specified files of the
2471 CPACK_RPM_<COMPONENT>_USER_FILELIST list will be removed from
2472 the generated list. If referring to directories do not add a
2473 trailing slash.
2474 CPACK_RPM_CHANGELOG_FILE
2476 RPM changelog file.
2477 · Mandatory : NO
2479 · Default : -
2481 May be used to embed a changelog in the spec file. The referred
2483 file will be read and directly put after the %changelog section.
2484 CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST
2486 list of path to be excluded.
2487 · Mandatory : NO
2489 ·
2491 Default
2493 /etc /etc/init.d /usr /usr/bin /usr/include /usr/lib
2494 /usr/libx32 /usr/lib64 /usr/share /usr/share/aclocal
2495 /usr/share/doc
2496 May be used to exclude path (directories or files) from the
2498 auto-generated list of paths discovered by CPack RPM. The
2499 default value contains a reasonable set of values if the vari‐
2500 able is not defined by the user. If the variable is defined by
2501 the user then the CPack RPM generator will NOT any of the
2502 default path. If you want to add some path to the default list
2503 then you can use CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION
2504 variable.
2505 CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST_ADDITION
2507 additional list of path to be excluded.
2508 · Mandatory : NO
2510 · Default : -
2512 May be used to add more exclude path (directories or files) from
2514 the initial default list of excluded paths. See
2515 CPACK_RPM_EXCLUDE_FROM_AUTO_FILELIST.
2516 CPACK_RPM_RELOCATION_PATHS
2518 Packages relocation paths list.
2519 · Mandatory : NO
2521 · Default : -
2523 May be used to specify more than one relocation path per relo‐
2525 catable RPM. Variable contains a list of relocation paths that
2526 if relative are prefixed by the value of
2527 CPACK_RPM_<COMPONENT>_PACKAGE_PREFIX or by the value of
2528 CPACK_PACKAGING_INSTALL_PREFIX if the component version is not
2529 provided. Variable is not component based as its content can be
2530 used to set a different path prefix for e.g. binary dir and doc‐
2531 umentation dir at the same time. Only prefixes that are
2532 required by a certain component are added to that component -
2533 component must contain at least one file/directory/symbolic link
2534 with CPACK_RPM_RELOCATION_PATHS prefix for a certain relocation
2535 path to be added. Package will not contain any relocation paths
2536 if there are no files/directories/symbolic links on any of the
2537 provided prefix locations. Packages that either do not contain
2538 any relocation paths or contain files/directories/symbolic links
2539 that are outside relocation paths print out an AUTHOR_WARNING
2540 that RPM will be partially relocatable.
2541 CPACK_RPM_<COMPONENT>_PACKAGE_PREFIX
2543 Per component relocation path install prefix.
2544 · Mandatory : NO
2546 · Default : CPACK_PACKAGING_INSTALL_PREFIX
2548 May be used to set per component CPACK_PACKAGING_INSTALL_PREFIX
2550 for relocatable RPM packages.
2551 CPACK_RPM_NO_INSTALL_PREFIX_RELOCATION
2553 CPACK_RPM_NO_<COMPONENT>_INSTALL_PREFIX_RELOCATION
2555 Removal of default install prefix from relocation paths list.
2556 · Mandatory : NO
2558 ·
2560 Default
2562 CPACK_PACKAGING_INSTALL_PREFIX or CPACK_RPM_<COMPO‐
2563 NENT>_PACKAGE_PREFIX are treated as one of relocation
2564 paths
2565 May be used to remove CPACK_PACKAGING_INSTALL_PREFIX and
2567 CPACK_RPM_<COMPONENT>_PACKAGE_PREFIX from relocatable RPM prefix
2568 paths.
2569 CPACK_RPM_ADDITIONAL_MAN_DIRS
2571 · Mandatory : NO
2573 · Default : -
2575 May be used to set additional man dirs that could potentially be
2577 compressed by brp-compress RPM macro. Variable content must be a
2578 list of regular expressions that point to directories containing
2579 man files or to man files directly. Note that in order to com‐
2580 press man pages a path must also be present in brp-compress RPM
2581 script and that brp-compress script must be added to RPM config‐
2582 uration by the operating system.
2583 Regular expressions that are added by default were taken from
2585 brp-compress RPM macro:
2586 · /usr/man/man.*
2588 · /usr/man/.*/man.*
2590 · /usr/info.*
2592 · /usr/share/man/man.*
2594 · /usr/share/man/.*/man.*
2596 · /usr/share/info.*
2598 · /usr/kerberos/man.*
2600 · /usr/X11R6/man/man.*
2602 · /usr/lib/perl5/man/man.*
2604 · /usr/share/doc/.*/man/man.*
2606 · /usr/lib/.*/man/man.*
2608 CPACK_RPM_DEFAULT_USER
2610 CPACK_RPM_<compName>_DEFAULT_USER
2612 default user ownership of RPM content
2613 · Mandatory : NO
2615 · Default : root
2617 Value should be user name and not UID. Note that <compName>
2619 must be in upper-case.
2620 CPACK_RPM_DEFAULT_GROUP
2622 CPACK_RPM_<compName>_DEFAULT_GROUP
2624 default group ownership of RPM content
2625 · Mandatory : NO
2627 · Default : root
2629 Value should be group name and not GID. Note that <compName>
2631 must be in upper-case.
2632 CPACK_RPM_DEFAULT_FILE_PERMISSIONS
2634 CPACK_RPM_<compName>_DEFAULT_FILE_PERMISSIONS
2636 default permissions used for packaged files
2637 · Mandatory : NO
2639 · Default : - (system default)
2641 Accepted values are lists with PERMISSIONS. Valid permissions
2643 are:
2644 · OWNER_READ
2646 · OWNER_WRITE
2648 · OWNER_EXECUTE
2650 · GROUP_READ
2652 · GROUP_WRITE
2654 · GROUP_EXECUTE
2656 · WORLD_READ
2658 · WORLD_WRITE
2660 · WORLD_EXECUTE
2662 Note that <compName> must be in upper-case.
2664 CPACK_RPM_DEFAULT_DIR_PERMISSIONS
2666 CPACK_RPM_<compName>_DEFAULT_DIR_PERMISSIONS
2668 default permissions used for packaged directories
2669 · Mandatory : NO
2671 · Default : - (system default)
2673 Accepted values are lists with PERMISSIONS. Valid permissions
2675 are the same as for CPACK_RPM_DEFAULT_FILE_PERMISSIONS. Note
2676 that <compName> must be in upper-case.
2677 CPACK_RPM_INSTALL_WITH_EXEC
2679 force execute permissions on programs and shared libraries
2680 · Mandatory : NO
2682 · Default : - (system default)
2684 Force set owner, group and world execute permissions on programs
2686 and shared libraries. This can be used for creating valid rpm
2687 packages on systems such as Debian where shared libraries do not
2688 have execute permissions set.
2689 NOTE:
2691 Programs and shared libraries without execute permissions are
2692 ignored during separation of debug symbols from the binary for
2693 debuginfo packages.
2694 Packaging of Symbolic Links
2696 The CPack RPM generator supports packaging of symbolic links:
2697 execute_process(COMMAND ${CMAKE_COMMAND}
2699 -E create_symlink <relative_path_location> <symlink_name>)
2700 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/<symlink_name>
2701 DESTINATION <symlink_location> COMPONENT libraries)
2702 Symbolic links will be optimized (paths will be shortened if possible)
2704 before being added to the package or if multiple relocation paths are
2705 detected, a post install symlink relocation script will be generated.
2706 Symbolic links may point to locations that are not packaged by the same
2708 package (either a different component or even not packaged at all) but
2709 those locations will be treated as if they were a part of the package
2710 while determining if symlink should be either created or present in a
2711 post install script - depending on relocation paths.
2712 Symbolic links that point to locations outside packaging path produce a
2714 warning and are treated as non relocatable permanent symbolic links.
2715 Currently there are a few limitations though:
2717 · For component based packaging component interdependency is not
2719 checked when processing symbolic links. Symbolic links pointing to
2720 content of a different component are treated the same way as if
2721 pointing to location that will not be packaged.
2722 · Symbolic links pointing to a location through one or more intermedi‐
2724 ate symbolic links will not be handled differently - if the interme‐
2725 diate symbolic link(s) is also on a relocatable path, relocating it
2726 during package installation may cause initial symbolic link to point
2727 to an invalid location.
2728 Packaging of debug information
2730 Debuginfo packages contain debug symbols and sources for debugging
2731 packaged binaries.
2732 Debuginfo RPM packaging has its own set of variables:
2734 CPACK_RPM_DEBUGINFO_PACKAGE
2736 CPACK_RPM_<component>_DEBUGINFO_PACKAGE
2738 Enable generation of debuginfo RPM package(s).
2739 · Mandatory : NO
2741 · Default : OFF
2743 NOTE:
2745 Binaries must contain debug symbols before packaging so use either
2746 Debug or RelWithDebInfo for CMAKE_BUILD_TYPE variable value.
2747 NOTE:
2749 Packages generated from packages without binary files, with binary
2750 files but without execute permissions or without debug symbols will
2751 cause packaging termination.
2752 CPACK_BUILD_SOURCE_DIRS
2754 Provides locations of root directories of source files from
2755 which binaries were built.
2756 · Mandatory : YES if CPACK_RPM_DEBUGINFO_PACKAGE is set
2758 · Default : -
2760 NOTE:
2762 For CMake project CPACK_BUILD_SOURCE_DIRS is set by default to point
2763 to CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR paths.
2764 NOTE:
2766 Sources with path prefixes that do not fall under any location pro‐
2767 vided with CPACK_BUILD_SOURCE_DIRS will not be present in debuginfo
2768 package.
2769 CPACK_RPM_BUILD_SOURCE_DIRS_PREFIX
2771 CPACK_RPM_<component>_BUILD_SOURCE_DIRS_PREFIX
2773 Prefix of location where sources will be placed during package
2774 installation.
2775 · Mandatory : YES if CPACK_RPM_DEBUGINFO_PACKAGE is set
2777 ·
2779 Default
2781 “/usr/src/debug/<CPACK_PACKAGE_FILE_NAME>” and for com‐
2782 ponent packaging “/usr/src/debug/<CPACK_PACK‐
2783 AGE_FILE_NAME>-<component>”
2784 NOTE:
2786 Each source path prefix is additionally suffixed by src_<index>
2787 where index is index of the path used from CPACK_BUILD_SOURCE_DIRS
2788 variable. This produces <CPACK_RPM_BUILD_SOURCE_DIRS_PRE‐
2789 FIX>/src_<index> replacement path. Limitation is that replaced path
2790 part must be shorter or of equal length than the length of its
2791 replacement. If that is not the case either
2792 CPACK_RPM_BUILD_SOURCE_DIRS_PREFIX variable has to be set to a
2793 shorter path or source directories must be placed on a longer path.
2794 CPACK_RPM_DEBUGINFO_EXCLUDE_DIRS
2796 Directories containing sources that should be excluded from
2797 debuginfo packages.
2798 · Mandatory : NO
2800 · Default : “/usr /usr/src /usr/src/debug”
2802 Listed paths are owned by other RPM packages and should there‐
2804 fore not be deleted on debuginfo package uninstallation.
2805 CPACK_RPM_DEBUGINFO_EXCLUDE_DIRS_ADDITION
2807 Paths that should be appended to
2808 CPACK_RPM_DEBUGINFO_EXCLUDE_DIRS for exclusion.
2809 · Mandatory : NO
2811 · Default : -
2813 CPACK_RPM_DEBUGINFO_SINGLE_PACKAGE
2815 Create a single debuginfo package even if components packaging
2816 is set.
2817 · Mandatory : NO
2819 · Default : OFF
2821 When this variable is enabled it produces a single debuginfo
2823 package even if component packaging is enabled.
2824 When using this feature in combination with components packaging
2826 and there is more than one component this variable requires
2827 CPACK_RPM_MAIN_COMPONENT to be set.
2828 NOTE:
2830 If none of the CPACK_RPM_<component>_DEBUGINFO_PACKAGE variables is
2831 set then CPACK_RPM_DEBUGINFO_PACKAGE is automatically set to ON when
2832 CPACK_RPM_DEBUGINFO_SINGLE_PACKAGE is set.
2833 CPACK_RPM_DEBUGINFO_FILE_NAME
2835 CPACK_RPM_<component>_DEBUGINFO_FILE_NAME
2837 Debuginfo package file name.
2838 · Mandatory : NO
2840 · Default : rpmbuild tool generated package file name
2842 Alternatively provided debuginfo package file name must end with
2844 .rpm suffix and should differ from file names of other generated
2845 packages.
2846 Variable may contain @cpack_component@ placeholder which will be
2848 replaced by component name if component packaging is enabled
2849 otherwise it deletes the placeholder.
2850 Setting the variable to RPM-DEFAULT may be used to explicitly
2852 set filename generation to default.
2853 NOTE:
2855 CPACK_RPM_FILE_NAME also supports rpmbuild tool generated package
2856 file name - disabled by default but can be enabled by setting the
2857 variable to RPM-DEFAULT.
2858 Packaging of sources (SRPM)
2860 SRPM packaging is enabled by setting CPACK_RPM_PACKAGE_SOURCES variable
2861 while usually using CPACK_INSTALLED_DIRECTORIES variable to provide
2862 directory containing CMakeLists.txt and source files.
2863 For CMake projects SRPM package would be produced by executing:
2865 cpack -G RPM --config ./CPackSourceConfig.cmake
2867 NOTE:
2869 Produced SRPM package is expected to be built with cmake(1) exe‐
2870 cutable and packaged with cpack(1) executable so CMakeLists.txt has
2871 to be located in root source directory and must be able to generate
2872 binary rpm packages by executing cpack -G command. The two executa‐
2873 bles as well as rpmbuild must also be present when generating binary
2874 rpm packages from the produced SRPM package.
2875 Once the SRPM package is generated it can be used to generate binary
2877 packages by creating a directory structure for rpm generation and exe‐
2878 cuting rpmbuild tool:
2879 mkdir -p build_dir/{BUILD,BUILDROOT,RPMS,SOURCES,SPECS,SRPMS}
2881 rpmbuild --define "_topdir <path_to_build_dir>" --rebuild <SRPM_file_name>
2882 Generated packages will be located in build_dir/RPMS directory or its
2884 sub directories.
2885 NOTE:
2887 SRPM package internally uses CPack/RPM generator to generate binary
2888 packages so CMakeScripts.txt can decide during the SRPM to binary
2889 rpm generation step what content the package(s) should have as well
2890 as how they should be packaged (monolithic or components). CMake can
2891 decide this for e.g. by reading environment variables set by the
2892 package manager before starting the process of generating binary rpm
2893 packages. This way a single SRPM package can be used to produce dif‐
2894 ferent binary rpm packages on different platforms depending on the
2895 platform’s packaging rules.
2896 Source RPM packaging has its own set of variables:
2898 CPACK_RPM_PACKAGE_SOURCES
2900 Should the content be packaged as a source rpm (default is
2901 binary rpm).
2902 · Mandatory : NO
2904 · Default : OFF
2906 NOTE:
2908 For cmake projects CPACK_RPM_PACKAGE_SOURCES variable is set to OFF
2909 in CPackConfig.cmake and ON in CPackSourceConfig.cmake generated
2910 files.
2911 CPACK_RPM_SOURCE_PKG_BUILD_PARAMS
2913 Additional command-line parameters provided to cmake(1) exe‐
2914 cutable.
2915 · Mandatory : NO
2917 · Default : -
2919 CPACK_RPM_SOURCE_PKG_PACKAGING_INSTALL_PREFIX
2921 Packaging install prefix that would be provided in CPACK_PACKAG‐
2922 ING_INSTALL_PREFIX variable for producing binary RPM packages.
2923 · Mandatory : YES
2925 · Default : “/”
2927 CPACK_RPM_BUILDREQUIRES
2929 List of source rpm build dependencies.
2930 · Mandatory : NO
2932 · Default : -
2934 May be used to set source RPM build dependencies (Buil‐
2936 dRequires). Note that you must enclose the complete build
2937 requirements string between quotes, for example:
2938 set(CPACK_RPM_BUILDREQUIRES "python >= 2.5.0, cmake >= 2.8")
2940 CPack WIX Generator
2942 CPack WIX generator specific options
2943 Variables specific to CPack WIX generator
2945 The following variables are specific to the installers built on Windows
2946 using WiX.
2947 CPACK_WIX_UPGRADE_GUID
2949 Upgrade GUID (Product/@UpgradeCode)
2950 Will be automatically generated unless explicitly provided.
2952 It should be explicitly set to a constant generated globally
2954 unique identifier (GUID) to allow your installers to replace
2955 existing installations that use the same GUID.
2956 You may for example explicitly set this variable in your CMake‐
2958 Lists.txt to the value that has been generated per default. You
2959 should not use GUIDs that you did not generate yourself or which
2960 may belong to other projects.
2961 A GUID shall have the following fixed length syntax:
2963 XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
2965 (each X represents an uppercase hexadecimal digit)
2967 CPACK_WIX_PRODUCT_GUID
2969 Product GUID (Product/@Id)
2970 Will be automatically generated unless explicitly provided.
2972 If explicitly provided this will set the Product Id of your in‐
2974 staller.
2975 The installer will abort if it detects a pre-existing installa‐
2977 tion that uses the same GUID.
2978 The GUID shall use the syntax described for
2980 CPACK_WIX_UPGRADE_GUID.
2981 CPACK_WIX_LICENSE_RTF
2983 RTF License File
2984 If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension it is used
2986 as-is.
2987 If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is
2989 implicitly converted to RTF by the WIX Generator. The expected
2990 encoding of the .txt file is UTF-8.
2991 With CPACK_WIX_LICENSE_RTF you can override the license file
2993 used by the WIX Generator in case CPACK_RESOURCE_FILE_LICENSE is
2994 in an unsupported format or the .txt -> .rtf conversion does not
2995 work as expected.
2996 CPACK_WIX_PRODUCT_ICON
2998 The Icon shown next to the program name in Add/Remove programs.
2999 If set, this icon is used in place of the default icon.
3001 CPACK_WIX_UI_REF
3003 This variable allows you to override the Id of the <UIRef> ele‐
3004 ment in the WiX template.
3005 The default is WixUI_InstallDir in case no CPack components have
3007 been defined and WixUI_FeatureTree otherwise.
3008 CPACK_WIX_UI_BANNER
3010 The bitmap will appear at the top of all installer pages other
3011 than the welcome and completion dialogs.
3012 If set, this image will replace the default banner image.
3014 This image must be 493 by 58 pixels.
3016 CPACK_WIX_UI_DIALOG
3018 Background bitmap used on the welcome and completion dialogs.
3019 If this variable is set, the installer will replace the default
3021 dialog image.
3022 This image must be 493 by 312 pixels.
3024 CPACK_WIX_PROGRAM_MENU_FOLDER
3026 Start menu folder name for launcher.
3027 If this variable is not set, it will be initialized with
3029 CPACK_PACKAGE_NAME
3030 If this variable is set to ., then application shortcuts will be
3032 created directly in the start menu and the uninstaller shortcut
3033 will be omitted.
3034 CPACK_WIX_CULTURES
3036 Language(s) of the installer
3037 Languages are compiled into the WixUI extension library. To use
3039 them, simply provide the name of the culture. If you specify
3040 more than one culture identifier in a comma or semicolon delim‐
3041 ited list, the first one that is found will be used. You can
3042 find a list of supported languages at:
3043 http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm
3044 CPACK_WIX_TEMPLATE
3046 Template file for WiX generation
3047 If this variable is set, the specified template will be used to
3049 generate the WiX wxs file. This should be used if further cus‐
3050 tomization of the output is required.
3051 If this variable is not set, the default MSI template included
3053 with CMake will be used.
3054 CPACK_WIX_PATCH_FILE
3056 Optional list of XML files with fragments to be inserted into
3057 generated WiX sources
3058 This optional variable can be used to specify an XML file that
3060 the WIX generator will use to inject fragments into its gener‐
3061 ated source files.
3062 Patch files understood by the CPack WIX generator roughly follow
3064 this RELAX NG compact schema:
3065 start = CPackWiXPatch
3067 CPackWiXPatch = element CPackWiXPatch { CPackWiXFragment* }
3069 CPackWiXFragment = element CPackWiXFragment
3071 {
3072 attribute Id { string },
3073 fragmentContent*
3074 }
3075 fragmentContent = element * - CPackWiXFragment
3077 {
3078 (attribute * { text } | text | fragmentContent)*
3079 }
3080 Currently fragments can be injected into most Component, File,
3082 Directory and Feature elements.
3083 The following additional special Ids can be used:
3085 · #PRODUCT for the <Product> element.
3087 · #PRODUCTFEATURE for the root <Feature> element.
3089 The following example illustrates how this works.
3091 Given that the WIX generator creates the following XML element:
3093 <Component Id="CM_CP_applications.bin.my_libapp.exe" Guid="*"/>
3095 The following XML patch file may be used to inject an Environ‐
3097 ment element into it:
3098 <CPackWiXPatch>
3100 <CPackWiXFragment Id="CM_CP_applications.bin.my_libapp.exe">
3101 <Environment Id="MyEnvironment" Action="set"
3102 Name="MyVariableName" Value="MyVariableValue"/>
3103 </CPackWiXFragment>
3104 </CPackWiXPatch>
3105 CPACK_WIX_EXTRA_SOURCES
3107 Extra WiX source files
3108 This variable provides an optional list of extra WiX source
3110 files (.wxs) that should be compiled and linked. The full path
3111 to source files is required.
3112 CPACK_WIX_EXTRA_OBJECTS
3114 Extra WiX object files or libraries
3115 This variable provides an optional list of extra WiX object
3117 (.wixobj) and/or WiX library (.wixlib) files. The full path to
3118 objects and libraries is required.
3119 CPACK_WIX_EXTENSIONS
3121 This variable provides a list of additional extensions for the
3122 WiX tools light and candle.
3123 CPACK_WIX_<TOOL>_EXTENSIONS
3125 This is the tool specific version of CPACK_WIX_EXTENSIONS.
3126 <TOOL> can be either LIGHT or CANDLE.
3127 CPACK_WIX_<TOOL>_EXTRA_FLAGS
3129 This list variable allows you to pass additional flags to the
3130 WiX tool <TOOL>.
3131 Use it at your own risk. Future versions of CPack may generate
3133 flags which may be in conflict with your own flags.
3134 <TOOL> can be either LIGHT or CANDLE.
3136 CPACK_WIX_CMAKE_PACKAGE_REGISTRY
3138 If this variable is set the generated installer will create an
3139 entry in the windows registry key HKEY_LOCAL_MACHINE\Soft‐
3140 ware\Kitware\CMake\Packages\<PackageName> The value for <Packa‐
3141 geName> is provided by this variable.
3142 Assuming you also install a CMake configuration file this will
3144 allow other CMake projects to find your package with the
3145 find_package() command.
3146 CPACK_WIX_PROPERTY_<PROPERTY>
3148 This variable can be used to provide a value for the Windows In‐
3149 staller property <PROPERTY>
3150 The following list contains some example properties that can be
3152 used to customize information under “Programs and Features”
3153 (also known as “Add or Remove Programs”)
3154 · ARPCOMMENTS - Comments
3156 · ARPHELPLINK - Help and support information URL
3158 · ARPURLINFOABOUT - General information URL
3160 · ARPURLUPDATEINFO - Update information URL
3162 · ARPHELPTELEPHONE - Help and support telephone number
3164 · ARPSIZE - Size (in kilobytes) of the application
3166 CPACK_WIX_ROOT_FEATURE_TITLE
3168 Sets the name of the root install feature in the WIX installer.
3169 Same as CPACK_COMPONENT_<compName>_DISPLAY_NAME for components.
3170 CPACK_WIX_ROOT_FEATURE_DESCRIPTION
3172 Sets the description of the root install feature in the WIX in‐
3173 staller. Same as CPACK_COMPONENT_<compName>_DESCRIPTION for com‐
3174 ponents.
3175 CPACK_WIX_SKIP_PROGRAM_FOLDER
3177 If this variable is set to true, the default install location of
3178 the generated package will be CPACK_PACKAGE_INSTALL_DIRECTORY
3179 directly. The install location will not be located relatively
3180 below ProgramFiles or ProgramFiles64.
3181 NOTE:
3183 Installers created with this feature do not take differ‐
3184 ences between the system on which the installer is cre‐
3185 ated and the system on which the installer might be used
3186 into account.
3187 It is therefore possible that the installer e.g. might
3189 try to install onto a drive that is unavailable or unin‐
3190 tended or a path that does not follow the localization or
3191 convention of the system on which the installation is
3192 performed.
3193 CPACK_WIX_ROOT_FOLDER_ID
3195 This variable allows specification of a custom root folder ID.
3196 The generator specific <64> token can be used for folder IDs
3197 that come in 32-bit and 64-bit variants. In 32-bit builds the
3198 token will expand empty while in 64-bit builds it will expand to
3199 64.
3200 When unset generated installers will default installing to Pro‐
3202 gramFiles<64>Folder.
3203 CPACK_WIX_ROOT
3205 This variable can optionally be set to the root directory of a
3206 custom WiX Toolset installation.
3207 When unspecified CPack will try to locate a WiX Toolset instal‐
3209 lation via the WIX environment variable instead.
3210
3212 2000-2019 Kitware, Inc. and Contributors
32133.16.1 Dec 14, 2019 CPACK-GENERATORS(7)