GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  CMAKE-PROPERTIES (7)

NAME

cmake-properties - CMake Properties Reference \$1 \n[an-margin] level \n[rst2man-indent-level] level margin: \n[rst2man-indent\n[rst2man-indent-level]] - \n[rst2man-indent0] \n[rst2man-indent1] \n[rst2man-indent2]

CONTENTS

Properties Of Global Scope
     Allow_duplicate_custom_targets
     Autogen_targets_folder
     Automoc_targets_folder
     Cmake_c_known_features
     Cmake_cxx_known_features
     Debug_configurations
     Disabled_features
     Enabled_features
     Enabled_languages
     Find_library_use_lib64_paths
     Find_library_use_openbsd_versioning
     Global_depends_debug_mode
     Global_depends_no_cycles
     In_try_compile
     Packages_found
     Packages_not_found
     Job_pools
     Predefined_targets_folder
     Eclipse_extra_natures
     Report_undefined_properties
     Rule_launch_compile
     Rule_launch_custom
     Rule_launch_link
     Rule_messages
     Target_archives_may_be_shared_libs
     Target_messages
     Target_supports_shared_libs
     Use_folders
Properties On Directories
     Additional_make_clean_files
     Cache_variables
     Clean_no_custom
     Cmake_configure_depends
     Compile_definitions
     Compile_options
     Definitions
     Exclude_from_all
     Implicit_depends_include_transform
     Include_directories
     Include_regular_expression
     INTERPROCEDURAL_OPTIMIZATION_<CONFIG>
     Interprocedural_optimization
     Link_directories
     Listfile_stack
     Macros
     Parent_directory
     Rule_launch_compile
     Rule_launch_custom
     Rule_launch_link
     Test_include_file
     Variables
     VS_GLOBAL_SECTION_POST_<section>
     VS_GLOBAL_SECTION_PRE_<section>
Properties On Targets
     Aliased_target
     Android_ant_additional_options
     Android_api
     Android_api_min
     Android_arch
     Android_assets_directories
     Android_gui
     Android_jar_dependencies
     Android_jar_directories
     Android_java_source_dir
     Android_native_lib_dependencies
     Android_native_lib_directories
     Android_process_max
     Android_proguard
     Android_proguard_config_path
     Android_secure_props_path
     Android_skip_ant_step
     Android_stl_type
     ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>
     Archive_output_directory
     ARCHIVE_OUTPUT_NAME_<CONFIG>
     Archive_output_name
     Autogen_target_depends
     Automoc_moc_options
     Automoc
     Autouic
     Autouic_options
     Autorcc
     Autorcc_options
     Binary_dir
     Build_with_install_rpath
     Bundle_extension
     Bundle
     C_extensions
     C_standard
     C_standard_required
     Compatible_interface_bool
     Compatible_interface_number_max
     Compatible_interface_number_min
     Compatible_interface_string
     Compile_definitions
     Compile_features
     Compile_flags
     Compile_options
     Compile_pdb_name
     COMPILE_PDB_NAME_<CONFIG>
     Compile_pdb_output_directory
     COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG>
     Crosscompiling_emulator
     Cxx_extensions
     Cxx_standard
     Cxx_standard_required
     Debug_postfix
     Define_symbol
     EchoString
     Enable_exports
     Exclude_from_all
     EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG>
     Exclude_from_default_build
     Export_name
     Folder
     Fortran_FORMAT
     Fortran_MODULE_DIRECTORY
     Framework
     Framework_version
     Generator_file_name
     GNUtoMS
     Has_cxx
     Implicit_depends_include_transform
     Imported_configurations
     IMPORTED_IMPLIB_<CONFIG>
     Imported_implib
     IMPORTED_LINK_DEPENDENT_LIBRARIES_<CONFIG>
     Imported_link_dependent_libraries
     IMPORTED_LINK_INTERFACE_LANGUAGES_<CONFIG>
     Imported_link_interface_languages
     IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG>
     Imported_link_interface_libraries
     IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG>
     Imported_link_interface_multiplicity
     IMPORTED_LOCATION_<CONFIG>
     Imported_location
     IMPORTED_NO_SONAME_<CONFIG>
     Imported_no_soname
     Imported
     IMPORTED_SONAME_<CONFIG>
     Imported_soname
     Import_prefix
     Import_suffix
     Include_directories
     Install_name_dir
     Install_rpath
     Install_rpath_use_link_path
     Interface_autouic_options
     Interface_compile_definitions
     Interface_compile_features
     Interface_compile_options
     Interface_include_directories
     Creating Relocatable Packages
     Interface_link_libraries
     Creating Relocatable Packages
     Interface_position_independent_code
     Interface_sources
     Interface_system_include_directories
     INTERPROCEDURAL_OPTIMIZATION_<CONFIG>
     Interprocedural_optimization
     Ios_install_combined
     Job_pool_compile
     Job_pool_link
     Labels
     LIBRARY_OUTPUT_DIRECTORY_<CONFIG>
     Library_output_directory
     LIBRARY_OUTPUT_NAME_<CONFIG>
     Library_output_name
     Link_depends_no_shared
     Link_depends
     Linker_language
     LINK_FLAGS_<CONFIG>
     Link_flags
     LINK_INTERFACE_LIBRARIES_<CONFIG>
     Creating Relocatable Packages
     Link_interface_libraries
     Creating Relocatable Packages
     LINK_INTERFACE_MULTIPLICITY_<CONFIG>
     Link_interface_multiplicity
     Link_libraries
     Link_search_end_static
     Link_search_start_static
     LOCATION_<CONFIG>
     Location
     Macosx_bundle_info_plist
     Macosx_bundle
     Macosx_framework_info_plist
     Macosx_rpath
     MAP_IMPORTED_CONFIG_<CONFIG>
     Name
     No_soname
     No_system_from_imported
     OSX_ARCHITECTURES_<CONFIG>
     Osx_architectures
     OUTPUT_NAME_<CONFIG>
     Output_name
     PDB_NAME_<CONFIG>
     Pdb_name
     PDB_OUTPUT_DIRECTORY_<CONFIG>
     Pdb_output_directory
     Position_independent_code
     Prefix
     Private_header
     Project_label
     Public_header
     Resource
     Rule_launch_compile
     Rule_launch_custom
     Rule_launch_link
     RUNTIME_OUTPUT_DIRECTORY_<CONFIG>
     Runtime_output_directory
     RUNTIME_OUTPUT_NAME_<CONFIG>
     Runtime_output_name
     Skip_build_rpath
     Source_dir
     Sources
     Soversion
     STATIC_LIBRARY_FLAGS_<CONFIG>
     Static_library_flags
     Suffix
     Type
     Version
     Visibility_inlines_hidden
     Vs_desktop_extensions_version
     Vs_dotnet_references
     Vs_dotnet_target_framework_version
     Vs_global_keyword
     Vs_global_project_types
     Vs_global_rootnamespace
     VS_GLOBAL_<variable>
     Vs_iot_extensions_version
     Vs_iot_startup_task
     Vs_keyword
     Vs_mobile_extensions_version
     Vs_scc_auxpath
     Vs_scc_localpath
     Vs_scc_projectname
     Vs_scc_provider
     Vs_windows_target_platform_min_version
     Vs_winrt_component
     Vs_winrt_extensions
     Vs_winrt_references
     Win32_executable
     Windows_export_all_symbols
     XCODE_ATTRIBUTE_<an-attribute>
     Xctest
Properties On Tests
     Attached_files_on_fail
     Attached_files
     Cost
     Depends
     Environment
     Fail_regular_expression
     Labels
     Measurement
     Pass_regular_expression
     Processors
     Required_files
     Resource_lock
     Run_serial
     Skip_return_code
     Timeout
     Will_fail
     Working_directory
Properties On Source Files
     Abstract
     Autouic_options
     Autorcc_options
     Compile_definitions
     Compile_flags
     External_object
     Fortran_FORMAT
     Generated
     Header_file_only
     Keep_extension
     Labels
     Language
     Location
     Macosx_package_location
     Object_depends
     Object_outputs
     Symbolic
     Vs_deployment_content
     Vs_deployment_location
     Vs_shader_entrypoint
     Vs_shader_flags
     Vs_shader_model
     Vs_shader_type
     Vs_xaml_type
     Wrap_exclude
     Xcode_explicit_file_type
     Xcode_last_known_file_type
Properties On Cache Entries
     Advanced
     Helpstring
     Modified
     Strings
     Type
     Value
Properties On Installed Files
     Cpack_desktop_shortcuts
     Cpack_never_overwrite
     Cpack_permanent
     Cpack_start_menu_shortcuts
     Cpack_startup_shortcuts
     Cpack_wix_acl
Deprecated Properties On Directories
     COMPILE_DEFINITIONS_<CONFIG>
Deprecated Properties On Targets
     COMPILE_DEFINITIONS_<CONFIG>
     Post_install_script
     Pre_install_script
Deprecated Properties On Source Files
     COMPILE_DEFINITIONS_<CONFIG>
Copyright

PROPERTIES OF GLOBAL SCOPE

    ALLOW_DUPLICATE_CUSTOM_TARGETS

Allow duplicate custom targets to be created.

Normally CMake requires that all targets built in a project have globally unique logical names (see policy CMP0002). This is necessary to generate meaningful project file names in Xcode and VS IDE generators. It also allows the target names to be referenced unambiguously.

Makefile generators are capable of supporting duplicate custom target names. For projects that care only about Makefile generators and do not wish to support Xcode or VS IDE generators, one may set this property to true to allow duplicate custom targets. The property allows multiple add_custom_target command calls in different directories to specify the same target name. However, setting this property will cause non-Makefile generators to produce an error and refuse to generate the project.

    AUTOGEN_TARGETS_FOLDER

Name of FOLDER for *_automoc targets that are added automatically by CMake for targets for which AUTOMOC is enabled.

If not set, CMake uses the FOLDER property of the parent target as a default value for this property. See also the documentation for the FOLDER target property and the AUTOMOC target property.

    AUTOMOC_TARGETS_FOLDER

Name of FOLDER for *_automoc targets that are added automatically by CMake for targets for which AUTOMOC is enabled.

This property is obsolete. Use AUTOGEN_TARGETS_FOLDER instead.

If not set, CMake uses the FOLDER property of the parent target as a default value for this property. See also the documentation for the FOLDER target property and the AUTOMOC target property.

    CMAKE_C_KNOWN_FEATURES

List of C features known to this version of CMake.

The features listed in this global property may be known to be available to the C compiler. If the feature is available with the C compiler, it will be listed in the CMAKE_C_COMPILE_FEATURES variable.

The features listed here may be used with the target_compile_features() command. See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

The features known to this version of CMake are:
c_function_prototypes
  Function prototypes, as defined in ISO/IEC 9899:1990.
c_restrict
  restrict keyword, as defined in ISO/IEC 9899:1999.
c_static_assert
  Static assert, as defined in ISO/IEC 9899:2011.
c_variadic_macros
  Variadic macros, as defined in ISO/IEC 9899:1999.

    CMAKE_CXX_KNOWN_FEATURES

List of C++ features known to this version of CMake.

The features listed in this global property may be known to be available to the C++ compiler. If the feature is available with the C++ compiler, it will be listed in the CMAKE_CXX_COMPILE_FEATURES variable.

The features listed here may be used with the target_compile_features() command. See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

The features known to this version of CMake are:
cxx_aggregate_default_initializers
  Aggregate default initializers, as defined in  N3605.
cxx_alias_templates
  Template aliases, as defined in  N2258.
cxx_alignas
  Alignment control alignas, as defined in  N2341.
cxx_alignof
  Alignment control alignof, as defined in  N2341.
cxx_attributes
  Generic attributes, as defined in  N2761.
cxx_attribute_deprecated
  [[deprecated]] attribute, as defined in  N3760.
cxx_auto_type
  Automatic type deduction, as defined in  N1984.
cxx_binary_literals
  Binary literals, as defined in  N3472.
cxx_constexpr
  Constant expressions, as defined in  N2235.
cxx_contextual_conversions
  Contextual conversions, as defined in  N3323.
cxx_decltype_incomplete_return_types
  Decltype on incomplete return types, as defined in  N3276.
cxx_decltype
  Decltype, as defined in  N2343.
cxx_decltype_auto
  decltype(auto) semantics, as defined in  N3638.
cxx_default_function_template_args
  Default template arguments for function templates, as defined in  DR226
cxx_defaulted_functions
  Defaulted functions, as defined in  N2346.
cxx_defaulted_move_initializers
  Defaulted move initializers, as defined in  N3053.
cxx_delegating_constructors
  Delegating constructors, as defined in  N1986.
cxx_deleted_functions
  Deleted functions, as defined in  N2346.
cxx_digit_separators
  Digit separators, as defined in  N3781.
cxx_enum_forward_declarations
  Enum forward declarations, as defined in  N2764.
cxx_explicit_conversions
  Explicit conversion operators, as defined in  N2437.
cxx_extended_friend_declarations
  Extended friend declarations, as defined in  N1791.
cxx_extern_templates
  Extern templates, as defined in  N1987.
cxx_final
  Override control final keyword, as defined in  N2928,  N3206 and  N3272.
cxx_func_identifier
  Predefined __func__ identifier, as defined in  N2340.
cxx_generalized_initializers
  Initializer lists, as defined in  N2672.
cxx_generic_lambdas
  Generic lambdas, as defined in  N3649.
cxx_inheriting_constructors
  Inheriting constructors, as defined in  N2540.
cxx_inline_namespaces
  Inline namespaces, as defined in  N2535.
cxx_lambdas
  Lambda functions, as defined in  N2927.
cxx_lambda_init_captures
  Initialized lambda captures, as defined in  N3648.
cxx_local_type_template_args
  Local and unnamed types as template arguments, as defined in  N2657.
cxx_long_long_type
  long long type, as defined in  N1811.
cxx_noexcept
  Exception specifications, as defined in  N3050.
cxx_nonstatic_member_init
  Non-static data member initialization, as defined in  N2756.
cxx_nullptr
  Null pointer, as defined in  N2431.
cxx_override
  Override control override keyword, as defined in  N2928,  N3206 and  N3272.
cxx_range_for
  Range-based for, as defined in  N2930.
cxx_raw_string_literals
  Raw string literals, as defined in  N2442.
cxx_reference_qualified_functions
  Reference qualified functions, as defined in  N2439.
cxx_relaxed_constexpr
  Relaxed constexpr, as defined in  N3652.
cxx_return_type_deduction
  Return type deduction on normal functions, as defined in  N3386.
cxx_right_angle_brackets
  Right angle bracket parsing, as defined in  N1757.
cxx_rvalue_references
  R-value references, as defined in  N2118.
cxx_sizeof_member
  Size of non-static data members, as defined in  N2253.
cxx_static_assert
  Static assert, as defined in  N1720.
cxx_strong_enums
  Strongly typed enums, as defined in  N2347.
cxx_thread_local
  Thread-local variables, as defined in  N2659.
cxx_trailing_return_types
  Automatic function return type, as defined in  N2541.
cxx_unicode_literals
  Unicode string literals, as defined in  N2442.
cxx_uniform_initialization
  Uniform intialization, as defined in  N2640.
cxx_unrestricted_unions
  Unrestricted unions, as defined in  N2544.
cxx_user_literals
  User-defined literals, as defined in  N2765.
cxx_variable_templates
  Variable templates, as defined in  N3651.
cxx_variadic_macros
  Variadic macros, as defined in  N1653.
