CPackNSIS.cmake 4.78 KB
Newer Older
1 2 3 4 5 6
#.rst:
# CPackNSIS
# ---------
#
# CPack NSIS generator specific options
#
7 8
# Variables specific to CPack NSIS generator
# ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
9 10
#
# The following variables are specific to the graphical installers built
11
# on Windows using the Nullsoft Installation System.
12
#
13
# .. variable:: CPACK_NSIS_INSTALL_ROOT
14
#
15 16 17
#  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}
18
#
19
# .. variable:: CPACK_NSIS_MUI_ICON
20
#
21 22
#  An icon filename.  The name of a ``*.ico`` file used as the main icon for the
#  generated install program.
23
#
24
# .. variable:: CPACK_NSIS_MUI_UNIICON
25
#
26 27
#  An icon filename.  The name of a ``*.ico`` file used as the main icon for the
#  generated uninstall program.
28
#
29
# .. variable:: CPACK_NSIS_INSTALLER_MUI_ICON_CODE
30
#
31
#  undocumented.
32
#
33 34 35 36 37 38 39 40
# .. variable:: CPACK_NSIS_MUI_WELCOMEFINISHPAGE_BITMAP
#
#  The filename of a bitmap to use as the NSIS MUI_WELCOMEFINISHPAGE_BITMAP.
#
# .. variable:: CPACK_NSIS_MUI_UNWELCOMEFINISHPAGE_BITMAP
#
#  The filename of a bitmap to use as the NSIS MUI_UNWELCOMEFINISHPAGE_BITMAP.
#
41
# .. variable:: CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS
42
#
43 44
#  Extra NSIS commands that will be added to the beginning of the install
#  Section, before your install tree is available on the target system.
45
#
46
# .. variable:: CPACK_NSIS_EXTRA_INSTALL_COMMANDS
47
#
48 49
#  Extra NSIS commands that will be added to the end of the install Section,
#  after your install tree is available on the target system.
50
#
51
# .. variable:: CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
52
#
53 54
#  Extra NSIS commands that will be added to the uninstall Section, before
#  your install tree is removed from the target system.
55
#
56
# .. variable:: CPACK_NSIS_COMPRESSOR
57
#
58
#  The arguments that will be passed to the NSIS SetCompressor command.
59
#
60
# .. variable:: CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL
61
#
62 63 64 65
#  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.
66
#
67
# .. variable:: CPACK_NSIS_MODIFY_PATH
68
#
69 70 71
#  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.
72
#
73
# .. variable:: CPACK_NSIS_DISPLAY_NAME
74
#
75 76
#  The display name string that appears in the Windows Add/Remove Program
#  control panel
77
#
78
# .. variable:: CPACK_NSIS_PACKAGE_NAME
79
#
80
#  The title displayed at the top of the installer.
81
#
82
# .. variable:: CPACK_NSIS_INSTALLED_ICON_NAME
83
#
84
#  A path to the executable that contains the installer icon.
85
#
86
# .. variable:: CPACK_NSIS_HELP_LINK
87
#
88
#  URL to a web site providing assistance in installing your application.
89
#
90
# .. variable:: CPACK_NSIS_URL_INFO_ABOUT
91
#
92
#  URL to a web site providing more information about your application.
93
#
94
# .. variable:: CPACK_NSIS_CONTACT
95
#
96 97
#  Contact information for questions and comments about the installation
#  process.
98
#
99
# .. variable:: CPACK_NSIS_CREATE_ICONS_EXTRA
100
#
101
#  Additional NSIS commands for creating start menu shortcuts.
102
#
103
# .. variable:: CPACK_NSIS_DELETE_ICONS_EXTRA
104
#
105
#  Additional NSIS commands to uninstall start menu shortcuts.
106
#
107
# .. variable:: CPACK_NSIS_EXECUTABLES_DIRECTORY
108
#
109 110 111
#  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.
112
#
113
# .. variable:: CPACK_NSIS_MUI_FINISHPAGE_RUN
114
#
115 116
#  Specify an executable to add an option to run on the finish page of the
#  NSIS installer.
117
#
118
# .. variable:: CPACK_NSIS_MENU_LINKS
119
#
120 121 122
#  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::
123
#
124
#   set(CPACK_NSIS_MENU_LINKS
125
#       "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html"
126
#       "CMake Help" "https://cmake.org" "CMake Web Site")
127
#
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143

#=============================================================================
# Copyright 2006-2009 Kitware, Inc.
#
# 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.)

#FIXME we should put NSIS specific code here
#FIXME but I'm not doing it because I'm not able to test it...