CMake/Help/cpack_gen/productbuild.rst
Bartosz Kosiorek fc1602456a Help: Replace occurrences of "Mac OS X" with "macOS"
Apple's main Operating system changed their name from OS X to macOS:

    https://www.engadget.com/2016/06/13/os-x-is-now-macos/

Revise documentation accordingly.
2018-09-05 16:10:49 -04:00

69 lines
2.2 KiB
ReStructuredText

CPack productbuild Generator
----------------------------
productbuild CPack generator (macOS).
Variables specific to CPack productbuild generator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The following variable is specific to installers built on Mac
macOS using ProductBuild:
.. variable:: 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).
.. variable:: CPACK_PRODUCTBUILD_IDENTITY_NAME
Adds a digital signature to the resulting package.
.. variable:: CPACK_PRODUCTBUILD_KEYCHAIN_PATH
Specify a specific keychain to search for the signing identity.
.. variable:: 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).
.. variable:: CPACK_PKGBUILD_IDENTITY_NAME
Adds a digital signature to the resulting package.
.. variable:: CPACK_PKGBUILD_KEYCHAIN_PATH
Specify a specific keychain to search for the signing identity.
.. variable:: CPACK_PREFLIGHT_<COMP>_SCRIPT
Full path to a file that will be used as the ``preinstall`` script for the
named ``<COMP>`` component's package, where ``<COMP>`` is the uppercased
component name. No ``preinstall`` script is added if this variable is not
defined for a given component.
.. variable:: CPACK_POSTFLIGHT_<COMP>_SCRIPT
Full path to a file that will be used as the ``postinstall`` script for the
named ``<COMP>`` component's package, where ``<COMP>`` is the uppercased
component name. No ``postinstall`` script is added if this variable is not
defined for a given component.
.. variable:: CPACK_PRODUCTBUILD_RESOURCES_DIR
If specified the productbuild generator copies files from this directory
(including subdirectories) to the ``Resources`` directory. This is done
before the :variable:`CPACK_RESOURCE_FILE_WELCOME`,
:variable:`CPACK_RESOURCE_FILE_README`, and
:variable:`CPACK_RESOURCE_FILE_LICENSE` files are copied.