cxx_variadic_templates
  Variadic templates, as defined in  N2242.
cxx_template_template_parameters
  Template template parameters, as defined in ISO/IEC 14882:1998.

    DEBUG_CONFIGURATIONS

Specify which configurations are for debugging.

The value must be a semi-colon separated list of configuration names. Currently this property is used only by the target_link_libraries command (see its documentation for details). Additional uses may be defined in the future.

This property must be set at the top level of the project and before the first target_link_libraries command invocation. If any entry in the list does not match a valid configuration for the project the behavior is undefined.

    DISABLED_FEATURES

List of features which are disabled during the CMake run.

List of features which are disabled during the CMake run. By default it contains the names of all packages which were not found. This is determined using the <NAME>_FOUND variables. Packages which are searched QUIET are not listed. A project can add its own features to this list. This property is used by the macros in FeatureSummary.cmake.

    ENABLED_FEATURES

List of features which are enabled during the CMake run.

List of features which are enabled during the CMake run. By default it contains the names of all packages which were found. This is determined using the <NAME>_FOUND variables. Packages which are searched QUIET are not listed. A project can add its own features to this list. This property is used by the macros in FeatureSummary.cmake.

    ENABLED_LANGUAGES

Read-only property that contains the list of currently enabled languages

Set to list of currently enabled languages.

    FIND_LIBRARY_USE_LIB64_PATHS

Whether FIND_LIBRARY should automatically search lib64 directories.

FIND_LIBRARY_USE_LIB64_PATHS is a boolean specifying whether the FIND_LIBRARY command should automatically search the lib64 variant of directories called lib in the search path when building 64-bit binaries.

    FIND_LIBRARY_USE_OPENBSD_VERSIONING

Whether FIND_LIBRARY should find OpenBSD-style shared libraries.

This property is a boolean specifying whether the FIND_LIBRARY command should find shared libraries with OpenBSD-style versioned extension: ".so.<major>.<minor>". The property is set to true on OpenBSD and false on other platforms.

    GLOBAL_DEPENDS_DEBUG_MODE

Enable global target dependency graph debug mode.

CMake automatically analyzes the global inter-target dependency graph at the beginning of native build system generation. This property causes it to display details of its analysis to stderr.

    GLOBAL_DEPENDS_NO_CYCLES

Disallow global target dependency graph cycles.

CMake automatically analyzes the global inter-target dependency graph at the beginning of native build system generation. It reports an error if the dependency graph contains a cycle that does not consist of all STATIC library targets. This property tells CMake to disallow all cycles completely, even among static libraries.

    IN_TRY_COMPILE

Read-only property that is true during a try-compile configuration.

True when building a project inside a TRY_COMPILE or TRY_RUN command.

    PACKAGES_FOUND

List of packages which were found during the CMake run.

List of packages which were found during the CMake run. Whether a package has been found is determined using the <NAME>_FOUND variables.

    PACKAGES_NOT_FOUND

List of packages which were not found during the CMake run.

List of packages which were not found during the CMake run. Whether a package has been found is determined using the <NAME>_FOUND variables.

    JOB_POOLS

Ninja only: List of available pools.

A pool is a named integer property and defines the maximum number of concurrent jobs which can be started by a rule assigned to the pool. The  JOB_POOLS property is a semicolon-separated list of pairs using the syntax NAME=integer (without a space after the equality sign).

For instance:


set_property(GLOBAL PROPERTY JOB_POOLS two_jobs=2 ten_jobs=10)


Defined pools could be used globally by setting CMAKE_JOB_POOL_COMPILE and CMAKE_JOB_POOL_LINK or per target by setting the target properties JOB_POOL_COMPILE and JOB_POOL_LINK.

Build targets provided by CMake that are meant for individual interactive use, such as install, are placed in the console pool automatically.

    PREDEFINED_TARGETS_FOLDER

Name of FOLDER for targets that are added automatically by CMake.

If not set, CMake uses "CMakePredefinedTargets" as a default value for this property. Targets such as INSTALL, PACKAGE and RUN_TESTS will be organized into this FOLDER. See also the documentation for the FOLDER target property.

    ECLIPSE_EXTRA_NATURES

List of natures to add to the generated Eclipse project file.

Eclipse projects specify language plugins by using natures. This property should be set to the unique identifier for a nature (which looks like a Java package name).

    REPORT_UNDEFINED_PROPERTIES

If set, report any undefined properties to this file.

If this property is set to a filename then when CMake runs it will report any properties or variables that were accessed but not defined into the filename specified in this property.

    RULE_LAUNCH_COMPILE

Specify a launcher for compile rules.

Makefile Generators and the Ninja generator prefix compiler commands with the given launcher command line. This is intended to allow launchers to intercept build problems with high granularity. Other generators ignore this property because their underlying build systems provide no hook to wrap individual commands with a launcher.

    RULE_LAUNCH_CUSTOM

Specify a launcher for custom rules.

Makefile Generators and the Ninja generator prefix custom commands with the given launcher command line. This is intended to allow launchers to intercept build problems with high granularity. Other generators ignore this property because their underlying build systems provide no hook to wrap individual commands with a launcher.

    RULE_LAUNCH_LINK

Specify a launcher for link rules.

Makefile Generators and the Ninja generator prefix link and archive commands with the given launcher command line. This is intended to allow launchers to intercept build problems with high granularity. Other generators ignore this property because their underlying build systems provide no hook to wrap individual commands with a launcher.

    RULE_MESSAGES

Specify whether to report a message for each make rule.

This property specifies whether Makefile generators should add a progress message describing what each build rule does. If the property is not set the default is ON. Set the property to OFF to disable granular messages and report only as each target completes. This is intended to allow scripted builds to avoid the build time cost of detailed reports. If a CMAKE_RULE_MESSAGES cache entry exists its value initializes the value of this property. Non-Makefile generators currently ignore this property.

    TARGET_ARCHIVES_MAY_BE_SHARED_LIBS

Set if shared libraries may be named like archives.

On AIX shared libraries may be named "lib<name>.a". This property is set to true on such platforms.

    TARGET_MESSAGES

Specify whether to report the completion of each target.

This property specifies whether Makefile Generators should add a progress message describing that each target has been completed. If the property is not set the default is ON. Set the property to OFF to disable target completion messages.

This option is intended to reduce build output when little or no work needs to be done to bring the build tree up to date.

If a CMAKE_TARGET_MESSAGES cache entry exists its value initializes the value of this property.

Non-Makefile generators currently ignore this property.

See the counterpart property RULE_MESSAGES to disable everything except for target completion messages.

    TARGET_SUPPORTS_SHARED_LIBS

Does the target platform support shared libraries.

TARGET_SUPPORTS_SHARED_LIBS is a boolean specifying whether the target platform supports shared libraries. Basically all current general general purpose OS do so, the exception are usually embedded systems with no or special OSs.

    USE_FOLDERS

Use the FOLDER target property to organize targets into folders.

If not set, CMake treats this property as OFF by default. CMake generators that are capable of organizing into a hierarchy of folders use the values of the FOLDER target property to name those folders. See also the documentation for the FOLDER target property.

PROPERTIES ON DIRECTORIES

    ADDITIONAL_MAKE_CLEAN_FILES

Additional files to clean during the make clean stage.

A list of files that will be cleaned as a part of the "make clean" stage.

    CACHE_VARIABLES

List of cache variables available in the current directory.

This read-only property specifies the list of CMake cache variables currently defined. It is intended for debugging purposes.

    CLEAN_NO_CUSTOM

Set to true to tell Makefile Generators not to remove the outputs of custom commands for this directory during the make clean operation. This is ignored on other generators because it is not possible to implement.

    CMAKE_CONFIGURE_DEPENDS

Tell CMake about additional input files to the configuration process. If any named file is modified the build system will re-run CMake to re-configure the file and generate the build system again.

Specify files as a semicolon-separated list of paths. Relative paths are interpreted as relative to the current source directory.

    COMPILE_DEFINITIONS

