cmake-properties.7.rst 12 KB
Newer Older
1
2
.. cmake-manual-description: CMake Properties Reference

3
4
5
cmake-properties(7)
*******************

Brad King's avatar
Brad King committed
6
.. only:: html
7
8
9

   .. contents::

10
11
.. _`Global Properties`:

12
13
14
15
Properties of Global Scope
==========================

.. toctree::
16
17
   :maxdepth: 1

18
   /prop_gbl/ALLOW_DUPLICATE_CUSTOM_TARGETS
19
   /prop_gbl/AUTOGEN_TARGETS_FOLDER
20
   /prop_gbl/AUTOMOC_TARGETS_FOLDER
21
   /prop_gbl/CMAKE_C_KNOWN_FEATURES
22
   /prop_gbl/CMAKE_CXX_KNOWN_FEATURES
23
24
25
26
   /prop_gbl/DEBUG_CONFIGURATIONS
   /prop_gbl/DISABLED_FEATURES
   /prop_gbl/ENABLED_FEATURES
   /prop_gbl/ENABLED_LANGUAGES
27
   /prop_gbl/FIND_LIBRARY_USE_LIB32_PATHS
28
29
30
31
32
33
34
   /prop_gbl/FIND_LIBRARY_USE_LIB64_PATHS
   /prop_gbl/FIND_LIBRARY_USE_OPENBSD_VERSIONING
   /prop_gbl/GLOBAL_DEPENDS_DEBUG_MODE
   /prop_gbl/GLOBAL_DEPENDS_NO_CYCLES
   /prop_gbl/IN_TRY_COMPILE
   /prop_gbl/PACKAGES_FOUND
   /prop_gbl/PACKAGES_NOT_FOUND
35
   /prop_gbl/JOB_POOLS
36
   /prop_gbl/PREDEFINED_TARGETS_FOLDER
37
   /prop_gbl/ECLIPSE_EXTRA_NATURES
38
39
40
41
42
43
   /prop_gbl/REPORT_UNDEFINED_PROPERTIES
   /prop_gbl/RULE_LAUNCH_COMPILE
   /prop_gbl/RULE_LAUNCH_CUSTOM
   /prop_gbl/RULE_LAUNCH_LINK
   /prop_gbl/RULE_MESSAGES
   /prop_gbl/TARGET_ARCHIVES_MAY_BE_SHARED_LIBS
44
   /prop_gbl/TARGET_MESSAGES
45
46
47
   /prop_gbl/TARGET_SUPPORTS_SHARED_LIBS
   /prop_gbl/USE_FOLDERS

48
49
.. _`Directory Properties`:

50
51
52
53
Properties on Directories
=========================

.. toctree::
54
55
   :maxdepth: 1

56
   /prop_dir/ADDITIONAL_MAKE_CLEAN_FILES
57
   /prop_dir/BINARY_DIR
58
   /prop_dir/BUILDSYSTEM_TARGETS
59
60
   /prop_dir/CACHE_VARIABLES
   /prop_dir/CLEAN_NO_CUSTOM
61
   /prop_dir/CMAKE_CONFIGURE_DEPENDS
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
   /prop_dir/COMPILE_DEFINITIONS
   /prop_dir/COMPILE_OPTIONS
   /prop_dir/DEFINITIONS
   /prop_dir/EXCLUDE_FROM_ALL
   /prop_dir/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM
   /prop_dir/INCLUDE_DIRECTORIES
   /prop_dir/INCLUDE_REGULAR_EXPRESSION
   /prop_dir/INTERPROCEDURAL_OPTIMIZATION_CONFIG
   /prop_dir/INTERPROCEDURAL_OPTIMIZATION
   /prop_dir/LINK_DIRECTORIES
   /prop_dir/LISTFILE_STACK
   /prop_dir/MACROS
   /prop_dir/PARENT_DIRECTORY
   /prop_dir/RULE_LAUNCH_COMPILE
   /prop_dir/RULE_LAUNCH_CUSTOM
   /prop_dir/RULE_LAUNCH_LINK
