CPackWIX.cmake 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270
  1. #.rst:
  2. # CPackWIX
  3. # --------
  4. #
  5. # CPack WiX generator specific options
  6. #
  7. # Variables specific to CPack WiX generator
  8. # ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  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. # identifier (GUID) to allow your installers to replace existing
  21. # installations that use the same GUID.
  22. #
  23. # You may for example explicitly set this variable in your
  24. # CMakeLists.txt to the value that has been generated per default. You
  25. # should not use GUIDs that you did not generate yourself or which may
  26. # 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. # The installer will abort if it detects a pre-existing installation that
  43. # 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. # If CPACK_RESOURCE_FILE_LICENSE has an .txt extension it is implicitly
  54. # converted to RTF by the WiX Generator.
  55. # The expected encoding of the .txt file is UTF-8.
  56. #
  57. # With CPACK_WIX_LICENSE_RTF you can override the license file used by the
  58. # WiX Generator in case CPACK_RESOURCE_FILE_LICENSE is in an unsupported
  59. # 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. # .. variable:: CPACK_WIX_UI_REF
  68. #
  69. # This variable allows you to override the Id of the ``<UIRef>`` element
  70. # in the WiX template.
  71. #
  72. # The default is ``WixUI_InstallDir`` in case no CPack components have
  73. # been defined and ``WixUI_FeatureTree`` otherwise.
  74. #
  75. # .. variable:: CPACK_WIX_UI_BANNER
  76. #
  77. # The bitmap will appear at the top of all installer pages other than the
  78. # 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. # If this variable is set, the installer will replace the default dialog
  89. # 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. # Languages are compiled into the WixUI extension library. To use them,
  104. # simply provide the name of the culture. If you specify more than one
  105. # culture identifier in a comma or semicolon delimited list, the first one
  106. # that is found will be used. You can find a list of supported languages at:
  107. # http://wix.sourceforge.net/manual-wix3/WixUI_localization.htm
  108. #
  109. # .. variable:: CPACK_WIX_TEMPLATE
  110. #
  111. # Template file for WiX generation
  112. #
  113. # If this variable is set, the specified template will be used to generate
  114. # the WiX wxs file. This should be used if further customization of the
  115. # output is required.
  116. #
  117. # If this variable is not set, the default MSI template included with CMake
  118. # will be used.
  119. #
  120. # .. variable:: CPACK_WIX_PATCH_FILE
  121. #
  122. # Optional list of XML files with fragments to be inserted into
  123. # generated WiX sources
  124. #
  125. # This optional variable can be used to specify an XML file that the
  126. # WiX generator will use to inject fragments into its generated
  127. # source files.
  128. #
  129. # Patch files understood by the CPack WiX generator
  130. # roughly follow this RELAX NG compact schema:
  131. #
  132. # .. code-block:: none
  133. #
  134. # start = CPackWiXPatch
  135. #
  136. # CPackWiXPatch = element CPackWiXPatch { CPackWiXFragment* }
  137. #
  138. # CPackWiXFragment = element CPackWiXFragment
  139. # {
  140. # attribute Id { string },
  141. # fragmentContent*
  142. # }
  143. #
  144. # fragmentContent = element * - CPackWiXFragment
  145. # {
  146. # (attribute * { text } | text | fragmentContent)*
  147. # }
  148. #
  149. # Currently fragments can be injected into most
  150. # Component, File and Directory elements.
  151. #
  152. # The following additional special Ids can be used:
  153. #
  154. # * ``#PRODUCT`` for the ``<Product>`` element.
  155. # * ``#PRODUCTFEATURE`` for the root ``<Feature>`` element.
  156. #
  157. # The following example illustrates how this works.
  158. #
  159. # Given that the WiX generator creates the following XML element:
  160. #
  161. # .. code-block:: xml
  162. #
  163. # <Component Id="CM_CP_applications.bin.my_libapp.exe" Guid="*"/>
  164. #
  165. # The following XML patch file may be used to inject an Environment element
  166. # into it:
  167. #
  168. # .. code-block:: xml
  169. #
  170. # <CPackWiXPatch>
  171. # <CPackWiXFragment Id="CM_CP_applications.bin.my_libapp.exe">
  172. # <Environment Id="MyEnvironment" Action="set"
  173. # Name="MyVariableName" Value="MyVariableValue"/>
  174. # </CPackWiXFragment>
  175. # </CPackWiXPatch>
  176. #
  177. # .. variable:: CPACK_WIX_EXTRA_SOURCES
  178. #
  179. # Extra WiX source files
  180. #
  181. # This variable provides an optional list of extra WiX source files (.wxs)
  182. # that should be compiled and linked. The full path to source files is
  183. # required.
  184. #
  185. # .. variable:: CPACK_WIX_EXTRA_OBJECTS
  186. #
  187. # Extra WiX object files or libraries
  188. #
  189. # This variable provides an optional list of extra WiX object (.wixobj)
  190. # and/or WiX library (.wixlib) files. The full path to objects and libraries
  191. # is required.
  192. #
  193. # .. variable:: CPACK_WIX_EXTENSIONS
  194. #
  195. # This variable provides a list of additional extensions for the WiX
  196. # tools light and candle.
  197. #
  198. # .. variable:: CPACK_WIX_<TOOL>_EXTENSIONS
  199. #
  200. # This is the tool specific version of CPACK_WIX_EXTENSIONS.
  201. # ``<TOOL>`` can be either LIGHT or CANDLE.
  202. #
  203. # .. variable:: CPACK_WIX_<TOOL>_EXTRA_FLAGS
  204. #
  205. # This list variable allows you to pass additional
  206. # flags to the WiX tool ``<TOOL>``.
  207. #
  208. # Use it at your own risk.
  209. # Future versions of CPack may generate flags which may be in conflict
  210. # with your own flags.
  211. #
  212. # ``<TOOL>`` can be either LIGHT or CANDLE.
  213. #
  214. # .. variable:: CPACK_WIX_CMAKE_PACKAGE_REGISTRY
  215. #
  216. # If this variable is set the generated installer will create
  217. # an entry in the windows registry key
  218. # ``HKEY_LOCAL_MACHINE\Software\Kitware\CMake\Packages\<package>``
  219. # The value for ``<package>`` is provided by this variable.
  220. #
  221. # Assuming you also install a CMake configuration file this will
  222. # allow other CMake projects to find your package with
  223. # the :command:`find_package` command.
  224. #
  225. # .. variable:: CPACK_WIX_PROPERTY_<PROPERTY>
  226. #
  227. # This variable can be used to provide a value for
  228. # the Windows Installer property ``<PROPERTY>``
  229. #
  230. # The following list contains some example properties that can be used to
  231. # customize information under
  232. # "Programs and Features" (also known as "Add or Remove Programs")
  233. #
  234. # * ARPCOMMENTS - Comments
  235. # * ARPHELPLINK - Help and support information URL
  236. # * ARPURLINFOABOUT - General information URL
  237. # * ARPURLUPDATEINFO - Update information URL
  238. # * ARPHELPTELEPHONE - Help and support telephone number
  239. # * ARPSIZE - Size (in kilobytes) of the application
  240. #=============================================================================
  241. # Copyright 2014-2015 Kitware, Inc.
  242. #
  243. # Distributed under the OSI-approved BSD License (the "License");
  244. # see accompanying file Copyright.txt for details.
  245. #
  246. # This software is distributed WITHOUT ANY WARRANTY; without even the
  247. # implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  248. # See the License for more information.
  249. #=============================================================================
  250. # (To distribute this file outside of CMake, substitute the full
  251. # License text for the above reference.)
  252. if(NOT CPACK_WIX_ROOT)
  253. file(TO_CMAKE_PATH "$ENV{WIX}" CPACK_WIX_ROOT)
  254. endif()
  255. find_program(CPACK_WIX_CANDLE_EXECUTABLE candle
  256. PATHS "${CPACK_WIX_ROOT}" PATH_SUFFIXES "bin")
  257. if(NOT CPACK_WIX_CANDLE_EXECUTABLE)
  258. message(FATAL_ERROR "Could not find the WiX candle executable.")
  259. endif()
  260. find_program(CPACK_WIX_LIGHT_EXECUTABLE light
  261. PATHS "${CPACK_WIX_ROOT}" PATH_SUFFIXES "bin")
  262. if(NOT CPACK_WIX_LIGHT_EXECUTABLE)
  263. message(FATAL_ERROR "Could not find the WiX light executable.")
  264. endif()