bundle.rst 2.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. CPack Bundle Generator
  2. ----------------------
  3. CPack Bundle generator (macOS) specific options
  4. Variables specific to CPack Bundle generator
  5. ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  6. Installers built on macOS using the Bundle generator use the
  7. aforementioned DragNDrop (``CPACK_DMG_xxx``) variables, plus the following
  8. Bundle-specific parameters (``CPACK_BUNDLE_xxx``).
  9. .. variable:: CPACK_BUNDLE_NAME
  10. The name of the generated bundle. This appears in the macOS Finder as the
  11. bundle name. Required.
  12. .. variable:: CPACK_BUNDLE_PLIST
  13. Path to an macOS Property List (``.plist``) file that will be used
  14. for the generated bundle. This
  15. assumes that the caller has generated or specified their own ``Info.plist``
  16. file. Required.
  17. .. variable:: CPACK_BUNDLE_ICON
  18. Path to an macOS icon file that will be used as the icon for the generated
  19. bundle. This is the icon that appears in the macOS Finder for the bundle, and
  20. in the macOS dock when the bundle is opened. Required.
  21. .. variable:: CPACK_BUNDLE_STARTUP_COMMAND
  22. Path to a startup script. This is a path to an executable or script that
  23. will be run whenever an end-user double-clicks the generated bundle in the
  24. macOS Finder. Optional.
  25. .. variable:: CPACK_BUNDLE_APPLE_CERT_APP
  26. .. versionadded:: 3.2
  27. The name of your Apple supplied code signing certificate for the application.
  28. The name usually takes the form ``Developer ID Application: [Name]`` or
  29. ``3rd Party Mac Developer Application: [Name]``. If this variable is not set
  30. the application will not be signed.
  31. .. variable:: CPACK_BUNDLE_APPLE_ENTITLEMENTS
  32. .. versionadded:: 3.2
  33. The name of the Property List (``.plist``) file that contains your Apple
  34. entitlements for sandboxing your application. This file is required
  35. for submission to the macOS App Store.
  36. .. variable:: CPACK_BUNDLE_APPLE_CODESIGN_FILES
  37. .. versionadded:: 3.2
  38. A list of additional files that you wish to be signed. You do not need to
  39. list the main application folder, or the main executable. You should
  40. list any frameworks and plugins that are included in your app bundle.
  41. .. variable:: CPACK_BUNDLE_APPLE_CODESIGN_PARAMETER
  42. .. versionadded:: 3.3
  43. Additional parameter that will passed to ``codesign``.
  44. Default value: ``--deep -f``
  45. .. variable:: CPACK_COMMAND_CODESIGN
  46. .. versionadded:: 3.2
  47. Path to the ``codesign(1)`` command used to sign applications with an
  48. Apple cert. This variable can be used to override the automatically
  49. detected command (or specify its location if the auto-detection fails
  50. to find it).