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