Help/cpack_gen/nsis.rst

   1 CPack NSIS Generator
   2 --------------------
   3
   4 CPack Nullsoft Scriptable Install System (NSIS) generator specific options.
   5
   6 The NSIS generator requires NSIS 3.0 or newer.
   7
   8 Variables specific to CPack NSIS generator
   9 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  10
  11 The following variables are specific to the graphical installers built
  12 on Windows Nullsoft Scriptable Install System.
  13
  14 .. variable:: CPACK_NSIS_INSTALL_ROOT
  15
  16  The default installation directory presented to the end user by the NSIS
  17  installer is under this root dir. The full directory presented to the end
  18  user is: ``${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY}``
  19
  20 .. variable:: CPACK_NSIS_MUI_ICON
  21
  22  An icon filename.  The name of a ``*.ico`` file used as the main icon for the
  23  generated install program.
  24
  25 .. variable:: CPACK_NSIS_MUI_UNIICON
  26
  27  An icon filename.  The name of a ``*.ico`` file used as the main icon for the
  28  generated uninstall program.
  29
  30 .. variable:: CPACK_NSIS_INSTALLER_MUI_ICON_CODE
  31
  32  undocumented.
  33
  34 .. variable:: CPACK_NSIS_MUI_WELCOMEFINISHPAGE_BITMAP
  35
  36  The filename of a bitmap to use as the NSIS ``MUI_WELCOMEFINISHPAGE_BITMAP``.
  37
  38 .. variable:: CPACK_NSIS_MUI_UNWELCOMEFINISHPAGE_BITMAP
  39
  40  The filename of a bitmap to use as the NSIS ``MUI_UNWELCOMEFINISHPAGE_BITMAP``.
  41
  42 .. variable:: CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS
  43
  44  Extra NSIS commands that will be added to the beginning of the install
  45  Section, before your install tree is available on the target system.
  46
  47 .. variable:: CPACK_NSIS_EXTRA_INSTALL_COMMANDS
  48
  49  Extra NSIS commands that will be added to the end of the install Section,
  50  after your install tree is available on the target system.
  51
  52 .. variable:: CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS
  53
  54  Extra NSIS commands that will be added to the uninstall Section, before
  55  your install tree is removed from the target system.
  56
  57 .. variable:: CPACK_NSIS_COMPRESSOR
  58
  59  The arguments that will be passed to the NSIS `SetCompressor` command.
  60
  61 .. variable:: CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL
  62
  63  Ask about uninstalling previous versions first.  If this is set to ``ON``,
  64  then an installer will look for previous installed versions and if one is
  65  found, ask the user whether to uninstall it before proceeding with the
  66  install.
  67
  68 .. variable:: CPACK_NSIS_MODIFY_PATH
  69
  70  Modify ``PATH`` toggle.  If this is set to ``ON``, then an extra page will appear
  71  in the installer that will allow the user to choose whether the program
  72  directory should be added to the system ``PATH`` variable.
  73
  74 .. variable:: CPACK_NSIS_DISPLAY_NAME
  75
  76  The display name string that appears in the Windows `Apps & features`
  77  in `Control Panel`
  78
  79 .. variable:: CPACK_NSIS_PACKAGE_NAME
  80
  81  The title displayed at the top of the installer.
  82
  83 .. variable:: CPACK_NSIS_INSTALLED_ICON_NAME
  84
  85  A path to the executable that contains the installer icon.
  86
  87 .. variable:: CPACK_NSIS_HELP_LINK
  88
  89  URL to a web site providing assistance in installing your application.
  90
  91 .. variable:: CPACK_NSIS_URL_INFO_ABOUT
  92
  93  URL to a web site providing more information about your application.
  94
  95 .. variable:: CPACK_NSIS_CONTACT
  96
  97  Contact information for questions and comments about the installation
  98  process.
  99
 100 .. variable:: CPACK_NSIS_<compName>_INSTALL_DIRECTORY
 101
 102  Custom install directory for the specified component ``<compName>`` instead
 103  of ``$INSTDIR``.
 104
 105 .. variable:: CPACK_NSIS_CREATE_ICONS_EXTRA
 106
 107  Additional NSIS commands for creating `Start Menu` shortcuts.
 108
 109 .. variable:: CPACK_NSIS_DELETE_ICONS_EXTRA
 110
 111  Additional NSIS commands to uninstall `Start Menu` shortcuts.
 112
 113 .. variable:: CPACK_NSIS_EXECUTABLES_DIRECTORY
 114
 115  Creating NSIS `Start Menu` links assumes that they are in ``bin`` unless this
 116  variable is set.  For example, you would set this to ``exec`` if your
 117  executables are in an exec directory.
 118
 119 .. variable:: CPACK_NSIS_MUI_FINISHPAGE_RUN
 120
 121  Specify an executable to add an option to run on the finish page of the
 122  NSIS installer.
 123
 124 .. variable:: CPACK_NSIS_MENU_LINKS
 125
 126  Specify links in ``[application]`` menu.  This should contain a list of pair
 127  ``link`` ``link name``. The link may be a URL or a path relative to
 128  installation prefix.  Like::
 129
 130   set(CPACK_NSIS_MENU_LINKS
 131       "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html"
 132       "CMake Help" "https://cmake.org" "CMake Web Site")
 133
 134 .. variable:: CPACK_NSIS_UNINSTALL_NAME
 135
 136  Specify the name of the program to uninstall the version.
 137  Default is ``Uninstall``.
 138
 139 .. variable:: CPACK_NSIS_WELCOME_TITLE
 140
 141   The title to display on the top of the page for the welcome page.
 142
 143 .. variable:: CPACK_NSIS_WELCOME_TITLE_3LINES
 144
 145  Display the title in the welcome page on 3 lines instead of 2.
 146
 147 .. variable:: CPACK_NSIS_FINISH_TITLE
 148
 149  The title to display on the top of the page for the finish page.
 150
 151 .. variable:: CPACK_NSIS_FINISH_TITLE_3LINES
 152
 153  Display the title in the finish page on 3 lines instead of 2.
 154
 155 .. variable:: CPACK_NSIS_MUI_HEADERIMAGE
 156
 157  The image to display on the header of installers pages.