cmake/Help/cpack_gen/archive.rst

CPack Archive Generator
-----------------------

CPack generator for packaging files into an archive, which can have
any of the following formats:

- 7Z - 7zip - (``.7z``) - LZMA compressed

  .. versionadded:: 3.1

  This is an alias for ``7Z_LZMA``

- 7Z_BZ2 - 7zip - (``.7z``) - BZip2 compressed

  .. versionadded:: 4.3

- 7Z_DEFLATE - 7zip - (``.7z``) - Deflate compressed

  .. versionadded:: 4.3

- 7Z_LZMA - 7zip - (``.7z``) - LZMA compressed

  .. versionadded:: 4.3

- 7Z_LZMA2 - 7zip - (``.7z``) - LZMA2 compressed

  .. versionadded:: 4.3

- 7Z_PPMD - 7zip - (``.7z``) - PPMd compressed

  .. versionadded:: 4.3

- 7Z_STORE - 7zip - (``.7z``) - no compression is used

  .. versionadded:: 4.3

- 7Z_ZSTD - 7zip - (``.7z``) - Zstandard compressed

  .. versionadded:: 4.3

- TAR (``.tar``) - no compression is used

  .. versionadded:: 4.0

- TBZ2 (``.tar.bz2``) - BZip2 compressed

- TGZ (``.tar.gz``) - Deflate compressed

- TXZ (``.tar.xz``) - LZMA2 compressed

  .. versionadded:: 3.1

- TZ (``.tar.Z``) - LZW compressed

- TZST (``.tar.zst``) - Zstandard compressed

  .. versionadded:: 3.16

- ZIP (``.zip``) - Deflate compressed

  This is an alias for ``ZIP_DEFLATE``

- ZIP_BZ2 (``.zip``) - BZip2 compressed

  .. versionadded:: 4.3

- ZIP_DEFLATE (``.zip``) - Deflate compressed

  .. versionadded:: 4.3

- ZIP_LZMA (``.zip``) - LZMA compressed

  .. versionadded:: 4.3

- ZIP_LZMA2 (``.zip``) - LZMA2 compressed

  .. versionadded:: 4.3

- ZIP_STORE (``.zip``) - no compression is used

  .. versionadded:: 4.3

- ZIP_ZSTD (``.zip``) - Zstandard compressed

  .. versionadded:: 4.3

When this generator is called from ``CPackSourceConfig.cmake`` (or through
the ``package_source`` target), then the generated archive will contain all
files in the project directory, except those specified in
:variable:`CPACK_SOURCE_IGNORE_FILES`.  The following is one example of
packaging all source files of a project:

.. code-block:: cmake

  set(CPACK_SOURCE_GENERATOR "TGZ")
  set(CPACK_SOURCE_IGNORE_FILES
    \\.git/
    build/
    ".*~$"
  )
  set(CPACK_VERBATIM_VARIABLES YES)
  include(CPack)

When this generator is called from ``CPackConfig.cmake`` (or through the
``package`` target), then the generated archive will contain all files
that have been installed via CMake's :command:`install` command (and the
deprecated commands :command:`install_files`, :command:`install_programs`,
and :command:`install_targets`).

Variables specific to CPack Archive generator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. variable:: CPACK_ARCHIVE_FILE_NAME

  .. versionadded:: 3.9

  Archive name for component-based packages, without extension.

  :Default: :variable:`CPACK_PACKAGE_FILE_NAME`

  The extension is appended automatically.

  If :variable:`CPACK_COMPONENTS_GROUPING` is set to ``ALL_COMPONENTS_IN_ONE``,
  this will be the name of the one output archive.

  .. versionchanged:: 4.0

    This variable also works for non-component packages.

.. variable:: CPACK_ARCHIVE_<component>_FILE_NAME

  .. versionadded:: 3.9

  Component archive name without extension.

  :Default: ``<CPACK_ARCHIVE_FILE_NAME>-<component>``, with spaces replaced
    by ``'-'``.

  The extension is appended automatically. Note that ``<component>`` is all
  uppercase in the variable name.

.. variable:: CPACK_ARCHIVE_FILE_EXTENSION

  .. versionadded:: 3.25

  Archive file extension.

  :Default: Default values are given in the list above.

.. variable:: CPACK_ARCHIVE_COMPONENT_INSTALL

  Enable component packaging.

  :Default: ``OFF``

  If enabled (``ON``) multiple packages are generated. By default a single package
  containing files of all components is generated.

.. variable:: CPACK_ARCHIVE_UID

  .. versionadded: 4.3

  Set the UID of entries contained in the archive.
  Specify ``-1`` to use the UID of the current user.

  :Default: ``0`` (see policy :policy:`CMP0206`)

.. variable:: CPACK_ARCHIVE_GID

  .. versionadded: 4.3

  Set the GID of entries contained in the archive.
  Specify ``-1`` to use the GID of the current user.

  :Default: ``0`` (see policy :policy:`CMP0206`)

Variables used by CPack Archive generator
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

These variables are used by the Archive generator, but are also available to
CPack generators which are essentially archives at their core. These include:

- :cpack_gen:`CPack Cygwin Generator`
- :cpack_gen:`CPack FreeBSD Generator`

.. variable:: CPACK_ARCHIVE_THREADS

  .. versionadded:: 3.18

  The number of threads to use when performing the compression.

  :Default: value of :variable:`CPACK_THREADS`

  If set to ``0``, the number of available cores on the machine will be used instead.
  Note that not all compression modes support threading in all environments.

  .. versionadded:: 3.21

    Official CMake binaries available on ``cmake.org`` now ship
    with a ``liblzma`` that supports parallel compression.
    Older versions did not.

.. variable:: CPACK_ARCHIVE_COMPRESSION_LEVEL

  .. versionadded:: 4.3

  The compression level to use when compressing the archive.

  :Default: value of :variable:`CPACK_COMPRESSION_LEVEL`

  The compression level should be between ``0`` and ``9``.

  The compression level of the Zstandard-based algorithm can be set
  between ``0`` and ``19``, except for the ``ZIP_ZSTD`` mode.

  The value ``0`` is used to specify the default compression level.
  It is selected automatically by the archive library backend and
  not directly set by CMake itself. The default compression level
  may vary between archive formats, platforms, etc.

.. variable:: CPACK_ARCHIVE_ENCODING

  .. versionadded:: 4.4

  Specify the pathname character encoding used in package archives.

  :Default: ``UTF-8``

  See the :option:`cmake -E tar <cmake-E tar>` tool's
  :option:`--cmake-tar-encoding <cmake-E_tar --cmake-tar-encoding>` flag
  for supported encoding names.

  In CMake 4.3 and below, the ``OEM`` encoding (current locale)
  was always used.