1CPACK(1)                             CMake                            CPACK(1)
2
3
4

NAME

6       cpack - CPack Command-Line Reference
7

SYNOPSIS

9          cpack [<options>]
10

DESCRIPTION

12       The  cpack executable is the CMake packaging program.  It generates in‐
13       stallers and source packages in a variety of formats.
14
15       For each installer or package format, cpack  has  a  specific  backend,
16       called  “generator”.  A  generator  is  responsible  for generating the
17       required inputs and invoking the specific package creation tools. These
18       installer  or  package generators are not to be confused with the make‐
19       file generators of the cmake command.
20
21       All supported generators are specified in the cpack-generators  manual.
22       The  command cpack --help prints a list of generators supported for the
23       target platform.  Which of them are to be used can be selected  through
24       the CPACK_GENERATOR variable or through the command-line option -G.
25
26       The  cpack  program  is  steered by a configuration file written in the
27       CMake language. Unless  chosen  differently  through  the  command-line
28       option --config, the file CPackConfig.cmake in the current directory is
29       used.
30
31       In the standard CMake workflow, the file CPackConfig.cmake is generated
32       by  the  cmake executable, provided the CPack module is included by the
33       project’s CMakeLists.txt file.
34

OPTIONS

36       -G <generators>
37              <generators> is a semicolon-separated list of  generator  names.
38              cpack  will  iterate through this list and produce package(s) in
39              that generator’s format according to the details provided in the
40              CPackConfig.cmake  configuration  file.   If  this option is not
41              given, the CPACK_GENERATOR variable determines the  default  set
42              of generators that will be used.
43
44       -C <Configuration>
45              Specify  the  project  configuration to be packaged (e.g. Debug,
46              Release, etc.).  When the CMake project uses a  multi-configura‐
47              tion  generator  such  as Xcode or Visual Studio, this option is
48              needed to tell cpack which built executables to include  in  the
49              package.
50
51       -D <var>=<value>
52              Set  a  CPack  variable.   This  will override any value set for
53              <var> in the input file read by cpack.
54
55       --config <configFile>
56              Specify the configuration file read  by  cpack  to  provide  the
57              packaging details.  By default, CPackConfig.cmake in the current
58              directory will be used.
59
60       --verbose,-V
61              Run cpack with verbose output.  This can be used  to  show  more
62              details  from  the  package generation tools and is suitable for
63              project developers.
64
65       --debug
66              Run cpack with debug output.  This option is intended mainly for
67              the  developers  of  cpack  itself and is not normally needed by
68              project developers.
69
70       --trace
71              Put the underlying cmake scripts in trace mode.
72
73       --trace-expand
74              Put the underlying cmake scripts in expanded trace mode.
75
76       -P <packageName>
77              Override/define the value  of  the  CPACK_PACKAGE_NAME  variable
78              used  for  packaging.   Any  value  set for this variable in the
79              CPackConfig.cmake file will then be ignored.
80
81       -R <packageVersion>
82              Override/define the value of the CPACK_PACKAGE_VERSION  variable
83              used  for packaging.  It will override a value set in the CPack‐
84              Config.cmake file or one automatically computed from CPACK_PACK‐
85              AGE_VERSION_MAJOR,  CPACK_PACKAGE_VERSION_MINOR  and CPACK_PACK‐
86              AGE_VERSION_PATCH.
87
88       -B <packageDirectory>
89              Override/define  CPACK_PACKAGE_DIRECTORY,  which  controls   the
90              directory  where  CPack  will  perform  its packaging work.  The
91              resultant package(s) will be created at this location by default
92              and  a  _CPack_Packages  subdirectory will also be created below
93              this directory to use as a working area during package creation.
94
95       --vendor <vendorName>
96              Override/define CPACK_PACKAGE_VENDOR.
97
98       --help,-help,-usage,-h,-H,/?
99              Print usage information and exit.
100
101              Usage  describes  the  basic  command  line  interface  and  its
102              options.
103
104       --version,-version,/V [<f>]
105              Show program name/version banner and exit.
106
107              If  a  file  is  specified, the version is written into it.  The
108              help is printed to a named <f>ile if given.
109
110       --help-full [<f>]
111              Print all help manuals and exit.
112
113              All manuals are printed in a human-readable  text  format.   The
114              help is printed to a named <f>ile if given.
115
116       --help-manual <man> [<f>]
117              Print one help manual and exit.
118
119              The specified manual is printed in a human-readable text format.
120              The help is printed to a named <f>ile if given.
121
122       --help-manual-list [<f>]
123              List help manuals available and exit.
124
125              The list contains all manuals for which help may be obtained  by
126              using  the  --help-manual option followed by a manual name.  The
127              help is printed to a named <f>ile if given.
128
129       --help-command <cmd> [<f>]
130              Print help for one command and exit.
131
132              The cmake-commands(7) manual entry for <cmd>  is  printed  in  a
133              human-readable  text  format.   The  help  is printed to a named
134              <f>ile if given.
135
136       --help-command-list [<f>]
137              List commands with help available and exit.
138
139              The list contains all commands for which help may be obtained by
140              using the --help-command option followed by a command name.  The
141              help is printed to a named <f>ile if given.
142
143       --help-commands [<f>]
144              Print cmake-commands manual and exit.
145
146              The cmake-commands(7) manual is printed in a human-readable text
147              format.  The help is printed to a named <f>ile if given.
148
149       --help-module <mod> [<f>]
150              Print help for one module and exit.
151
152              The  cmake-modules(7)  manual  entry  for  <mod> is printed in a
153              human-readable text format.  The help  is  printed  to  a  named
154              <f>ile if given.
155
156       --help-module-list [<f>]
157              List modules with help available and exit.
158
159              The  list contains all modules for which help may be obtained by
160              using the --help-module option followed by a module  name.   The
161              help is printed to a named <f>ile if given.
162
163       --help-modules [<f>]
164              Print cmake-modules manual and exit.
165
166              The  cmake-modules(7) manual is printed in a human-readable text
167              format.  The help is printed to a named <f>ile if given.
168
169       --help-policy <cmp> [<f>]
170              Print help for one policy and exit.
171
172              The cmake-policies(7) manual entry for <cmp>  is  printed  in  a
173              human-readable  text  format.   The  help  is printed to a named
174              <f>ile if given.
175
176       --help-policy-list [<f>]
177              List policies with help available and exit.
178
179              The list contains all policies for which help may be obtained by
180              using  the  --help-policy option followed by a policy name.  The
181              help is printed to a named <f>ile if given.
182
183       --help-policies [<f>]
184              Print cmake-policies manual and exit.
185
186              The cmake-policies(7) manual is printed in a human-readable text
187              format.  The help is printed to a named <f>ile if given.
188
189       --help-property <prop> [<f>]
190              Print help for one property and exit.
191
192              The cmake-properties(7) manual entries for <prop> are printed in
193              a human-readable text format.  The help is printed  to  a  named
194              <f>ile if given.
195
196       --help-property-list [<f>]
197              List properties with help available and exit.
198
199              The  list contains all properties for which help may be obtained
200              by using the --help-property option followed by a property name.
201              The help is printed to a named <f>ile if given.
202
203       --help-properties [<f>]
204              Print cmake-properties manual and exit.
205
206              The  cmake-properties(7)  manual  is printed in a human-readable
207              text format.  The help is printed to a named <f>ile if given.
208
209       --help-variable <var> [<f>]
210              Print help for one variable and exit.
211
212              The cmake-variables(7) manual entry for <var> is  printed  in  a
213              human-readable  text  format.   The  help  is printed to a named
214              <f>ile if given.
215
216       --help-variable-list [<f>]
217              List variables with help available and exit.
218
219              The list contains all variables for which help may  be  obtained
220              by using the --help-variable option followed by a variable name.
221              The help is printed to a named <f>ile if given.
222
223       --help-variables [<f>]
224              Print cmake-variables manual and exit.
225
226              The cmake-variables(7) manual is  printed  in  a  human-readable
227              text format.  The help is printed to a named <f>ile if given.
228

SEE ALSO

230       The following resources are available to get help using CMake:
231
232       Home Page
233              https://cmake.org
234
235              The primary starting point for learning about CMake.
236
237       Online Documentation and Community Resources
238              https://cmake.org/documentation
239
240              Links  to available documentation and community resources may be
241              found on this web page.
242
243       Mailing List
244              https://cmake.org/mailing-lists
245
246              For help and discussion about using cmake,  a  mailing  list  is
247              provided  at  cmake@cmake.org.  The list is member-post-only but
248              one may sign up on the CMake web page.  Please  first  read  the
249              full documentation at https://cmake.org before posting questions
250              to the list.
251

COPYRIGHT

253       2000-2019 Kitware, Inc. and Contributors
254
255
256
257
2583.14.5                           Jun 01, 2019                         CPACK(1)