1CPack productbuild Generator 2---------------------------- 3 4.. versionadded:: 3.7 5 6productbuild CPack generator (macOS). 7 8Variables specific to CPack productbuild generator 9^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 10 11The following variable is specific to installers built on Mac 12macOS using ProductBuild: 13 14.. variable:: CPACK_COMMAND_PRODUCTBUILD 15 16 Path to the ``productbuild(1)`` command used to generate a product archive for 17 the macOS Installer or Mac App Store. This variable can be used to override 18 the automatically detected command (or specify its location if the 19 auto-detection fails to find it). 20 21.. variable:: CPACK_PRODUCTBUILD_IDENTITY_NAME 22 23 .. versionadded:: 3.8 24 25 Adds a digital signature to the resulting package. 26 27 28.. variable:: CPACK_PRODUCTBUILD_KEYCHAIN_PATH 29 30 .. versionadded:: 3.8 31 32 Specify a specific keychain to search for the signing identity. 33 34 35.. variable:: CPACK_COMMAND_PKGBUILD 36 37 Path to the ``pkgbuild(1)`` command used to generate an macOS component package 38 on macOS. This variable can be used to override the automatically detected 39 command (or specify its location if the auto-detection fails to find it). 40 41 42.. variable:: CPACK_PKGBUILD_IDENTITY_NAME 43 44 .. versionadded:: 3.8 45 46 Adds a digital signature to the resulting package. 47 48 49.. variable:: CPACK_PKGBUILD_KEYCHAIN_PATH 50 51 .. versionadded:: 3.8 52 53 Specify a specific keychain to search for the signing identity. 54 55 56.. variable:: CPACK_PREFLIGHT_<COMP>_SCRIPT 57 58 Full path to a file that will be used as the ``preinstall`` script for the 59 named ``<COMP>`` component's package, where ``<COMP>`` is the uppercased 60 component name. No ``preinstall`` script is added if this variable is not 61 defined for a given component. 62 63 64.. variable:: CPACK_POSTFLIGHT_<COMP>_SCRIPT 65 66 Full path to a file that will be used as the ``postinstall`` script for the 67 named ``<COMP>`` component's package, where ``<COMP>`` is the uppercased 68 component name. No ``postinstall`` script is added if this variable is not 69 defined for a given component. 70 71.. variable:: CPACK_PRODUCTBUILD_RESOURCES_DIR 72 73 .. versionadded:: 3.9 74 75 If specified the productbuild generator copies files from this directory 76 (including subdirectories) to the ``Resources`` directory. This is done 77 before the :variable:`CPACK_RESOURCE_FILE_WELCOME`, 78 :variable:`CPACK_RESOURCE_FILE_README`, and 79 :variable:`CPACK_RESOURCE_FILE_LICENSE` files are copied. 80 81Background Image 82"""""""""""""""" 83 84.. versionadded:: 3.17 85 86This group of variables controls the background image of the generated 87installer. 88 89.. variable:: CPACK_PRODUCTBUILD_BACKGROUND 90 91 Adds a background to Distribution XML if specified. The value contains the 92 path to image in ``Resources`` directory. 93 94.. variable:: CPACK_PRODUCTBUILD_BACKGROUND_ALIGNMENT 95 96 Adds an ``alignment`` attribute to the background in Distribution XML. 97 Refer to Apple documentation for valid values. 98 99.. variable:: CPACK_PRODUCTBUILD_BACKGROUND_SCALING 100 101 Adds a ``scaling`` attribute to the background in Distribution XML. 102 Refer to Apple documentation for valid values. 103 104.. variable:: CPACK_PRODUCTBUILD_BACKGROUND_MIME_TYPE 105 106 Adds a ``mime-type`` attribute to the background in Distribution XML. 107 The option contains MIME type of an image. 108 109.. variable:: CPACK_PRODUCTBUILD_BACKGROUND_UTI 110 111 Adds an ``uti`` attribute to the background in Distribution XML. 112 The option contains UTI type of an image. 113 114.. variable:: CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA 115 116 Adds a background for the Dark Aqua theme to Distribution XML if 117 specified. The value contains the path to image in ``Resources`` 118 directory. 119 120.. variable:: CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_ALIGNMENT 121 122 Does the same as :variable:`CPACK_PRODUCTBUILD_BACKGROUND_ALIGNMENT` option, 123 but for the dark theme. 124 125.. variable:: CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_SCALING 126 127 Does the same as :variable:`CPACK_PRODUCTBUILD_BACKGROUND_SCALING` option, 128 but for the dark theme. 129 130.. variable:: CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_MIME_TYPE 131 132 Does the same as :variable:`CPACK_PRODUCTBUILD_BACKGROUND_MIME_TYPE` option, 133 but for the dark theme. 134 135.. variable:: CPACK_PRODUCTBUILD_BACKGROUND_DARKAQUA_UTI 136 137 Does the same as :variable:`CPACK_PRODUCTBUILD_BACKGROUND_UTI` option, 138 but for the dark theme. 139