78
   /prop_dir/SOURCE_DIR
79
   /prop_dir/SUBDIRECTORIES
80
81
82
83
   /prop_dir/TEST_INCLUDE_FILE
   /prop_dir/VARIABLES
   /prop_dir/VS_GLOBAL_SECTION_POST_section
   /prop_dir/VS_GLOBAL_SECTION_PRE_section
84
   /prop_dir/VS_STARTUP_PROJECT
85

86
87
.. _`Target Properties`:

88
89
90
91
Properties on Targets
=====================

.. toctree::
92
93
   :maxdepth: 1

94
   /prop_tgt/ALIASED_TARGET
95
   /prop_tgt/ANDROID_ANT_ADDITIONAL_OPTIONS
96
   /prop_tgt/ANDROID_API
97
   /prop_tgt/ANDROID_API_MIN
98
99
   /prop_tgt/ANDROID_ARCH
   /prop_tgt/ANDROID_ASSETS_DIRECTORIES
100
   /prop_tgt/ANDROID_GUI
101
102
103
104
105
106
107
108
109
110
111
   /prop_tgt/ANDROID_JAR_DEPENDENCIES
   /prop_tgt/ANDROID_JAR_DIRECTORIES
   /prop_tgt/ANDROID_JAVA_SOURCE_DIR
   /prop_tgt/ANDROID_NATIVE_LIB_DEPENDENCIES
   /prop_tgt/ANDROID_NATIVE_LIB_DIRECTORIES
   /prop_tgt/ANDROID_PROCESS_MAX
   /prop_tgt/ANDROID_PROGUARD
   /prop_tgt/ANDROID_PROGUARD_CONFIG_PATH
   /prop_tgt/ANDROID_SECURE_PROPS_PATH
   /prop_tgt/ANDROID_SKIP_ANT_STEP
   /prop_tgt/ANDROID_STL_TYPE
112
113
114
115
   /prop_tgt/ARCHIVE_OUTPUT_DIRECTORY_CONFIG
   /prop_tgt/ARCHIVE_OUTPUT_DIRECTORY
   /prop_tgt/ARCHIVE_OUTPUT_NAME_CONFIG
   /prop_tgt/ARCHIVE_OUTPUT_NAME
116
   /prop_tgt/AUTOGEN_TARGET_DEPENDS
117
118
   /prop_tgt/AUTOMOC_MOC_OPTIONS
   /prop_tgt/AUTOMOC
119
120
   /prop_tgt/AUTOUIC
   /prop_tgt/AUTOUIC_OPTIONS
121
122
   /prop_tgt/AUTORCC
   /prop_tgt/AUTORCC_OPTIONS
123
   /prop_tgt/BINARY_DIR
124
   /prop_tgt/BUILD_RPATH
125
126
127
   /prop_tgt/BUILD_WITH_INSTALL_RPATH
   /prop_tgt/BUNDLE_EXTENSION
   /prop_tgt/BUNDLE
128
129
130
   /prop_tgt/C_EXTENSIONS
   /prop_tgt/C_STANDARD
   /prop_tgt/C_STANDARD_REQUIRED
131
   /prop_tgt/COMPATIBLE_INTERFACE_BOOL
132
133
   /prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MAX
   /prop_tgt/COMPATIBLE_INTERFACE_NUMBER_MIN
134
135
   /prop_tgt/COMPATIBLE_INTERFACE_STRING
   /prop_tgt/COMPILE_DEFINITIONS
136
   /prop_tgt/COMPILE_FEATURES
137
138
   /prop_tgt/COMPILE_FLAGS
   /prop_tgt/COMPILE_OPTIONS
