CPackWIX.cmake 8.42 KB
Newer Older
1 2 3 4 5 6
#.rst:
# CPackWIX
# --------
#
# CPack WiX generator specific options
#
7 8
# Variables specific to CPack WiX generator
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9 10
#
# The following variables are specific to the installers built on
11
# Windows using WiX.
12
#
13
# .. variable:: CPACK_WIX_UPGRADE_GUID
14
#
15
#  Upgrade GUID (``Product/@UpgradeCode``)
16
#
17
#  Will be automatically generated unless explicitly provided.
18
#
19
#  It should be explicitly set to a constant generated globally unique
20 21
#  identifier (GUID) to allow your installers to replace existing
#  installations that use the same GUID.
22
#
23 24 25 26
#  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.
27
#
28
#  A GUID shall have the following fixed length syntax::
29
#
30
#   XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX
31
#
32
#  (each X represents an uppercase hexadecimal digit)
33
#
34
# .. variable:: CPACK_WIX_PRODUCT_GUID
35
#
36
#  Product GUID (``Product/@Id``)
37
#
38
#  Will be automatically generated unless explicitly provided.
39
#
40
#  If explicitly provided this will set the Product Id of your installer.
41
#
42 43
#  The installer will abort if it detects a pre-existing installation that
#  uses the same GUID.
44
#
45
#  The GUID shall use the syntax described for CPACK_WIX_UPGRADE_GUID.
46
#
47
# .. variable:: CPACK_WIX_LICENSE_RTF
48
#
49
#  RTF License File
50
#
51
#  If CPACK_RESOURCE_FILE_LICENSE has an .rtf extension it is used as-is.
52
#
53 54
#  If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is implicitly
#  converted to RTF by the WiX Generator.
55
#  The expected encoding of the .txt file is UTF-8.
56
#
57 58 59
#  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.
60
#
61
# .. variable:: CPACK_WIX_PRODUCT_ICON
62
#
63
#  The Icon shown next to the program name in Add/Remove programs.
64
#
65
#  If set, this icon is used in place of the default icon.
66
#
67 68 69 70 71 72 73 74
# .. variable:: CPACK_WIX_UI_REF
#
#  This variable allows you to override the Id of the ``<UIRef>`` element
#  in the WiX template.
#
#  The default is ``WixUI_InstallDir`` in case no CPack components have
#  been defined and ``WixUI_FeatureTree`` otherwise.
#
75
# .. variable:: CPACK_WIX_UI_BANNER
76
#
77 78
#  The bitmap will appear at the top of all installer pages other than the
#  welcome and completion dialogs.
79
#
80
#  If set, this image will replace the default banner image.
81
#
82
#  This image must be 493 by 58 pixels.
83
#
84
# .. variable:: CPACK_WIX_UI_DIALOG
85
#
86
#  Background bitmap used on the welcome and completion dialogs.
87
#
88 89
#  If this variable is set, the installer will replace the default dialog
#  image.
90
#
91
#  This image must be 493 by 312 pixels.
92
#
93
# .. variable:: CPACK_WIX_PROGRAM_MENU_FOLDER
94
#
95
#  Start menu folder name for launcher.
96
#
97
#  If this variable is not set, it will be initialized with CPACK_PACKAGE_NAME
98
#
99
# .. variable:: CPACK_WIX_CULTURES
100
#
101
#  Language(s) of the installer
102
#
103 104 105 106 107
#  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
108
#
109
# .. variable:: CPACK_WIX_TEMPLATE
110
#
111
#  Template file for WiX generation
112
#
113 114 115
#  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.
116
#
117 118
#  If this variable is not set, the default MSI template included with CMake
#  will be used.
119
#
120 121
# .. variable:: CPACK_WIX_PATCH_FILE
#
122 123
#  Optional list of XML files with fragments to be inserted into
#  generated WiX sources
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
#
#  This optional variable can be used to specify an XML file that the
#  WiX generator will use to inject fragments into its generated
#  source files.
#
#  Patch files understood by the CPack WiX generator
#  roughly follow this RELAX NG compact schema:
#
#  .. code-block:: none
#
#     start = CPackWiXPatch
#
#     CPackWiXPatch = element CPackWiXPatch { CPackWiXFragment* }
#
#     CPackWiXFragment = element CPackWiXFragment
#     {
#         attribute Id { string },
#         fragmentContent*
#     }
#
#     fragmentContent = element * - CPackWiXFragment
#     {
#         (attribute * { text } | text | fragmentContent)*
#     }
#
#  Currently fragments can be injected into most
#  Component, File and Directory elements.
#
152 153 154 155
#  The following additional special Ids can be used:
#
#  * ``#PRODUCT`` for the ``<Product>`` element.
#  * ``#PRODUCTFEATURE`` for the root ``<Feature>`` element.
156
#
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
#  The following example illustrates how this works.
#
#  Given that the WiX generator creates the following XML element:
#
#  .. code-block:: xml
#
#     <Component Id="CM_CP_applications.bin.my_libapp.exe" Guid="*"/>
#
#  The following XML patch file may be used to inject an Environment element
#  into it:
#
#  .. code-block:: xml
#
#     <CPackWiXPatch>
#       <CPackWiXFragment Id="CM_CP_applications.bin.my_libapp.exe">
#         <Environment Id="MyEnvironment" Action="set"
#           Name="MyVariableName" Value="MyVariableValue"/>
#       </CPackWiXFragment>
#     </CPackWiXPatch>
#
177
# .. variable:: CPACK_WIX_EXTRA_SOURCES
178
#
179
#  Extra WiX source files
180
#
181 182 183
#  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.
184
#
185
# .. variable:: CPACK_WIX_EXTRA_OBJECTS
186
#
187
#  Extra WiX object files or libraries
188
#
189 190 191
#  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.
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
#
# .. variable:: CPACK_WIX_EXTENSIONS
#
#  This variable provides a list of additional extensions for the WiX
#  tools light and candle.
#
# .. variable:: CPACK_WIX_<TOOL>_EXTENSIONS
#
#  This is the tool specific version of CPACK_WIX_EXTENSIONS.
#  ``<TOOL>`` can be either LIGHT or CANDLE.
#
# .. variable:: CPACK_WIX_<TOOL>_EXTRA_FLAGS
#
#  This list variable allows you to pass additional
#  flags to the WiX tool ``<TOOL>``.
#
#  Use it at your own risk.
#  Future versions of CPack may generate flags which may be in conflict
#  with your own flags.
#
#  ``<TOOL>`` can be either LIGHT or CANDLE.
#
214 215 216 217 218 219 220 221 222 223 224
# .. variable:: CPACK_WIX_CMAKE_PACKAGE_REGISTRY
#
#  If this variable is set the generated installer will create
#  an entry in the windows registry key
#  ``HKEY_LOCAL_MACHINE\Software\Kitware\CMake\Packages\<package>``
#  The value for ``<package>`` is provided by this variable.
#
#  Assuming you also install a CMake configuration file this will
#  allow other CMake projects to find your package with
#  the :command:`find_package` command.
#
225 226 227 228 229
# .. variable:: CPACK_WIX_PROPERTY_<PROPERTY>
#
#  This variable can be used to provide a value for
#  the Windows Installer property ``<PROPERTY>``
#
230
#  The following list contains some example properties that can be used to
231 232 233 234 235 236 237 238 239
#  customize information under
#  "Programs and Features" (also known as "Add or Remove Programs")
#
#  * ARPCOMMENTS - Comments
#  * ARPHELPLINK - Help and support information URL
#  * ARPURLINFOABOUT - General information URL
#  * URLUPDATEINFO - Update information URL
#  * ARPHELPTELEPHONE - Help and support telephone number
#  * ARPSIZE - Size (in kilobytes) of the application
240 241

#=============================================================================
242
# Copyright 2014-2015 Kitware, Inc.
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270
#
# Distributed under the OSI-approved BSD License (the "License");
# see accompanying file Copyright.txt for details.
#
# This software is distributed WITHOUT ANY WARRANTY; without even the
# implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the License for more information.
#=============================================================================
# (To distribute this file outside of CMake, substitute the full
#  License text for the above reference.)

if(NOT CPACK_WIX_ROOT)
  file(TO_CMAKE_PATH "$ENV{WIX}" CPACK_WIX_ROOT)
endif()

find_program(CPACK_WIX_CANDLE_EXECUTABLE candle
  PATHS "${CPACK_WIX_ROOT}/bin")

if(NOT CPACK_WIX_CANDLE_EXECUTABLE)
  message(FATAL_ERROR "Could not find the WiX candle executable.")
endif()

find_program(CPACK_WIX_LIGHT_EXECUTABLE light
  PATHS "${CPACK_WIX_ROOT}/bin")

if(NOT CPACK_WIX_LIGHT_EXECUTABLE)
  message(FATAL_ERROR "Could not find the WiX light executable.")
endif()