summaryrefslogtreecommitdiff
path: root/Modules/CPackWIX.cmake
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 11:17:36 -0400
committerBrad King <brad.king@kitware.com>2013-10-15 14:12:03 -0400
commitf051814ed0e63badbfd68049354f36259dbf4b49 (patch)
treef4e6f885f86c882d723a7dd53d2b702d0c7fdffb /Modules/CPackWIX.cmake
parente94958e99c4dec26c86ce8b76d744c04ba960675 (diff)
downloadcmake-f051814ed0e63badbfd68049354f36259dbf4b49.tar.gz
Convert builtin help to reStructuredText source files
Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
Diffstat (limited to 'Modules/CPackWIX.cmake')
-rw-r--r--Modules/CPackWIX.cmake155
1 files changed, 86 insertions, 69 deletions
diff --git a/Modules/CPackWIX.cmake b/Modules/CPackWIX.cmake
index 604eb370ca..2634f5f04b 100644
--- a/Modules/CPackWIX.cmake
+++ b/Modules/CPackWIX.cmake
@@ -1,121 +1,138 @@
-##section Variables specific to CPack WiX generator
-##end
-##module
-# - CPack WiX generator specific options
+#.rst:
+# CPackWIX
+# --------
+#
+# CPack WiX generator specific options
+#
+# #section Variables specific to CPack WiX generator #end #module
+#
+# The following variables are specific to the installers built on
+# Windows using WiX. #end #variable
+#
+# ::
+#
+# CPACK_WIX_UPGRADE_GUID - Upgrade GUID (Product/@UpgradeCode)
+#
#
-# 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.
+# 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
+# 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)
+#
+# ::
+#
+# (each X represents an uppercase hexadecimal digit)
+#
+# #end #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 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.
-##end
-##variable
-# CPACK_WIX_LICENSE_RTF - RTF License File
+# #end #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 .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.
+# 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.
+# 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.
#
-##end
+# #end
#
-##variable
-# CPACK_WIX_PRODUCT_ICON - The Icon shown next to the program name in Add/Remove programs.
+# #variable CPACK_WIX_PRODUCT_ICON - The Icon shown next to the program
+# name in Add/Remove programs.
#
# If set, this icon is used in place of the default icon.
#
-##end
+# #end
#
-##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_UI_BANNER - The bitmap will appear at the top of
+# all installer pages other than the welcome and completion dialogs.
#
# If set, this image will replace the default banner image.
#
# This image must be 493 by 58 pixels.
#
-##end
+# #end
#
-##variable
-# CPACK_WIX_UI_DIALOG - Background bitmap used on the welcome and completion dialogs.
+# #variable CPACK_WIX_UI_DIALOG - Background bitmap used on the welcome
+# and completion dialogs.
#
-# If this variable is set, the installer will replace the default dialog image.
+# If this variable is set, the installer will replace the default dialog
+# image.
#
# This image must be 493 by 312 pixels.
#
-##end
+# #end
#
-##variable
-# CPACK_WIX_PROGRAM_MENU_FOLDER - Start menu folder name for launcher.
+# #variable CPACK_WIX_PROGRAM_MENU_FOLDER - Start menu folder name for
+# launcher.
#
-# If this variable is not set, it will be initialized with CPACK_PACKAGE_NAME
+# If this variable is not set, it will be initialized with
+# CPACK_PACKAGE_NAME
#
-##end
-##variable
-# CPACK_WIX_CULTURES - Language(s) of the installer
+# #end #variable CPACK_WIX_CULTURES - Language(s) of the installer
#
-# Languages are compiled into the WixUI extension library. To use them,
+# 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:
+# 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
#
-##end
-##variable
-# CPACK_WIX_TEMPLATE - Template file for WiX generation
+# #end #variable CPACK_WIX_TEMPLATE - Template file for WiX generation
#
-# 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 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, the default MSI template included with CMake will be used.
+# If this variable is not set, the default MSI template included with
+# CMake will be used.
#
-##end
-##variable
-# CPACK_WIX_EXTRA_SOURCES - Extra WiX source files
+# #end #variable CPACK_WIX_EXTRA_SOURCES - Extra WiX source files
#
-# 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.
+# 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.
#
-##end
-##variable
-# CPACK_WIX_EXTRA_OBJECTS - Extra WiX object files or libraries
+# #end #variable CPACK_WIX_EXTRA_OBJECTS - Extra WiX object files or
+# libraries
#
-# 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.
+# 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.
#
-##end
+# #end
#=============================================================================
# Copyright 2012 Kitware, Inc.