139
140
141
142
   /prop_tgt/COMPILE_PDB_NAME
   /prop_tgt/COMPILE_PDB_NAME_CONFIG
   /prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY
   /prop_tgt/COMPILE_PDB_OUTPUT_DIRECTORY_CONFIG
143
144
   /prop_tgt/CONFIG_OUTPUT_NAME
   /prop_tgt/CONFIG_POSTFIX
145
   /prop_tgt/CROSSCOMPILING_EMULATOR
146
   /prop_tgt/CUDA_SEPARABLE_COMPILATION
147
148
149
   /prop_tgt/CUDA_EXTENSIONS
   /prop_tgt/CUDA_STANDARD
   /prop_tgt/CUDA_STANDARD_REQUIRED
150
   /prop_tgt/CXX_EXTENSIONS
151
   /prop_tgt/CXX_STANDARD
152
   /prop_tgt/CXX_STANDARD_REQUIRED
153
154
   /prop_tgt/DEBUG_POSTFIX
   /prop_tgt/DEFINE_SYMBOL
155
   /prop_tgt/DEPLOYMENT_REMOTE_DIRECTORY
156
157
158
159
160
161
162
163
164
165
   /prop_tgt/EchoString
   /prop_tgt/ENABLE_EXPORTS
   /prop_tgt/EXCLUDE_FROM_ALL
   /prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD_CONFIG
   /prop_tgt/EXCLUDE_FROM_DEFAULT_BUILD
   /prop_tgt/EXPORT_NAME
   /prop_tgt/FOLDER
   /prop_tgt/Fortran_FORMAT
   /prop_tgt/Fortran_MODULE_DIRECTORY
   /prop_tgt/FRAMEWORK
166
   /prop_tgt/FRAMEWORK_VERSION
167
168
169
170
171
172
173
   /prop_tgt/GENERATOR_FILE_NAME
   /prop_tgt/GNUtoMS
   /prop_tgt/HAS_CXX
   /prop_tgt/IMPLICIT_DEPENDS_INCLUDE_TRANSFORM
   /prop_tgt/IMPORTED_CONFIGURATIONS
   /prop_tgt/IMPORTED_IMPLIB_CONFIG
   /prop_tgt/IMPORTED_IMPLIB
174
175
   /prop_tgt/IMPORTED_LIBNAME_CONFIG
   /prop_tgt/IMPORTED_LIBNAME
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
   /prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES_CONFIG
   /prop_tgt/IMPORTED_LINK_DEPENDENT_LIBRARIES
   /prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES_CONFIG
   /prop_tgt/IMPORTED_LINK_INTERFACE_LANGUAGES
   /prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES_CONFIG
   /prop_tgt/IMPORTED_LINK_INTERFACE_LIBRARIES
   /prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY_CONFIG
   /prop_tgt/IMPORTED_LINK_INTERFACE_MULTIPLICITY
   /prop_tgt/IMPORTED_LOCATION_CONFIG
   /prop_tgt/IMPORTED_LOCATION
   /prop_tgt/IMPORTED_NO_SONAME_CONFIG
   /prop_tgt/IMPORTED_NO_SONAME
   /prop_tgt/IMPORTED
   /prop_tgt/IMPORTED_SONAME_CONFIG
   /prop_tgt/IMPORTED_SONAME
   /prop_tgt/IMPORT_PREFIX
   /prop_tgt/IMPORT_SUFFIX
   /prop_tgt/INCLUDE_DIRECTORIES
   /prop_tgt/INSTALL_NAME_DIR
   /prop_tgt/INSTALL_RPATH
   /prop_tgt/INSTALL_RPATH_USE_LINK_PATH
197
   /prop_tgt/INTERFACE_AUTOUIC_OPTIONS
198
   /prop_tgt/INTERFACE_COMPILE_DEFINITIONS
199
   /prop_tgt/INTERFACE_COMPILE_FEATURES
