Add structured documentation for NSIS

This commit is contained in:
Eric NOULARD 2012-02-18 22:10:19 +01:00
parent a6bce55aef
commit b8a274c091
1 changed files with 42 additions and 0 deletions

View File

@ -1,70 +1,112 @@
##section Variables specific to CPack Debian (DEB) generator
##end
##module
# - CPack NSIS generator specific options # - CPack NSIS generator specific options
# #
# The following variables are specific to the graphical installers built # The following variables are specific to the graphical installers built
# on Windows using the Nullsoft Installation System. # on Windows using the Nullsoft Installation System.
##end
# #
##variable
# CPACK_PACKAGE_INSTALL_REGISTRY_KEY - Registry key used when # CPACK_PACKAGE_INSTALL_REGISTRY_KEY - Registry key used when
# installing this project. # installing this project.
##end
# #
##variable
# CPACK_NSIS_INSTALL_ROOT - The default installation directory presented # CPACK_NSIS_INSTALL_ROOT - The default installation directory presented
# to the end user by the NSIS installer is under this root dir. The full # to the end user by the NSIS installer is under this root dir. The full
# directory presented to the end user is: # directory presented to the end user is:
# ${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY} # ${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY}
##end
# #
##variable
# CPACK_NSIS_MUI_ICON - The icon file (.ico) for the generated # CPACK_NSIS_MUI_ICON - The icon file (.ico) for the generated
# install program. # install program.
##end
# #
##variable
# CPACK_NSIS_MUI_UNIICON - The icon file (.ico) for the generated # CPACK_NSIS_MUI_UNIICON - The icon file (.ico) for the generated
# uninstall program. # uninstall program.
##end
# #
##variable
# CPACK_PACKAGE_ICON - A branding image that will be displayed inside # CPACK_PACKAGE_ICON - A branding image that will be displayed inside
# the installer. # the installer.
##end
# #
##variable
# CPACK_NSIS_EXTRA_INSTALL_COMMANDS - Extra NSIS commands that will # CPACK_NSIS_EXTRA_INSTALL_COMMANDS - Extra NSIS commands that will
# be added to the install Section. # be added to the install Section.
##end
# #
##variable
# CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS - Extra NSIS commands that will # CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS - Extra NSIS commands that will
# be added to the uninstall Section. # be added to the uninstall Section.
##end
# #
##variable
# CPACK_NSIS_COMPRESSOR - The arguments that will be passed to the # CPACK_NSIS_COMPRESSOR - The arguments that will be passed to the
# NSIS SetCompressor command. # NSIS SetCompressor command.
##end
# #
##variable
# CPACK_NSIS_MODIFY_PATH - If this is set to "ON", then an extra page # CPACK_NSIS_MODIFY_PATH - If this is set to "ON", then an extra page
# will appear in the installer that will allow the user to choose # will appear in the installer that will allow the user to choose
# whether the program directory should be added to the system PATH # whether the program directory should be added to the system PATH
# variable. # variable.
##end
# #
##variable
# CPACK_NSIS_DISPLAY_NAME - The display name string that appears in # CPACK_NSIS_DISPLAY_NAME - The display name string that appears in
# the Windows Add/Remove Program control panel # the Windows Add/Remove Program control panel
##end
# #
##variable
# CPACK_NSIS_PACKAGE_NAME - The title displayed at the top of the # CPACK_NSIS_PACKAGE_NAME - The title displayed at the top of the
# installer. # installer.
##end
# #
##variable
# CPACK_NSIS_INSTALLED_ICON_NAME - A path to the executable that # CPACK_NSIS_INSTALLED_ICON_NAME - A path to the executable that
# contains the installer icon. # contains the installer icon.
##end
# #
##variable
# CPACK_NSIS_HELP_LINK - URL to a web site providing assistance in # CPACK_NSIS_HELP_LINK - URL to a web site providing assistance in
# installing your application. # installing your application.
##end
# #
##variable
# CPACK_NSIS_URL_INFO_ABOUT - URL to a web site providing more # CPACK_NSIS_URL_INFO_ABOUT - URL to a web site providing more
# information about your application. # information about your application.
##end
# #
##variable
# CPACK_NSIS_CONTACT - Contact information for questions and comments # CPACK_NSIS_CONTACT - Contact information for questions and comments
# about the installation process. # about the installation process.
##end
# #
##variable
# CPACK_NSIS_CREATE_ICONS_EXTRA - Additional NSIS commands for # CPACK_NSIS_CREATE_ICONS_EXTRA - Additional NSIS commands for
# creating start menu shortcuts. # creating start menu shortcuts.
##end
# #
##variable
# CPACK_NSIS_DELETE_ICONS_EXTRA -Additional NSIS commands to # CPACK_NSIS_DELETE_ICONS_EXTRA -Additional NSIS commands to
# uninstall start menu shortcuts. # uninstall start menu shortcuts.
##end
# #
##variable
# CPACK_NSIS_EXECUTABLES_DIRECTORY - Creating NSIS start menu links # CPACK_NSIS_EXECUTABLES_DIRECTORY - Creating NSIS start menu links
# assumes that they are in 'bin' unless this variable is set. # assumes that they are in 'bin' unless this variable is set.
# For example, you would set this to 'exec' if your executables are # For example, you would set this to 'exec' if your executables are
# in an exec directory. # in an exec directory.
##end
# #
##variable
# CPACK_NSIS_MUI_FINISHPAGE_RUN - Specify an executable to add an option # CPACK_NSIS_MUI_FINISHPAGE_RUN - Specify an executable to add an option
# to run on the finish page of the NSIS installer. # to run on the finish page of the NSIS installer.
##end
#============================================================================= #=============================================================================
# Copyright 2006-2009 Kitware, Inc. # Copyright 2006-2009 Kitware, Inc.