1CPack PackageMaker Generator
2----------------------------
3
4PackageMaker CPack generator (macOS).
5
6.. deprecated:: 3.17
7
8  Xcode no longer distributes the PackageMaker tools.
9  This CPack generator will be removed in a future version of CPack.
10
11Variables specific to CPack PackageMaker generator
12^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
13
14The following variable is specific to installers built on Mac
15macOS using PackageMaker:
16
17.. variable:: CPACK_OSX_PACKAGE_VERSION
18
19 The version of macOS that the resulting PackageMaker archive should be
20 compatible with. Different versions of macOS support different
21 features. For example, CPack can only build component-based installers for
22 macOS 10.4 or newer, and can only build installers that download
23 components on-the-fly for macOS 10.5 or newer. If left blank, this value
24 will be set to the minimum version of macOS that supports the requested
25 features. Set this variable to some value (e.g., 10.4) only if you want to
26 guarantee that your installer will work on that version of macOS, and
27 don't mind missing extra features available in the installer shipping with
28 later versions of macOS.
29
30Background Image
31""""""""""""""""
32
33.. versionadded:: 3.17
34
35This group of variables controls the background image of the generated
36installer.
37
38.. variable:: CPACK_PACKAGEMAKER_BACKGROUND
39
40 Adds a background to Distribution XML if specified. The value contains the
41 path to image in ``Resources`` directory.
42
43.. variable:: CPACK_PACKAGEMAKER_BACKGROUND_ALIGNMENT
44
45 Adds an ``alignment`` attribute to the background in Distribution XML.
46 Refer to Apple documentation for valid values.
47
48.. variable:: CPACK_PACKAGEMAKER_BACKGROUND_SCALING
49
50 Adds a ``scaling`` attribute to the background in Distribution XML.
51 Refer to Apple documentation for valid values.
52
53.. variable:: CPACK_PACKAGEMAKER_BACKGROUND_MIME_TYPE
54
55 Adds a ``mime-type`` attribute to the background in Distribution XML.
56 The option contains MIME type of an image.
57
58.. variable:: CPACK_PACKAGEMAKER_BACKGROUND_UTI
59
60 Adds an ``uti`` attribute to the background in Distribution XML.
61 The option contains UTI type of an image.
62
63.. variable:: CPACK_PACKAGEMAKER_BACKGROUND_DARKAQUA
64
65 Adds a background for the Dark Aqua theme to Distribution XML if
66 specified. The value contains the path to image in ``Resources``
67 directory.
68
69.. variable:: CPACK_PACKAGEMAKER_BACKGROUND_DARKAQUA_ALIGNMENT
70
71 Does the same as :variable:`CPACK_PACKAGEMAKER_BACKGROUND_ALIGNMENT` option,
72 but for the dark theme.
73
74.. variable:: CPACK_PACKAGEMAKER_BACKGROUND_DARKAQUA_SCALING
75
76 Does the same as :variable:`CPACK_PACKAGEMAKER_BACKGROUND_SCALING` option,
77 but for the dark theme.
78
79.. variable:: CPACK_PACKAGEMAKER_BACKGROUND_DARKAQUA_MIME_TYPE
80
81 Does the same as :variable:`CPACK_PACKAGEMAKER_BACKGROUND_MIME_TYPE` option,
82 but for the dark theme.
83
84.. variable:: CPACK_PACKAGEMAKER_BACKGROUND_DARKAQUA_UTI
85
86 Does the same as :variable:`CPACK_PACKAGEMAKER_BACKGROUND_UTI` option,
87 but for the dark theme.
88