Preprocessor definitions for compiling a directory\(aqs sources.

This property specifies the list of options given so far to the add_definitions() command.

The COMPILE_DEFINITIONS property may be set to a semicolon-separated list of preprocessor definitions using the syntax VAR or VAR=value. Function-style definitions are not supported. CMake will automatically escape the value correctly for the native build system (note that CMake language syntax may require escapes to specify some values).

This property will be initialized in each directory by its value in the directory\(aqs parent.

CMake will automatically drop some definitions that are not supported by the native build tool. The VS6 IDE does not support definition values with spaces (but NMake does).

Disclaimer: Most native build tools have poor support for escaping certain values. CMake has work-arounds for many cases but some values may just not be possible to pass correctly. If a value does not seem to be escaped correctly, do not attempt to work-around the problem by adding escape sequences to the value. Your work-around may break in a future version of CMake that has improved escape support. Instead consider defining the macro in a (configured) header file. Then report the limitation. Known limitations include:


#          - broken almost everywhere
;          - broken in VS IDE 7.0 and Borland Makefiles
,          - broken in VS IDE
%          - broken in some cases in NMake
& |        - broken in some cases on MinGW
^ < > \"   - broken in most Make tools on Windows


CMake does not reject these values outright because they do work in some cases. Use with caution.

Contents of COMPILE_DEFINITIONS may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

The corresponding COMPILE_DEFINITIONS_<CONFIG> property may be set to specify per-configuration definitions. Generator expressions should be preferred instead of setting the alternative property.

    COMPILE_OPTIONS

List of options to pass to the compiler.

This property holds a ;-list of options given so far to the add_compile_options() command.

This property is used to initialize the COMPILE_OPTIONS target property when a target is created, which is used by the generators to set the options for the compiler.

Contents of COMPILE_OPTIONS may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

    DEFINITIONS

For CMake 2.4 compatibility only. Use COMPILE_DEFINITIONS instead.

This read-only property specifies the list of flags given so far to the add_definitions() command. It is intended for debugging purposes. Use the COMPILE_DEFINITIONS directory property instead.

This built-in read-only property does not exist if policy CMP0059 is set to NEW.

    EXCLUDE_FROM_ALL

Exclude the directory from the all target of its parent.

A property on a directory that indicates if its targets are excluded from the default build target. If it is not, then with a Makefile for example typing make will cause the targets to be built. The same concept applies to the default build of other generators.

    IMPLICIT_DEPENDS_INCLUDE_TRANSFORM

Specify #include line transforms for dependencies in a directory.

This property specifies rules to transform macro-like #include lines during implicit dependency scanning of C and C++ source files. The list of rules must be semicolon-separated with each entry of the form "A_MACRO(%)=value-with-%" (the % must be literal). During dependency scanning occurrences of A_MACRO(...) on #include lines will be replaced by the value given with the macro argument substituted for \(aq%\(aq. For example, the entry


MYDIR(%)=<mydir/%>


will convert lines of the form


#include MYDIR(myheader.h)


to


#include <mydir/myheader.h>


allowing the dependency to be followed.

This property applies to sources in all targets within a directory. The property value is initialized in each directory by its value in the directory\(aqs parent.

    INCLUDE_DIRECTORIES

List of preprocessor include file search directories.

This property specifies the list of directories given so far to the include_directories() command.

This property is used to populate the INCLUDE_DIRECTORIES target property, which is used by the generators to set the include directories for the compiler.

In addition to accepting values from that command, values may be set directly on any directory using the set_property() command. A directory gets its initial value from its parent directory if it has one. The intial value of the INCLUDE_DIRECTORIES target property comes from the value of this property. Both directory and target property values are adjusted by calls to the include_directories() command.

The target property values are used by the generators to set the include paths for the compiler.

Contents of INCLUDE_DIRECTORIES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

    INCLUDE_REGULAR_EXPRESSION

Include file scanning regular expression.

This property specifies the regular expression used during dependency scanning to match include files that should be followed. See the include_regular_expression() command for a high-level interface to set this property.

    INTERPROCEDURAL_OPTIMIZATION_<CONFIG>

Per-configuration interprocedural optimization for a directory.

This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. If set, this property overrides the generic property for the named configuration.

    INTERPROCEDURAL_OPTIMIZATION

Enable interprocedural optimization for targets in a directory.

If set to true, enables interprocedural optimizations if they are known to be supported by the compiler.

    LINK_DIRECTORIES

List of linker search directories.

This read-only property specifies the list of directories given so far to the link_directories command. It is intended for debugging purposes.

    LISTFILE_STACK

The current stack of listfiles being processed.

This property is mainly useful when trying to debug errors in your CMake scripts. It returns a list of what list files are currently being processed, in order. So if one listfile does an INCLUDE command then that is effectively pushing the included listfile onto the stack.

    MACROS

List of macro commands available in the current directory.

This read-only property specifies the list of CMake macros currently defined. It is intended for debugging purposes. See the macro command.

    PARENT_DIRECTORY

Source directory that added current subdirectory.

This read-only property specifies the source directory that added the current source directory as a subdirectory of the build. In the top-level directory the value is the empty-string.

    RULE_LAUNCH_COMPILE

Specify a launcher for compile rules.

See the global property of the same name for details. This overrides the global property for a directory.

    RULE_LAUNCH_CUSTOM

Specify a launcher for custom rules.

See the global property of the same name for details. This overrides the global property for a directory.

    RULE_LAUNCH_LINK

Specify a launcher for link rules.

See the global property of the same name for details. This overrides the global property for a directory.

    TEST_INCLUDE_FILE

A cmake file that will be included when ctest is run.

If you specify TEST_INCLUDE_FILE, that file will be included and processed when ctest is run on the directory.

    VARIABLES

List of variables defined in the current directory.

This read-only property specifies the list of CMake variables currently defined. It is intended for debugging purposes.

    VS_GLOBAL_SECTION_POST_<section>

Specify a postSolution global section in Visual Studio.

Setting a property like this generates an entry of the following form in the solution file:


GlobalSection(<section>) = postSolution
  <contents based on property value>
EndGlobalSection


The property must be set to a semicolon-separated list of key=value pairs. Each such pair will be transformed into an entry in the solution global section. Whitespace around key and value is ignored. List elements which do not contain an equal sign are skipped.

This property only works for Visual Studio 7 and above; it is ignored on other generators. The property only applies when set on a directory whose CMakeLists.txt contains a project() command.

Note that CMake generates postSolution sections ExtensibilityGlobals and ExtensibilityAddIns by default. If you set the corresponding property, it will override the default section. For example, setting VS_GLOBAL_SECTION_POST_ExtensibilityGlobals will override the default contents of the ExtensibilityGlobals section, while keeping ExtensibilityAddIns on its default.

    VS_GLOBAL_SECTION_PRE_<section>

Specify a preSolution global section in Visual Studio.

Setting a property like this generates an entry of the following form in the solution file:


GlobalSection(<section>) = preSolution
  <contents based on property value>
EndGlobalSection


The property must be set to a semicolon-separated list of key=value pairs. Each such pair will be transformed into an entry in the solution global section. Whitespace around key and value is ignored. List elements which do not contain an equal sign are skipped.

This property only works for Visual Studio 7 and above; it is ignored on other generators. The property only applies when set on a directory whose CMakeLists.txt contains a project() command.

PROPERTIES ON TARGETS

    ALIASED_TARGET

Name of target aliased by this target.

If this is an Alias Target, this property contains the name of the target aliased.

    ANDROID_ANT_ADDITIONAL_OPTIONS

Set the additional options for Android Ant build system. This is a string value containing all command line options for the Ant build. This property is initialized by the value of the CMAKE_ANDROID_ANT_ADDITIONAL_OPTIONS variable if it is set when a target is created.

    ANDROID_API

Set the Android Target API version (e.g. 15). The version number must be a positive decimal integer. This property is initialized by the value of the CMAKE_ANDROID_API variable if it is set when a target is created.

    ANDROID_API_MIN

Set the Android MIN API version (e.g. 9). The version number must be a positive decimal integer. This property is initialized by the value of the CMAKE_ANDROID_API_MIN variable if it is set when a target is created. Native code builds using this API version.

    ANDROID_ARCH

Set the Android target architecture.

This is a string property that could be set to the one of the following values:
o armv7-a: "ARMv7-A (armv7-a)"
o armv7-a-hard: "ARMv7-A, hard-float ABI (armv7-a)"
o arm64-v8a: "ARMv8-A, 64bit (arm64-v8a)"
o x86: "x86 (x86)"
o x86_64: "x86_64 (x86_64)"

This property is initialized by the value of the CMAKE_ANDROID_ARCH variable if it is set when a target is created.

    ANDROID_ASSETS_DIRECTORIES

Set the Android assets directories to copy into the main assets folder before build. This a string property that contains the directory paths separated by semicolon. This property is initialized by the value of the CMAKE_ANDROID_ASSETS_DIRECTORIES variable if it is set when a target is created.

    ANDROID_GUI

Build an executable as an application package on Android.

When this property is set to true the executable when built for Android will be created as an application package. This property is initialized by the value of the CMAKE_ANDROID_GUI variable if it is set when a target is created.

Add the AndroidManifest.xml source file explicitly to the target add_executable() command invocation to specify the root directory of the application package source.

    ANDROID_JAR_DEPENDENCIES

Set the Android property that specifies JAR dependencies. This is a string value property. This property is initialized by the value of the CMAKE_ANDROID_JAR_DEPENDENCIES variable if it is set when a target is created.

    ANDROID_JAR_DIRECTORIES

Set the Android property that specifies directories to search for the JAR libraries.

This a string property that contains the directory paths separated by semicolons. This property is initialized by the value of the CMAKE_ANDROID_JAR_DIRECTORIES variable if it is set when a target is created.

Contents of ANDROID_JAR_DIRECTORIES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions.

    ANDROID_JAVA_SOURCE_DIR

Set the Android property that defines the Java source code root directories. This a string property that contains the directory paths separated by semicolon. This property is initialized by the value of the CMAKE_ANDROID_JAVA_SOURCE_DIR variable if it is set when a target is created.

    ANDROID_NATIVE_LIB_DEPENDENCIES

Set the Android property that specifies the .so dependencies. This is a string property.

This property is initialized by the value of the CMAKE_ANDROID_NATIVE_LIB_DEPENDENCIES variable if it is set when a target is created.

Contents of ANDROID_NATIVE_LIB_DEPENDENCIES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions.

    ANDROID_NATIVE_LIB_DIRECTORIES

Set the Android property that specifies directories to search for the

[Include document libraries.]

This a string property that contains the directory paths separated by semicolons.

This property is initialized by the value of the CMAKE_ANDROID_NATIVE_LIB_DIRECTORIES variable if it is set when a target is created.

Contents of ANDROID_NATIVE_LIB_DIRECTORIES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions.

    ANDROID_PROCESS_MAX

Set the Android property that defines the maximum number of a parallel Android NDK compiler processes (e.g. 4). This property is initialized by the value of the CMAKE_ANDROID_PROCESS_MAX variable if it is set when a target is created.

    ANDROID_PROGUARD

When this property is set to true that enables the ProGuard tool to shrink, optimize, and obfuscate the code by removing unused code and renaming classes, fields, and methods with semantically obscure names. This property is initialized by the value of the CMAKE_ANDROID_PROGUARD variable if it is set when a target is created.

    ANDROID_PROGUARD_CONFIG_PATH

Set the Android property that specifies the location of the ProGuard config file. Leave empty to use the default one. This a string property that contains the path to ProGuard config file. This property is initialized by the value of the CMAKE_ANDROID_PROGUARD_CONFIG_PATH variable if it is set when a target is created.

    ANDROID_SECURE_PROPS_PATH

Set the Android property that states the location of the secure properties file. This is a string property that contains the file path. This property is initialized by the value of the CMAKE_ANDROID_SECURE_PROPS_PATH variable if it is set when a target is created.

    ANDROID_SKIP_ANT_STEP

Set the Android property that defines whether or not to skip the Ant build step. This is a boolean property initialized by the value of the CMAKE_ANDROID_SKIP_ANT_STEP variable if it is set when a target is created.

    ANDROID_STL_TYPE

Set the Android property that defines the type of STL support for the project. This is a string property that could set to the one of the following values: none e.g. "No C++ Support" system e.g. "Minimal C++ without STL" gabi++_static e.g. "GAbi++ Static" gabi++_shared e.g. "GAbi++ Shared" gnustl_static e.g. "GNU libstdc++ Static" gnustl_shared e.g. "GNU libstdc++ Shared" stlport_static e.g. "STLport Static" stlport_shared e.g. "STLport Shared" This property is initialized by the value of the variable:CMAKE_ANDROID_STL_TYPE variable if it is set when a target is created.

    ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>

Per-configuration output directory for ARCHIVE target files.

This is a per-configuration version of the ARCHIVE_OUTPUT_DIRECTORY target property, but multi-configuration generators (VS, Xcode) do NOT append a per-configuration subdirectory to the specified directory. This property is initialized by the value of the CMAKE_ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.

Contents of ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> may use generator expressions.

    ARCHIVE_OUTPUT_DIRECTORY

Output directory in which to build ARCHIVE target files.

This property specifies the directory into which archive target files should be built. The property value may use generator expressions. Multi-configuration generators (VS, Xcode) append a per-configuration subdirectory to the specified directory unless a generator expression is used.

This property is initialized by the value of the variable CMAKE_ARCHIVE_OUTPUT_DIRECTORY if it is set when a target is created.

See also the ARCHIVE_OUTPUT_DIRECTORY_<CONFIG> target property.

    ARCHIVE_OUTPUT_NAME_<CONFIG>

Per-configuration output name for ARCHIVE target files.

This is the configuration-specific version of the ARCHIVE_OUTPUT_NAME target property.

    ARCHIVE_OUTPUT_NAME

Output name for ARCHIVE target files.

This property specifies the base name for archive target files. It overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties.

See also the ARCHIVE_OUTPUT_NAME_<CONFIG> target property.

    AUTOGEN_TARGET_DEPENDS

Target dependencies of the corresponding _automoc target.

Targets which have their AUTOMOC target ON have a corresponding _automoc target which is used to autogenerate generate moc files. As this _automoc target is created at generate-time, it is not possible to define dependencies of it, such as to create inputs for the moc executable.

The AUTOGEN_TARGET_DEPENDS target property can be set instead to a list of dependencies for the _automoc target. The buildsystem will be generated to depend on its contents.

See the cmake-qt(7) manual for more information on using CMake with Qt.

    AUTOMOC_MOC_OPTIONS

Additional options for moc when using AUTOMOC

This property is only used if the AUTOMOC property is ON for this target. In this case, it holds additional command line options which will be used when moc is executed during the build, i.e. it is equivalent to the optional OPTIONS argument of the qt4_wrap_cpp() macro.

By default it is empty.

See the cmake-qt(7) manual for more information on using CMake with Qt.

    AUTOMOC

Should the target be processed with automoc (for Qt projects).

AUTOMOC is a boolean specifying whether CMake will handle the Qt moc preprocessor automatically, i.e. without having to use the QT4_WRAP_CPP() or QT5_WRAP_CPP() macro. Currently Qt4 and Qt5 are supported. When this property is set ON, CMake will scan the source files at build time and invoke moc accordingly. If an #include statement like #include "moc_foo.cpp" is found, the Q_OBJECT class declaration is expected in the header, and moc is run on the header file. If an #include statement like #include "foo.moc" is found, then a Q_OBJECT is expected in the current source file and moc is run on the file itself. Additionally, header files with the same base name (like foo.h) or _p appended to the base name (like foo_p.h) are parsed for Q_OBJECT macros, and if found, moc is also executed on those files. AUTOMOC checks multiple header alternative extensions, such as hpp, hxx etc when searching for headers. The resulting moc files, which are not included as shown above in any of the source files are included in a generated <targetname>_automoc.cpp file, which is compiled as part of the target. This property is initialized by the value of the CMAKE_AUTOMOC variable if it is set when a target is created.

Additional command line options for moc can be set via the AUTOMOC_MOC_OPTIONS property.

By enabling the CMAKE_AUTOMOC_RELAXED_MODE variable the rules for searching the files which will be processed by moc can be relaxed. See the documentation for this variable for more details.

The global property AUTOGEN_TARGETS_FOLDER can be used to group the automoc targets together in an IDE, e.g. in MSVS.

See the cmake-qt(7) manual for more information on using CMake with Qt.

    AUTOUIC

Should the target be processed with autouic (for Qt projects).

AUTOUIC is a boolean specifying whether CMake will handle the Qt uic code generator automatically, i.e. without having to use the QT4_WRAP_UI() or QT5_WRAP_UI() macro. Currently Qt4 and Qt5 are supported.

When this property is ON, CMake will scan the source files at build time and invoke uic accordingly. If an #include statement like #include "ui_foo.h" is found in foo.cpp, a foo.ui file is expected next to foo.cpp, and uic is run on the foo.ui file. This property is initialized by the value of the CMAKE_AUTOUIC variable if it is set when a target is created.

Additional command line options for uic can be set via the AUTOUIC_OPTIONS source file property on the foo.ui file. The global property AUTOGEN_TARGETS_FOLDER can be used to group the autouic targets together in an IDE, e.g. in MSVS.

See the cmake-qt(7) manual for more information on using CMake with Qt.

    AUTOUIC_OPTIONS

Additional options for uic when using AUTOUIC

This property holds additional command line options which will be used when uic is executed during the build via AUTOUIC, i.e. it is equivalent to the optional OPTIONS argument of the qt4_wrap_ui() macro.

By default it is empty.

This property is initialized by the value of the CMAKE_AUTOUIC_OPTIONS variable if it is set when a target is created.

The options set on the target may be overridden by AUTOUIC_OPTIONS set on the .ui source file.

This property may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions.

See the cmake-qt(7) manual for more information on using CMake with Qt.

    AUTORCC

Should the target be processed with autorcc (for Qt projects).

AUTORCC is a boolean specifying whether CMake will handle the Qt rcc code generator automatically, i.e. without having to use the QT4_ADD_RESOURCES() or QT5_ADD_RESOURCES() macro. Currently Qt4 and Qt5 are supported.

When this property is ON, CMake will handle .qrc files added as target sources at build time and invoke rcc accordingly. This property is initialized by the value of the CMAKE_AUTORCC variable if it is set when a target is created.

Additional command line options for rcc can be set via the AUTORCC_OPTIONS source file property on the .qrc file.

The global property AUTOGEN_TARGETS_FOLDER can be used to group the autorcc targets together in an IDE, e.g. in MSVS.

See the cmake-qt(7) manual for more information on using CMake with Qt.

    AUTORCC_OPTIONS

Additional options for rcc when using AUTORCC

This property holds additional command line options which will be used when rcc is executed during the build via AUTORCC, i.e. it is equivalent to the optional OPTIONS argument of the qt4_add_resources() macro.

By default it is empty.

This property is initialized by the value of the CMAKE_AUTORCC_OPTIONS variable if it is set when a target is created.

The options set on the target may be overridden by AUTORCC_OPTIONS set on the .qrc source file.

See the cmake-qt(7) manual for more information on using CMake with Qt.

    BINARY_DIR

This read-only property reports the value of the CMAKE_CURRENT_BINARY_DIR variable in the directory in which the target was defined.

    BUILD_WITH_INSTALL_RPATH

Should build tree targets have install tree rpaths.

BUILD_WITH_INSTALL_RPATH is a boolean specifying whether to link the target in the build tree with the INSTALL_RPATH. This takes precedence over SKIP_BUILD_RPATH and avoids the need for relinking before installation. This property is initialized by the value of the variable CMAKE_BUILD_WITH_INSTALL_RPATH if it is set when a target is created.

    BUNDLE_EXTENSION

The file extension used to name a BUNDLE target on the OS X and iOS.

The default value is bundle - you can also use plugin or whatever file extension is required by the host app for your bundle.

    BUNDLE

This target is a CFBundle on the OS X.

If a module library target has this property set to true it will be built as a CFBundle when built on the mac. It will have the directory structure required for a CFBundle and will be suitable to be used for creating Browser Plugins or other application resources.

    C_EXTENSIONS

Boolean specifying whether compiler specific extensions are requested.

This property specifies whether compiler specific extensions should be used. For some compilers, this results in adding a flag such as -std=gnu11 instead of -std=c11 to the compile line. This property is ON by default.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_C_EXTENSIONS variable if it is set when a target is created.

    C_STANDARD

The C standard whose features are requested to build this target.

This property specifies the C standard whose features are requested to build this target. For some compilers, this results in adding a flag such as -std=gnu11 to the compile line. For compilers that have no notion of a standard level, such as MSVC, this has no effect.

Supported values are 90, 99 and 11.

If the value requested does not result in a compile flag being added for the compiler in use, a previous standard flag will be added instead. This means that using:


set_property(TARGET tgt PROPERTY C_STANDARD 11)


with a compiler which does not support -std=gnu11 or an equivalent flag will not result in an error or warning, but will instead add the -std=gnu99 or -std=gnu90 flag if supported. This "decay" behavior may be controlled with the C_STANDARD_REQUIRED target property.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_C_STANDARD variable if it is set when a target is created.

    C_STANDARD_REQUIRED

Boolean describing whether the value of C_STANDARD is a requirement.

If this property is set to ON, then the value of the C_STANDARD target property is treated as a requirement. If this property is OFF or unset, the C_STANDARD target property is treated as optional and may "decay" to a previous standard if the requested is not available. For compilers that have no notion of a standard level, such as MSVC, this has no effect.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_C_STANDARD_REQUIRED variable if it is set when a target is created.

    COMPATIBLE_INTERFACE_BOOL

Properties which must be compatible with their link interface

The COMPATIBLE_INTERFACE_BOOL property may contain a list of properties for this target which must be consistent when evaluated as a boolean with the INTERFACE variant of the property in all linked dependees. For example, if a property FOO appears in the list, then for each dependee, the INTERFACE_FOO property content in all of its dependencies must be consistent with each other, and with the FOO property in the depender.

Consistency in this sense has the meaning that if the property is set, then it must have the same boolean value as all others, and if the property is not set, then it is ignored.

Note that for each dependee, the set of properties specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.

    COMPATIBLE_INTERFACE_NUMBER_MAX

Properties whose maximum value from the link interface will be used.

The COMPATIBLE_INTERFACE_NUMBER_MAX property may contain a list of properties for this target whose maximum value may be read at generate time when evaluated in the INTERFACE variant of the property in all linked dependees. For example, if a property FOO appears in the list, then for each dependee, the INTERFACE_FOO property content in all of its dependencies will be compared with each other and with the FOO property in the depender. When reading the FOO property at generate time, the maximum value will be returned. If the property is not set, then it is ignored.

Note that for each dependee, the set of properties specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.

    COMPATIBLE_INTERFACE_NUMBER_MIN

Properties whose maximum value from the link interface will be used.

The COMPATIBLE_INTERFACE_NUMBER_MIN property may contain a list of properties for this target whose minimum value may be read at generate time when evaluated in the INTERFACE variant of the property of all linked dependees. For example, if a property FOO appears in the list, then for each dependee, the INTERFACE_FOO property content in all of its dependencies will be compared with each other and with the FOO property in the depender. When reading the FOO property at generate time, the minimum value will be returned. If the property is not set, then it is ignored.

Note that for each dependee, the set of properties specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.

    COMPATIBLE_INTERFACE_STRING

Properties which must be string-compatible with their link interface

The COMPATIBLE_INTERFACE_STRING property may contain a list of properties for this target which must be the same when evaluated as a string in the INTERFACE variant of the property all linked dependees. For example, if a property FOO appears in the list, then for each dependee, the INTERFACE_FOO property content in all of its dependencies must be equal with each other, and with the FOO property in the depender. If the property is not set, then it is ignored.

Note that for each dependee, the set of properties specified in this property must not intersect with the set specified in any of the other Compatible Interface Properties.

    COMPILE_DEFINITIONS

Preprocessor definitions for compiling a target\(aqs sources.

The COMPILE_DEFINITIONS property may be set to a semicolon-separated list of preprocessor definitions using the syntax VAR or VAR=value. Function-style definitions are not supported. CMake will automatically escape the value correctly for the native build system (note that CMake language syntax may require escapes to specify some values).

CMake will automatically drop some definitions that are not supported by the native build tool. The VS6 IDE does not support definition values with spaces (but NMake does).

Disclaimer: Most native build tools have poor support for escaping certain values. CMake has work-arounds for many cases but some values may just not be possible to pass correctly. If a value does not seem to be escaped correctly, do not attempt to work-around the problem by adding escape sequences to the value. Your work-around may break in a future version of CMake that has improved escape support. Instead consider defining the macro in a (configured) header file. Then report the limitation. Known limitations include:


#          - broken almost everywhere
;          - broken in VS IDE 7.0 and Borland Makefiles
,          - broken in VS IDE
%          - broken in some cases in NMake
& |        - broken in some cases on MinGW
^ < > \"   - broken in most Make tools on Windows


CMake does not reject these values outright because they do work in some cases. Use with caution.

Contents of COMPILE_DEFINITIONS may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

The corresponding COMPILE_DEFINITIONS_<CONFIG> property may be set to specify per-configuration definitions. Generator expressions should be preferred instead of setting the alternative property.

    COMPILE_FEATURES

Compiler features enabled for this target.

The list of features in this property are a subset of the features listed in the CMAKE_CXX_COMPILE_FEATURES variable.

Contents of COMPILE_FEATURES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

    COMPILE_FLAGS

Additional flags to use when compiling this target\(aqs sources.

The COMPILE_FLAGS property sets additional compiler flags used to build sources within the target. Use COMPILE_DEFINITIONS to pass additional preprocessor definitions.

This property is deprecated. Use the COMPILE_OPTIONS property or the target_compile_options command instead.

    COMPILE_OPTIONS

List of options to pass to the compiler.

This property holds a ;-list of options specified so far for its target. Use the target_compile_options() command to append more options.

This property is intialized by the COMPILE_OPTIONS directory property when a target is created, and is used by the generators to set the options for the compiler.

Contents of COMPILE_OPTIONS may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

    COMPILE_PDB_NAME

Output name for the MS debug symbol .pdb file generated by the compiler while building source files.

This property specifies the base name for the debug symbols file. If not set, the default is unspecified.

NOTE: The compiler-generated program database files are specified by the /Fd compiler flag and are not the same as linker-generated program database files specified by the /pdb linker flag. Use the PDB_NAME property to specify the latter.

This property is not implemented by the Visual Studio 6 generator.

    COMPILE_PDB_NAME_<CONFIG>

Per-configuration output name for the MS debug symbol .pdb file generated by the compiler while building source files.

This is the configuration-specific version of COMPILE_PDB_NAME.

NOTE: The compiler-generated program database files are specified by the /Fd compiler flag and are not the same as linker-generated program database files specified by the /pdb linker flag. Use the PDB_NAME_<CONFIG> property to specify the latter.

This property is not implemented by the Visual Studio 6 generator.

    COMPILE_PDB_OUTPUT_DIRECTORY

Output directory for the MS debug symbol .pdb file generated by the compiler while building source files.

This property specifies the directory into which the MS debug symbols will be placed by the compiler. This property is initialized by the value of the CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY variable if it is set when a target is created.

NOTE: The compiler-generated program database files are specified by the /Fd compiler flag and are not the same as linker-generated program database files specified by the /pdb linker flag. Use the PDB_OUTPUT_DIRECTORY property to specify the latter.

This property is not implemented by the Visual Studio 6 generator.

    COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG>

Per-configuration output directory for the MS debug symbol .pdb file generated by the compiler while building source files.

This is a per-configuration version of COMPILE_PDB_OUTPUT_DIRECTORY, but multi-configuration generators (VS, Xcode) do NOT append a per-configuration subdirectory to the specified directory. This property is initialized by the value of the CMAKE_COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.

NOTE: The compiler-generated program database files are specified by the /Fd compiler flag and are not the same as linker-generated program database files specified by the /pdb linker flag. Use the PDB_OUTPUT_DIRECTORY_<CONFIG> property to specify the latter.

This property is not implemented by the Visual Studio 6 generator.

    <CONFIG>_OUTPUT_NAME

Old per-configuration target file base name. Use OUTPUT_NAME_<CONFIG> instead.

This is a configuration-specific version of the OUTPUT_NAME target property.

    <CONFIG>_POSTFIX

Postfix to append to the target file name for configuration <CONFIG>.

When building with configuration <CONFIG> the value of this property is appended to the target file name built on disk. For non-executable targets, this property is initialized by the value of the variable CMAKE_<CONFIG>_POSTFIX if it is set when a target is created. This property is ignored on the Mac for Frameworks and App Bundles.

    CROSSCOMPILING_EMULATOR

Use the given emulator to run executables created when crosscompiling. This command will be added as a prefix to add_test() test commands for built target system executables.

    CXX_EXTENSIONS

Boolean specifying whether compiler specific extensions are requested.

This property specifies whether compiler specific extensions should be used. For some compilers, this results in adding a flag such as -std=gnu++11 instead of -std=c++11 to the compile line. This property is ON by default.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_CXX_EXTENSIONS variable if it is set when a target is created.

    CXX_STANDARD

The C++ standard whose features are requested to build this target.

This property specifies the C++ standard whose features are requested to build this target. For some compilers, this results in adding a flag such as -std=gnu++11 to the compile line. For compilers that have no notion of a standard level, such as MSVC, this has no effect.

Supported values are 98, 11 and 14.

If the value requested does not result in a compile flag being added for the compiler in use, a previous standard flag will be added instead. This means that using:


set_property(TARGET tgt PROPERTY CXX_STANDARD 11)


with a compiler which does not support -std=gnu++11 or an equivalent flag will not result in an error or warning, but will instead add the -std=gnu++98 flag if supported. This "decay" behavior may be controlled with the CXX_STANDARD_REQUIRED target property.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_CXX_STANDARD variable if it is set when a target is created.

    CXX_STANDARD_REQUIRED

Boolean describing whether the value of CXX_STANDARD is a requirement.

If this property is set to ON, then the value of the CXX_STANDARD target property is treated as a requirement. If this property is OFF or unset, the CXX_STANDARD target property is treated as optional and may "decay" to a previous standard if the requested is not available. For compilers that have no notion of a standard level, such as MSVC, this has no effect.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

This property is initialized by the value of the CMAKE_CXX_STANDARD_REQUIRED variable if it is set when a target is created.

    DEBUG_POSTFIX

See target property <CONFIG>_POSTFIX.

This property is a special case of the more-general <CONFIG>_POSTFIX property for the DEBUG configuration.

    DEFINE_SYMBOL

Define a symbol when compiling this target\(aqs sources.

DEFINE_SYMBOL sets the name of the preprocessor symbol defined when compiling sources in a shared library. If not set here then it is set to target_EXPORTS by default (with some substitutions if the target is not a valid C identifier). This is useful for headers to know whether they are being included from inside their library or outside to properly setup dllexport/dllimport decorations.

    EchoString

A message to be displayed when the target is built.

A message to display on some generators (such as makefiles) when the target is built.

    ENABLE_EXPORTS

Specify whether an executable exports symbols for loadable modules.

Normally an executable does not export any symbols because it is the final program. It is possible for an executable to export symbols to be used by loadable modules. When this property is set to true CMake will allow other targets to "link" to the executable with the TARGET_LINK_LIBRARIES() command. On all platforms a target-level dependency on the executable is created for targets that link to it. For DLL platforms an import library will be created for the exported symbols and then used for linking. All Windows-based systems including Cygwin are DLL platforms. For non-DLL platforms that require all symbols to be resolved at link time, such as OS X, the module will "link" to the executable using a flag like -bundle_loader. For other non-DLL platforms the link rule is simply ignored since the dynamic loader will automatically bind symbols when the module is loaded.

This property is initialized by the value of the variable CMAKE_ENABLE_EXPORTS if it is set when a target is created.

    EXCLUDE_FROM_ALL

Exclude the target from the all target.

A property on a target that indicates if the target is excluded from the default build target. If it is not, then with a Makefile for example typing make will cause this target to be built. The same concept applies to the default build of other generators. Installing a target with EXCLUDE_FROM_ALL set to true has undefined behavior.

    EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG>

Per-configuration version of target exclusion from "Build Solution".

This is the configuration-specific version of EXCLUDE_FROM_DEFAULT_BUILD. If the generic EXCLUDE_FROM_DEFAULT_BUILD is also set on a target, EXCLUDE_FROM_DEFAULT_BUILD_<CONFIG> takes precedence in configurations for which it has a value.

    EXCLUDE_FROM_DEFAULT_BUILD

Exclude target from "Build Solution".

This property is only used by Visual Studio generators 7 and above. When set to TRUE, the target will not be built when you press "Build Solution".

    EXPORT_NAME

Exported name for target files.

This sets the name for the IMPORTED target generated when it this target is is exported. If not set, the logical target name is used by default.

    FOLDER

Set the folder name. Use to organize targets in an IDE.

Targets with no FOLDER property will appear as top level entities in IDEs like Visual Studio. Targets with the same FOLDER property value will appear next to each other in a folder of that name. To nest folders, use FOLDER values such as \(aqGUI/Dialogs\(aq with \(aq/\(aq characters separating folder levels.

    Fortran_FORMAT

Set to FIXED or FREE to indicate the Fortran source layout.

This property tells CMake whether the Fortran source files in a target use fixed-format or free-format. CMake will pass the corresponding format flag to the compiler. Use the source-specific Fortran_FORMAT property to change the format of a specific source file. If the variable CMAKE_Fortran_FORMAT is set when a target is created its value is used to initialize this property.

    Fortran_MODULE_DIRECTORY

Specify output directory for Fortran modules provided by the target.

If the target contains Fortran source files that provide modules and the compiler supports a module output directory this specifies the directory in which the modules will be placed. When this property is not set the modules will be placed in the build directory corresponding to the target\(aqs source directory. If the variable CMAKE_Fortran_MODULE_DIRECTORY is set when a target is created its value is used to initialize this property.

Note that some compilers will automatically search the module output directory for modules USEd during compilation but others will not. If your sources USE modules their location must be specified by INCLUDE_DIRECTORIES regardless of this property.

    FRAMEWORK

Build SHARED library as Framework Bundle on the OS X and iOS.

If a SHARED library target has this property set to TRUE it will be built as a framework when built on the OS X and iOS. It will have the directory structure required for a framework and will be suitable to be used with the -framework option

To customize Info.plist file in the framework, use MACOSX_FRAMEWORK_INFO_PLIST target property.

For OS X see also the FRAMEWORK_VERSION target property.

Example of creation dynamicFramework:


add_library(dynamicFramework SHARED
            dynamicFramework.c
            dynamicFramework.h
)
set_target_properties(dynamicFramework PROPERTIES
  FRAMEWORK TRUE
  FRAMEWORK_VERSION C
  MACOSX_FRAMEWORK_IDENTIFIER com.cmake.dynamicFramework
  MACOSX_FRAMEWORK_INFO_PLIST Info.plist
  PUBLIC_HEADER dynamicFramework.h
  XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY "iPhone Developer"
)


    FRAMEWORK_VERSION

Version of a framework created using the FRAMEWORK target property (e.g. A).

This property only affects OS X, as iOS doesn\(aqt have versioned directory structure.

    GENERATOR_FILE_NAME

Generator\(aqs file for this target.

An internal property used by some generators to record the name of the project or dsp file associated with this target. Note that at configure time, this property is only set for targets created by include_external_msproject().

    GNUtoMS

Convert GNU import library (.dll.a) to MS format (.lib).

When linking a shared library or executable that exports symbols using GNU tools on Windows (MinGW/MSYS) with Visual Studio installed convert the import library (.dll.a) from GNU to MS format (.lib). Both import libraries will be installed by install(TARGETS) and exported by install(EXPORT) and export() to be linked by applications with either GNU- or MS-compatible tools.

If the variable CMAKE_GNUtoMS is set when a target is created its value is used to initialize this property. The variable must be set prior to the first command that enables a language such as project() or enable_language(). CMake provides the variable as an option to the user automatically when configuring on Windows with GNU tools.

    HAS_CXX

Link the target using the C++ linker tool (obsolete).

This is equivalent to setting the LINKER_LANGUAGE property to CXX. See that property\(aqs documentation for details.

    IMPLICIT_DEPENDS_INCLUDE_TRANSFORM

Specify #include line transforms for dependencies in a target.

This property specifies rules to transform macro-like #include lines during implicit dependency scanning of C and C++ source files. The list of rules must be semicolon-separated with each entry of the form "A_MACRO(%)=value-with-%" (the % must be literal). During dependency scanning occurrences of A_MACRO(...) on #include lines will be replaced by the value given with the macro argument substituted for \(aq%\(aq. For example, the entry


MYDIR(%)=<mydir/%>


will convert lines of the form


#include MYDIR(myheader.h)


to


#include <mydir/myheader.h>


allowing the dependency to be followed.

This property applies to sources in the target on which it is set.

    IMPORTED_CONFIGURATIONS

Configurations provided for an IMPORTED target.

Set this to the list of configuration names available for an IMPORTED target. The names correspond to configurations defined in the project from which the target is imported. If the importing project uses a different set of configurations the names may be mapped using the MAP_IMPORTED_CONFIG_<CONFIG> property. Ignored for non-imported targets.

    IMPORTED_IMPLIB_<CONFIG>

<CONFIG>-specific version of IMPORTED_IMPLIB property.

Configuration names correspond to those provided by the project from which the target is imported.

    IMPORTED_IMPLIB

Full path to the import library for an IMPORTED target.

Set this to the location of the ".lib" part of a windows DLL. Ignored for non-imported targets.

    IMPORTED_LINK_DEPENDENT_LIBRARIES_<CONFIG>

<CONFIG>-specific version of IMPORTED_LINK_DEPENDENT_LIBRARIES.

Configuration names correspond to those provided by the project from which the target is imported. If set, this property completely overrides the generic property for the named configuration.

    IMPORTED_LINK_DEPENDENT_LIBRARIES

Dependent shared libraries of an imported shared library.

Shared libraries may be linked to other shared libraries as part of their implementation. On some platforms the linker searches for the dependent libraries of shared libraries they are including in the link. Set this property to the list of dependent shared libraries of an imported library. The list should be disjoint from the list of interface libraries in the INTERFACE_LINK_LIBRARIES property. On platforms requiring dependent shared libraries to be found at link time CMake uses this list to add appropriate files or paths to the link command line. Ignored for non-imported targets.

    IMPORTED_LINK_INTERFACE_LANGUAGES_<CONFIG>

<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LANGUAGES.

Configuration names correspond to those provided by the project from which the target is imported. If set, this property completely overrides the generic property for the named configuration.

    IMPORTED_LINK_INTERFACE_LANGUAGES

Languages compiled into an IMPORTED static library.

Set this to the list of languages of source files compiled to produce a STATIC IMPORTED library (such as "C" or "CXX"). CMake accounts for these languages when computing how to link a target to the imported library. For example, when a C executable links to an imported C++ static library CMake chooses the C++ linker to satisfy language runtime dependencies of the static library.

This property is ignored for targets that are not STATIC libraries. This property is ignored for non-imported targets.

    IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG>

<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_LIBRARIES.

Configuration names correspond to those provided by the project from which the target is imported. If set, this property completely overrides the generic property for the named configuration.

This property is ignored if the target also has a non-empty INTERFACE_LINK_LIBRARIES property.

This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead.

    IMPORTED_LINK_INTERFACE_LIBRARIES

Transitive link interface of an IMPORTED target.

Set this to the list of libraries whose interface is included when an IMPORTED library target is linked to another target. The libraries will be included on the link line for the target. Unlike the LINK_INTERFACE_LIBRARIES property, this property applies to all imported target types, including STATIC libraries. This property is ignored for non-imported targets.

This property is ignored if the target also has a non-empty INTERFACE_LINK_LIBRARIES property.

This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead.

    IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG>

<CONFIG>-specific version of IMPORTED_LINK_INTERFACE_MULTIPLICITY.

If set, this property completely overrides the generic property for the named configuration.

    IMPORTED_LINK_INTERFACE_MULTIPLICITY

Repetition count for cycles of IMPORTED static libraries.

This is LINK_INTERFACE_MULTIPLICITY for IMPORTED targets.

    IMPORTED_LOCATION_<CONFIG>

<CONFIG>-specific version of IMPORTED_LOCATION property.

Configuration names correspond to those provided by the project from which the target is imported.

    IMPORTED_LOCATION

Full path to the main file on disk for an IMPORTED target.

Set this to the location of an IMPORTED target file on disk. For executables this is the location of the executable file. For bundles on OS X this is the location of the executable file inside Contents/MacOS under the application bundle folder. For static libraries and modules this is the location of the library or module. For shared libraries on non-DLL platforms this is the location of the shared library. For frameworks on OS X this is the location of the library file symlink just inside the framework folder. For DLLs this is the location of the ".dll" part of the library. For UNKNOWN libraries this is the location of the file to be linked. Ignored for non-imported targets.

Projects may skip IMPORTED_LOCATION if the configuration-specific property IMPORTED_LOCATION_<CONFIG> is set. To get the location of an imported target read one of the LOCATION or LOCATION_<CONFIG> properties.

    IMPORTED_NO_SONAME_<CONFIG>

<CONFIG>-specific version of IMPORTED_NO_SONAME property.

Configuration names correspond to those provided by the project from which the target is imported.

    IMPORTED_NO_SONAME

Specifies that an IMPORTED shared library target has no "soname".

Set this property to true for an imported shared library file that has no "soname" field. CMake may adjust generated link commands for some platforms to prevent the linker from using the path to the library in place of its missing soname. Ignored for non-imported targets.

    IMPORTED

Read-only indication of whether a target is IMPORTED.

The boolean value of this property is True for targets created with the IMPORTED option to add_executable() or add_library(). It is False for targets built within the project.

    IMPORTED_SONAME_<CONFIG>

<CONFIG>-specific version of IMPORTED_SONAME property.

Configuration names correspond to those provided by the project from which the target is imported.

    IMPORTED_SONAME

The "soname" of an IMPORTED target of shared library type.

Set this to the "soname" embedded in an imported shared library. This is meaningful only on platforms supporting the feature. Ignored for non-imported targets.

    IMPORT_PREFIX

What comes before the import library name.

Similar to the target property PREFIX, but used for import libraries (typically corresponding to a DLL) instead of regular libraries. A target property that can be set to override the prefix (such as "lib") on an import library name.

    IMPORT_SUFFIX

What comes after the import library name.

Similar to the target property SUFFIX, but used for import libraries (typically corresponding to a DLL) instead of regular libraries. A target property that can be set to override the suffix (such as ".lib") on an import library name.

    INCLUDE_DIRECTORIES

List of preprocessor include file search directories.

This property specifies the list of directories given so far to the target_include_directories() command. In addition to accepting values from that command, values may be set directly on any target using the set_property() command. A target gets its initial value for this property from the value of the INCLUDE_DIRECTORIES directory property. Both directory and target property values are adjusted by calls to the include_directories() command.

The value of this property is used by the generators to set the include paths for the compiler.

Relative paths should not be added to this property directly. Use one of the commands above instead to handle relative paths.

Contents of INCLUDE_DIRECTORIES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

    INSTALL_NAME_DIR

Mac OSX directory name for installed targets.

INSTALL_NAME_DIR is a string specifying the directory portion of the "install_name" field of shared libraries on Mac OSX to use in the installed targets.

    INSTALL_RPATH

The rpath to use for installed targets.

A semicolon-separated list specifying the rpath to use in installed targets (for platforms that support it). This property is initialized by the value of the variable CMAKE_INSTALL_RPATH if it is set when a target is created.

    INSTALL_RPATH_USE_LINK_PATH

Add paths to linker search and installed rpath.

INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to true will append directories in the linker search path and outside the project to the INSTALL_RPATH. This property is initialized by the value of the variable CMAKE_INSTALL_RPATH_USE_LINK_PATH if it is set when a target is created.

    INTERFACE_AUTOUIC_OPTIONS

List of interface options to pass to uic.

Targets may populate this property to publish the options required to use when invoking uic. Consuming targets can add entries to their own AUTOUIC_OPTIONS property such as $<TARGET_PROPERTY:foo,INTERFACE_AUTOUIC_OPTIONS> to use the uic options specified in the interface of foo. This is done automatically by the target_link_libraries() command.

This property supports generator expressions. See the cmake-generator-expressions(7) manual for available expressions.

    INTERFACE_COMPILE_DEFINITIONS

List of public compile definitions requirements for a library.

Targets may populate this property to publish the compile definitions required to compile against the headers for the target. The target_compile_definitions() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.

Contents of INTERFACE_COMPILE_DEFINITIONS may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.

    INTERFACE_COMPILE_FEATURES

List of public compile features requirements for a library.

Targets may populate this property to publish the compile features required to compile against the headers for the target. The target_compile_features() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.

Contents of INTERFACE_COMPILE_FEATURES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.

See the cmake-compile-features(7) manual for information on compile features and a list of supported compilers.

    INTERFACE_COMPILE_OPTIONS

List of public compile options requirements for a library.

Targets may populate this property to publish the compile options required to compile against the headers for the target. The target_compile_options() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.

Contents of INTERFACE_COMPILE_OPTIONS may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.

    INTERFACE_INCLUDE_DIRECTORIES

List of public include directories requirements for a library.

Targets may populate this property to publish the include directories required to compile against the headers for the target. The target_include_directories() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the build properties of the consumer.

Contents of INTERFACE_INCLUDE_DIRECTORIES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) -manual for more on defining buildsystem properties.

Include directories usage requirements commonly differ between the build-tree and the install-tree. The BUILD_INTERFACE and INSTALL_INTERFACE generator expressions can be used to describe separate usage requirements based on the usage location. Relative paths are allowed within the INSTALL_INTERFACE expression and are interpreted relative to the installation prefix. For example:


target_include_directories(mylib INTERFACE
  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include/mylib>
  $<INSTALL_INTERFACE:include/mylib>  # <prefix>/include/mylib
)


    Creating Relocatable Packages

Note that it is not advisable to populate the INSTALL_INTERFACE of the INTERFACE_INCLUDE_DIRECTORIES of a target with absolute paths to the include directories of dependencies. That would hard-code into installed packages the include directory paths for dependencies as found on the machine the package was made on.

The INSTALL_INTERFACE of the INTERFACE_INCLUDE_DIRECTORIES is only suitable for specifying the required include directories for headers provided with the target itself, not those provided by the transitive dependencies listed in its INTERFACE_LINK_LIBRARIES target property. Those dependencies should themselves be targets that specify their own header locations in INTERFACE_INCLUDE_DIRECTORIES.

See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.

    INTERFACE_LINK_LIBRARIES

List public interface libraries for a library.

This property contains the list of transitive link dependencies. When the target is linked into another target using the target_link_libraries() command, the libraries listed (and recursively their link interface libraries) will be provided to the other target also. This property is overridden by the LINK_INTERFACE_LIBRARIES or LINK_INTERFACE_LIBRARIES_<CONFIG> property if policy CMP0022 is OLD or unset.

Contents of INTERFACE_LINK_LIBRARIES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

    Creating Relocatable Packages

Note that it is not advisable to populate the INTERFACE_LINK_LIBRARIES of a target with absolute paths to dependencies. That would hard-code into installed packages the library file paths for dependencies as found on the machine the package was made on.

See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.

    INTERFACE_POSITION_INDEPENDENT_CODE

Whether consumers need to create a position-independent target

The INTERFACE_POSITION_INDEPENDENT_CODE property informs consumers of this target whether they must set their POSITION_INDEPENDENT_CODE property to ON. If this property is set to ON, then the POSITION_INDEPENDENT_CODE property on all consumers will be set to ON. Similarly, if this property is set to OFF, then the POSITION_INDEPENDENT_CODE property on all consumers will be set to OFF. If this property is undefined, then consumers will determine their POSITION_INDEPENDENT_CODE property by other means. Consumers must ensure that the targets that they link to have a consistent requirement for their INTERFACE_POSITION_INDEPENDENT_CODE property.

    INTERFACE_SOURCES

List of interface sources to compile into consuming targets.

Targets may populate this property to publish the sources for consuming targets to compile. The target_sources() command populates this property with values given to the PUBLIC and INTERFACE keywords. Projects may also get and set the property directly.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to determine the sources of the consumer.

Contents of INTERFACE_SOURCES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

    INTERFACE_SYSTEM_INCLUDE_DIRECTORIES

List of public system include directories for a library.

Targets may populate this property to publish the include directories which contain system headers, and therefore should not result in compiler warnings. The target_include_directories(SYSTEM) command signature populates this property with values given to the PUBLIC and INTERFACE keywords.

Projects may also get and set the property directly, but must be aware that adding directories to this property does not make those directories used during compilation. Adding directories to this property marks directories as SYSTEM which otherwise would be used in a non-SYSTEM manner. This can appear similar to \(aqduplication\(aq, so prefer the high-level target_include_directories(SYSTEM) command and avoid setting the property by low-level means.

When target dependencies are specified using target_link_libraries(), CMake will read this property from all target dependencies to mark the same include directories as containing system headers.

Contents of INTERFACE_SYSTEM_INCLUDE_DIRECTORIES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

    INTERPROCEDURAL_OPTIMIZATION_<CONFIG>

Per-configuration interprocedural optimization for a target.

This is a per-configuration version of INTERPROCEDURAL_OPTIMIZATION. If set, this property overrides the generic property for the named configuration.

    INTERPROCEDURAL_OPTIMIZATION

Enable interprocedural optimization for a target.

If set to true, enables interprocedural optimizations if they are known to be supported by the compiler.

    IOS_INSTALL_COMBINED

Build a combined (device and simulator) target when installing.

When this property is set to set to false (which is the default) then it will either be built with the device SDK or the simulator SDK depending on the SDK set. But if this property is set to true then the target will at install time also be built for the corresponding SDK and combined into one library.

This feature requires at least Xcode version 6.

    JOB_POOL_COMPILE

Ninja only: Pool used for compiling.

The number of parallel compile processes could be limited by defining pools with the global JOB_POOLS property and then specifying here the pool name.

For instance:


set_property(TARGET myexe PROPERTY JOB_POOL_COMPILE ten_jobs)


This property is initialized by the value of CMAKE_JOB_POOL_COMPILE.

    JOB_POOL_LINK

Ninja only: Pool used for linking.

The number of parallel link processes could be limited by defining pools with the global JOB_POOLS property and then specifing here the pool name.

For instance:


set_property(TARGET myexe PROPERTY JOB_POOL_LINK two_jobs)


This property is initialized by the value of CMAKE_JOB_POOL_LINK.

    LABELS

Specify a list of text labels associated with a target.

Target label semantics are currently unspecified.

    <LANG>_COMPILER_LAUNCHER

This property is implemented only when <LANG> is C or CXX.

Specify a ;-list containing a command line for a compiler launching tool. The Makefile Generators and the Ninja generator will run this tool and pass the compiler and its arguments to the tool. Some example tools are distcc and ccache.

This property is initialized by the value of the CMAKE_<LANG>_COMPILER_LAUNCHER variable if it is set when a target is created.

    <LANG>_INCLUDE_WHAT_YOU_USE

This property is implemented only when <LANG> is C or CXX.

Specify a ;-list containing a command line for the include-what-you-use tool. The Makefile Generators and the Ninja generator will run this tool along with the compiler and report a warning if the tool reports any problems.

This property is initialized by the value of the CMAKE_<LANG>_INCLUDE_WHAT_YOU_USE variable if it is set when a target is created.

    <LANG>_VISIBILITY_PRESET

Value for symbol visibility compile flags

The <LANG>_VISIBILITY_PRESET property determines the value passed in a visibility related compile option, such as -fvisibility= for <LANG>. This property affects compilation in sources of all types of targets (subject to policy CMP0063).

This property is initialized by the value of the CMAKE_<LANG>_VISIBILITY_PRESET variable if it is set when a target is created.

    LIBRARY_OUTPUT_DIRECTORY_<CONFIG>

Per-configuration output directory for LIBRARY target files.

This is a per-configuration version of the LIBRARY_OUTPUT_DIRECTORY target property, but multi-configuration generators (VS, Xcode) do NOT append a per-configuration subdirectory to the specified directory. This property is initialized by the value of the CMAKE_LIBRARY_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.

Contents of LIBRARY_OUTPUT_DIRECTORY_<CONFIG> may use generator expressions.

    LIBRARY_OUTPUT_DIRECTORY

Output directory in which to build LIBRARY target files.

This property specifies the directory into which library target files should be built. The property value may use generator expressions. Multi-configuration generators (VS, Xcode) append a per-configuration subdirectory to the specified directory unless a generator expression is used.

This property is initialized by the value of the variable CMAKE_LIBRARY_OUTPUT_DIRECTORY if it is set when a target is created.

See also the LIBRARY_OUTPUT_DIRECTORY_<CONFIG> target property.

    LIBRARY_OUTPUT_NAME_<CONFIG>

Per-configuration output name for LIBRARY target files.

This is the configuration-specific version of the LIBRARY_OUTPUT_NAME target property.

    LIBRARY_OUTPUT_NAME

Output name for LIBRARY target files.

This property specifies the base name for library target files. It overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties.

See also the LIBRARY_OUTPUT_NAME_<CONFIG> target property.

    LINK_DEPENDS_NO_SHARED

Do not depend on linked shared library files.

Set this property to true to tell CMake generators not to add file-level dependencies on the shared library files linked by this target. Modification to the shared libraries will not be sufficient to re-link this target. Logical target-level dependencies will not be affected so the linked shared libraries will still be brought up to date before this target is built.

This property is initialized by the value of the variable CMAKE_LINK_DEPENDS_NO_SHARED if it is set when a target is created.

    LINK_DEPENDS

Additional files on which a target binary depends for linking.

Specifies a semicolon-separated list of full-paths to files on which the link rule for this target depends. The target binary will be linked if any of the named files is newer than it.

This property is ignored by non-Makefile generators. It is intended to specify dependencies on "linker scripts" for custom Makefile link rules.

    LINKER_LANGUAGE

Specifies language whose compiler will invoke the linker.

For executables, shared libraries, and modules, this sets the language whose compiler is used to link the target (such as "C" or "CXX"). A typical value for an executable is the language of the source file providing the program entry point (main). If not set, the language with the highest linker preference value is the default. See documentation of CMAKE_<LANG>_LINKER_PREFERENCE variables.

If this property is not set by the user, it will be calculated at generate-time by CMake.

    LINK_FLAGS_<CONFIG>

Per-configuration linker flags for a target.

This is the configuration-specific version of LINK_FLAGS.

    LINK_FLAGS

Additional flags to use when linking this target.

The LINK_FLAGS property can be used to add extra flags to the link step of a target. LINK_FLAGS_<CONFIG> will add to the configuration <CONFIG>, for example, DEBUG, RELEASE, MINSIZEREL, RELWITHDEBINFO.

    LINK_INTERFACE_LIBRARIES_<CONFIG>

Per-configuration list of public interface libraries for a target.

This is the configuration-specific version of LINK_INTERFACE_LIBRARIES. If set, this property completely overrides the generic property for the named configuration.

This property is overridden by the INTERFACE_LINK_LIBRARIES property if policy CMP0022 is NEW.

This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead.

    Creating Relocatable Packages

Note that it is not advisable to populate the LINK_INTERFACE_LIBRARIES_<CONFIG> of a target with absolute paths to dependencies. That would hard-code into installed packages the library file paths for dependencies as found on the machine the package was made on.

See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.

    LINK_INTERFACE_LIBRARIES

List public interface libraries for a shared library or executable.

By default linking to a shared library target transitively links to targets with which the library itself was linked. For an executable with exports (see the ENABLE_EXPORTS target property) no default transitive link dependencies are used. This property replaces the default transitive link dependencies with an explicit list. When the target is linked into another target using the target_link_libraries() command, the libraries listed (and recursively their link interface libraries) will be provided to the other target also. If the list is empty then no transitive link dependencies will be incorporated when this target is linked into another target even if the default set is non-empty. This property is initialized by the value of the CMAKE_LINK_INTERFACE_LIBRARIES variable if it is set when a target is created. This property is ignored for STATIC libraries.

This property is overridden by the INTERFACE_LINK_LIBRARIES property if policy CMP0022 is NEW.

This property is deprecated. Use INTERFACE_LINK_LIBRARIES instead.

    Creating Relocatable Packages

Note that it is not advisable to populate the LINK_INTERFACE_LIBRARIES of a target with absolute paths to dependencies. That would hard-code into installed packages the library file paths for dependencies as found on the machine the package was made on.

See the Creating Relocatable Packages section of the cmake-packages(7) manual for discussion of additional care that must be taken when specifying usage requirements while creating packages for redistribution.

    LINK_INTERFACE_MULTIPLICITY_<CONFIG>

Per-configuration repetition count for cycles of STATIC libraries.

This is the configuration-specific version of LINK_INTERFACE_MULTIPLICITY. If set, this property completely overrides the generic property for the named configuration.

    LINK_INTERFACE_MULTIPLICITY

Repetition count for STATIC libraries with cyclic dependencies.

When linking to a STATIC library target with cyclic dependencies the linker may need to scan more than once through the archives in the strongly connected component of the dependency graph. CMake by default constructs the link line so that the linker will scan through the component at least twice. This property specifies the minimum number of scans if it is larger than the default. CMake uses the largest value specified by any target in a component.

    LINK_LIBRARIES

List of direct link dependencies.

This property specifies the list of libraries or targets which will be used for linking. In addition to accepting values from the target_link_libraries() command, values may be set directly on any target using the set_property() command.

The value of this property is used by the generators to set the link libraries for the compiler.

Contents of LINK_LIBRARIES may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

    LINK_SEARCH_END_STATIC

End a link line such that static system libraries are used.

Some linkers support switches such as -Bstatic and -Bdynamic to determine whether to use static or shared libraries for -lXXX options. CMake uses these options to set the link type for libraries whose full paths are not known or (in some cases) are in implicit link directories for the platform. By default CMake adds an option at the end of the library list (if necessary) to set the linker search type back to its starting type. This property switches the final linker search type to -Bstatic regardless of how it started.

This property is initialized by the value of the variable CMAKE_LINK_SEARCH_END_STATIC if it is set when a target is created.

See also LINK_SEARCH_START_STATIC.

    LINK_SEARCH_START_STATIC

Assume the linker looks for static libraries by default.

Some linkers support switches such as -Bstatic and -Bdynamic to determine whether to use static or shared libraries for -lXXX options. CMake uses these options to set the link type for libraries whose full paths are not known or (in some cases) are in implicit link directories for the platform. By default the linker search type is assumed to be -Bdynamic at the beginning of the library list. This property switches the assumption to -Bstatic. It is intended for use when linking an executable statically (e.g. with the GNU -static option).

This property is initialized by the value of the variable CMAKE_LINK_SEARCH_START_STATIC if it is set when a target is created.

See also LINK_SEARCH_END_STATIC.

    LOCATION_<CONFIG>

Read-only property providing a target location on disk.

A read-only property that indicates where a target\(aqs main file is located on disk for the configuration <CONFIG>. The property is defined only for library and executable targets. An imported target may provide a set of configurations different from that of the importing project. By default CMake looks for an exact-match but otherwise uses an arbitrary available configuration. Use the MAP_IMPORTED_CONFIG_<CONFIG> property to map imported configurations explicitly.

Do not set properties that affect the location of a target after reading this property. These include properties whose names match "(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?", (IMPLIB_)?(PREFIX|SUFFIX), or "LINKER_LANGUAGE". Failure to follow this rule is not diagnosed and leaves the location of the target undefined.

    LOCATION

Read-only location of a target on disk.

For an imported target, this read-only property returns the value of the LOCATION_<CONFIG> property for an unspecified configuration <CONFIG> provided by the target.

For a non-imported target, this property is provided for compatibility with CMake 2.4 and below. It was meant to get the location of an executable target\(aqs output file for use in add_custom_command. The path may contain a build-system-specific portion that is replaced at build time with the configuration getting built (such as "$(ConfigurationName)" in VS). In CMake 2.6 and above add_custom_command automatically recognizes a target name in its COMMAND and DEPENDS options and computes the target location. In CMake 2.8.4 and above add_custom_command recognizes generator expressions to refer to target locations anywhere in the command. Therefore this property is not needed for creating custom commands.

Do not set properties that affect the location of a target after reading this property. These include properties whose names match "(RUNTIME|LIBRARY|ARCHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?", (IMPLIB_)?(PREFIX|SUFFIX), or "LINKER_LANGUAGE". Failure to follow this rule is not diagnosed and leaves the location of the target undefined.

    MACOSX_BUNDLE_INFO_PLIST

Specify a custom Info.plist template for a OS X and iOS Application Bundle.

An executable target with MACOSX_BUNDLE enabled will be built as an application bundle on OS X. By default its Info.plist file is created by configuring a template called MacOSXBundleInfo.plist.in located in the CMAKE_MODULE_PATH. This property specifies an alternative template file name which may be a full path.

The following target properties may be set to specify content to be configured into the file:
MACOSX_BUNDLE_BUNDLE_NAME
  Sets CFBundleName.
MACOSX_BUNDLE_BUNDLE_VERSION
  Sets CFBundleVersion.
MACOSX_BUNDLE_COPYRIGHT
  Sets NSHumanReadableCopyright.
MACOSX_BUNDLE_GUI_IDENTIFIER
  Sets CFBundleIdentifier.
MACOSX_BUNDLE_ICON_FILE
  Sets CFBundleIconFile.
MACOSX_BUNDLE_INFO_STRING
  Sets CFBundleGetInfoString.
MACOSX_BUNDLE_LONG_VERSION_STRING
  Sets CFBundleLongVersionString.
MACOSX_BUNDLE_SHORT_VERSION_STRING
  Sets CFBundleShortVersionString.

CMake variables of the same name may be set to affect all targets in a directory that do not have each specific property set. If a custom Info.plist is specified by this property it may of course hard-code all the settings instead of using the target properties.

    MACOSX_BUNDLE

Build an executable as an Application Bundle on OS X or iOS.

When this property is set to TRUE the executable when built on OS X or iOS will be created as an application bundle. This makes it a GUI executable that can be launched from the Finder. See the MACOSX_FRAMEWORK_INFO_PLIST target property for information about creation of the Info.plist file for the application bundle. This property is initialized by the value of the variable CMAKE_MACOSX_BUNDLE if it is set when a target is created.

    MACOSX_FRAMEWORK_INFO_PLIST

Specify a custom Info.plist template for a OS X and iOS Framework.

A library target with FRAMEWORK enabled will be built as a framework on OS X. By default its Info.plist file is created by configuring a template called MacOSXFrameworkInfo.plist.in located in the CMAKE_MODULE_PATH. This property specifies an alternative template file name which may be a full path.

The following target properties may be set to specify content to be configured into the file:
MACOSX_FRAMEWORK_BUNDLE_VERSION
  Sets CFBundleVersion.
MACOSX_FRAMEWORK_ICON_FILE
  Sets CFBundleIconFile.
MACOSX_FRAMEWORK_IDENTIFIER
  Sets CFBundleIdentifier.
MACOSX_FRAMEWORK_SHORT_VERSION_STRING
  Sets CFBundleShortVersionString.

CMake variables of the same name may be set to affect all targets in a directory that do not have each specific property set. If a custom Info.plist is specified by this property it may of course hard-code all the settings instead of using the target properties.

    MACOSX_RPATH

Whether this target on OS X or iOS is located at runtime using rpaths.

When this property is set to TRUE, the directory portion of the install_name field of this shared library will be @rpath unless overridden by INSTALL_NAME_DIR. This indicates the shared library is to be found at runtime using runtime paths (rpaths).

This property is initialized by the value of the variable CMAKE_MACOSX_RPATH if it is set when a target is created.

Runtime paths will also be embedded in binaries using this target and can be controlled by the INSTALL_RPATH target property on the target linking to this target.

Policy CMP0042 was introduced to change the default value of MACOSX_RPATH to TRUE. This is because use of @rpath is a more flexible and powerful alternative to @executable_path and @loader_path.

    MAP_IMPORTED_CONFIG_<CONFIG>

Map from project configuration to IMPORTED target\(aqs configuration.

Set this to the list of configurations of an imported target that may be used for the current project\(aqs <CONFIG> configuration. Targets imported from another project may not provide the same set of configuration names available in the current project. Setting this property tells CMake what imported configurations are suitable for use when building the <CONFIG> configuration. The first configuration in the list found to be provided by the imported target is selected. If this property is set and no matching configurations are available, then the imported target is considered to be not found. This property is ignored for non-imported targets.

This property is initialized by the value of the variable CMAKE_MAP_IMPORTED_CONFIG_<CONFIG> if it is set when a target is created.

    NAME

Logical name for the target.

Read-only logical name for the target as used by CMake.

    NO_SONAME

Whether to set "soname" when linking a shared library.

Enable this boolean property if a generated shared library should not have "soname" set. Default is to set "soname" on all shared libraries as long as the platform supports it. Generally, use this property only for leaf private libraries or plugins. If you use it on normal shared libraries which other targets link against, on some platforms a linker will insert a full path to the library (as specified at link time) into the dynamic section of the dependent binary. Therefore, once installed, dynamic loader may eventually fail to locate the library for the binary.

    NO_SYSTEM_FROM_IMPORTED

Do not treat includes from IMPORTED target interfaces as SYSTEM.

The contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED targets are treated as SYSTEM includes by default. If this property is enabled, the contents of the INTERFACE_INCLUDE_DIRECTORIES of IMPORTED targets are not treated as system includes. This property is initialized by the value of the variable CMAKE_NO_SYSTEM_FROM_IMPORTED if it is set when a target is created.

    OSX_ARCHITECTURES_<CONFIG>

Per-configuration OS X and iOS binary architectures for a target.

This property is the configuration-specific version of OSX_ARCHITECTURES.

    OSX_ARCHITECTURES

Target specific architectures for OS X.

The OSX_ARCHITECTURES property sets the target binary architecture for targets on OS X (-arch). This property is initialized by the value of the variable CMAKE_OSX_ARCHITECTURES if it is set when a target is created. Use OSX_ARCHITECTURES_<CONFIG> to set the binary architectures on a per-configuration basis, where <CONFIG> is an upper-case name (e.g. OSX_ARCHITECTURES_DEBUG).

    OUTPUT_NAME_<CONFIG>

Per-configuration target file base name.

This is the configuration-specific version of the OUTPUT_NAME target property.

    OUTPUT_NAME

Output name for target files.

This sets the base name for output files created for an executable or library target. If not set, the logical target name is used by default.

Contents of OUTPUT_NAME and the variants listed below may use generator expressions.

See also the variants:
o OUTPUT_NAME_<CONFIG>
o ARCHIVE_OUTPUT_NAME_<CONFIG>
o ARCHIVE_OUTPUT_NAME
o LIBRARY_OUTPUT_NAME_<CONFIG>
o LIBRARY_OUTPUT_NAME
o RUNTIME_OUTPUT_NAME_<CONFIG>
o RUNTIME_OUTPUT_NAME

    PDB_NAME_<CONFIG>

Per-configuration output name for the MS debug symbol .pdb file generated by the linker for an executable or shared library target.

This is the configuration-specific version of PDB_NAME.

NOTE: This property does not apply to STATIC library targets because no linker is invoked to produce them so they have no linker-generated .pdb file containing debug symbols.

The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the COMPILE_PDB_NAME_<CONFIG> property to specify the latter.

This property is not implemented by the Visual Studio 6 generator.

    PDB_NAME

Output name for the MS debug symbol .pdb file generated by the linker for an executable or shared library target.

This property specifies the base name for the debug symbols file. If not set, the OUTPUT_NAME target property value or logical target name is used by default.

NOTE: This property does not apply to STATIC library targets because no linker is invoked to produce them so they have no linker-generated .pdb file containing debug symbols.

The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the COMPILE_PDB_NAME property to specify the latter.

This property is not implemented by the Visual Studio 6 generator.

    PDB_OUTPUT_DIRECTORY_<CONFIG>

Per-configuration output directory for the MS debug symbol .pdb file generated by the linker for an executable or shared library target.

This is a per-configuration version of PDB_OUTPUT_DIRECTORY, but multi-configuration generators (VS, Xcode) do NOT append a per-configuration subdirectory to the specified directory. This property is initialized by the value of the CMAKE_PDB_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.

NOTE: This property does not apply to STATIC library targets because no linker is invoked to produce them so they have no linker-generated .pdb file containing debug symbols.

The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the COMPILE_PDB_OUTPUT_DIRECTORY_<CONFIG> property to specify the latter.

This property is not implemented by the Visual Studio 6 generator.

    PDB_OUTPUT_DIRECTORY

Output directory for the MS debug symbols .pdb file generated by the linker for an executable or shared library target.

This property specifies the directory into which the MS debug symbols will be placed by the linker. This property is initialized by the value of the CMAKE_PDB_OUTPUT_DIRECTORY variable if it is set when a target is created.

NOTE: This property does not apply to STATIC library targets because no linker is invoked to produce them so they have no linker-generated .pdb file containing debug symbols.

The linker-generated program database files are specified by the /pdb linker flag and are not the same as compiler-generated program database files specified by the /Fd compiler flag. Use the COMPILE_PDB_OUTPUT_DIRECTORY property to specify the latter.

This property is not implemented by the Visual Studio 6 generator.

    POSITION_INDEPENDENT_CODE

Whether to create a position-independent target

The POSITION_INDEPENDENT_CODE property determines whether position independent executables or shared libraries will be created. This property is True by default for SHARED and MODULE library targets and False otherwise. This property is initialized by the value of the CMAKE_POSITION_INDEPENDENT_CODE variable if it is set when a target is created.

    PREFIX

What comes before the library name.

A target property that can be set to override the prefix (such as "lib") on a library name.

    PRIVATE_HEADER

Specify private header files in a FRAMEWORK shared library target.

Shared library targets marked with the FRAMEWORK property generate frameworks on OS X, iOS and normal shared libraries on other platforms. This property may be set to a list of header files to be placed in the PrivateHeaders directory inside the framework folder. On non-Apple platforms these headers may be installed using the PRIVATE_HEADER option to the install(TARGETS) command.

    PROJECT_LABEL

Change the name of a target in an IDE.

Can be used to change the name of the target in an IDE like Visual Studio.

    PUBLIC_HEADER

Specify public header files in a FRAMEWORK shared library target.

Shared library targets marked with the FRAMEWORK property generate frameworks on OS X, iOS and normal shared libraries on other platforms. This property may be set to a list of header files to be placed in the Headers directory inside the framework folder. On non-Apple platforms these headers may be installed using the PUBLIC_HEADER option to the install(TARGETS) command.

    RESOURCE

Specify resource files in a FRAMEWORK or BUNDLE.

Target marked with the FRAMEWORK or BUNDLE property generate framework or application bundle (both OS X and iOS is supported) or normal shared libraries on other platforms. This property may be set to a list of files to be placed in the corresponding directory (eg. Resources directory for OS X) inside the bundle. On non-Apple platforms these files may be installed using the RESOURCE option to the install(TARGETS) command.

Following example of Application Bundle:


add_executable(ExecutableTarget
  addDemo.c
  resourcefile.txt
  appresourcedir/appres.txt
)

target_link_libraries(ExecutableTarget heymath mul)

set(RESOURCE_FILES resourcefile.txt appresourcedir/appres.txt )

set_target_properties(ExecutableTarget PROPERTIES MACOSX_BUNDLE TRUE MACOSX_FRAMEWORK_IDENTIFIER org.cmake.ExecutableTarget RESOURCE "${RESOURCE_FILES}" )

will produce flat structure for iOS systems:


ExecutableTarget.app
  appres.txt
  ExecutableTarget
  Info.plist
  resourcefile.txt


For OS X systems it will produce following directory structure:


ExecutableTarget.app/
  Contents
    Info.plist
    MacOS
      ExecutableTarget
    Resources
      appres.txt
      resourcefile.txt


For Linux, such cmake script produce following files:


ExecutableTarget
Resources
  appres.txt
  resourcefile.txt


    RULE_LAUNCH_COMPILE

Specify a launcher for compile rules.

See the global property of the same name for details. This overrides the global and directory property for a target.

    RULE_LAUNCH_CUSTOM

Specify a launcher for custom rules.

See the global property of the same name for details. This overrides the global and directory property for a target.

    RULE_LAUNCH_LINK

Specify a launcher for link rules.

See the global property of the same name for details. This overrides the global and directory property for a target.

    RUNTIME_OUTPUT_DIRECTORY_<CONFIG>

Per-configuration output directory for RUNTIME target files.

This is a per-configuration version of the RUNTIME_OUTPUT_DIRECTORY target property, but multi-configuration generators (VS, Xcode) do NOT append a per-configuration subdirectory to the specified directory. This property is initialized by the value of the CMAKE_RUNTIME_OUTPUT_DIRECTORY_<CONFIG> variable if it is set when a target is created.

Contents of RUNTIME_OUTPUT_DIRECTORY_<CONFIG> may use generator expressions.

    RUNTIME_OUTPUT_DIRECTORY

Output directory in which to build RUNTIME target files.

This property specifies the directory into which runtime target files should be built. The property value may use generator expressions. Multi-configuration generators (VS, Xcode) append a per-configuration subdirectory to the specified directory unless a generator expression is used.

This property is initialized by the value of the variable CMAKE_RUNTIME_OUTPUT_DIRECTORY if it is set when a target is created.

See also the RUNTIME_OUTPUT_DIRECTORY_<CONFIG> target property.

    RUNTIME_OUTPUT_NAME_<CONFIG>

Per-configuration output name for RUNTIME target files.

This is the configuration-specific version of the RUNTIME_OUTPUT_NAME target property.

    RUNTIME_OUTPUT_NAME

Output name for RUNTIME target files.

This property specifies the base name for runtime target files. It overrides OUTPUT_NAME and OUTPUT_NAME_<CONFIG> properties.

See also the RUNTIME_OUTPUT_NAME_<CONFIG> target property.

    SKIP_BUILD_RPATH

Should rpaths be used for the build tree.

SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic generation of an rpath allowing the target to run from the build tree. This property is initialized by the value of the variable CMAKE_SKIP_BUILD_RPATH if it is set when a target is created.

    SOURCE_DIR

This read-only property reports the value of the CMAKE_CURRENT_SOURCE_DIR variable in the directory in which the target was defined.

    SOURCES

Source names specified for a target.

List of sources specified for a target.

    SOVERSION

What version number is this target.

For shared libraries VERSION and SOVERSION can be used to specify the build version and API version respectively. When building or installing appropriate symlinks are created if the platform supports symlinks and the linker supports so-names. If only one of both is specified the missing is assumed to have the same version number. SOVERSION is ignored if NO_SONAME property is set. For shared libraries and executables on Windows the VERSION attribute is parsed to extract a "major.minor" version number. These numbers are used as the image version of the binary.

    STATIC_LIBRARY_FLAGS_<CONFIG>

Per-configuration flags for creating a static library.

This is the configuration-specific version of STATIC_LIBRARY_FLAGS.

    STATIC_LIBRARY_FLAGS

Extra flags to use when linking static libraries.

Extra flags to use when linking a static library.

    SUFFIX

What comes after the target name.

A target property that can be set to override the suffix (such as ".so" or ".exe") on the name of a library, module or executable.

    TYPE

The type of the target.

This read-only property can be used to test the type of the given target. It will be one of STATIC_LIBRARY, MODULE_LIBRARY, SHARED_LIBRARY, INTERFACE_LIBRARY, EXECUTABLE or one of the internal target types.

    VERSION

What version number is this target.

For shared libraries VERSION and SOVERSION can be used to specify the build version and API version respectively. When building or installing appropriate symlinks are created if the platform supports symlinks and the linker supports so-names. If only one of both is specified the missing is assumed to have the same version number. For executables VERSION can be used to specify the build version. When building or installing appropriate symlinks are created if the platform supports symlinks. For shared libraries and executables on Windows the VERSION attribute is parsed to extract a "major.minor" version number. These numbers are used as the image version of the binary.

    VISIBILITY_INLINES_HIDDEN

Whether to add a compile flag to hide symbols of inline functions

The VISIBILITY_INLINES_HIDDEN property determines whether a flag for hiding symbols for inline functions, such as -fvisibility-inlines-hidden, should be used when invoking the compiler. This property affects compilation in sources of all types of targets (subject to policy CMP0063).

This property is initialized by the value of the CMAKE_VISIBILITY_INLINES_HIDDEN variable if it is set when a target is created.

    VS_DESKTOP_EXTENSIONS_VERSION

Visual Studio Windows 10 Desktop Extensions Version

Specifies the version of the Desktop Extensions that should be included in the target. For example 10.0.10240.0. If the value is not specified, the Desktop Extensions will not be included. To use the same version of the extensions as the Windows 10 SDK that is being used, you can use the CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION variable.

    VS_DOTNET_REFERENCES

Visual Studio managed project .NET references

Adds one or more semicolon-delimited .NET references to a generated Visual Studio project. For example, "System;System.Windows.Forms".

    VS_DOTNET_TARGET_FRAMEWORK_VERSION

Specify the .NET target framework version.

Used to specify the .NET target framework version for C++/CLI. For example, "v4.5".

    VS_GLOBAL_KEYWORD

Visual Studio project keyword for VS 10 (2010) and newer.

Sets the "keyword" attribute for a generated Visual Studio project. Defaults to "Win32Proj". You may wish to override this value with "ManagedCProj", for example, in a Visual Studio managed C++ unit test project.

Use the VS_KEYWORD target property to set the keyword for Visual Studio 9 (2008) and older.

    VS_GLOBAL_PROJECT_TYPES

Visual Studio project type(s).

Can be set to one or more UUIDs recognized by Visual Studio to indicate the type of project. This value is copied verbatim into the generated project file. Example for a managed C++ unit testing project:


{3AC096D0-A1C2-E12C-1390-A8335801FDAB};{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}


UUIDs are semicolon-delimited.

    VS_GLOBAL_ROOTNAMESPACE

Visual Studio project root namespace.

Sets the "RootNamespace" attribute for a generated Visual Studio project. The attribute will be generated only if this is set.

    VS_GLOBAL_<variable>

Visual Studio project-specific global variable.

Tell the Visual Studio generator to set the global variable \(aq<variable>\(aq to a given value in the generated Visual Studio project. Ignored on other generators. Qt integration works better if VS_GLOBAL_QtVersion is set to the version FindQt4.cmake found. For example, "4.7.3"

    VS_IOT_EXTENSIONS_VERSION

Visual Studio Windows 10 IoT Extensions Version

Specifies the version of the IoT Extensions that should be included in the target. For example 10.0.10240.0. If the value is not specified, the IoT Extensions will not be included. To use the same version of the extensions as the Windows 10 SDK that is being used, you can use the CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION variable.

    VS_IOT_STARTUP_TASK

Visual Studio Windows 10 IoT Continuous Background Task

Specifies that the target should be compiled as a Continuous Background Task library.

    VS_KEYWORD

Visual Studio project keyword for VS 9 (2008) and older.

Can be set to change the visual studio keyword, for example Qt integration works better if this is set to Qt4VSv1.0.

Use the VS_GLOBAL_KEYWORD target property to set the keyword for Visual Studio 10 (2010) and newer.

    VS_MOBILE_EXTENSIONS_VERSION

Visual Studio Windows 10 Mobile Extensions Version

Specifies the version of the Mobile Extensions that should be included in the target. For example 10.0.10240.0. If the value is not specified, the Mobile Extensions will not be included. To use the same version of the extensions as the Windows 10 SDK that is being used, you can use the CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION variable.

    VS_SCC_AUXPATH

Visual Studio Source Code Control Aux Path.

Can be set to change the visual studio source code control auxpath property.

    VS_SCC_LOCALPATH

Visual Studio Source Code Control Local Path.

Can be set to change the visual studio source code control local path property.

    VS_SCC_PROJECTNAME

Visual Studio Source Code Control Project.

Can be set to change the visual studio source code control project name property.

    VS_SCC_PROVIDER

Visual Studio Source Code Control Provider.

Can be set to change the visual studio source code control provider property.

    VS_WINDOWS_TARGET_PLATFORM_MIN_VERSION

Visual Studio Windows Target Platform Minimum Version

For Windows 10. Specifies the minimum version of the OS that is being targeted. For example 10.0.10240.0. If the value is not specified, the value of CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION will be used on WindowsStore projects otherwise the target platform minimum version will not be specified for the project.

    VS_WINRT_COMPONENT

Mark a target as a Windows Runtime component for the Visual Studio generator. Compile the target with C++/CX language extensions for Windows Runtime. For SHARED and MODULE libraries, this also defines the _WINRT_DLL preprocessor macro.

NOTE: Currently this is implemented only by Visual Studio generators. Support may be added to other generators in the future.

    VS_WINRT_EXTENSIONS

Deprecated. Use VS_WINRT_COMPONENT instead. This property was an experimental partial implementation of that one.

    VS_WINRT_REFERENCES

Visual Studio project Windows Runtime Metadata references

Adds one or more semicolon-delimited WinRT references to a generated Visual Studio project. For example, "Windows;Windows.UI.Core".

    WIN32_EXECUTABLE

Build an executable with a WinMain entry point on windows.

When this property is set to true the executable when linked on Windows will be created with a WinMain() entry point instead of just main(). This makes it a GUI executable instead of a console application. See the CMAKE_MFC_FLAG variable documentation to configure use of MFC for WinMain executables. This property is initialized by the value of the variable CMAKE_WIN32_EXECUTABLE if it is set when a target is created.

    WINDOWS_EXPORT_ALL_SYMBOLS

This property is implemented only for MS-compatible tools on Windows.

Enable this boolean property to automatically create a module definition (.def) file with all global symbols found in the input .obj files for a SHARED library on Windows. The module definition file will be passed to the linker causing all symbols to be exported from the .dll. For global data symbols, __declspec(dllimport) must still be used when compiling against the code in the .dll. All other function symbols will be automatically exported and imported by callers. This simplifies porting projects to Windows by reducing the need for explicit dllexport markup, even in C++ classes.

This property is initialized by the value of the CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS variable if it is set when a target is created.

    XCODE_ATTRIBUTE_<an-attribute>

Set Xcode target attributes directly.

Tell the Xcode generator to set \(aq<an-attribute>\(aq to a given value in the generated Xcode project. Ignored on other generators.

See the CMAKE_XCODE_ATTRIBUTE_<an-attribute> variable to set attributes on all targets in a directory tree.

Contents of XCODE_ATTRIBUTE_<an-attribute> may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

    XCTEST

This target is a XCTest CFBundle on the Mac.

This property will usually get set via the xctest_add_bundle() macro in FindXCTest module.

If a module library target has this property set to true it will be built as a CFBundle when built on the Mac. It will have the directory structure required for a CFBundle.

This property depends on BUNDLE to be effective.

PROPERTIES ON TESTS

    ATTACHED_FILES_ON_FAIL

Attach a list of files to a dashboard submission if the test fails.

Same as ATTACHED_FILES, but these files will only be included if the test does not pass.

    ATTACHED_FILES

Attach a list of files to a dashboard submission.

Set this property to a list of files that will be encoded and submitted to the dashboard as an addition to the test result.

    COST

Set this to a floating point value. Tests in a test set will be run in descending order of cost.

This property describes the cost of a test. You can explicitly set this value; tests with higher COST values will run first.

    DEPENDS

Specifies that this test should only be run after the specified list of tests.

Set this to a list of tests that must finish before this test is run.

    ENVIRONMENT

Specify environment variables that should be defined for running a test.

If set to a list of environment variables and values of the form MYVAR=value those environment variables will be defined while running the test. The environment is restored to its previous state after the test is done.

    FAIL_REGULAR_EXPRESSION

If the output matches this regular expression the test will fail.

If set, if the output matches one of specified regular expressions, the test will fail. Example:


set_tests_properties(mytest PROPERTIES
  FAIL_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed"
)


FAIL_REGULAR_EXPRESSION expects a list of regular expressions.

    LABELS

Specify a list of text labels associated with a test.

The list is reported in dashboard submissions.

    MEASUREMENT

Specify a CDASH measurement and value to be reported for a test.

If set to a name then that name will be reported to CDASH as a named measurement with a value of 1. You may also specify a value by setting MEASUREMENT to "measurement=value".

    PASS_REGULAR_EXPRESSION

The output must match this regular expression for the test to pass.

If set, the test output will be checked against the specified regular expressions and at least one of the regular expressions has to match, otherwise the test will fail. Example:


set_tests_properties(mytest PROPERTIES
  PASS_REGULAR_EXPRESSION "TestPassed;All ok"
)


PASS_REGULAR_EXPRESSION expects a list of regular expressions.

    PROCESSORS

How many process slots this test requires

Denotes the number of processors that this test will require. This is typically used for MPI tests, and should be used in conjunction with the ctest_test PARALLEL_LEVEL option.

    REQUIRED_FILES

List of files required to run the test.

If set to a list of files, the test will not be run unless all of the files exist.

    RESOURCE_LOCK

Specify a list of resources that are locked by this test.

If multiple tests specify the same resource lock, they are guaranteed not to run concurrently.

    RUN_SERIAL

Do not run this test in parallel with any other test.

Use this option in conjunction with the ctest_test PARALLEL_LEVEL option to specify that this test should not be run in parallel with any other tests.

    SKIP_RETURN_CODE

Return code to mark a test as skipped.

Sometimes only a test itself can determine if all requirements for the test are met. If such a situation should not be considered a hard failure a return code of the process can be specified that will mark the test as "Not Run" if it is encountered.

    TIMEOUT

How many seconds to allow for this test.

This property if set will limit a test to not take more than the specified number of seconds to run. If it exceeds that the test process will be killed and ctest will move to the next test. This setting takes precedence over CTEST_TEST_TIMEOUT.

    WILL_FAIL

If set to true, this will invert the pass/fail flag of the test.

This property can be used for tests that are expected to fail and return a non zero return code.

    WORKING_DIRECTORY

The directory from which the test executable will be called.

If this is not set it is called from the directory the test executable is located in.

PROPERTIES ON SOURCE FILES

    ABSTRACT

Is this source file an abstract class.

A property on a source file that indicates if the source file represents a class that is abstract. This only makes sense for languages that have a notion of an abstract class and it is only used by some tools that wrap classes into other languages.

    AUTOUIC_OPTIONS

Additional options for uic when using AUTOUIC

This property holds additional command line options which will be used when uic is executed during the build via AUTOUIC, i.e. it is equivalent to the optional OPTIONS argument of the qt4_wrap_ui() macro.

By default it is empty.

The options set on the .ui source file may override AUTOUIC_OPTIONS set on the target.

    AUTORCC_OPTIONS

Additional options for rcc when using AUTORCC

This property holds additional command line options which will be used when rcc is executed during the build via AUTORCC, i.e. it is equivalent to the optional OPTIONS argument of the qt4_add_resources() macro.

By default it is empty.

The options set on the .qrc source file may override AUTORCC_OPTIONS set on the target.

    COMPILE_DEFINITIONS

Preprocessor definitions for compiling a source file.

The COMPILE_DEFINITIONS property may be set to a semicolon-separated list of preprocessor definitions using the syntax VAR or VAR=value. Function-style definitions are not supported. CMake will automatically escape the value correctly for the native build system (note that CMake language syntax may require escapes to specify some values). This property may be set on a per-configuration basis using the name COMPILE_DEFINITIONS_<CONFIG> where <CONFIG> is an upper-case name (ex. "COMPILE_DEFINITIONS_DEBUG").

CMake will automatically drop some definitions that are not supported by the native build tool. The VS6 IDE does not support definition values with spaces (but NMake does). Xcode does not support per-configuration definitions on source files.

Disclaimer: Most native build tools have poor support for escaping certain values. CMake has work-arounds for many cases but some values may just not be possible to pass correctly. If a value does not seem to be escaped correctly, do not attempt to work-around the problem by adding escape sequences to the value. Your work-around may break in a future version of CMake that has improved escape support. Instead consider defining the macro in a (configured) header file. Then report the limitation. Known limitations include:


#          - broken almost everywhere
;          - broken in VS IDE 7.0 and Borland Makefiles
,          - broken in VS IDE
%          - broken in some cases in NMake
& |        - broken in some cases on MinGW
^ < > \"   - broken in most Make tools on Windows


CMake does not reject these values outright because they do work in some cases. Use with caution.

    COMPILE_FLAGS

Additional flags to be added when compiling this source file.

These flags will be added to the list of compile flags when this source file builds. Use COMPILE_DEFINITIONS to pass additional preprocessor definitions.

    EXTERNAL_OBJECT

If set to true then this is an object file.

If this property is set to true then the source file is really an object file and should not be compiled. It will still be linked into the target though.

    Fortran_FORMAT

Set to FIXED or FREE to indicate the Fortran source layout.

This property tells CMake whether a given Fortran source file uses fixed-format or free-format. CMake will pass the corresponding format flag to the compiler. Consider using the target-wide Fortran_FORMAT property if all source files in a target share the same format.

    GENERATED

Is this source file generated as part of the build process.

If a source file is generated by the build process CMake will handle it differently in terms of dependency checking etc. Otherwise having a non-existent source file could create problems.

    HEADER_FILE_ONLY

Is this source file only a header file.

A property on a source file that indicates if the source file is a header file with no associated implementation. This is set automatically based on the file extension and is used by CMake to determine if certain dependency information should be computed.

    KEEP_EXTENSION

Make the output file have the same extension as the source file.

If this property is set then the file extension of the output file will be the same as that of the source file. Normally the output file extension is computed based on the language of the source file, for example .cxx will go to a .o extension.

    LABELS

Specify a list of text labels associated with a source file.

This property has meaning only when the source file is listed in a target whose LABELS property is also set. No other semantics are currently specified.

    LANGUAGE

What programming language is the file.

A property that can be set to indicate what programming language the source file is. If it is not set the language is determined based on the file extension. Typical values are CXX C etc. Setting this property for a file means this file will be compiled. Do not set this for headers or files that should not be compiled.

    LOCATION

The full path to a source file.

A read only property on a SOURCE FILE that contains the full path to the source file.

    MACOSX_PACKAGE_LOCATION

Place a source file inside a Application Bundle (MACOSX_BUNDLE), Core Foundation Bundle (BUNDLE), or Framework Bundle (FRAMEWORK). It is applicable for OS X and iOS.

Executable targets with the MACOSX_BUNDLE property set are built as OS X or iOS application bundles on Apple platforms. Shared library targets with the FRAMEWORK property set are built as OS X or iOS frameworks on Apple platforms. Module library targets with the BUNDLE property set are built as OS X CFBundle bundles on Apple platforms. Source files listed in the target with this property set will be copied to a directory inside the bundle or framework content folder specified by the property value. For OS X Application Bundles the content folder is <name>.app/Contents. For OS X Frameworks the content folder is <name>.framework/Versions/<version>. For OS X CFBundles the content folder is <name>.bundle/Contents (unless the extension is changed). See the PUBLIC_HEADER, PRIVATE_HEADER, and RESOURCE target properties for specifying files meant for Headers, PrivateHeaders, or Resources directories.

    OBJECT_DEPENDS

Additional files on which a compiled object file depends.

Specifies a ;-list of full-paths to files on which any object files compiled from this source file depend. On Makefile Generators and the Ninja generator an object file will be recompiled if any of the named files is newer than it. Visual Studio Generators and the Xcode generator cannot implement such compilation dependencies.

This property need not be used to specify the dependency of a source file on a generated header file that it includes. Although the property was originally introduced for this purpose, it is no longer necessary. If the generated header file is created by a custom command in the same target as the source file, the automatic dependency scanning process will recognize the dependency. If the generated header file is created by another target, an inter-target dependency should be created with the add_dependencies() command (if one does not already exist due to linking relationships).

    OBJECT_OUTPUTS

Additional outputs for a Makefile rule.

Additional outputs created by compilation of this source file. If any of these outputs is missing the object will be recompiled. This is supported only on Makefile generators and will be ignored on other generators.

    SYMBOLIC

Is this just a name for a rule.

If SYMBOLIC (boolean) is set to true the build system will be informed that the source file is not actually created on disk but instead used as a symbolic name for a build rule.

    VS_DEPLOYMENT_CONTENT

Mark a source file as content for deployment with a Windows Phone or Windows Store application when built with a Visual Studio generator. The value must evaluate to either 1 or 0 and may use generator expressions to make the choice based on the build configuration. The .vcxproj file entry for the source file will be marked either DeploymentContent or ExcludedFromBuild for values 1 and 0, respectively.

    VS_DEPLOYMENT_LOCATION

Specifies the deployment location for a content source file with a Windows Phone or Windows Store application when built with a Visual Studio generator. This property is only applicable when using VS_DEPLOYMENT_CONTENT. The value represent the path relative to the app package and applies to all configurations.

    VS_SHADER_ENTRYPOINT

Specifies the name of the entry point for the shader of a .hlsl source file.

    VS_SHADER_FLAGS

Set additional VS shader flags of a .hlsl source file.

    VS_SHADER_MODEL

Specifies the shader model of a .hlsl source file. Some shader types can only be used with recent shader models

    VS_SHADER_TYPE

Set the VS shader type of a .hlsl source file.

    VS_XAML_TYPE

Mark a XAML source file as a different type than the default Page. The most common usage would be to set the default App.xaml file as ApplicationDefinition.

    WRAP_EXCLUDE

Exclude this source file from any code wrapping techniques.

Some packages can wrap source files into alternate languages to provide additional functionality. For example, C++ code can be wrapped into Java or Python etc using SWIG etc. If WRAP_EXCLUDE is set to true (1 etc) that indicates that this source file should not be wrapped.

    XCODE_EXPLICIT_FILE_TYPE

Set the Xcode explicitFileType attribute on its reference to a source file. CMake computes a default based on file extension but can be told explicitly with this property.

See also XCODE_LAST_KNOWN_FILE_TYPE.

    XCODE_LAST_KNOWN_FILE_TYPE

Set the Xcode lastKnownFileType attribute on its reference to a source file. CMake computes a default based on file extension but can be told explicitly with this property.

See also XCODE_EXPLICIT_FILE_TYPE, which is preferred over this property if set.

PROPERTIES ON CACHE ENTRIES

    ADVANCED

True if entry should be hidden by default in GUIs.

This is a boolean value indicating whether the entry is considered interesting only for advanced configuration. The mark_as_advanced() command modifies this property.

    HELPSTRING

Help associated with entry in GUIs.

This string summarizes the purpose of an entry to help users set it through a CMake GUI.

    MODIFIED

Internal management property. Do not set or get.

This is an internal cache entry property managed by CMake to track interactive user modification of entries. Ignore it.

    STRINGS

Enumerate possible STRING entry values for GUI selection.

For cache entries with type STRING, this enumerates a set of values. CMake GUIs may use this to provide a selection widget instead of a generic string entry field. This is for convenience only. CMake does not enforce that the value matches one of those listed.

    TYPE

Widget type for entry in GUIs.

Cache entry values are always strings, but CMake GUIs present widgets to help users set values. The GUIs use this property as a hint to determine the widget type. Valid TYPE values are:


BOOL          = Boolean ON/OFF value.
PATH          = Path to a directory.
FILEPATH      = Path to a file.
STRING        = Generic string value.
INTERNAL      = Do not present in GUI at all.
STATIC        = Value managed by CMake, do not change.
UNINITIALIZED = Type not yet specified.


Generally the TYPE of a cache entry should be set by the command which creates it (set, option, find_library, etc.).

    VALUE

Value of a cache entry.

This property maps to the actual value of a cache entry. Setting this property always sets the value without checking, so use with care.

PROPERTIES ON INSTALLED FILES

    CPACK_DESKTOP_SHORTCUTS

Species a list of shortcut names that should be created on the Desktop for this file.

The property is currently only supported by the WIX generator.

    CPACK_NEVER_OVERWRITE

Request that this file not be overwritten on install or reinstall.

The property is currently only supported by the WIX generator.

    CPACK_PERMANENT

Request that this file not be removed on uninstall.

The property is currently only supported by the WIX generator.

    CPACK_START_MENU_SHORTCUTS

Species a list of shortcut names that should be created in the Start Menu for this file.

The property is currently only supported by the WIX generator.

    CPACK_STARTUP_SHORTCUTS

Species a list of shortcut names that should be created in the Startup folder for this file.

The property is currently only supported by the WIX generator.

    CPACK_WIX_ACL

Specifies access permissions for files or directories installed by a WiX installer.

The property can contain multiple list entries, each of which has to match the following format.


<user>[@<domain>]=<permission>[,<permission>]


<user> and <domain> specify the windows user and domain for which the <Permission> element should be generated.

<permission> is any of the YesNoType attributes listed here:


http://wixtoolset.org/documentation/manual/v3/xsd/wix/permission.html


DEPRECATED PROPERTIES ON DIRECTORIES

    COMPILE_DEFINITIONS_<CONFIG>

Ignored. See CMake Policy CMP0043.

Per-configuration preprocessor definitions in a directory.

This is the configuration-specific version of COMPILE_DEFINITIONS where <CONFIG> is an upper-case name (ex. COMPILE_DEFINITIONS_DEBUG).

This property will be initialized in each directory by its value in the directory\(aqs parent.

Contents of COMPILE_DEFINITIONS_<CONFIG> may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Generator expressions should be preferred instead of setting this property.

DEPRECATED PROPERTIES ON TARGETS

    COMPILE_DEFINITIONS_<CONFIG>

Ignored. See CMake Policy CMP0043.

Per-configuration preprocessor definitions on a target.

This is the configuration-specific version of COMPILE_DEFINITIONS where <CONFIG> is an upper-case name (ex. COMPILE_DEFINITIONS_DEBUG).

Contents of COMPILE_DEFINITIONS_<CONFIG> may use "generator expressions" with the syntax $<...>. See the cmake-generator-expressions(7) manual for available expressions. See the cmake-buildsystem(7) manual for more on defining buildsystem properties.

Generator expressions should be preferred instead of setting this property.

    POST_INSTALL_SCRIPT

Deprecated install support.

The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the old way to specify CMake scripts to run before and after installing a target. They are used only when the old INSTALL_TARGETS command is used to install the target. Use the INSTALL command instead.

    PRE_INSTALL_SCRIPT

Deprecated install support.

The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT properties are the old way to specify CMake scripts to run before and after installing a target. They are used only when the old INSTALL_TARGETS command is used to install the target. Use the INSTALL command instead.

DEPRECATED PROPERTIES ON SOURCE FILES

    COMPILE_DEFINITIONS_<CONFIG>

Ignored. See CMake Policy CMP0043.

Per-configuration preprocessor definitions on a source file.

This is the configuration-specific version of COMPILE_DEFINITIONS. Note that Xcode does not support per-configuration source file flags so this property will be ignored by the Xcode generator.

COPYRIGHT

2000-2016 Kitware, Inc.
Search for    or go to Top of page |  Section 7 |  Main Index


3.5.0 CMAKE-PROPERTIES (7) April 03, 2016

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.