1CPACK(1) CMake CPACK(1)
2
3
4
6 cpack - CPack Command-Line Reference
7
9 cpack -G <generator> [<options>]
10
12 The “cpack” executable is the CMake packaging program. CMake-generated
13 build trees created for projects that use the INSTALL_* commands have
14 packaging support. This program will generate the package.
15
16 CMake is a cross-platform build system generator. Projects specify
17 their build process with platform-independent CMake listfiles included
18 in each directory of a source tree with the name CMakeLists.txt. Users
19 build a project by using CMake to generate a build system for a native
20 tool on their platform.
21
23 -G <generator>
24 Use the specified generator to generate package.
25
26 CPack may support multiple native packaging systems on certain
27 platforms. A generator is responsible for generating input
28 files for particular system and invoking that systems. Possible
29 generator names are specified in the Generators section.
30
31 -C <Configuration>
32 Specify the project configuration
33
34 This option specifies the configuration that the project was
35 build with, for example ‘Debug’, ‘Release’.
36
37 -D <var>=<value>
38 Set a CPack variable.
39
40 Set a variable that can be used by the generator.
41
42 --config <config file>
43 Specify the config file.
44
45 Specify the config file to use to create the package. By
46 default CPackConfig.cmake in the current directory will be used.
47
48 --verbose,-V
49 enable verbose output
50
51 Run cpack with verbose output.
52
53 --debug
54 enable debug output (for CPack developers)
55
56 Run cpack with debug output (for CPack developers).
57
58 --trace
59 Put underlying cmake scripts in trace mode.
60
61 --trace-expand
62 Put underlying cmake scripts in expanded trace mode.
63
64 -P <package name>
65 override/define CPACK_PACKAGE_NAME
66
67 If the package name is not specified on cpack command line
68 thenCPack.cmake defines it as CMAKE_PROJECT_NAME
69
70 -R <package version>
71 override/define CPACK_PACKAGE_VERSION
72
73 If version is not specified on cpack command line thenC‐
74 Pack.cmake defines it from CPACK_PACKAGE_VER‐
75 SION_[MAJOR|MINOR|PATCH]look into CPack.cmake for detail
76
77 -B <package directory>
78 override/define CPACK_PACKAGE_DIRECTORY
79
80 The directory where CPack will be doing its packaging work.The
81 resulting package will be found there. Inside this directoryC‐
82 Pack creates ‘_CPack_Packages’ sub-directory which is theCPack
83 temporary directory.
84
85 --vendor <vendor name>
86 override/define CPACK_PACKAGE_VENDOR
87
88 If vendor is not specified on cpack command line (or inside
89 CMakeLists.txt) thenCPack.cmake defines it with a default value
90
91 --help,-help,-usage,-h,-H,/?
92 Print usage information and exit.
93
94 Usage describes the basic command line interface and its
95 options.
96
97 --version,-version,/V [<f>]
98 Show program name/version banner and exit.
99
100 If a file is specified, the version is written into it. The
101 help is printed to a named <f>ile if given.
102
103 --help-full [<f>]
104 Print all help manuals and exit.
105
106 All manuals are printed in a human-readable text format. The
107 help is printed to a named <f>ile if given.
108
109 --help-manual <man> [<f>]
110 Print one help manual and exit.
111
112 The specified manual is printed in a human-readable text format.
113 The help is printed to a named <f>ile if given.
114
115 --help-manual-list [<f>]
116 List help manuals available and exit.
117
118 The list contains all manuals for which help may be obtained by
119 using the --help-manual option followed by a manual name. The
120 help is printed to a named <f>ile if given.
121
122 --help-command <cmd> [<f>]
123 Print help for one command and exit.
124
125 The cmake-commands(7) manual entry for <cmd> is printed in a
126 human-readable text format. The help is printed to a named
127 <f>ile if given.
128
129 --help-command-list [<f>]
130 List commands with help available and exit.
131
132 The list contains all commands for which help may be obtained by
133 using the --help-command option followed by a command name. The
134 help is printed to a named <f>ile if given.
135
136 --help-commands [<f>]
137 Print cmake-commands manual and exit.
138
139 The cmake-commands(7) manual is printed in a human-readable text
140 format. The help is printed to a named <f>ile if given.
141
142 --help-module <mod> [<f>]
143 Print help for one module and exit.
144
145 The cmake-modules(7) manual entry for <mod> is printed in a
146 human-readable text format. The help is printed to a named
147 <f>ile if given.
148
149 --help-module-list [<f>]
150 List modules with help available and exit.
151
152 The list contains all modules for which help may be obtained by
153 using the --help-module option followed by a module name. The
154 help is printed to a named <f>ile if given.
155
156 --help-modules [<f>]
157 Print cmake-modules manual and exit.
158
159 The cmake-modules(7) manual is printed in a human-readable text
160 format. The help is printed to a named <f>ile if given.
161
162 --help-policy <cmp> [<f>]
163 Print help for one policy and exit.
164
165 The cmake-policies(7) manual entry for <cmp> is printed in a
166 human-readable text format. The help is printed to a named
167 <f>ile if given.
168
169 --help-policy-list [<f>]
170 List policies with help available and exit.
171
172 The list contains all policies for which help may be obtained by
173 using the --help-policy option followed by a policy name. The
174 help is printed to a named <f>ile if given.
175
176 --help-policies [<f>]
177 Print cmake-policies manual and exit.
178
179 The cmake-policies(7) manual is printed in a human-readable text
180 format. The help is printed to a named <f>ile if given.
181
182 --help-property <prop> [<f>]
183 Print help for one property and exit.
184
185 The cmake-properties(7) manual entries for <prop> are printed in
186 a human-readable text format. The help is printed to a named
187 <f>ile if given.
188
189 --help-property-list [<f>]
190 List properties with help available and exit.
191
192 The list contains all properties for which help may be obtained
193 by using the --help-property option followed by a property name.
194 The help is printed to a named <f>ile if given.
195
196 --help-properties [<f>]
197 Print cmake-properties manual and exit.
198
199 The cmake-properties(7) manual is printed in a human-readable
200 text format. The help is printed to a named <f>ile if given.
201
202 --help-variable <var> [<f>]
203 Print help for one variable and exit.
204
205 The cmake-variables(7) manual entry for <var> is printed in a
206 human-readable text format. The help is printed to a named
207 <f>ile if given.
208
209 --help-variable-list [<f>]
210 List variables with help available and exit.
211
212 The list contains all variables for which help may be obtained
213 by using the --help-variable option followed by a variable name.
214 The help is printed to a named <f>ile if given.
215
216 --help-variables [<f>]
217 Print cmake-variables manual and exit.
218
219 The cmake-variables(7) manual is printed in a human-readable
220 text format. The help is printed to a named <f>ile if given.
221
223 The following resources are available to get help using CMake:
224
225 Home Page
226 https://cmake.org
227
228 The primary starting point for learning about CMake.
229
230 Frequently Asked Questions
231 https://cmake.org/Wiki/CMake_FAQ
232
233 A Wiki is provided containing answers to frequently asked ques‐
234 tions.
235
236 Online Documentation
237 https://cmake.org/documentation
238
239 Links to available documentation may be found on this web page.
240
241 Mailing List
242 https://cmake.org/mailing-lists
243
244 For help and discussion about using cmake, a mailing list is
245 provided at cmake@cmake.org. The list is member-post-only but
246 one may sign up on the CMake web page. Please first read the
247 full documentation at https://cmake.org before posting questions
248 to the list.
249
251 2000-2018 Kitware, Inc. and Contributors
252
253
254
255
2563.11.4 May 13, 2019 CPACK(1)