diff options
Diffstat (limited to 'Modules/CPackWIX.cmake')
| -rw-r--r-- | Modules/CPackWIX.cmake | 173 |
1 files changed, 97 insertions, 76 deletions
diff --git a/Modules/CPackWIX.cmake b/Modules/CPackWIX.cmake index fce25f0..7c7d924 100644 --- a/Modules/CPackWIX.cmake +++ b/Modules/CPackWIX.cmake @@ -1,107 +1,128 @@ -##section Variables specific to CPack WiX generator -##end -##module -# - CPack WiX generator specific options -# -# The following variables are specific to the installers built -# on Windows using WiX. -##end -##variable -# CPACK_WIX_UPGRADE_GUID - Upgrade GUID (Product/@UpgradeCode) -# -# Will be automatically generated unless explicitly provided. -# -# It should be explicitly set to a constant generated -# gloabally unique identifier (GUID) to allow your installers -# to replace existing installations that use the same GUID. -# -# You may for example explicitly set this variable in -# your CMakeLists.txt to the value that has been generated per default. -# You should not use GUIDs that you did not generate yourself or which may -# belong to other projects. -# -# A GUID shall have the following fixed length syntax: -# XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +#.rst: +# CPackWIX +# -------- +# +# CPack WiX generator specific options +# +# Variables specific to CPack WiX generator +# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +# +# The following variables are specific to the installers built on +# Windows using WiX. +# +# .. variable:: CPACK_WIX_UPGRADE_GUID +# +# Upgrade GUID (Product/@UpgradeCode) +# +# Will be automatically generated unless explicitly provided. +# +# It should be explicitly set to a constant generated gloabally unique +# identifier (GUID) to allow your installers to replace existing +# installations that use the same GUID. +# +# You may for example explicitly set this variable in your +# CMakeLists.txt to the value that has been generated per default. You +# should not use GUIDs that you did not generate yourself or which may +# belong to other projects. +# +# A GUID shall have the following fixed length syntax:: +# +# XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX +# # (each X represents an uppercase hexadecimal digit) -##end -##variable -# CPACK_WIX_PRODUCT_GUID - Product GUID (Product/@Id) # -# Will be automatically generated unless explicitly provided. +# .. variable:: CPACK_WIX_PRODUCT_GUID +# +# Product GUID (Product/@Id) +# +# Will be automatically generated unless explicitly provided. +# +# If explicitly provided this will set the Product Id of your installer. +# +# The installer will abort if it detects a pre-existing installation that +# uses the same GUID. +# +# The GUID shall use the syntax described for CPACK_WIX_UPGRADE_GUID. +# +# .. variable:: CPACK_WIX_LICENSE_RTF +# +# RTF License File +# +# If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension it is used as-is. +# +# If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is implicitly +# converted to RTF by the WiX Generator. +# +# With CPACK_WIX_LICENSE_RTF you can override the license file used by the +# WiX Generator in case CPACK_RESOURCE_FILE_LICENSE is in an unsupported +# format or the .txt -> .rtf conversion does not work as expected. +# +# .. variable:: CPACK_WIX_PRODUCT_ICON # -# If explicitly provided this will set the Product Id of your installer. +# The Icon shown next to the program name in Add/Remove programs. # -# The installer will abort if it detects a pre-existing installation that uses -# the same GUID. +# If set, this icon is used in place of the default icon. # -# The GUID shall use the syntax described for CPACK_WIX_UPGRADE_GUID. -##end -##variable -# CPACK_WIX_LICENSE_RTF - RTF License File +# .. variable:: CPACK_WIX_UI_BANNER # -# If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension -# it is used as-is. +# The bitmap will appear at the top of all installer pages other than the +# welcome and completion dialogs. # -# If CPACK_RESOURCE_FILE_LICENSE has an .txt extension -# it is implicitly converted to RTF by the WiX Generator. +# If set, this image will replace the default banner image. # -# With CPACK_WIX_LICENSE_RTF you can override the license file used -# by the WiX Generator in case CPACK_RESOURCE_FILE_LICENSE -# is in an unsupported format or the .txt -> .rtf -# conversion does not work as expected. +# This image must be 493 by 58 pixels. # -##end +# .. variable:: CPACK_WIX_UI_DIALOG # -##variable -# CPACK_WIX_PRODUCT_ICON - The Icon shown next to the program name in Add/Remove programs. +# Background bitmap used on the welcome and completion dialogs. # -# If set, this icon is used in place of the default icon. +# If this variable is set, the installer will replace the default dialog +# image. # -##end +# This image must be 493 by 312 pixels. # -##variable -# CPACK_WIX_UI_BANNER - The bitmap will appear at the top of all installer pages other than the welcome and completion dialogs. +# .. variable:: CPACK_WIX_PROGRAM_MENU_FOLDER # -# If set, this image will replace the default banner image. +# Start menu folder name for launcher. # -# This image must be 493 by 58 pixels. +# If this variable is not set, it will be initialized with CPACK_PACKAGE_NAME # -##end +# .. variable:: CPACK_WIX_CULTURES # -##variable -# CPACK_WIX_UI_DIALOG - Background bitmap used on the welcome and completion dialogs. +# Language(s) of the installer # -# If this variable is set, the installer will replace the default dialog image. +# Languages are compiled into the WixUI extension library. To use them, +# simply provide the name of the culture. If you specify more than one +# culture identifier in a comma or semicolon delimited list, the first one +# that is found will be used. You can find a list of supported languages at: +# http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm # -# This image must be 493 by 312 pixels. +# .. variable:: CPACK_WIX_TEMPLATE # -##end +# Template file for WiX generation # -##variable -# CPACK_WIX_PROGRAM_MENU_FOLDER - Start menu folder name for launcher. +# If this variable is set, the specified template will be used to generate +# the WiX wxs file. This should be used if further customization of the +# output is required. # -# If this variable is not set, it will be initialized with CPACK_PACKAGE_NAME +# If this variable is not set, the default MSI template included with CMake +# will be used. # -##end -##variable -# CPACK_WIX_CULTURES - Language(s) of the installer +# .. variable:: CPACK_WIX_EXTRA_SOURCES # -# Languages are compiled into the WixUI extension library. To use them, -# simply provide the name of the culture. If you specify more than one -# culture identifier in a comma or semicolon delimited list, the first one -# that is found will be used. You can find a list of supported languages at: -# http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm +# Extra WiX source files # -##end -##variable -# CPACK_WIX_TEMPLATE - Template file for WiX generation +# This variable provides an optional list of extra WiX source files (.wxs) +# that should be compiled and linked. The full path to source files is +# required. # -# If this variable is set, the specified template will be used to generate the WiX wxs file. -# This should be used if further customization of the output is required. +# .. variable:: CPACK_WIX_EXTRA_OBJECTS # -# If this variable is not set, the default MSI template included with CMake will be used. +# Extra WiX object files or libraries # -##end +# This variable provides an optional list of extra WiX object (.wixobj) +# and/or WiX library (.wixlib) files. The full path to objects and libraries +# is required. #============================================================================= # Copyright 2012 Kitware, Inc. |