200
201
202
203
   /prop_tgt/INTERFACE_COMPILE_OPTIONS
   /prop_tgt/INTERFACE_INCLUDE_DIRECTORIES
   /prop_tgt/INTERFACE_LINK_LIBRARIES
   /prop_tgt/INTERFACE_POSITION_INDEPENDENT_CODE
204
   /prop_tgt/INTERFACE_SOURCES
205
206
207
   /prop_tgt/INTERFACE_SYSTEM_INCLUDE_DIRECTORIES
   /prop_tgt/INTERPROCEDURAL_OPTIMIZATION_CONFIG
   /prop_tgt/INTERPROCEDURAL_OPTIMIZATION
208
   /prop_tgt/IOS_INSTALL_COMBINED
209
210
   /prop_tgt/JOB_POOL_COMPILE
   /prop_tgt/JOB_POOL_LINK
211
   /prop_tgt/LABELS
212
   /prop_tgt/LANG_CLANG_TIDY
213
   /prop_tgt/LANG_COMPILER_LAUNCHER
214
   /prop_tgt/LANG_INCLUDE_WHAT_YOU_USE
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
   /prop_tgt/LANG_VISIBILITY_PRESET
   /prop_tgt/LIBRARY_OUTPUT_DIRECTORY_CONFIG
   /prop_tgt/LIBRARY_OUTPUT_DIRECTORY
   /prop_tgt/LIBRARY_OUTPUT_NAME_CONFIG
   /prop_tgt/LIBRARY_OUTPUT_NAME
   /prop_tgt/LINK_DEPENDS_NO_SHARED
   /prop_tgt/LINK_DEPENDS
   /prop_tgt/LINKER_LANGUAGE
   /prop_tgt/LINK_FLAGS_CONFIG
   /prop_tgt/LINK_FLAGS
   /prop_tgt/LINK_INTERFACE_LIBRARIES_CONFIG
   /prop_tgt/LINK_INTERFACE_LIBRARIES
   /prop_tgt/LINK_INTERFACE_MULTIPLICITY_CONFIG
   /prop_tgt/LINK_INTERFACE_MULTIPLICITY
   /prop_tgt/LINK_LIBRARIES
   /prop_tgt/LINK_SEARCH_END_STATIC
   /prop_tgt/LINK_SEARCH_START_STATIC
232
   /prop_tgt/LINK_WHAT_YOU_USE
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
   /prop_tgt/LOCATION_CONFIG
   /prop_tgt/LOCATION
   /prop_tgt/MACOSX_BUNDLE_INFO_PLIST
   /prop_tgt/MACOSX_BUNDLE
   /prop_tgt/MACOSX_FRAMEWORK_INFO_PLIST
   /prop_tgt/MACOSX_RPATH
   /prop_tgt/MAP_IMPORTED_CONFIG_CONFIG
   /prop_tgt/NAME
   /prop_tgt/NO_SONAME
   /prop_tgt/NO_SYSTEM_FROM_IMPORTED
   /prop_tgt/OSX_ARCHITECTURES_CONFIG
   /prop_tgt/OSX_ARCHITECTURES
   /prop_tgt/OUTPUT_NAME_CONFIG
   /prop_tgt/OUTPUT_NAME
   /prop_tgt/PDB_NAME_CONFIG
   /prop_tgt/PDB_NAME
   /prop_tgt/PDB_OUTPUT_DIRECTORY_CONFIG
   /prop_tgt/PDB_OUTPUT_DIRECTORY
   /prop_tgt/POSITION_INDEPENDENT_CODE
   /prop_tgt/PREFIX
   /prop_tgt/PRIVATE_HEADER
   /prop_tgt/PROJECT_LABEL
   /prop_tgt/PUBLIC_HEADER
   /prop_tgt/RESOURCE
   /prop_tgt/RULE_LAUNCH_COMPILE
   /prop_tgt/RULE_LAUNCH_CUSTOM
   /prop_tgt/RULE_LAUNCH_LINK
   /prop_tgt/RUNTIME_OUTPUT_DIRECTORY_CONFIG
   /prop_tgt/RUNTIME_OUTPUT_DIRECTORY
   /prop_tgt/RUNTIME_OUTPUT_NAME_CONFIG
   /prop_tgt/RUNTIME_OUTPUT_NAME
   /prop_tgt/SKIP_BUILD_RPATH
