Difference between revisions of "CMake:CPackConfiguration"

From KitwarePublic
Jump to: navigation, search
(Other source of informations)
Line 75: Line 75:
 
|-
 
|-
 
| CPACK_INSTALL_DIRECTORIES || Extra directories to install. ||
 
| CPACK_INSTALL_DIRECTORIES || Extra directories to install. ||
|}
 
 
=Nullsoft Install System (NSIS) settings=
 
 
{|
 
|- bgcolor="#abcdef"
 
! Variable Name || Description || Example
 
|-
 
| CPACK_NSIS_MUI_ICON || The icon file (.ico) for the generated install program. Both this and CPACK_NSIS_MUI_UNIICON need to set for this to have any effect. || installer.ico
 
|-
 
| CPACK_NSIS_MUI_UNIICON || The icon file (.ico) for the generated uninstall program. Both this and CPACK_NSIS_MUI_ICON need to set for this to have any effect. || uninstaller.ico
 
|-
 
| CPACK_PACKAGE_ICON || A branding image that will be displayed on the top bar inside the installer. || installer.bmp
 
|-
 
| CPACK_NSIS_EXTRA_INSTALL_COMMANDS || Extra NSIS commands that will be added to the install Section. || ExecWait '\\\"$INSTDIR\\\\vcredist_x86.exe\\\" /q:a'
 
|-
 
| CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS || Extra NSIS commands that will be added to the uninstall Section. ||
 
|-
 
| CPACK_NSIS_COMPRESSOR || The arguments that will be passed to the NSIS SetCompressor command. || /SOLID lzma
 
|-
 
| 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 whether the program directory should be added to the system PATH variable. || ON
 
|-
 
| CPACK_NSIS_DISPLAY_NAME || Undocumented. || "${CPACK_PACKAGE_INSTALL_DIRECTORY} My Famous Project"
 
|-
 
| CPACK_NSIS_INSTALLED_ICON_NAME || Set the icon used for the Windows "Add or Remove Programs" tool. || "bin\\\\MyExecutable.exe"
 
|-
 
| CPACK_NSIS_HELP_LINK || Adds link to registry. URI. || "http:\\\\\\\\www.my-project-home-page.org"
 
|-
 
| CPACK_NSIS_URL_INFO_ABOUT || Adds link to registry and the vendor in add/remove programs' "Click here for support information" in program entry links here. || "http:\\\\\\\\www.my-personal-home-page.com"
 
|-
 
| CPACK_NSIS_CONTACT || Adds link to add/remove programs' "Click here for support information" in program entry.  || "me@my-personal-home-page.com"
 
|-
 
| CPACK_NSIS_CREATE_ICONS_EXTRA || Additional NSIS commands for creating start menu shortcuts. || set(CPACK_NSIS_CREATE_ICONS "CreateShortCut '\$SMPROGRAMS\\\\$STARTMENU_FOLDER\\\\${PROJECT_NAME}.lnk' '\$INSTDIR\\\\${PROJECT_NAME}.exe'")
 
|-
 
| CPACK_NSIS_DELETE_ICONS_EXTRA || Undocumented. Possibly: Additional NSIS commands to uninstall start menu shortcuts. ||
 
|-
 
| CPACK_NSIS_MENU_LINKS || Used to override the Start Menu links. || "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/CMakeSetup.html" "CMakeSetup Help"
 
|-
 
 
|}
 
|}

Revision as of 08:56, 30 January 2011

The following variables can be set to adjust the behaviour of CPack:

Other source of informations

If you seek CPack generators specific settings please go there; CPackPackageGenerators

Basic settings

Variable Name Description Example
CPACK_GENERATOR CPack generator to be used STGZ;TGZ;TZ
CPACK_INCLUDE_TOPLEVEL_DIRECTORY Controls whether CPack adds a top-level directory, usually of the form ProjectName-Version-OS, to the top of package tree. 0 to disable, 1 to enable
CPACK_INSTALL_CMAKE_PROJECTS List of four values: Build directory, Project Name, Project Component, Directory in the package /home/andy/vtk/CMake-bin;CMake;ALL;/
CPACK_PACKAGE_DESCRIPTION_FILE File used as a description of a project /path/to/project/ReadMe.txt
CPACK_PACKAGE_DESCRIPTION_SUMMARY Description summary of a project CMake is a build tool
CPACK_PACKAGE_EXECUTABLES List of pairs of executables and labels. Used by the NSIS generator to create Start Menu shortcuts. ccmake;CMake
CPACK_PACKAGE_FILE_NAME Package file name without extension. Also a directory of installer cmake-2.5.0-Linux-i686
CPACK_PACKAGE_INSTALL_DIRECTORY Installation directory on the target system CMake 2.5
CPACK_PACKAGE_INSTALL_REGISTRY_KEY Registry key used when installing this project CMake 2.5.0
CPACK_PACKAGE_NAME Package name, defaults to the project name. CMake
CPACK_PACKAGE_VENDOR Package vendor name Kitware
CPACK_PACKAGE_VERSION_MAJOR Package Major Version 2
CPACK_PACKAGE_VERSION_MINOR Package Minor Version 5
CPACK_PACKAGE_VERSION_PATCH Package Patch Version 0
CPACK_PROJECT_CONFIG_FILE File included at cpack time, once per generator after setting CPACK_GENERATOR to the actual generator being used; allows per-generator setting of CPACK_* variables at cpack time. ${PROJECT_BINARY_DIR}/CPackOptions.cmake
CPACK_SOURCE_GENERATOR List of generators used for the source package TGZ;TZ
CPACK_SOURCE_IGNORE_FILES Pattern of files in the source tree that won't be packaged /CVS/;/\\.svn/;\\.swp$;\\.#;/#;.*~;cscope.*
CPACK_SOURCE_PACKAGE_FILE_NAME Name of the source package cmake-2.5.0
CPACK_SOURCE_STRIP_FILES List of files in the source tree that will be stripped. Starting with CMake 2.6.0 CPACK_SOURCE_STRIP_FILES will be a boolean variable which enables stripping of all files (a list of files evaluates to TRUE in CMake, so this change is compatible).
CPACK_STRIP_FILES List of files to be stripped. Starting with CMake 2.6.0 CPACK_STRIP_FILES will be a boolean variable which enables stripping of all files (a list of files evaluates to TRUE in CMake, so this change is compatible). bin/ccmake;bin/cmake;bin/cpack;bin/ctest
CPACK_SYSTEM_NAME System name, defaults to the value of ${CMAKE_SYSTEM_NAME}. Linux-i686

Advanced settings

Variable Name Description Example
CPACK_CMAKE_GENERATOR What CMake generator should be used if the project is CMake project. Defaults to the value of CMAKE_GENERATOR. Unix Makefiles
CPACK_RESOURCE_FILE_LICENSE License file for the project, used by the STGZ, NSIS, and PackageMaker generators. /home/andy/vtk/CMake/Copyright.txt
CPACK_RESOURCE_FILE_README ReadMe file for the project, used by PackageMaker generator. /home/andy/vtk/CMake/Templates/CPack.GenericDescription.txt
CPACK_RESOURCE_FILE_WELCOME Welcome file for the project, used by PackageMaker generator. /home/andy/vtk/CMake/Templates/CPack.GenericWelcome.txt
CPACK_PACKAGE_VERSION Package full version, used internally. 2.5.0
CPACK_TOPLEVEL_TAG Directory for the installed files. Linux-i686
CPACK_INSTALL_COMMANDS Extra commands to install components.
CPACK_INSTALL_DIRECTORIES Extra directories to install.