packagemaker.rst 2.9 KB

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