1CPack DragNDrop Generator 2------------------------- 3 4The DragNDrop CPack generator (macOS) creates a DMG image. 5 6Variables specific to CPack DragNDrop generator 7^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 8 9The following variables are specific to the DragNDrop installers built 10on macOS: 11 12.. variable:: CPACK_DMG_VOLUME_NAME 13 14 The volume name of the generated disk image. Defaults to 15 CPACK_PACKAGE_FILE_NAME. 16 17.. variable:: CPACK_DMG_FORMAT 18 19 The disk image format. Common values are ``UDRO`` (UDIF read-only), ``UDZO`` (UDIF 20 zlib-compressed) or ``UDBZ`` (UDIF bzip2-compressed). Refer to ``hdiutil(1)`` for 21 more information on other available formats. Defaults to ``UDZO``. 22 23.. variable:: CPACK_DMG_DS_STORE 24 25 Path to a custom ``.DS_Store`` file. This ``.DS_Store`` file can be used to 26 specify the Finder window position/geometry and layout (such as hidden 27 toolbars, placement of the icons etc.). This file has to be generated by 28 the Finder (either manually or through AppleScript) using a normal folder 29 from which the ``.DS_Store`` file can then be extracted. 30 31.. variable:: CPACK_DMG_DS_STORE_SETUP_SCRIPT 32 33 .. versionadded:: 3.5 34 35 Path to a custom AppleScript file. This AppleScript is used to generate 36 a ``.DS_Store`` file which specifies the Finder window position/geometry and 37 layout (such as hidden toolbars, placement of the icons etc.). 38 By specifying a custom AppleScript there is no need to use 39 ``CPACK_DMG_DS_STORE``, as the ``.DS_Store`` that is generated by the AppleScript 40 will be packaged. 41 42.. variable:: CPACK_DMG_BACKGROUND_IMAGE 43 44 Path to an image file to be used as the background. This file will be 45 copied to ``.background``/``background.<ext>``, where ``<ext>`` is the original image file 46 extension. The background image is installed into the image before 47 ``CPACK_DMG_DS_STORE_SETUP_SCRIPT`` is executed or ``CPACK_DMG_DS_STORE`` is 48 installed. By default no background image is set. 49 50.. variable:: CPACK_DMG_DISABLE_APPLICATIONS_SYMLINK 51 52 .. versionadded:: 3.6 53 54 Default behavior is to include a symlink to ``/Applications`` in the DMG. 55 Set this option to ``ON`` to avoid adding the symlink. 56 57.. variable:: CPACK_DMG_SLA_DIR 58 59 .. versionadded:: 3.5 60 61 Directory where license and menu files for different languages are stored. 62 Setting this causes CPack to look for a ``<language>.menu.txt`` and 63 ``<language>.license.txt`` or ``<language>.license.rtf`` file for every 64 language defined in ``CPACK_DMG_SLA_LANGUAGES``. If both this variable and 65 ``CPACK_RESOURCE_FILE_LICENSE`` are set, CPack will only look for the menu 66 files and use the same license file for all languages. If both 67 ``<language>.license.txt`` and ``<language>.license.rtf`` exist, the ``.txt`` 68 file will be used. 69 70 .. versionadded:: 3.17 71 RTF support. 72 73.. variable:: CPACK_DMG_SLA_LANGUAGES 74 75 .. versionadded:: 3.5 76 77 Languages for which a license agreement is provided when mounting the 78 generated DMG. A menu file consists of 9 lines of text. The first line is 79 is the name of the language itself, uppercase, in English (e.g. German). 80 The other lines are translations of the following strings: 81 82 - Agree 83 - Disagree 84 - Print 85 - Save... 86 - You agree to the terms of the License Agreement when you click the 87 "Agree" button. 88 - Software License Agreement 89 - This text cannot be saved. The disk may be full or locked, or the file 90 may be locked. 91 - Unable to print. Make sure you have selected a printer. 92 93 For every language in this list, CPack will try to find files 94 ``<language>.menu.txt`` and ``<language>.license.txt`` in the directory 95 specified by the :variable:`CPACK_DMG_SLA_DIR` variable. 96 97.. variable:: CPACK_DMG_<component>_FILE_NAME 98 99 .. versionadded:: 3.17 100 101 File name when packaging ``<component>`` as its own DMG 102 (``CPACK_COMPONENTS_GROUPING`` set to IGNORE). 103 104 - Default: ``CPACK_PACKAGE_FILE_NAME-<component>`` 105 106.. variable:: CPACK_DMG_FILESYSTEM 107 108 .. versionadded:: 3.21 109 110 The filesystem format. Common values are ``APFS`` and ``HFS+``. 111 See ``man hdiutil`` for a full list of supported formats. 112 Defaults to ``HFS+``. 113 114.. variable:: CPACK_COMMAND_HDIUTIL 115 116 Path to the ``hdiutil(1)`` command used to operate on disk image files on 117 macOS. This variable can be used to override the automatically detected 118 command (or specify its location if the auto-detection fails to find it). 119 120.. variable:: CPACK_COMMAND_SETFILE 121 122 Path to the ``SetFile(1)`` command used to set extended attributes on files and 123 directories on macOS. This variable can be used to override the 124 automatically detected command (or specify its location if the 125 auto-detection fails to find it). 126 127.. variable:: CPACK_COMMAND_REZ 128 129 Path to the ``Rez(1)`` command used to compile resources on macOS. This 130 variable can be used to override the automatically detected command (or 131 specify its location if the auto-detection fails to find it). 132