diff options
author | Brad King <brad.king@kitware.com> | 2015-10-30 09:04:52 -0400 |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2015-10-30 09:09:40 -0400 |
commit | 9a7f042a955e814f66b8e468f934852ed53e0376 (patch) | |
tree | 879cd3eecbab8fff28a4a13265767340f5cddc97 /Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst | |
parent | 3187de20fd9949ab90df4651f5d1ae0d218a9afd (diff) | |
download | cmake-9a7f042a955e814f66b8e468f934852ed53e0376.tar.gz |
Help: Document target properties setting Info.plist fields (#15820)
Format the documentation of MACOSX_{BUNDLE,FRAMEWORK}_INFO_PLIST and
specify for each property what field in the Info.plist file it sets.
Diffstat (limited to 'Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst')
-rw-r--r-- | Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst | 40 |
1 files changed, 23 insertions, 17 deletions
diff --git a/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst index 097cce1869..07a933faf7 100644 --- a/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst +++ b/Help/prop_tgt/MACOSX_BUNDLE_INFO_PLIST.rst @@ -1,29 +1,35 @@ MACOSX_BUNDLE_INFO_PLIST ------------------------ -Specify a custom Info.plist template for a Mac OS X App Bundle. +Specify a custom ``Info.plist`` template for a Mac OS X App Bundle. -An executable target with MACOSX_BUNDLE enabled will be built as an -application bundle on Mac OS X. By default its Info.plist file is -created by configuring a template called MacOSXBundleInfo.plist.in -located in the CMAKE_MODULE_PATH. This property specifies an -alternative template file name which may be a full path. +An executable target with :prop_tgt:`MACOSX_BUNDLE` enabled will be built as an +application bundle on Mac OS X. By default its ``Info.plist`` file is created +by configuring a template called ``MacOSXBundleInfo.plist.in`` located in the +:variable:`CMAKE_MODULE_PATH`. This property specifies an alternative template +file name which may be a full path. The following target properties may be set to specify content to be configured into the file: -:: - - MACOSX_BUNDLE_INFO_STRING - MACOSX_BUNDLE_ICON_FILE - MACOSX_BUNDLE_GUI_IDENTIFIER - MACOSX_BUNDLE_LONG_VERSION_STRING - MACOSX_BUNDLE_BUNDLE_NAME - MACOSX_BUNDLE_SHORT_VERSION_STRING - MACOSX_BUNDLE_BUNDLE_VERSION - MACOSX_BUNDLE_COPYRIGHT +``MACOSX_BUNDLE_BUNDLE_NAME`` + Sets ``CFBundleName``. +``MACOSX_BUNDLE_BUNDLE_VERSION`` + Sets ``CFBundleVersion``. +``MACOSX_BUNDLE_COPYRIGHT`` + Sets ``NSHumanReadableCopyright``. +``MACOSX_BUNDLE_GUI_IDENTIFIER`` + Sets ``CFBundleIdentifier``. +``MACOSX_BUNDLE_ICON_FILE`` + Sets ``CFBundleIconFile``. +``MACOSX_BUNDLE_INFO_STRING`` + Sets ``CFBundleGetInfoString``. +``MACOSX_BUNDLE_LONG_VERSION_STRING`` + Sets ``CFBundleLongVersionString``. +``MACOSX_BUNDLE_SHORT_VERSION_STRING`` + Sets ``CFBundleShortVersionString``. CMake variables of the same name may be set to affect all targets in a directory that do not have each specific property set. If a custom -Info.plist is specified by this property it may of course hard-code +``Info.plist`` is specified by this property it may of course hard-code all the settings instead of using the target properties. |