CPack productbuild Generator¶
New in version 3.7.
productbuild CPack generator (macOS).
Variables specific to CPack productbuild generator¶
The following variable is specific to installers built on Mac macOS using ProductBuild:
- CPACK_COMMAND_PRODUCTBUILD¶
- Path to the - productbuild(1)command used to generate a product archive for the macOS Installer or Mac App Store. This variable can be used to override the automatically detected command (or specify its location if the auto-detection fails to find it).
- CPACK_PRODUCTBUILD_IDENTITY_NAME¶
- New in version 3.8. - Adds a digital signature to the resulting package. 
- CPACK_PRODUCTBUILD_KEYCHAIN_PATH¶
- New in version 3.8. - Specify a specific keychain to search for the signing identity. 
- CPACK_COMMAND_PKGBUILD¶
- Path to the - pkgbuild(1)command used to generate an macOS component package on macOS. This variable can be used to override the automatically detected command (or specify its location if the auto-detection fails to find it).
- CPACK_PKGBUILD_IDENTITY_NAME¶
- New in version 3.8. - Adds a digital signature to the resulting package. 
- CPACK_PKGBUILD_KEYCHAIN_PATH¶
- New in version 3.8. - Specify a specific keychain to search for the signing identity. 
- CPACK_PREFLIGHT_<COMP>_SCRIPT¶
- Full path to a file that will be used as the - preinstallscript for the named- <COMP>component's package, where- <COMP>is the uppercased component name. No- preinstallscript is added if this variable is not defined for a given component.
- CPACK_POSTFLIGHT_<COMP>_SCRIPT¶
- Full path to a file that will be used as the - postinstallscript for the named- <COMP>component's package, where- <COMP>is the uppercased component name. No- postinstallscript is added if this variable is not defined for a given component.
- CPACK_PRODUCTBUILD_RESOURCES_DIR¶
- New in version 3.9. - If specified the productbuild generator copies files from this directory (including subdirectories) to the - Resourcesdirectory. This is done before the- CPACK_RESOURCE_FILE_WELCOME,- CPACK_RESOURCE_FILE_README, and- CPACK_RESOURCE_FILE_LICENSEfiles are copied.
Background Image¶
New in version 3.17.
This group of variables controls the background image of the generated installer.
- CPACK_PRODUCTBUILD_BACKGROUND¶
- Adds a background to Distribution XML if specified. The value contains the path to image in - Resourcesdirectory.
- CPACK_PRODUCTBUILD_BACKGROUND_ALIGNMENT¶
- Adds an - alignmentattribute to the background in Distribution XML. Refer to Apple documentation for valid values.
- CPACK_PRODUCTBUILD_BACKGROUND_SCALING¶
- Adds a - scalingattribute to the background in Distribution XML. Refer to Apple documentation for valid values.
- CPACK_PRODUCTBUILD_BACKGROUND_MIME_TYPE¶
- Adds a - mime-typeattribute to the background in Distribution XML. The option contains MIME type of an image.
- CPACK_PRODUCTBUILD_BACKGROUND_UTI¶
- Adds an - utiattribute to the background in Distribution XML. The option contains UTI type of an image.
- CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA¶
- Adds a background for the Dark Aqua theme to Distribution XML if specified. The value contains the path to image in - Resourcesdirectory.
- CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_ALIGNMENT¶
- Does the same as - CPACK_PRODUCTBUILD_BACKGROUND_ALIGNMENToption, but for the dark theme.
- CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_SCALING¶
- Does the same as - CPACK_PRODUCTBUILD_BACKGROUND_SCALINGoption, but for the dark theme.
- CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_MIME_TYPE¶
- Does the same as - CPACK_PRODUCTBUILD_BACKGROUND_MIME_TYPEoption, but for the dark theme.
- CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_UTI¶
- Does the same as - CPACK_PRODUCTBUILD_BACKGROUND_UTIoption, but for the dark theme.
