Help/cpack_gen/nsis.rst

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