265
   /prop_tgt/SOURCE_DIR
266
267
268
269
270
271
272
273
   /prop_tgt/SOURCES
   /prop_tgt/SOVERSION
   /prop_tgt/STATIC_LIBRARY_FLAGS_CONFIG
   /prop_tgt/STATIC_LIBRARY_FLAGS
   /prop_tgt/SUFFIX
   /prop_tgt/TYPE
   /prop_tgt/VERSION
   /prop_tgt/VISIBILITY_INLINES_HIDDEN
274
   /prop_tgt/VS_CONFIGURATION_TYPE
275
   /prop_tgt/VS_DEBUGGER_WORKING_DIRECTORY
276
   /prop_tgt/VS_DESKTOP_EXTENSIONS_VERSION
277
278
279
280
281
282
   /prop_tgt/VS_DOTNET_REFERENCES
   /prop_tgt/VS_DOTNET_TARGET_FRAMEWORK_VERSION
   /prop_tgt/VS_GLOBAL_KEYWORD
   /prop_tgt/VS_GLOBAL_PROJECT_TYPES
   /prop_tgt/VS_GLOBAL_ROOTNAMESPACE
   /prop_tgt/VS_GLOBAL_variable
283
284
   /prop_tgt/VS_IOT_EXTENSIONS_VERSION
   /prop_tgt/VS_IOT_STARTUP_TASK
285
   /prop_tgt/VS_KEYWORD
286
   /prop_tgt/VS_MOBILE_EXTENSIONS_VERSION
287
288
289
290
   /prop_tgt/VS_SCC_AUXPATH
   /prop_tgt/VS_SCC_LOCALPATH
   /prop_tgt/VS_SCC_PROJECTNAME
   /prop_tgt/VS_SCC_PROVIDER
291
   /prop_tgt/VS_SDK_REFERENCES
292
   /prop_tgt/VS_USER_PROPS_CXX
293
   /prop_tgt/VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION
294
   /prop_tgt/VS_WINRT_COMPONENT
295
296
297
   /prop_tgt/VS_WINRT_EXTENSIONS
   /prop_tgt/VS_WINRT_REFERENCES
   /prop_tgt/WIN32_EXECUTABLE
298
   /prop_tgt/WINDOWS_EXPORT_ALL_SYMBOLS
299
   /prop_tgt/XCODE_ATTRIBUTE_an-attribute
300
   /prop_tgt/XCODE_EXPLICIT_FILE_TYPE
301
   /prop_tgt/XCODE_PRODUCT_TYPE
302
   /prop_tgt/XCTEST
303

304
305
.. _`Test Properties`:

306
307
308
309
Properties on Tests
===================

.. toctree::
310
311
   :maxdepth: 1

312
313
314
315
316
317
   /prop_test/ATTACHED_FILES_ON_FAIL
   /prop_test/ATTACHED_FILES
   /prop_test/COST
   /prop_test/DEPENDS
   /prop_test/ENVIRONMENT
   /prop_test/FAIL_REGULAR_EXPRESSION
318
319
320
   /prop_test/FIXTURES_CLEANUP
   /prop_test/FIXTURES_REQUIRED
   /prop_test/FIXTURES_SETUP
321
322
323
324
325
326
327
   /prop_test/LABELS
   /prop_test/MEASUREMENT
   /prop_test/PASS_REGULAR_EXPRESSION
   /prop_test/PROCESSORS
   /prop_test/REQUIRED_FILES
   /prop_test/RESOURCE_LOCK
   /prop_test/RUN_SERIAL
