summaryrefslogtreecommitdiffstats
path: root/Help/manual/cpack.1.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Help/manual/cpack.1.rst')
-rw-r--r--Help/manual/cpack.1.rst52
1 files changed, 37 insertions, 15 deletions
diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst
index 395cd41..3f26d72 100644
--- a/Help/manual/cpack.1.rst
+++ b/Help/manual/cpack.1.rst
@@ -26,12 +26,12 @@ All supported generators are specified in the :manual:`cpack-generators
<cpack-generators(7)>` 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 :variable:`CPACK_GENERATOR` variable
-or through the command-line option ``-G``.
+or through the command-line option :option:`-G <cpack -G>`.
The **cpack** program is steered by a configuration file written in the
:manual:`CMake language <cmake-language(7)>`. Unless chosen differently
-through the command-line option ``--config``, the file ``CPackConfig.cmake``
-in the current directory is used.
+through the command-line option :option:`--config <cpack --config>`, the
+file ``CPackConfig.cmake`` in the current directory is used.
In the standard CMake workflow, the file ``CPackConfig.cmake`` is generated
by the :manual:`cmake <cmake(1)>` executable, provided the :module:`CPack`
@@ -40,7 +40,10 @@ module is included by the project's ``CMakeLists.txt`` file.
Options
=======
-``-G <generators>``
+.. program:: cpack
+
+.. option:: -G <generators>
+
``<generators>`` is a :ref:`semicolon-separated list <CMake Language Lists>`
of generator names. ``cpack`` will iterate through this list and produce
package(s) in that generator's format according to the details provided in
@@ -48,7 +51,8 @@ Options
the :variable:`CPACK_GENERATOR` variable determines the default set of
generators that will be used.
-``-C <configs>``
+.. option:: -C <configs>
+
Specify the project configuration(s) to be packaged (e.g. ``Debug``,
``Release``, etc.), where ``<configs>`` is a
:ref:`semicolon-separated list <CMake Language Lists>`.
@@ -58,36 +62,44 @@ Options
The user is responsible for ensuring that the configuration(s) listed
have already been built before invoking ``cpack``.
-``-D <var>=<value>``
+.. option:: -D <var>=<value>
+
Set a CPack variable. This will override any value set for ``<var>`` in the
input file read by ``cpack``.
-``--config <configFile>``
+.. option:: --config <configFile>
+
Specify the configuration file read by ``cpack`` to provide the packaging
details. By default, ``CPackConfig.cmake`` in the current directory will
be used.
-``--verbose, -V``
+.. option:: -V, --verbose
+
Run ``cpack`` with verbose output. This can be used to show more details
from the package generation tools and is suitable for project developers.
-``--debug``
+.. option:: --debug
+
Run ``cpack`` with debug output. This option is intended mainly for the
developers of ``cpack`` itself and is not normally needed by project
developers.
-``--trace``
+.. option:: --trace
+
Put the underlying cmake scripts in trace mode.
-``--trace-expand``
+.. option:: --trace-expand
+
Put the underlying cmake scripts in expanded trace mode.
-``-P <packageName>``
+.. option:: -P <packageName>
+
Override/define the value of the :variable:`CPACK_PACKAGE_NAME` variable used
for packaging. Any value set for this variable in the ``CPackConfig.cmake``
file will then be ignored.
-``-R <packageVersion>``
+.. option:: -R <packageVersion>
+
Override/define the value of the :variable:`CPACK_PACKAGE_VERSION`
variable used for packaging. It will override a value set in the
``CPackConfig.cmake`` file or one automatically computed from
@@ -95,16 +107,26 @@ Options
:variable:`CPACK_PACKAGE_VERSION_MINOR` and
:variable:`CPACK_PACKAGE_VERSION_PATCH`.
-``-B <packageDirectory>``
+.. option:: -B <packageDirectory>
+
Override/define :variable:`CPACK_PACKAGE_DIRECTORY`, which controls the
directory where CPack will perform its packaging work. The resultant
package(s) will be created at this location by default and a
``_CPack_Packages`` subdirectory will also be created below this directory to
use as a working area during package creation.
-``--vendor <vendorName>``
+.. option:: --vendor <vendorName>
+
Override/define :variable:`CPACK_PACKAGE_VENDOR`.
+.. option:: --preset <presetName>
+
+ Use a preset from :manual:`cmake-presets(7)`.
+
+.. option:: --list-presets
+
+ List presets from :manual:`cmake-presets(7)`.
+
.. include:: OPTIONS_HELP.txt
See Also