summaryrefslogtreecommitdiffstats
path: root/Modules/CPackNSIS.cmake
diff options
context:
space:
mode:
authorKitware Robot <kwrobot@kitware.com>2013-10-15 17:23:23 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-16 13:22:39 (GMT)
commita77e3086938d46c56f62901531245711dbd55cc4 (patch)
tree310f64bed6b69c741cbd1ec4e2be8177004d86e2 /Modules/CPackNSIS.cmake
parente7ca48f226782e7354a7ea9d6f9cef58e8773306 (diff)
downloadCMake-a77e3086938d46c56f62901531245711dbd55cc4.zip
CMake-a77e3086938d46c56f62901531245711dbd55cc4.tar.gz
CMake-a77e3086938d46c56f62901531245711dbd55cc4.tar.bz2
CPack: Replace #<type> markup with reStructuredText equivalent
Drop #end and #module. Convert #section to a subsection header. Convert #variable to the cmake domain "variable" directive. Convert #macro to the cmake domain "command" directive. Perform minor formatting fixes in text near these changes.
Diffstat (limited to 'Modules/CPackNSIS.cmake')
-rw-r--r--Modules/CPackNSIS.cmake231
1 files changed, 67 insertions, 164 deletions
diff --git a/Modules/CPackNSIS.cmake b/Modules/CPackNSIS.cmake
index 717bf92..9d23ec0 100644
--- a/Modules/CPackNSIS.cmake
+++ b/Modules/CPackNSIS.cmake
@@ -4,216 +4,119 @@
#
# CPack NSIS generator specific options
#
-# #section Variables specific to CPack NSIS generator #end #module
+# Variables specific to CPack NSIS generator
+# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
#
# The following variables are specific to the graphical installers built
-# on Windows using the Nullsoft Installation System. #end
+# on Windows using the Nullsoft Installation System.
#
-# #variable
+# .. variable:: CPACK_NSIS_INSTALL_ROOT
#
-# ::
+# The default installation directory presented to the end user by the NSIS
+# installer is under this root dir. The full directory presented to the end
+# user is: ${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY}
#
-# CPACK_NSIS_INSTALL_ROOT - The default installation directory presented
-# to the end user by the NSIS installer is under this root dir. The full
-# directory presented to the end user is:
-# ${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY}
+# .. variable:: CPACK_NSIS_MUI_ICON
#
-# #end
+# An icon filename. The name of a ``*.ico`` file used as the main icon for the
+# generated install program.
#
-# #variable
+# .. variable:: CPACK_NSIS_MUI_UNIICON
#
-# ::
+# An icon filename. The name of a ``*.ico`` file used as the main icon for the
+# generated uninstall program.
#
-# CPACK_NSIS_MUI_ICON - An icon filename.
-# The name of a *.ico file used as the main icon for the generated
-# install program.
+# .. variable:: CPACK_NSIS_INSTALLER_MUI_ICON_CODE
#
-# #end
+# undocumented.
#
-# #variable
+# .. variable:: CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS
#
-# ::
+# Extra NSIS commands that will be added to the beginning of the install
+# Section, before your install tree is available on the target system.
#
-# CPACK_NSIS_MUI_UNIICON - An icon filename.
-# The name of a *.ico file used as the main icon for the generated
-# uninstall program.
+# .. variable:: CPACK_NSIS_EXTRA_INSTALL_COMMANDS
#
-# #end
+# Extra NSIS commands that will be added to the end of the install Section,
+# after your install tree is available on the target system.
#
-# #variable
+# .. variable:: CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
#
-# ::
+# Extra NSIS commands that will be added to the uninstall Section, before
+# your install tree is removed from the target system.
#
-# CPACK_NSIS_INSTALLER_MUI_ICON_CODE - undocumented.
+# .. variable:: CPACK_NSIS_COMPRESSOR
#
-# #end
+# The arguments that will be passed to the NSIS SetCompressor command.
#
-# #variable
+# .. variable:: CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL
#
-# ::
+# Ask about uninstalling previous versions first. If this is set to "ON",
+# then an installer will look for previous installed versions and if one is
+# found, ask the user whether to uninstall it before proceeding with the
+# install.
#
-# CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS - Extra NSIS commands that
-# will be added to the beginning of the install Section, before your
-# install tree is available on the target system.
+# .. variable:: CPACK_NSIS_MODIFY_PATH
#
-# #end
+# Modify PATH toggle. If this is set to "ON", then an extra page will appear
+# in the installer that will allow the user to choose whether the program
+# directory should be added to the system PATH variable.
#
-# #variable
+# .. variable:: CPACK_NSIS_DISPLAY_NAME
#
-# ::
+# The display name string that appears in the Windows Add/Remove Program
+# control panel
#
-# CPACK_NSIS_EXTRA_INSTALL_COMMANDS - Extra NSIS commands that
-# will be added to the end of the install Section, after your
-# install tree is available on the target system.
+# .. variable:: CPACK_NSIS_PACKAGE_NAME
#
-# #end
+# The title displayed at the top of the installer.
#
-# #variable
+# .. variable:: CPACK_NSIS_INSTALLED_ICON_NAME
#
-# ::
+# A path to the executable that contains the installer icon.
#
-# CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS - Extra NSIS commands that will
-# be added to the uninstall Section, before your install tree is
-# removed from the target system.
+# .. variable:: CPACK_NSIS_HELP_LINK
#
-# #end
+# URL to a web site providing assistance in installing your application.
#
-# #variable
+# .. variable:: CPACK_NSIS_URL_INFO_ABOUT
#
-# ::
+# URL to a web site providing more information about your application.
#
-# CPACK_NSIS_COMPRESSOR - The arguments that will be passed to the
-# NSIS SetCompressor command.
+# .. variable:: CPACK_NSIS_CONTACT
#
-# #end
+# Contact information for questions and comments about the installation
+# process.
#
-# #variable
+# .. variable:: CPACK_NSIS_CREATE_ICONS_EXTRA
#
-# ::
+# Additional NSIS commands for creating start menu shortcuts.
#
-# CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL - Ask about uninstalling
-# previous versions first.
-# If this is set to "ON", then an installer will look for previous
-# installed versions and if one is found, ask the user whether to
-# uninstall it before proceeding with the install.
+# .. variable:: CPACK_NSIS_DELETE_ICONS_EXTRA
#
-# #end
+# Additional NSIS commands to uninstall start menu shortcuts.
#
-# #variable
+# .. variable:: CPACK_NSIS_EXECUTABLES_DIRECTORY
#
-# ::
+# Creating NSIS start menu links assumes that they are in 'bin' unless this
+# variable is set. For example, you would set this to 'exec' if your
+# executables are in an exec directory.
#
-# CPACK_NSIS_MODIFY_PATH - Modify PATH toggle.
-# If this is set to "ON", then an extra page
-# will appear in the installer that will allow the user to choose
-# whether the program directory should be added to the system PATH
-# variable.
+# .. variable:: CPACK_NSIS_MUI_FINISHPAGE_RUN
#
-# #end
+# Specify an executable to add an option to run on the finish page of the
+# NSIS installer.
#
-# #variable
+# .. variable:: CPACK_NSIS_MENU_LINKS
#
-# ::
+# Specify links in [application] menu. This should contain a list of pair
+# "link" "link name". The link may be an URL or a path relative to
+# installation prefix. Like::
#
-# CPACK_NSIS_DISPLAY_NAME - The display name string that appears in
-# the Windows Add/Remove Program control panel
+# set(CPACK_NSIS_MENU_LINKS
+# "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html" "CMake Help"
+# "http://www.cmake.org" "CMake Web Site")
#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_PACKAGE_NAME - The title displayed at the top of the
-# installer.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_INSTALLED_ICON_NAME - A path to the executable that
-# contains the installer icon.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_HELP_LINK - URL to a web site providing assistance in
-# installing your application.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_URL_INFO_ABOUT - URL to a web site providing more
-# information about your application.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_CONTACT - Contact information for questions and comments
-# about the installation process.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_CREATE_ICONS_EXTRA - Additional NSIS commands for
-# creating start menu shortcuts.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_DELETE_ICONS_EXTRA -Additional NSIS commands to
-# uninstall start menu shortcuts.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_EXECUTABLES_DIRECTORY - Creating NSIS start menu links
-# assumes that they are in 'bin' unless this variable is set.
-# For example, you would set this to 'exec' if your executables are
-# in an exec directory.
-#
-# #end
-#
-# #variable
-#
-# ::
-#
-# CPACK_NSIS_MUI_FINISHPAGE_RUN - Specify an executable to add an option
-# to run on the finish page of the NSIS installer.
-#
-# #end #variable
-#
-# ::
-#
-# CPACK_NSIS_MENU_LINKS - Specify links in [application] menu.
-# This should contain a list of pair "link" "link name". The link
-# may be an URL or a path relative to installation prefix.
-# Like:
-# set(CPACK_NSIS_MENU_LINKS
-# "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html" "CMake Help"
-# "http://www.cmake.org" "CMake Web Site")
-#
-# #end
#=============================================================================
# Copyright 2006-2009 Kitware, Inc.