cpack [<options>]
The cpack executable is the CMake packaging program. It generates installers and source packages in a variety of formats.
For each installer or package format, cpack has a specific backend, called “generator”. A generator is responsible for generating the required inputs and invoking the specific package creation tools. These installer or package generators are not to be confused with the makefile generators of the cmake command.
All supported generators are specified in the cpack-generators manual. The command cpack --help prints a list of generators supported for the target platform. Which of them are to be used can be selected through the CPACK_GENERATOR variable or through the command-line option -G.
The cpack program is steered by a configuration file written in the CMake language. Unless chosen differently through the command-line option --config, the file CPackConfig.cmake in the current directory is used.
In the standard CMake workflow, the file CPackConfig.cmake is generated by the cmake executable, provided the CPack module is included by the project’s CMakeLists.txt file.
Print usage information and exit.
Usage describes the basic command line interface and its options.
Show program name/version banner and exit.
If a file is specified, the version is written into it. The help is printed to a named <f>ile if given.
Print all help manuals and exit.
All manuals are printed in a human-readable text format. The help is printed to a named <f>ile if given.
Print one help manual and exit.
The specified manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
List help manuals available and exit.
The list contains all manuals for which help may be obtained by using the --help-manual option followed by a manual name. The help is printed to a named <f>ile if given.
Print help for one command and exit.
The cmake-commands(7) manual entry for <cmd> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
List commands with help available and exit.
The list contains all commands for which help may be obtained by using the --help-command option followed by a command name. The help is printed to a named <f>ile if given.
Print cmake-commands manual and exit.
The cmake-commands(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
Print help for one module and exit.
The cmake-modules(7) manual entry for <mod> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
List modules with help available and exit.
The list contains all modules for which help may be obtained by using the --help-module option followed by a module name. The help is printed to a named <f>ile if given.
Print cmake-modules manual and exit.
The cmake-modules(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
Print help for one policy and exit.
The cmake-policies(7) manual entry for <cmp> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
List policies with help available and exit.
The list contains all policies for which help may be obtained by using the --help-policy option followed by a policy name. The help is printed to a named <f>ile if given.
Print cmake-policies manual and exit.
The cmake-policies(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
Print help for one property and exit.
The cmake-properties(7) manual entries for <prop> are printed in a human-readable text format. The help is printed to a named <f>ile if given.
List properties with help available and exit.
The list contains all properties for which help may be obtained by using the --help-property option followed by a property name. The help is printed to a named <f>ile if given.
Print cmake-properties manual and exit.
The cmake-properties(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
Print help for one variable and exit.
The cmake-variables(7) manual entry for <var> is printed in a human-readable text format. The help is printed to a named <f>ile if given.
List variables with help available and exit.
The list contains all variables for which help may be obtained by using the --help-variable option followed by a variable name. The help is printed to a named <f>ile if given.
Print cmake-variables manual and exit.
The cmake-variables(7) manual is printed in a human-readable text format. The help is printed to a named <f>ile if given.
The following resources are available to get help using CMake:
The primary starting point for learning about CMake.
https://cmake.org/documentation
Links to available documentation and community resources may be found on this web page.
The Discourse Forum hosts discussion and questions about CMake.