summaryrefslogtreecommitdiff
path: root/Help/cpack_gen/archive.rst
blob: d455f4b45cb24fd2337d1155ee88f4798e8ed4c8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
CPack Archive Generator
-----------------------

Archive CPack generator that supports packaging of sources and binaries in
different formats:

  - 7Z - 7zip - (.7z)
  - TBZ2 (.tar.bz2)
  - TGZ (.tar.gz)
  - TXZ (.tar.xz)
  - TZ (.tar.Z)
  - TZST (.tar.zst)
  - ZIP (.zip)

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

.. variable:: CPACK_ARCHIVE_FILE_NAME
              CPACK_ARCHIVE_<component>_FILE_NAME

 Package file name without extension which is added automatically depending
 on the archive format.

 * Mandatory : YES
 * Default   : ``<CPACK_PACKAGE_FILE_NAME>[-<component>].<extension>`` with
               spaces replaced by '-'

.. variable:: CPACK_ARCHIVE_COMPONENT_INSTALL

 Enable component packaging for CPackArchive

 * Mandatory : NO
 * Default   : OFF

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