328
   /prop_test/SKIP_RETURN_CODE
329
   /prop_test/TIMEOUT
330
   /prop_test/TIMEOUT_AFTER_MATCH
331
332
333
   /prop_test/WILL_FAIL
   /prop_test/WORKING_DIRECTORY

334
335
.. _`Source File Properties`:

336
337
338
339
Properties on Source Files
==========================

.. toctree::
340
341
   :maxdepth: 1

342
   /prop_sf/ABSTRACT
343
   /prop_sf/AUTOUIC_OPTIONS
344
   /prop_sf/AUTORCC_OPTIONS
345
346
347
348
349
350
351
352
353
354
355
356
357
358
   /prop_sf/COMPILE_DEFINITIONS
   /prop_sf/COMPILE_FLAGS
   /prop_sf/EXTERNAL_OBJECT
   /prop_sf/Fortran_FORMAT
   /prop_sf/GENERATED
   /prop_sf/HEADER_FILE_ONLY
   /prop_sf/KEEP_EXTENSION
   /prop_sf/LABELS
   /prop_sf/LANGUAGE
   /prop_sf/LOCATION
   /prop_sf/MACOSX_PACKAGE_LOCATION
   /prop_sf/OBJECT_DEPENDS
   /prop_sf/OBJECT_OUTPUTS
   /prop_sf/SYMBOLIC
359
   /prop_sf/VS_DEPLOYMENT_CONTENT
360
   /prop_sf/VS_DEPLOYMENT_LOCATION
361
   /prop_sf/VS_SHADER_ENTRYPOINT
362
   /prop_sf/VS_SHADER_FLAGS
363
   /prop_sf/VS_SHADER_MODEL
364
   /prop_sf/VS_SHADER_TYPE
365
   /prop_sf/VS_TOOL_OVERRIDE.rst
366
   /prop_sf/VS_XAML_TYPE
367
   /prop_sf/WRAP_EXCLUDE
368
   /prop_sf/XCODE_EXPLICIT_FILE_TYPE
369
   /prop_sf/XCODE_FILE_ATTRIBUTES
370
   /prop_sf/XCODE_LAST_KNOWN_FILE_TYPE
371

372
373
.. _`Cache Entry Properties`:

374
375
376
377
Properties on Cache Entries
===========================

.. toctree::
378
379
   :maxdepth: 1

380
381
382
383
384
385
   /prop_cache/ADVANCED
   /prop_cache/HELPSTRING
   /prop_cache/MODIFIED
   /prop_cache/STRINGS
   /prop_cache/TYPE
   /prop_cache/VALUE
386

387
388
.. _`Installed File Properties`:

389
390
391
392
393
Properties on Installed Files
=============================

.. toctree::
   :maxdepth: 1
394

395
   /prop_inst/CPACK_DESKTOP_SHORTCUTS.rst
396
397
   /prop_inst/CPACK_NEVER_OVERWRITE.rst
   /prop_inst/CPACK_PERMANENT.rst
398
   /prop_inst/CPACK_START_MENU_SHORTCUTS.rst
399
   /prop_inst/CPACK_STARTUP_SHORTCUTS.rst
400
   /prop_inst/CPACK_WIX_ACL.rst
401
402
403


Deprecated Properties on Directories
404
====================================
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429

.. toctree::
   :maxdepth: 1

   /prop_dir/COMPILE_DEFINITIONS_CONFIG


Deprecated Properties on Targets
================================

.. toctree::
   :maxdepth: 1

   /prop_tgt/COMPILE_DEFINITIONS_CONFIG
   /prop_tgt/POST_INSTALL_SCRIPT
   /prop_tgt/PRE_INSTALL_SCRIPT


Deprecated Properties on Source Files
=====================================

.. toctree::
   :maxdepth: 1

   /prop_sf/COMPILE_DEFINITIONS_CONFIG