diff options
| author | Robert Maynard <robert.maynard@kitware.com> | 2014-12-18 19:56:37 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-11-13 13:45:59 (GMT) |
| commit | c4b9ee1878c62a272d38ae057e0a76409be54e8f (patch) | |
| tree | 25a5cab0a3da253cb6b9ac486e431c4a26699e81 /Modules | |
| parent | 167a465565cda9bb33d2e919509c23a761ea45e9 (diff) | |
| download | CMake-c4b9ee1878c62a272d38ae057e0a76409be54e8f.zip CMake-c4b9ee1878c62a272d38ae057e0a76409be54e8f.tar.gz CMake-c4b9ee1878c62a272d38ae057e0a76409be54e8f.tar.bz2 | |
CPack/DragNDrop: Update documentation to include new variables
Document the new behavior of `CPACK_DMG_BACKGROUND_IMAGE` and the
purpose of `CPACK_DMG_DS_STORE_SETUP_SCRIPT`.
Diffstat (limited to 'Modules')
| -rw-r--r-- | Modules/CPackDMG.cmake | 20 |
1 files changed, 15 insertions, 5 deletions
diff --git a/Modules/CPackDMG.cmake b/Modules/CPackDMG.cmake index 37d7352..6b5af7e 100644 --- a/Modules/CPackDMG.cmake +++ b/Modules/CPackDMG.cmake @@ -26,15 +26,25 @@ # Path to a custom DS_Store file. This .DS_Store file e.g. can be used to # specify the Finder window position/geometry and layout (such as hidden # toolbars, placement of the icons etc.). This file has to be generated by -# the Finder (either manually or through OSA-script) using a normal folder +# the Finder (either manually or through AppleScript) using a normal folder # from which the .DS_Store file can then be extracted. # +# .. variable:: CPACK_DMG_DS_STORE_SETUP_SCRIPT +# +# Path to a custom AppleScript file. This AppleScript is used to generate +# a .DS_Store file which specifies the Finder window position/geometry and +# layout (such as hidden toolbars, placement of the icons etc.). +# By specifying a custom AppleScript there is no need to use +# CPACK_DMG_DS_STORE, as the .DS_Store that is generated by the AppleScript +# will be packaged. +# # .. variable:: CPACK_DMG_BACKGROUND_IMAGE # -# Path to a background image file. This file will be used as the background -# for the Finder Window when the disk image is opened. By default no -# background image is set. The background image is applied after applying the -# custom .DS_Store file. +# Path to an image file to be used as the background. This file will be +# copied to .background/background.<ext>, where ext is the original image file +# extension. The background image is installed into the image before +# CPACK_DMG_DS_STORE_SETUP_SCRIPT is executed or CPACK_DMG_DS_STORE is +# installed. By default no background image is set. # # .. variable:: CPACK_DMG_SLA_DIR # |