|
1 .\" Man page generated from reStructuredText. |
|
2 . |
|
3 .TH "CPACK" "1" "October 14, 2015" "3.3.2" "CMake" |
|
4 .SH NAME |
|
5 cpack \- CPack Command-Line Reference |
|
6 . |
|
7 .nr rst2man-indent-level 0 |
|
8 . |
|
9 .de1 rstReportMargin |
|
10 \\$1 \\n[an-margin] |
|
11 level \\n[rst2man-indent-level] |
|
12 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
13 - |
|
14 \\n[rst2man-indent0] |
|
15 \\n[rst2man-indent1] |
|
16 \\n[rst2man-indent2] |
|
17 .. |
|
18 .de1 INDENT |
|
19 .\" .rstReportMargin pre: |
|
20 . RS \\$1 |
|
21 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] |
|
22 . nr rst2man-indent-level +1 |
|
23 .\" .rstReportMargin post: |
|
24 .. |
|
25 .de UNINDENT |
|
26 . RE |
|
27 .\" indent \\n[an-margin] |
|
28 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
29 .nr rst2man-indent-level -1 |
|
30 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] |
|
31 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u |
|
32 .. |
|
33 .SH SYNOPSIS |
|
34 .INDENT 0.0 |
|
35 .INDENT 3.5 |
|
36 .sp |
|
37 .nf |
|
38 .ft C |
|
39 cpack \-G <generator> [<options>] |
|
40 .ft P |
|
41 .fi |
|
42 .UNINDENT |
|
43 .UNINDENT |
|
44 .SH DESCRIPTION |
|
45 .sp |
|
46 The "cpack" executable is the CMake packaging program. |
|
47 CMake\-generated build trees created for projects that use the |
|
48 INSTALL_* commands have packaging support. This program will generate |
|
49 the package. |
|
50 .sp |
|
51 CMake is a cross\-platform build system generator. Projects specify |
|
52 their build process with platform\-independent CMake listfiles included |
|
53 in each directory of a source tree with the name CMakeLists.txt. |
|
54 Users build a project by using CMake to generate a build system for a |
|
55 native tool on their platform. |
|
56 .SH OPTIONS |
|
57 .INDENT 0.0 |
|
58 .TP |
|
59 .B \fB\-G <generator>\fP |
|
60 Use the specified generator to generate package. |
|
61 .sp |
|
62 CPack may support multiple native packaging systems on certain |
|
63 platforms. A generator is responsible for generating input files |
|
64 for particular system and invoking that systems. Possible generator |
|
65 names are specified in the Generators section. |
|
66 .TP |
|
67 .B \fB\-C <Configuration>\fP |
|
68 Specify the project configuration |
|
69 .sp |
|
70 This option specifies the configuration that the project was build |
|
71 with, for example \(aqDebug\(aq, \(aqRelease\(aq. |
|
72 .TP |
|
73 .B \fB\-D <var>=<value>\fP |
|
74 Set a CPack variable. |
|
75 .sp |
|
76 Set a variable that can be used by the generator. |
|
77 .TP |
|
78 .B \fB\-\-config <config file>\fP |
|
79 Specify the config file. |
|
80 .sp |
|
81 Specify the config file to use to create the package. By default |
|
82 CPackConfig.cmake in the current directory will be used. |
|
83 .TP |
|
84 .B \fB\-\-verbose,\-V\fP |
|
85 enable verbose output |
|
86 .sp |
|
87 Run cpack with verbose output. |
|
88 .TP |
|
89 .B \fB\-\-debug\fP |
|
90 enable debug output (for CPack developers) |
|
91 .sp |
|
92 Run cpack with debug output (for CPack developers). |
|
93 .TP |
|
94 .B \fB\-P <package name>\fP |
|
95 override/define CPACK_PACKAGE_NAME |
|
96 .sp |
|
97 If the package name is not specified on cpack commmand line |
|
98 thenCPack.cmake defines it as CMAKE_PROJECT_NAME |
|
99 .TP |
|
100 .B \fB\-R <package version>\fP |
|
101 override/define CPACK_PACKAGE_VERSION |
|
102 .sp |
|
103 If version is not specified on cpack command line thenCPack.cmake |
|
104 defines it from CPACK_PACKAGE_VERSION_[MAJOR|MINOR|PATCH]look into |
|
105 CPack.cmake for detail |
|
106 .TP |
|
107 .B \fB\-B <package directory>\fP |
|
108 override/define CPACK_PACKAGE_DIRECTORY |
|
109 .sp |
|
110 The directory where CPack will be doing its packaging work.The |
|
111 resulting package will be found there. Inside this directoryCPack |
|
112 creates \(aq_CPack_Packages\(aq sub\-directory which is theCPack temporary |
|
113 directory. |
|
114 .TP |
|
115 .B \fB\-\-vendor <vendor name>\fP |
|
116 override/define CPACK_PACKAGE_VENDOR |
|
117 .sp |
|
118 If vendor is not specified on cpack command line (or inside |
|
119 CMakeLists.txt) thenCPack.cmake defines it with a default value |
|
120 .UNINDENT |
|
121 .INDENT 0.0 |
|
122 .TP |
|
123 .B \fB\-\-help,\-help,\-usage,\-h,\-H,/?\fP |
|
124 Print usage information and exit. |
|
125 .sp |
|
126 Usage describes the basic command line interface and its options. |
|
127 .TP |
|
128 .B \fB\-\-version,\-version,/V [<f>]\fP |
|
129 Show program name/version banner and exit. |
|
130 .sp |
|
131 If a file is specified, the version is written into it. |
|
132 The help is printed to a named <f>ile if given. |
|
133 .TP |
|
134 .B \fB\-\-help\-full [<f>]\fP |
|
135 Print all help manuals and exit. |
|
136 .sp |
|
137 All manuals are printed in a human\-readable text format. |
|
138 The help is printed to a named <f>ile if given. |
|
139 .TP |
|
140 .B \fB\-\-help\-manual <man> [<f>]\fP |
|
141 Print one help manual and exit. |
|
142 .sp |
|
143 The specified manual is printed in a human\-readable text format. |
|
144 The help is printed to a named <f>ile if given. |
|
145 .TP |
|
146 .B \fB\-\-help\-manual\-list [<f>]\fP |
|
147 List help manuals available and exit. |
|
148 .sp |
|
149 The list contains all manuals for which help may be obtained by |
|
150 using the \fB\-\-help\-manual\fP option followed by a manual name. |
|
151 The help is printed to a named <f>ile if given. |
|
152 .TP |
|
153 .B \fB\-\-help\-command <cmd> [<f>]\fP |
|
154 Print help for one command and exit. |
|
155 .sp |
|
156 The \fBcmake\-commands(7)\fP manual entry for \fB<cmd>\fP is |
|
157 printed in a human\-readable text format. |
|
158 The help is printed to a named <f>ile if given. |
|
159 .TP |
|
160 .B \fB\-\-help\-command\-list [<f>]\fP |
|
161 List commands with help available and exit. |
|
162 .sp |
|
163 The list contains all commands for which help may be obtained by |
|
164 using the \fB\-\-help\-command\fP option followed by a command name. |
|
165 The help is printed to a named <f>ile if given. |
|
166 .TP |
|
167 .B \fB\-\-help\-commands [<f>]\fP |
|
168 Print cmake\-commands manual and exit. |
|
169 .sp |
|
170 The \fBcmake\-commands(7)\fP manual is printed in a |
|
171 human\-readable text format. |
|
172 The help is printed to a named <f>ile if given. |
|
173 .TP |
|
174 .B \fB\-\-help\-module <mod> [<f>]\fP |
|
175 Print help for one module and exit. |
|
176 .sp |
|
177 The \fBcmake\-modules(7)\fP manual entry for \fB<mod>\fP is printed |
|
178 in a human\-readable text format. |
|
179 The help is printed to a named <f>ile if given. |
|
180 .TP |
|
181 .B \fB\-\-help\-module\-list [<f>]\fP |
|
182 List modules with help available and exit. |
|
183 .sp |
|
184 The list contains all modules for which help may be obtained by |
|
185 using the \fB\-\-help\-module\fP option followed by a module name. |
|
186 The help is printed to a named <f>ile if given. |
|
187 .TP |
|
188 .B \fB\-\-help\-modules [<f>]\fP |
|
189 Print cmake\-modules manual and exit. |
|
190 .sp |
|
191 The \fBcmake\-modules(7)\fP manual is printed in a human\-readable |
|
192 text format. |
|
193 The help is printed to a named <f>ile if given. |
|
194 .TP |
|
195 .B \fB\-\-help\-policy <cmp> [<f>]\fP |
|
196 Print help for one policy and exit. |
|
197 .sp |
|
198 The \fBcmake\-policies(7)\fP manual entry for \fB<cmp>\fP is |
|
199 printed in a human\-readable text format. |
|
200 The help is printed to a named <f>ile if given. |
|
201 .TP |
|
202 .B \fB\-\-help\-policy\-list [<f>]\fP |
|
203 List policies with help available and exit. |
|
204 .sp |
|
205 The list contains all policies for which help may be obtained by |
|
206 using the \fB\-\-help\-policy\fP option followed by a policy name. |
|
207 The help is printed to a named <f>ile if given. |
|
208 .TP |
|
209 .B \fB\-\-help\-policies [<f>]\fP |
|
210 Print cmake\-policies manual and exit. |
|
211 .sp |
|
212 The \fBcmake\-policies(7)\fP manual is printed in a |
|
213 human\-readable text format. |
|
214 The help is printed to a named <f>ile if given. |
|
215 .TP |
|
216 .B \fB\-\-help\-property <prop> [<f>]\fP |
|
217 Print help for one property and exit. |
|
218 .sp |
|
219 The \fBcmake\-properties(7)\fP manual entries for \fB<prop>\fP are |
|
220 printed in a human\-readable text format. |
|
221 The help is printed to a named <f>ile if given. |
|
222 .TP |
|
223 .B \fB\-\-help\-property\-list [<f>]\fP |
|
224 List properties with help available and exit. |
|
225 .sp |
|
226 The list contains all properties for which help may be obtained by |
|
227 using the \fB\-\-help\-property\fP option followed by a property name. |
|
228 The help is printed to a named <f>ile if given. |
|
229 .TP |
|
230 .B \fB\-\-help\-properties [<f>]\fP |
|
231 Print cmake\-properties manual and exit. |
|
232 .sp |
|
233 The \fBcmake\-properties(7)\fP manual is printed in a |
|
234 human\-readable text format. |
|
235 The help is printed to a named <f>ile if given. |
|
236 .TP |
|
237 .B \fB\-\-help\-variable <var> [<f>]\fP |
|
238 Print help for one variable and exit. |
|
239 .sp |
|
240 The \fBcmake\-variables(7)\fP manual entry for \fB<var>\fP is |
|
241 printed in a human\-readable text format. |
|
242 The help is printed to a named <f>ile if given. |
|
243 .TP |
|
244 .B \fB\-\-help\-variable\-list [<f>]\fP |
|
245 List variables with help available and exit. |
|
246 .sp |
|
247 The list contains all variables for which help may be obtained by |
|
248 using the \fB\-\-help\-variable\fP option followed by a variable name. |
|
249 The help is printed to a named <f>ile if given. |
|
250 .TP |
|
251 .B \fB\-\-help\-variables [<f>]\fP |
|
252 Print cmake\-variables manual and exit. |
|
253 .sp |
|
254 The \fBcmake\-variables(7)\fP manual is printed in a |
|
255 human\-readable text format. |
|
256 The help is printed to a named <f>ile if given. |
|
257 .UNINDENT |
|
258 .SH SEE ALSO |
|
259 .sp |
|
260 The following resources are available to get help using CMake: |
|
261 .INDENT 0.0 |
|
262 .TP |
|
263 .B Home Page |
|
264 \fI\%http://www.cmake.org\fP |
|
265 .sp |
|
266 The primary starting point for learning about CMake. |
|
267 .TP |
|
268 .B Frequently Asked Questions |
|
269 \fI\%http://www.cmake.org/Wiki/CMake_FAQ\fP |
|
270 .sp |
|
271 A Wiki is provided containing answers to frequently asked questions. |
|
272 .TP |
|
273 .B Online Documentation |
|
274 \fI\%http://www.cmake.org/documentation\fP |
|
275 .sp |
|
276 Links to available documentation may be found on this web page. |
|
277 .TP |
|
278 .B Mailing List |
|
279 \fI\%http://www.cmake.org/mailing\-lists\fP |
|
280 .sp |
|
281 For help and discussion about using cmake, a mailing list is |
|
282 provided at \fI\%[email protected]\fP\&. The list is member\-post\-only but one |
|
283 may sign up on the CMake web page. Please first read the full |
|
284 documentation at \fI\%http://www.cmake.org\fP before posting questions to |
|
285 the list. |
|
286 .UNINDENT |
|
287 .SH COPYRIGHT |
|
288 2000-2015 Kitware, Inc. |
|
289 .\" Generated by docutils manpage writer. |
|
290 . |