CMake 2.8.0 Documentation

This is not the latest CMake version. See the main CMake Documentation index for newer versions.
Generated by cmake --help-html.

Master Index CMake 2.8.0

Name

  cmake - Cross-Platform Makefile Generator.

Usage

  cmake [options] <path-to-source>
  cmake [options] <path-to-existing-build>

Description

The "cmake" executable is the CMake command-line interface. It may be used to configure projects in scripts. Project configuration settings may be specified on the command line with the -D option. The -i option will cause cmake to interactively prompt for such settings.

CMake is a cross-platform build system generator. Projects specify their build process with platform-independent CMake listfiles included in each directory of a source tree with the name CMakeLists.txt. Users build a project by using CMake to generate a build system for a native tool on their platform.

Options

  • -C <initial-cache>: Pre-load a script to populate the cache.

    When cmake is first run in an empty build tree, it creates a CMakeCache.txt file and populates it with customizable settings for the project. This option may be used to specify a file from which to load cache entries before the first pass through the project's cmake listfiles. The loaded entries take priority over the project's default values. The given file should be a CMake script containing SET commands that use the CACHE option, not a cache-format file.

  • -D <var>:<type>=<value>: Create a cmake cache entry.

    When cmake is first run in an empty build tree, it creates a CMakeCache.txt file and populates it with customizable settings for the project. This option may be used to specify a setting that takes priority over the project's default value. The option may be repeated for as many cache entries as desired.

  • -U <globbing_expr>: Remove matching entries from CMake cache.

    This option may be used to remove one or more variables from the CMakeCache.txt file, globbing expressions using * and ? are supported. The option may be repeated for as many cache entries as desired.

    Use with care, you can make your CMakeCache.txt non-working.

  • -G <generator-name>: Specify a makefile generator.

    CMake may support multiple native build systems on certain platforms. A makefile generator is responsible for generating a particular build system. Possible generator names are specified in the Generators section.

  • -Wno-dev: Suppress developer warnings.

    Suppress warnings that are meant for the author of the CMakeLists.txt files.

  • -Wdev: Enable developer warnings.

    Enable warnings that are meant for the author of the CMakeLists.txt files.

  • -E: CMake command mode.

    For true platform independence, CMake provides a list of commands that can be used on all systems. Run with -E help for the usage information. Commands available are: chdir, copy, copy_if_different copy_directory, compare_files, echo, echo_append, environment, make_directory, md5sum, remove_directory, remove, tar, time, touch, touch_nocreate, write_regv, delete_regv, comspec, create_symlink.

  • -i: Run in wizard mode.

    Wizard mode runs cmake interactively without a GUI. The user is prompted to answer questions about the project configuration. The answers are used to set cmake cache values.

  • -L[A][H]: List non-advanced cached variables.

    List cache variables will run CMake and list all the variables from the CMake cache that are not marked as INTERNAL or ADVANCED. This will effectively display current CMake settings, which can be then changed with -D option. Changing some of the variable may result in more variables being created. If A is specified, then it will display also advanced variables. If H is specified, it will also display help for each variable.

  • --build <dir>: Build a CMake-generated project binary tree.

    This abstracts a native build tool's command-line interface with the following options:

      <dir>          = Project binary directory to be built.
      --target <tgt> = Build <tgt> instead of default targets.
      --config <cfg> = For multi-configuration tools, choose <cfg>.
      --clean-first  = Build target 'clean' first, then build.
                       (To clean only, use --target 'clean'.)
      --             = Pass remaining options to the native tool.

    Run cmake --build with no options for quick help.

  • -N: View mode only.

    Only load the cache. Do not actually run configure and generate steps.

  • -P <file>: Process script mode.

    Process the given cmake file as a script written in the CMake language. No configure or generate step is performed and the cache is not modified. If variables are defined using -D, this must be done before the -P argument.

  • --graphviz=[file]: Generate graphviz of dependencies.

    Generate a graphviz input file that will contain all the library and executable dependencies in the project.

  • --system-information [file]: Dump information about this system.

    Dump a wide range of information about the current system. If run from the top of a binary tree for a CMake project it will dump additional information such as the cache, log files etc.

  • --debug-trycompile: Do not delete the try compile directories..

    Do not delete the files and directories created for try_compile calls. This is useful in debugging failed try_compiles. It may however change the results of the try-compiles as old junk from a previous try-compile may cause a different test to either pass or fail incorrectly. This option is best used for one try-compile at a time, and only when debugging.

  • --debug-output: Put cmake in a debug mode.

    Print extra stuff during the cmake run like stack traces with message(send_error ) calls.

  • --trace: Put cmake in trace mode.

    Print a trace of all calls made and from where with message(send_error ) calls.

  • --help-command cmd [file]: Print help for a single command and exit.

    Full documentation specific to the given command is displayed. If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-command-list [file]: List available listfile commands and exit.

    The list contains all commands for which help may be obtained by using the --help-command argument followed by a command name. If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-commands [file]: Print help for all commands and exit.

    Full documentation specific for all current command is displayed.If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-compatcommands [file]: Print help for compatibility commands.

    Full documentation specific for all compatibility commands is displayed.If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-module module [file]: Print help for a single module and exit.

    Full documentation specific to the given module is displayed.If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-module-list [file]: List available modules and exit.

    The list contains all modules for which help may be obtained by using the --help-module argument followed by a module name. If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-modules [file]: Print help for all modules and exit.

    Full documentation for all modules is displayed. If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-custom-modules [file]: Print help for all custom modules and exit.

    Full documentation for all custom modules is displayed. If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-policy cmp [file]: Print help for a single policy and exit.

    Full documentation specific to the given policy is displayed.If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-policies [file]: Print help for all policies and exit.

    Full documentation for all policies is displayed.If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-property prop [file]: Print help for a single property and exit.

    Full documentation specific to the given property is displayed.If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-property-list [file]: List available properties and exit.

    The list contains all properties for which help may be obtained by using the --help-property argument followed by a property name. If a file is specified, the help is written into it.If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-properties [file]: Print help for all properties and exit.

    Full documentation for all properties is displayed.If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-variable var [file]: Print help for a single variable and exit.

    Full documentation specific to the given variable is displayed.If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-variable-list [file]: List documented variables and exit.

    The list contains all variables for which help may be obtained by using the --help-variable argument followed by a variable name. If a file is specified, the help is written into it.If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --help-variables [file]: Print help for all variables and exit.

    Full documentation for all variables is displayed.If a file is specified, the documentation is written into and the output format is determined depending on the filename suffix. Supported are man page, HTML, DocBook and plain text.

  • --copyright [file]: Print the CMake copyright and exit.

    If a file is specified, the copyright is written into it.

  • --help: Print usage information and exit.

    Usage describes the basic command line interface and its options.

  • --help-full [file]: Print full help and exit.

    Full help displays most of the documentation provided by the UNIX man page. It is provided for use on non-UNIX platforms, but is also convenient if the man page is not installed. If a file is specified, the help is written into it.

  • --help-html [file]: Print full help in HTML format.

    This option is used by CMake authors to help produce web pages. If a file is specified, the help is written into it.

  • --help-man [file]: Print full help as a UNIX man page and exit.

    This option is used by the cmake build to generate the UNIX man page. If a file is specified, the help is written into it.

  • --version [file]: Show program name/version banner and exit.

    If a file is specified, the version is written into it.

Generators

The following generators are available on this platform:

  • Borland Makefiles: Generates Borland makefiles.
  • MSYS Makefiles: Generates MSYS makefiles.

    The makefiles use /bin/sh as the shell. They require msys to be installed on the machine.

  • MinGW Makefiles: Generates a make file for use with mingw32-make.

    The makefiles generated use cmd.exe as the shell. They do not require msys or a unix shell.

  • NMake Makefiles: Generates NMake makefiles.
  • Unix Makefiles: Generates standard UNIX makefiles.

    A hierarchy of UNIX makefiles is generated into the build tree. Any standard UNIX-style make program can build the project through the default make target. A "make install" target is also provided.

  • Visual Studio 10: Generates Visual Studio 10 project files.
  • Visual Studio 10 Win64: Generates Visual Studio 10 Win64 project files.
  • Visual Studio 6: Generates Visual Studio 6 project files.
  • Visual Studio 7: Generates Visual Studio .NET 2002 project files.
  • Visual Studio 7 .NET 2003: Generates Visual Studio .NET 2003 project files.
  • Visual Studio 8 2005: Generates Visual Studio .NET 2005 project files.
  • Visual Studio 8 2005 Win64: Generates Visual Studio .NET 2005 Win64 project files.
  • Visual Studio 9 2008: Generates Visual Studio 9 2008 project files.
  • Visual Studio 9 2008 Win64: Generates Visual Studio 9 2008 Win64 project files.
  • Watcom WMake: Generates Watcom WMake makefiles.
  • Xcode: Generate Xcode project files.
  • CodeBlocks - MinGW Makefiles: Generates CodeBlocks project files.

    Project files for CodeBlocks will be created in the top directory and in every subdirectory which features a CMakeLists.txt file containing a PROJECT() call. Additionally a hierarchy of makefiles is generated into the build tree. The appropriate make program can build the project through the default make target. A "make install" target is also provided.

  • CodeBlocks - NMake Makefiles: Generates CodeBlocks project files.

    Project files for CodeBlocks will be created in the top directory and in every subdirectory which features a CMakeLists.txt file containing a PROJECT() call. Additionally a hierarchy of makefiles is generated into the build tree. The appropriate make program can build the project through the default make target. A "make install" target is also provided.

  • CodeBlocks - Unix Makefiles: Generates CodeBlocks project files.

    Project files for CodeBlocks will be created in the top directory and in every subdirectory which features a CMakeLists.txt file containing a PROJECT() call. Additionally a hierarchy of makefiles is generated into the build tree. The appropriate make program can build the project through the default make target. A "make install" target is also provided.

  • Eclipse CDT4 - MinGW Makefiles: Generates Eclipse CDT 4.0 project files.

    Project files for Eclipse will be created in the top directory and will have a linked resource to every subdirectory which features a CMakeLists.txt file containing a PROJECT() call.Additionally a hierarchy of makefiles is generated into the build tree. The appropriate make program can build the project through the default make target. A "make install" target is also provided.

  • Eclipse CDT4 - NMake Makefiles: Generates Eclipse CDT 4.0 project files.

    Project files for Eclipse will be created in the top directory and will have a linked resource to every subdirectory which features a CMakeLists.txt file containing a PROJECT() call.Additionally a hierarchy of makefiles is generated into the build tree. The appropriate make program can build the project through the default make target. A "make install" target is also provided.

  • Eclipse CDT4 - Unix Makefiles: Generates Eclipse CDT 4.0 project files.

    Project files for Eclipse will be created in the top directory and will have a linked resource to every subdirectory which features a CMakeLists.txt file containing a PROJECT() call.Additionally a hierarchy of makefiles is generated into the build tree. The appropriate make program can build the project through the default make target. A "make install" target is also provided.

Commands

  • add_custom_command: Add a custom build rule to the generated build system.

    There are two main signatures for add_custom_command The first signature is for adding a custom command to produce an output.

      add_custom_command(OUTPUT output1 [output2 ...]
                         COMMAND command1 [ARGS] [args1...]
                         [COMMAND command2 [ARGS] [args2...] ...]
                         [MAIN_DEPENDENCY depend]
                         [DEPENDS [depends...]]
                         [IMPLICIT_DEPENDS <lang1> depend1 ...]
                         [WORKING_DIRECTORY dir]
                         [COMMENT comment] [VERBATIM] [APPEND])

    This defines a command to generate specified OUTPUT file(s). A target created in the same directory (CMakeLists.txt file) that specifies any output of the custom command as a source file is given a rule to generate the file using the command at build time. If an output name is a relative path it will be interpreted relative to the build tree directory corresponding to the current source directory. Note that MAIN_DEPENDENCY is completely optional and is used as a suggestion to visual studio about where to hang the custom command. In makefile terms this creates a new target in the following form:

      OUTPUT: MAIN_DEPENDENCY DEPENDS
              COMMAND

    If more than one command is specified they will be executed in order. The optional ARGS argument is for backward compatibility and will be ignored.

    The second signature adds a custom command to a target such as a library or executable. This is useful for performing an operation before or after building the target. The command becomes part of the target and will only execute when the target itself is built. If the target is already built, the command will not execute.

      add_custom_command(TARGET target
                         PRE_BUILD | PRE_LINK | POST_BUILD
                         COMMAND command1 [ARGS] [args1...]
                         [COMMAND command2 [ARGS] [args2...] ...]
                         [WORKING_DIRECTORY dir]
                         [COMMENT comment] [VERBATIM])

    This defines a new command that will be associated with building the specified target. When the command will happen is determined by which of the following is specified:

      PRE_BUILD - run before all other dependencies
      PRE_LINK - run after other dependencies
      POST_BUILD - run after the target has been built

    Note that the PRE_BUILD option is only supported on Visual Studio 7 or later. For all other generators PRE_BUILD will be treated as PRE_LINK.

    If WORKING_DIRECTORY is specified the command will be executed in the directory given. If COMMENT is set, the value will be displayed as a message before the commands are executed at build time. If APPEND is specified the COMMAND and DEPENDS option values are appended to the custom command for the first output specified. There must have already been a previous call to this command with the same output. The COMMENT, WORKING_DIRECTORY, and MAIN_DEPENDENCY options are currently ignored when APPEND is given, but may be used in the future.

    If VERBATIM is given then all arguments to the commands will be escaped properly for the build tool so that the invoked command receives each argument unchanged. Note that one level of escapes is still used by the CMake language processor before add_custom_command even sees the arguments. Use of VERBATIM is recommended as it enables correct behavior. When VERBATIM is not given the behavior is platform specific because there is no protection of tool-specific special characters.

    If the output of the custom command is not actually created as a file on disk it should be marked as SYMBOLIC with SET_SOURCE_FILES_PROPERTIES.

    The IMPLICIT_DEPENDS option requests scanning of implicit dependencies of an input file. The language given specifies the programming language whose corresponding dependency scanner should be used. Currently only C and CXX language scanners are supported. Dependencies discovered from the scanning are added to those of the custom command at build time. Note that the IMPLICIT_DEPENDS option is currently supported only for Makefile generators and will be ignored by other generators.

    If COMMAND specifies an executable target (created by ADD_EXECUTABLE) it will automatically be replaced by the location of the executable created at build time. Additionally a target-level dependency will be added so that the executable target will be built before any target using this custom command. However this does NOT add a file-level dependency that would cause the custom command to re-run whenever the executable is recompiled.

    The DEPENDS option specifies files on which the command depends. If any dependency is an OUTPUT of another custom command in the same directory (CMakeLists.txt file) CMake automatically brings the other custom command into the target in which this command is built. If DEPENDS specifies any target (created by an ADD_* command) a target-level dependency is created to make sure the target is built before any target using this custom command. Additionally, if the target is an executable or library a file-level dependency is created to cause the custom command to re-run whenever the target is recompiled.

  • add_custom_target: Add a target with no output so it will always be built.
      add_custom_target(Name [ALL] [command1 [args1...]]
                        [COMMAND command2 [args2...] ...]
                        [DEPENDS depend depend depend ... ]
                        [WORKING_DIRECTORY dir]
                        [COMMENT comment] [VERBATIM]
                        [SOURCES src1 [src2...]])

    Adds a target with the given name that executes the given commands. The target has no output file and is ALWAYS CONSIDERED OUT OF DATE even if the commands try to create a file with the name of the target. Use ADD_CUSTOM_COMMAND to generate a file with dependencies. By default nothing depends on the custom target. Use ADD_DEPENDENCIES to add dependencies to or from other targets. If the ALL option is specified it indicates that this target should be added to the default build target so that it will be run every time (the command cannot be called ALL). The command and arguments are optional and if not specified an empty target will be created. If WORKING_DIRECTORY is set, then the command will be run in that directory. If COMMENT is set, the value will be displayed as a message before the commands are executed at build time. Dependencies listed with the DEPENDS argument may reference files and outputs of custom commands created with add_custom_command() in the same directory (CMakeLists.txt file).

    If VERBATIM is given then all arguments to the commands will be escaped properly for the build tool so that the invoked command receives each argument unchanged. Note that one level of escapes is still used by the CMake language processor before add_custom_target even sees the arguments. Use of VERBATIM is recommended as it enables correct behavior. When VERBATIM is not given the behavior is platform specific because there is no protection of tool-specific special characters.

    The SOURCES option specifies additional source files to be included in the custom target. Specified source files will be added to IDE project files for convenience in editing even if they have not build rules.

  • add_definitions: Adds -D define flags to the compilation of source files.
      add_definitions(-DFOO -DBAR ...)

    Adds flags to the compiler command line for sources in the current directory and below. This command can be used to add any flags, but it was originally intended to add preprocessor definitions. Flags beginning in -D or /D that look like preprocessor definitions are automatically added to the COMPILE_DEFINITIONS property for the current directory. Definitions with non-trival values may be left in the set of flags instead of being converted for reasons of backwards compatibility. See documentation of the directory, target, and source file COMPILE_DEFINITIONS properties for details on adding preprocessor definitions to specific scopes and configurations.

  • add_dependencies: Add a dependency between top-level targets.
      add_dependencies(target-name depend-target1
                       depend-target2 ...)

    Make a top-level target depend on other top-level targets. A top-level target is one created by ADD_EXECUTABLE, ADD_LIBRARY, or ADD_CUSTOM_TARGET. Adding dependencies with this command can be used to make sure one target is built before another target. See the DEPENDS option of ADD_CUSTOM_TARGET and ADD_CUSTOM_COMMAND for adding file-level dependencies in custom rules. See the OBJECT_DEPENDS option in SET_SOURCE_FILES_PROPERTIES to add file-level dependencies to object files.

  • add_executable: Add an executable to the project using the specified source files.
      add_executable(<name> [WIN32] [MACOSX_BUNDLE]
                     [EXCLUDE_FROM_ALL]
                     source1 source2 ... sourceN)

    Adds an executable target called <name> to be built from the source files listed in the command invocation. The <name> corresponds to the logical target name and must be globally unique within a project. The actual file name of the executable built is constructed based on conventions of the native platform (such as <name>.exe or just <name>).

    By default the executable file will be created in the build tree directory corresponding to the source tree directory in which the command was invoked. See documentation of the RUNTIME_OUTPUT_DIRECTORY target property to change this location. See documentation of the OUTPUT_NAME target property to change the <name> part of the final file name.

    If WIN32 is given the property WIN32_EXECUTABLE will be set on the target created. See documentation of that target property for details.

    If MACOSX_BUNDLE is given the corresponding property will be set on the created target. See documentation of the MACOSX_BUNDLE target property for details.

    If EXCLUDE_FROM_ALL is given the corresponding property will be set on the created target. See documentation of the EXCLUDE_FROM_ALL target property for details.

    The add_executable command can also create IMPORTED executable targets using this signature:

      add_executable(<name> IMPORTED)

    An IMPORTED executable target references an executable file located outside the project. No rules are generated to build it. The target name has scope in the directory in which it is created and below. It may be referenced like any target built within the project. IMPORTED executables are useful for convenient reference from commands like add_custom_command. Details about the imported executable are specified by setting properties whose names begin in "IMPORTED_". The most important such property is IMPORTED_LOCATION (and its per-configuration version IMPORTED_LOCATION_<CONFIG>) which specifies the location of the main executable file on disk. See documentation of the IMPORTED_* properties for more information.

  • add_library: Add a library to the project using the specified source files.
      add_library(<name> [STATIC | SHARED | MODULE]
                  [EXCLUDE_FROM_ALL]
                  source1 source2 ... sourceN)

    Adds a library target called <name> to be built from the source files listed in the command invocation. The <name> corresponds to the logical target name and must be globally unique within a project. The actual file name of the library built is constructed based on conventions of the native platform (such as lib<name>.a or <name>.lib).

    STATIC, SHARED, or MODULE may be given to specify the type of library to be created. STATIC libraries are archives of object files for use when linking other targets. SHARED libraries are linked dynamically and loaded at runtime. MODULE libraries are plugins that are not linked into other targets but may be loaded dynamically at runtime using dlopen-like functionality. If no type is given explicitly the type is STATIC or SHARED based on whether the current value of the variable BUILD_SHARED_LIBS is true.

    By default the library file will be created in the build tree directory corresponding to the source tree directory in which the command was invoked. See documentation of the ARCHIVE_OUTPUT_DIRECTORY, LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY target properties to change this location. See documentation of the OUTPUT_NAME target property to change the <name> part of the final file name.

    If EXCLUDE_FROM_ALL is given the corresponding property will be set on the created target. See documentation of the EXCLUDE_FROM_ALL target property for details.

    The add_library command can also create IMPORTED library targets using this signature:

      add_library(<name> <SHARED|STATIC|MODULE|UNKNOWN> IMPORTED)

    An IMPORTED library target references a library file located outside the project. No rules are generated to build it. The target name has scope in the directory in which it is created and below. It may be referenced like any target built within the project. IMPORTED libraries are useful for convenient reference from commands like target_link_libraries. Details about the imported library are specified by setting properties whose names begin in "IMPORTED_". The most important such property is IMPORTED_LOCATION (and its per-configuration version IMPORTED_LOCATION_<CONFIG>) which specifies the location of the main library file on disk. See documentation of the IMPORTED_* properties for more information.

  • add_subdirectory: Add a subdirectory to the build.
      add_subdirectory(source_dir [binary_dir] 
                       [EXCLUDE_FROM_ALL])

    Add a subdirectory to the build. The source_dir specifies the directory in which the source CmakeLists.txt and code files are located. If it is a relative path it will be evaluated with respect to the current directory (the typical usage), but it may also be an absolute path. The binary_dir specifies the directory in which to place the output files. If it is a relative path it will be evaluated with respect to the current output directory, but it may also be an absolute path. If binary_dir is not specified, the value of source_dir, before expanding any relative path, will be used (the typical usage). The CMakeLists.txt file in the specified source directory will be processed immediately by CMake before processing in the current input file continues beyond this command.

    If the EXCLUDE_FROM_ALL argument is provided then targets in the subdirectory will not be included in the ALL target of the parent directory by default, and will be excluded from IDE project files. Users must explicitly build targets in the subdirectory. This is meant for use when the subdirectory contains a separate part of the project that is useful but not necessary, such as a set of examples. Typically the subdirectory should contain its own project() command invocation so that a full build system will be generated in the subdirectory (such as a VS IDE solution file). Note that inter-target dependencies supercede this exclusion. If a target built by the parent project depends on a target in the subdirectory, the dependee target will be included in the parent project build system to satisfy the dependency.

  • add_test: Add a test to the project with the specified arguments.
      add_test(testname Exename arg1 arg2 ...)

    If the ENABLE_TESTING command has been run, this command adds a test target to the current directory. If ENABLE_TESTING has not been run, this command does nothing. The tests are run by the testing subsystem by executing Exename with the specified arguments. Exename can be either an executable built by this project or an arbitrary executable on the system (like tclsh). The test will be run with the current working directory set to the CMakeList.txt files corresponding directory in the binary tree.

      add_test(NAME <name> [CONFIGURATIONS [Debug|Release|...]]
               COMMAND <command> [arg1 [arg2 ...]])

    If COMMAND specifies an executable target (created by add_executable) it will automatically be replaced by the location of the executable created at build time. If a CONFIGURATIONS option is given then the test will be executed only when testing under one of the named configurations.

    Arguments after COMMAND may use "generator expressions" with the syntax "$<...>". These expressions are evaluted during build system generation and produce information specific to each generated build configuration. Valid expressions are:

      $<CONFIGURATION>          = configuration name
      $<TARGET_FILE:tgt>        = main file (.exe, .so.1.2, .a)
      $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so)
      $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3)

    where "tgt" is the name of a target. Target file expressions produce a full path, but _DIR and _NAME versions can produce the directory and file name components:

      $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt>
      $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt>
      $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt>

    Example usage:

      add_test(NAME mytest
               COMMAND testDriver --config $<CONFIGURATION>
                                  --exe $<TARGET_FILE:myexe>)

    This creates a test "mytest" whose command runs a testDriver tool passing the configuration name and the full path to the executable file produced by target "myexe".

  • aux_source_directory: Find all source files in a directory.
      aux_source_directory(<dir> <variable>)

    Collects the names of all the source files in the specified directory and stores the list in the <variable> provided. This command is intended to be used by projects that use explicit template instantiation. Template instantiation files can be stored in a "Templates" subdirectory and collected automatically using this command to avoid manually listing all instantiations.

    It is tempting to use this command to avoid writing the list of source files for a library or executable target. While this seems to work, there is no way for CMake to generate a build system that knows when a new source file has been added. Normally the generated build system knows when it needs to rerun CMake because the CMakeLists.txt file is modified to add a new source. When the source is just added to the directory without modifying this file, one would have to manually rerun CMake to generate a build system incorporating the new file.

  • break: Break from an enclosing foreach or while loop.
      break()

    Breaks from an enclosing foreach loop or while loop

  • build_command: Get the command line that will build this project.
      build_command(<variable> <makecommand>)

    Sets the given <variable> to a string containing the command that will build this project from the root of the build tree using the build tool given by <makecommand>. <makecommand> should be msdev, nmake, make or one of the end user build tools. This is useful for configuring testing systems.

  • cmake_minimum_required: Set the minimum required version of cmake for a project.
      cmake_minimum_required(VERSION major[.minor[.patch]]
                             [FATAL_ERROR])

    If the current version of CMake is lower than that required it will stop processing the project and report an error. When a version higher than 2.4 is specified the command implicitly invokes

      cmake_policy(VERSION major[.minor[.patch]])

    which sets the cmake policy version level to the version specified. When version 2.4 or lower is given the command implicitly invokes

      cmake_policy(VERSION 2.4)

    which enables compatibility features for CMake 2.4 and lower.

    The FATAL_ERROR option is accepted but ignored by CMake 2.6 and higher. It should be specified so CMake versions 2.4 and lower fail with an error instead of just a warning.

  • cmake_policy: Manage CMake Policy settings.

    As CMake evolves it is sometimes necessary to change existing behavior in order to fix bugs or improve implementations of existing features. The CMake Policy mechanism is designed to help keep existing projects building as new versions of CMake introduce changes in behavior. Each new policy (behavioral change) is given an identifier of the form "CMP<NNNN>" where "<NNNN>" is an integer index. Documentation associated with each policy describes the OLD and NEW behavior and the reason the policy was introduced. Projects may set each policy to select the desired behavior. When CMake needs to know which behavior to use it checks for a setting specified by the project. If no setting is available the OLD behavior is assumed and a warning is produced requesting that the policy be set.

    The cmake_policy command is used to set policies to OLD or NEW behavior. While setting policies individually is supported, we encourage projects to set policies based on CMake versions.

      cmake_policy(VERSION major.minor[.patch])

    Specify that the current CMake list file is written for the given version of CMake. All policies introduced in the specified version or earlier will be set to use NEW behavior. All policies introduced after the specified version will be unset. This effectively requests behavior preferred as of a given CMake version and tells newer CMake versions to warn about their new policies. The policy version specified must be at least 2.4 or the command will report an error. In order to get compatibility features supporting versions earlier than 2.4 see documentation of policy CMP0001.

      cmake_policy(SET CMP<NNNN> NEW)
      cmake_policy(SET CMP<NNNN> OLD)

    Tell CMake to use the OLD or NEW behavior for a given policy. Projects depending on the old behavior of a given policy may silence a policy warning by setting the policy state to OLD. Alternatively one may fix the project to work with the new behavior and set the policy state to NEW.

      cmake_policy(GET CMP<NNNN> <variable>)

    Check whether a given policy is set to OLD or NEW behavior. The output variable value will be "OLD" or "NEW" if the policy is set, and empty otherwise.

    CMake keeps policy settings on a stack, so changes made by the cmake_policy command affect only the top of the stack. A new entry on the policy stack is managed automatically for each subdirectory to protect its parents and siblings. CMake also manages a new entry for scripts loaded by include() and find_package() commands except when invoked with the NO_POLICY_SCOPE option (see also policy CMP0011). The cmake_policy command provides an interface to manage custom entries on the policy stack:

      cmake_policy(PUSH)
      cmake_policy(POP)

    Each PUSH must have a matching POP to erase any changes. This is useful to make temporary changes to policy settings.

    Functions and macros record policy settings when they are created and use the pre-record policies when they are invoked. If the function or macro implementation sets policies, the changes automatically propagate up through callers until they reach the closest nested policy stack entry.

  • configure_file: Copy a file to another location and modify its contents.
      configure_file(<input> <output>
                     [COPYONLY] [ESCAPE_QUOTES] [@ONLY])

    Copies a file <input> to file <output> and substitutes variable values referenced in the file content. If <input> is a relative path it is evaluated with respect to the current source directory. The <input> must be a file, not a directory. If <output> is a relative path it is evaluated with respect to the current binary directory. If <output> names an existing directory the input file is placed in that directory with its original name.

    This command replaces any variables in the input file referenced as ${VAR} or @VAR@ with their values as determined by CMake. If a variable is not defined, it will be replaced with nothing. If COPYONLY is specified, then no variable expansion will take place. If ESCAPE_QUOTES is specified then any substituted quotes will be C-style escaped. The file will be configured with the current values of CMake variables. If @ONLY is specified, only variables of the form @VAR@ will be replaces and ${VAR} will be ignored. This is useful for configuring scripts that use ${VAR}. Any occurrences of #cmakedefine VAR will be replaced with either #define VAR or /* #undef VAR */ depending on the setting of VAR in CMake. Any occurrences of #cmakedefine01 VAR will be replaced with either #define VAR 1 or #define VAR 0 depending on whether VAR evaluates to TRUE or FALSE in CMake

  • create_test_sourcelist: Create a test driver and source list for building test programs.
      create_test_sourcelist(sourceListName driverName
                             test1 test2 test3
                             EXTRA_INCLUDE include.h
                             FUNCTION function)

    A test driver is a program that links together many small tests into a single executable. This is useful when building static executables with large libraries to shrink the total required size. The list of source files needed to build the test driver will be in sourceListName. DriverName is the name of the test driver program. The rest of the arguments consist of a list of test source files, can be semicolon separated. Each test source file should have a function in it that is the same name as the file with no extension (foo.cxx should have int foo(int, char*[]);) DriverName will be able to call each of the tests by name on the command line. If EXTRA_INCLUDE is specified, then the next argument is included into the generated file. If FUNCTION is specified, then the next argument is taken as a function name that is passed a pointer to ac and av. This can be used to add extra command line processing to each test. The cmake variable CMAKE_TESTDRIVER_BEFORE_TESTMAIN can be set to have code that will be placed directly before calling the test main function. CMAKE_TESTDRIVER_AFTER_TESTMAIN can be set to have code that will be placed directly after the call to the test main function.

  • define_property: Define and document custom properties.
      define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE |
                       TEST | VARIABLE | CACHED_VARIABLE>
                       PROPERTY <name> [INHERITED]
                       BRIEF_DOCS <brief-doc> [docs...]
                       FULL_DOCS <full-doc> [docs...])

    Define one property in a scope for use with the set_property and get_property commands. This is primarily useful to associate documentation with property names that may be retrieved with the get_property command. The first argument determines the kind of scope in which the property should be used. It must be one of the following:

      GLOBAL    = associated with the global namespace
      DIRECTORY = associated with one directory
      TARGET    = associated with one target
      SOURCE    = associated with one source file
      TEST      = associated with a test named with add_test
      VARIABLE  = documents a CMake language variable
      CACHED_VARIABLE = documents a CMake cache variable

    Note that unlike set_property and get_property no actual scope needs to be given; only the kind of scope is important.

    The required PROPERTY option is immediately followed by the name of the property being defined.

    If the INHERITED option then the get_property command will chain up to the next higher scope when the requested property is not set in the scope given to the command. DIRECTORY scope chains to GLOBAL. TARGET, SOURCE, and TEST chain to DIRECTORY.

    The BRIEF_DOCS and FULL_DOCS options are followed by strings to be associated with the property as its brief and full documentation. Corresponding options to the get_property command will retrieve the documentation.

  • else: Starts the else portion of an if block.
      else(expression)

    See the if command.

  • elseif: Starts the elseif portion of an if block.
      elseif(expression)

    See the if command.

  • enable_language: Enable a language (CXX/C/Fortran/etc)
      enable_language(languageName [OPTIONAL] )

    This command enables support for the named language in CMake. This is the same as the project command but does not create any of the extra variables that are created by the project command. Example languages are CXX, C, Fortran. If OPTIONAL is used, use the CMAKE_<languageName>_COMPILER_WORKS variable to check whether the language has been enabled successfully.

  • enable_testing: Enable testing for current directory and below.
      enable_testing()

    Enables testing for this directory and below. See also the add_test command. Note that ctest expects to find a test file in the build directory root. Therefore, this command should be in the source directory root.

  • endforeach: Ends a list of commands in a FOREACH block.
      endforeach(expression)

    See the FOREACH command.

  • endfunction: Ends a list of commands in a function block.
      endfunction(expression)

    See the function command.

  • endif: Ends a list of commands in an if block.
      endif(expression)

    See the if command.

  • endmacro: Ends a list of commands in a macro block.
      endmacro(expression)

    See the macro command.

  • endwhile: Ends a list of commands in a while block.
      endwhile(expression)

    See the while command.

  • execute_process: Execute one or more child processes.
      execute_process(COMMAND <cmd1> [args1...]]
                      [COMMAND <cmd2> [args2...] [...]]
                      [WORKING_DIRECTORY <directory>]
                      [TIMEOUT <seconds>]
                      [RESULT_VARIABLE <variable>]
                      [OUTPUT_VARIABLE <variable>]
                      [ERROR_VARIABLE <variable>]
                      [INPUT_FILE <file>]
                      [OUTPUT_FILE <file>]
                      [ERROR_FILE <file>]
                      [OUTPUT_QUIET]
                      [ERROR_QUIET]
                      [OUTPUT_STRIP_TRAILING_WHITESPACE]
                      [ERROR_STRIP_TRAILING_WHITESPACE])

    Runs the given sequence of one or more commands with the standard output of each process piped to the standard input of the next. A single standard error pipe is used for all processes. If WORKING_DIRECTORY is given the named directory will be set as the current working directory of the child processes. If TIMEOUT is given the child processes will be terminated if they do not finish in the specified number of seconds (fractions are allowed). If RESULT_VARIABLE is given the variable will be set to contain the result of running the processes. This will be an integer return code from the last child or a string describing an error condition. If OUTPUT_VARIABLE or ERROR_VARIABLE are given the variable named will be set with the contents of the standard output and standard error pipes respectively. If the same variable is named for both pipes their output will be merged in the order produced. If INPUT_FILE, OUTPUT_FILE, or ERROR_FILE is given the file named will be attached to the standard input of the first process, standard output of the last process, or standard error of all processes respectively. If OUTPUT_QUIET or ERROR_QUIET is given then the standard output or standard error results will be quietly ignored. If more than one OUTPUT_* or ERROR_* option is given for the same pipe the precedence is not specified. If no OUTPUT_* or ERROR_* options are given the output will be shared with the corresponding pipes of the CMake process itself.

    The execute_process command is a newer more powerful version of exec_program, but the old command has been kept for compatibility.

  • export: Export targets from the build tree for use by outside projects.
      export(TARGETS [target1 [target2 [...]]] [NAMESPACE <namespace>]
             [APPEND] FILE <filename>)

    Create a file <filename> that may be included by outside projects to import targets from the current project's build tree. This is useful during cross-compiling to build utility executables that can run on the host platform in one project and then import them into another project being compiled for the target platform. If the NAMESPACE option is given the <namespace> string will be prepended to all target names written to the file. If the APPEND option is given the generated code will be appended to the file instead of overwriting it. If a library target is included in the export but a target to which it links is not included the behavior is unspecified.

    The file created by this command is specific to the build tree and should never be installed. See the install(EXPORT) command to export targets from an installation tree.

      export(PACKAGE <name>)

    Store the current build directory in the CMake user package registry for package <name>. The find_package command may consider the directory while searching for package <name>. This helps dependent projects find and use a package from the current project's build tree without help from the user. Note that the entry in the package registry that this command creates works only in conjunction with a package configuration file (<name>Config.cmake) that works with the build tree.

  • file: File manipulation command.
      file(WRITE filename "message to write"... )
      file(APPEND filename "message to write"... )
      file(READ filename variable [LIMIT numBytes] [OFFSET offset] [HEX])
      file(STRINGS filename variable [LIMIT_COUNT num]
           [LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes]
           [LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes]
           [NEWLINE_CONSUME] [REGEX regex]
           [NO_HEX_CONVERSION])
      file(GLOB variable [RELATIVE path] [globbing expressions]...)
      file(GLOB_RECURSE variable [RELATIVE path] 
           [FOLLOW_SYMLINKS] [globbing expressions]...)
      file(RENAME <oldname> <newname>)
      file(REMOVE [file1 ...])
      file(REMOVE_RECURSE [file1 ...])
      file(MAKE_DIRECTORY [directory1 directory2 ...])
      file(RELATIVE_PATH variable directory file)
      file(TO_CMAKE_PATH path result)
      file(TO_NATIVE_PATH path result)
      file(DOWNLOAD url file [TIMEOUT timeout] [STATUS status] [LOG log])

    WRITE will write a message into a file called 'filename'. It overwrites the file if it already exists, and creates the file if it does not exist.

    APPEND will write a message into a file same as WRITE, except it will append it to the end of the file

    READ will read the content of a file and store it into the variable. It will start at the given offset and read up to numBytes. If the argument HEX is given, the binary data will be converted to hexadecimal representation and this will be stored in the variable.

    STRINGS will parse a list of ASCII strings from a file and store it in a variable. Binary data in the file are ignored. Carriage return (CR) characters are ignored. It works also for Intel Hex and Motorola S-record files, which are automatically converted to binary format when reading them. Disable this using NO_HEX_CONVERSION.

    LIMIT_COUNT sets the maximum number of strings to return. LIMIT_INPUT sets the maximum number of bytes to read from the input file. LIMIT_OUTPUT sets the maximum number of bytes to store in the output variable. LENGTH_MINIMUM sets the minimum length of a string to return. Shorter strings are ignored. LENGTH_MAXIMUM sets the maximum length of a string to return. Longer strings are split into strings no longer than the maximum length. NEWLINE_CONSUME allows newlines to be included in strings instead of terminating them.

    REGEX specifies a regular expression that a string must match to be returned. Typical usage 

      file(STRINGS myfile.txt myfile)

    stores a list in the variable "myfile" in which each item is a line from the input file.

    GLOB will generate a list of all files that match the globbing expressions and store it into the variable. Globbing expressions are similar to regular expressions, but much simpler. If RELATIVE flag is specified for an expression, the results will be returned as a relative path to the given path.

    Examples of globbing expressions include:

       *.cxx      - match all files with extension cxx
       *.vt?      - match all files with extension vta,...,vtz
       f[3-5].txt - match files f3.txt, f4.txt, f5.txt

    GLOB_RECURSE will generate a list similar to the regular GLOB, except it will traverse all the subdirectories of the matched directory and match the files. Subdirectories that are symlinks are only traversed if FOLLOW_SYMLINKS is given or cmake policy CMP0009 is not set to NEW. See cmake --help-policy CMP0009 for more information.

    Examples of recursive globbing include:

       /dir/*.py  - match all python files in /dir and subdirectories

    MAKE_DIRECTORY will create the given directories, also if their parent directories don't exist yet

    RENAME moves a file or directory within a filesystem, replacing the destination atomically.

    REMOVE will remove the given files, also in subdirectories

    REMOVE_RECURSE will remove the given files and directories, also non-empty directories

    RELATIVE_PATH will determine relative path from directory to the given file.

    TO_CMAKE_PATH will convert path into a cmake style path with unix /. The input can be a single path or a system path like "$ENV{PATH}". Note the double quotes around the ENV call TO_CMAKE_PATH only takes one argument.

    TO_NATIVE_PATH works just like TO_CMAKE_PATH, but will convert from a cmake style path into the native path style \ for windows and / for UNIX.

    DOWNLOAD will download the given URL to the given file. If LOG var is specified a log of the download will be put in var. If STATUS var is specified the status of the operation will be put in var. The status is returned in a list of length 2. The first element is the numeric return value for the operation, and the second element is a string value for the error. A 0 numeric error means no error in the operation. If TIMEOUT time is specified, the operation will timeout after time seconds, time should be specified as an integer.

    The file() command also provides COPY and INSTALL signatures:

      file(<COPY|INSTALL> files... DESTINATION <dir>
           [FILE_PERMISSIONS permissions...]
           [DIRECTORY_PERMISSIONS permissions...]
           [NO_SOURCE_PERMISSIONS] [USE_SOURCE_PERMISSIONS]
           [FILES_MATCHING]
           [[PATTERN <pattern> | REGEX <regex>]
            [EXCLUDE] [PERMISSIONS permissions...]] [...])

    The COPY signature copies files, directories, and symlinks to a destination folder. Relative input paths are evaluated with respect to the current source directory, and a relative destination is evaluated with respect to the current build directory. Copying preserves input file timestamps, and optimizes out a file if it exists at the destination with the same timestamp. Copying preserves input permissions unless explicit permissions or NO_SOURCE_PERMISSIONS are given (default is USE_SOURCE_PERMISSIONS). See the install(DIRECTORY) command for documentation of permissions, PATTERN, REGEX, and EXCLUDE options.

    The INSTALL signature differs slightly from COPY: it prints status messages, and NO_SOURCE_PERMISSIONS is default. Installation scripts generated by the install() command use this signature (with some undocumented options for internal use).

  • find_file: Find the full path to a file.
       find_file(<VAR> name1 [path1 path2 ...])

    This is the short-hand signature for the command that is sufficient in many cases. It is the same as find_file(<VAR> name1 [PATHS path1 path2 ...])

       find_file(
                 <VAR>
                 name | NAMES name1 [name2 ...]
                 [HINTS path1 [path2 ... ENV var]]
                 [PATHS path1 [path2 ... ENV var]]
                 [PATH_SUFFIXES suffix1 [suffix2 ...]]
                 [DOC "cache documentation string"]
                 [NO_DEFAULT_PATH]
                 [NO_CMAKE_ENVIRONMENT_PATH]
                 [NO_CMAKE_PATH]
                 [NO_SYSTEM_ENVIRONMENT_PATH]
                 [NO_CMAKE_SYSTEM_PATH]
                 [CMAKE_FIND_ROOT_PATH_BOTH |
                  ONLY_CMAKE_FIND_ROOT_PATH |
                  NO_CMAKE_FIND_ROOT_PATH]
                )

    This command is used to find a full path to named file. A cache entry named by <VAR> is created to store the result of this command. If the full path to a file is found the result is stored in the variable and the search will not be repeated unless the variable is cleared. If nothing is found, the result will be <VAR>-NOTFOUND, and the search will be attempted again the next time find_file is invoked with the same variable. The name of the full path to a file that is searched for is specified by the names listed after the NAMES argument. Additional search locations can be specified after the PATHS argument. If ENV var is found in the HINTS or PATHS section the environment variable var will be read and converted from a system environment variable to a cmake style list of paths. For example ENV PATH would be a way to list the system path variable. The argument after DOC will be used for the documentation string in the cache. PATH_SUFFIXES specifies additional subdirectories to check below each search path.

    If NO_DEFAULT_PATH is specified, then no additional paths are added to the search. If NO_DEFAULT_PATH is not specified, the search process is as follows:

    1. Search paths specified in cmake-specific cache variables. These are intended to be used on the command line with a -DVAR=value. This can be skipped if NO_CMAKE_PATH is passed.

       <prefix>/include for each <prefix> in CMAKE_PREFIX_PATH
       CMAKE_INCLUDE_PATH
       CMAKE_FRAMEWORK_PATH

    2. Search paths specified in cmake-specific environment variables. These are intended to be set in the user's shell configuration. This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.

       <prefix>/include for each <prefix> in CMAKE_PREFIX_PATH
       CMAKE_INCLUDE_PATH
       CMAKE_FRAMEWORK_PATH

    3. Search the paths specified by the HINTS option. These should be paths computed by system introspection, such as a hint provided by the location of another item already found. Hard-coded guesses should be specified with the PATHS option.

    4. Search the standard system environment variables. This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument.

       PATH
       INCLUDE

    5. Search cmake variables defined in the Platform files for the current system. This can be skipped if NO_CMAKE_SYSTEM_PATH is passed.

       <prefix>/include for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH
       CMAKE_SYSTEM_INCLUDE_PATH
       CMAKE_SYSTEM_FRAMEWORK_PATH

    6. Search the paths specified by the PATHS option or in the short-hand version of the command. These are typically hard-coded guesses.

    On Darwin or systems supporting OS X Frameworks, the cmake variable CMAKE_FIND_FRAMEWORK can be set to empty or one of the following:

       "FIRST"  - Try to find frameworks before standard
                  libraries or headers. This is the default on Darwin.
       "LAST"   - Try to find frameworks after standard
                  libraries or headers.
       "ONLY"   - Only try to find frameworks.
       "NEVER" - Never try to find frameworks.

    On Darwin or systems supporting OS X Application Bundles, the cmake variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the following:

       "FIRST"  - Try to find application bundles before standard
                  programs. This is the default on Darwin.
       "LAST"   - Try to find application bundles after standard
                  programs.
       "ONLY"   - Only try to find application bundles.
       "NEVER" - Never try to find application bundles.

    The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more directories to be prepended to all other search directories. This effectively "re-roots" the entire search under given locations. By default it is empty. It is especially useful when cross-compiling to point to the root directory of the target environment and CMake will search there too. By default at first the directories listed in CMAKE_FIND_ROOT_PATH and then the non-rooted directories will be searched. The default behavior can be adjusted by setting CMAKE_FIND_ROOT_PATH_MODE_INCLUDE. This behavior can be manually overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH the search order will be as described above. If NO_CMAKE_FIND_ROOT_PATH is used then CMAKE_FIND_ROOT_PATH will not be used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted directories will be searched.

    The default search order is designed to be most-specific to least-specific for common use cases. Projects may override the order by simply calling the command multiple times and using the NO_* options:

       find_file(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
       find_file(<VAR> NAMES name)

    Once one of the calls succeeds the result variable will be set and stored in the cache so that no call will search again.

  • find_library: Find a library.
       find_library(<VAR> name1 [path1 path2 ...])

    This is the short-hand signature for the command that is sufficient in many cases. It is the same as find_library(<VAR> name1 [PATHS path1 path2 ...])

       find_library(
                 <VAR>
                 name | NAMES name1 [name2 ...]
                 [HINTS path1 [path2 ... ENV var]]
                 [PATHS path1 [path2 ... ENV var]]
                 [PATH_SUFFIXES suffix1 [suffix2 ...]]
                 [DOC "cache documentation string"]
                 [NO_DEFAULT_PATH]
                 [NO_CMAKE_ENVIRONMENT_PATH]
                 [NO_CMAKE_PATH]
                 [NO_SYSTEM_ENVIRONMENT_PATH]
                 [NO_CMAKE_SYSTEM_PATH]
                 [CMAKE_FIND_ROOT_PATH_BOTH |
                  ONLY_CMAKE_FIND_ROOT_PATH |
                  NO_CMAKE_FIND_ROOT_PATH]
                )

    This command is used to find a library. A cache entry named by <VAR> is created to store the result of this command. If the library is found the result is stored in the variable and the search will not be repeated unless the variable is cleared. If nothing is found, the result will be <VAR>-NOTFOUND, and the search will be attempted again the next time find_library is invoked with the same variable. The name of the library that is searched for is specified by the names listed after the NAMES argument. Additional search locations can be specified after the PATHS argument. If ENV var is found in the HINTS or PATHS section the environment variable var will be read and converted from a system environment variable to a cmake style list of paths. For example ENV PATH would be a way to list the system path variable. The argument after DOC will be used for the documentation string in the cache. PATH_SUFFIXES specifies additional subdirectories to check below each search path.

    If NO_DEFAULT_PATH is specified, then no additional paths are added to the search. If NO_DEFAULT_PATH is not specified, the search process is as follows:

    1. Search paths specified in cmake-specific cache variables. These are intended to be used on the command line with a -DVAR=value. This can be skipped if NO_CMAKE_PATH is passed.

       <prefix>/lib for each <prefix> in CMAKE_PREFIX_PATH
       CMAKE_LIBRARY_PATH
       CMAKE_FRAMEWORK_PATH

    2. Search paths specified in cmake-specific environment variables. These are intended to be set in the user's shell configuration. This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.

       <prefix>/lib for each <prefix> in CMAKE_PREFIX_PATH
       CMAKE_LIBRARY_PATH
       CMAKE_FRAMEWORK_PATH

    3. Search the paths specified by the HINTS option. These should be paths computed by system introspection, such as a hint provided by the location of another item already found. Hard-coded guesses should be specified with the PATHS option.

    4. Search the standard system environment variables. This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument.

       PATH
       LIB

    5. Search cmake variables defined in the Platform files for the current system. This can be skipped if NO_CMAKE_SYSTEM_PATH is passed.

       <prefix>/lib for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH
       CMAKE_SYSTEM_LIBRARY_PATH
       CMAKE_SYSTEM_FRAMEWORK_PATH

    6. Search the paths specified by the PATHS option or in the short-hand version of the command. These are typically hard-coded guesses.

    On Darwin or systems supporting OS X Frameworks, the cmake variable CMAKE_FIND_FRAMEWORK can be set to empty or one of the following:

       "FIRST"  - Try to find frameworks before standard
                  libraries or headers. This is the default on Darwin.
       "LAST"   - Try to find frameworks after standard
                  libraries or headers.
       "ONLY"   - Only try to find frameworks.
       "NEVER" - Never try to find frameworks.

    On Darwin or systems supporting OS X Application Bundles, the cmake variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the following:

       "FIRST"  - Try to find application bundles before standard
                  programs. This is the default on Darwin.
       "LAST"   - Try to find application bundles after standard
                  programs.
       "ONLY"   - Only try to find application bundles.
       "NEVER" - Never try to find application bundles.

    The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more directories to be prepended to all other search directories. This effectively "re-roots" the entire search under given locations. By default it is empty. It is especially useful when cross-compiling to point to the root directory of the target environment and CMake will search there too. By default at first the directories listed in CMAKE_FIND_ROOT_PATH and then the non-rooted directories will be searched. The default behavior can be adjusted by setting CMAKE_FIND_ROOT_PATH_MODE_LIBRARY. This behavior can be manually overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH the search order will be as described above. If NO_CMAKE_FIND_ROOT_PATH is used then CMAKE_FIND_ROOT_PATH will not be used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted directories will be searched.

    The default search order is designed to be most-specific to least-specific for common use cases. Projects may override the order by simply calling the command multiple times and using the NO_* options:

       find_library(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
       find_library(<VAR> NAMES name)

    Once one of the calls succeeds the result variable will be set and stored in the cache so that no call will search again.

    If the library found is a framework, then VAR will be set to the full path to the framework <fullPath>/A.framework. When a full path to a framework is used as a library, CMake will use a -framework A, and a -F<fullPath> to link the framework to the target.

  • find_package: Load settings for an external project.
      find_package(<package> [version] [EXACT] [QUIET]
                   [[REQUIRED|COMPONENTS] [components...]]
                   [NO_POLICY_SCOPE])

    Finds and loads settings from an external project. <package>_FOUND will be set to indicate whether the package was found. When the package is found package-specific information is provided through variables documented by the package itself. The QUIET option disables messages if the package cannot be found. The REQUIRED option stops processing with an error message if the package cannot be found. A package-specific list of components may be listed after the REQUIRED option or after the COMPONENTS option if no REQUIRED option is given. The [version] argument requests a version with which the package found should be compatible (format is major[.minor[.patch[.tweak]]]). The EXACT option requests that the version be matched exactly. If no [version] is given to a recursive invocation inside a find-module, the [version] and EXACT arguments are forwarded automatically from the outer call. Version support is currently provided only on a package-by-package basis (details below).

    User code should generally look for packages using the above simple signature. The remainder of this command documentation specifies the full command signature and details of the search process. Project maintainers wishing to provide a package to be found by this command are encouraged to read on.

    The command has two modes by which it searches for packages: "Module" mode and "Config" mode. Module mode is available when the command is invoked with the above reduced signature. CMake searches for a file called "Find<package>.cmake" in the CMAKE_MODULE_PATH followed by the CMake installation. If the file is found, it is read and processed by CMake. It is responsible for finding the package, checking the version, and producing any needed messages. Many find-modules provide limited or no support for versioning; check the module documentation. If no module is found the command proceeds to Config mode.

    The complete Config mode command signature is:

      find_package(<package> [version] [EXACT] [QUIET]
                   [[REQUIRED|COMPONENTS] [components...]] [NO_MODULE]
                   [NO_POLICY_SCOPE]
                   [NAMES name1 [name2 ...]]
                   [CONFIGS config1 [config2 ...]]
                   [HINTS path1 [path2 ... ]]
                   [PATHS path1 [path2 ... ]]
                   [PATH_SUFFIXES suffix1 [suffix2 ...]]
                   [NO_DEFAULT_PATH]
                   [NO_CMAKE_ENVIRONMENT_PATH]
                   [NO_CMAKE_PATH]
                   [NO_SYSTEM_ENVIRONMENT_PATH]
                   [NO_CMAKE_PACKAGE_REGISTRY]
                   [NO_CMAKE_BUILDS_PATH]
                   [NO_CMAKE_SYSTEM_PATH]
                   [CMAKE_FIND_ROOT_PATH_BOTH |
                    ONLY_CMAKE_FIND_ROOT_PATH |
                    NO_CMAKE_FIND_ROOT_PATH])

    The NO_MODULE option may be used to skip Module mode explicitly. It is also implied by use of options not specified in the reduced signature.

    Config mode attempts to locate a configuration file provided by the package to be found. A cache entry called <package>_DIR is created to hold the directory containing the file. By default the command searches for a package with the name <package>. If the NAMES option is given the names following it are used instead of <package>. The command searches for a file called "<name>Config.cmake" or "<lower-case-name>-config.cmake" for each name specified. A replacement set of possible configuration file names may be given using the CONFIGS option. The search procedure is specified below. Once found, the configuration file is read and processed by CMake. Since the file is provided by the package it already knows the location of package contents. The full path to the configuration file is stored in the cmake variable <package>_CONFIG.

    If the package configuration file cannot be found CMake will generate an error describing the problem unless the QUIET argument is specified. If REQUIRED is specified and the package is not found a fatal error is generated and the configure step stops executing. If <package>_DIR has been set to a directory not containing a configuration file CMake will ignore it and search from scratch.

    When the [version] argument is given Config mode will only find a version of the package that claims compatibility with the requested version (format is major[.minor[.patch[.tweak]]]). If the EXACT option is given only a version of the package claiming an exact match of the requested version may be found. CMake does not establish any convention for the meaning of version numbers. Package version numbers are checked by "version" files provided by the packages themselves. For a candidate package configuration file "<config-file>.cmake" the corresponding version file is located next to it and named either "<config-file>-version.cmake" or "<config-file>Version.cmake". If no such version file is available then the configuration file is assumed to not be compatible with any requested version. When a version file is found it is loaded to check the requested version number. The version file is loaded in a nested scope in which the following variables have been defined:

      PACKAGE_FIND_NAME          = the <package> name
      PACKAGE_FIND_VERSION       = full requested version string
      PACKAGE_FIND_VERSION_MAJOR = major version if requested, else 0
      PACKAGE_FIND_VERSION_MINOR = minor version if requested, else 0
      PACKAGE_FIND_VERSION_PATCH = patch version if requested, else 0
      PACKAGE_FIND_VERSION_TWEAK = tweak version if requested, else 0
      PACKAGE_FIND_VERSION_COUNT = number of version components, 0 to 4

    The version file checks whether it satisfies the requested version and sets these variables:

      PACKAGE_VERSION            = full provided version string
      PACKAGE_VERSION_EXACT      = true if version is exact match
      PACKAGE_VERSION_COMPATIBLE = true if version is compatible
      PACKAGE_VERSION_UNSUITABLE = true if unsuitable as any version

    These variables are checked by the find_package command to determine whether the configuration file provides an acceptable version. They are not available after the find_package call returns. If the version is acceptable the following variables are set:

      <package>_VERSION       = full provided version string
      <package>_VERSION_MAJOR = major version if provided, else 0
      <package>_VERSION_MINOR = minor version if provided, else 0
      <package>_VERSION_PATCH = patch version if provided, else 0
      <package>_VERSION_TWEAK = tweak version if provided, else 0
      <package>_VERSION_COUNT = number of version components, 0 to 4

    and the corresponding package configuration file is loaded. When multiple package configuration files are available whose version files claim compatibility with the version requested it is unspecified which one is chosen. No attempt is made to choose a highest or closest version number.

    Config mode provides an elaborate interface and search procedure. Much of the interface is provided for completeness and for use internally by find-modules loaded by Module mode. Most user code should simply call

      find_package(<package> [major[.minor]] [EXACT] [REQUIRED|QUIET])

    in order to find a package. Package maintainers providing CMake package configuration files are encouraged to name and install them such that the procedure outlined below will find them without requiring use of additional options.

    CMake constructs a set of possible installation prefixes for the package. Under each prefix several directories are searched for a configuration file. The tables below show the directories searched. Each entry is meant for installation trees following Windows (W), UNIX (U), or Apple (A) conventions.

      <prefix>/                                               (W)
      <prefix>/(cmake|CMake)/                                 (W)
      <prefix>/<name>*/                                       (W)
      <prefix>/<name>*/(cmake|CMake)/                         (W)
      <prefix>/(share|lib)/cmake/<name>*/                     (U)
      <prefix>/(share|lib)/<name>*/                           (U)
      <prefix>/(share|lib)/<name>*/(cmake|CMake)/             (U)

    On systems supporting OS X Frameworks and Application Bundles the following directories are searched for frameworks or bundles containing a configuration file:

      <prefix>/<name>.framework/Resources/                    (A)
      <prefix>/<name>.framework/Resources/CMake/              (A)
      <prefix>/<name>.framework/Versions/*/Resources/         (A)
      <prefix>/<name>.framework/Versions/*/Resources/CMake/   (A)
      <prefix>/<name>.app/Contents/Resources/                 (A)
      <prefix>/<name>.app/Contents/Resources/CMake/           (A)

    In all cases the <name> is treated as case-insensitive and corresponds to any of the names specified (<package> or names given by NAMES). If PATH_SUFFIXES is specified the suffixes are appended to each (W) or (U) directory entry one-by-one.

    This set of directories is intended to work in cooperation with projects that provide configuration files in their installation trees. Directories above marked with (W) are intended for installations on Windows where the prefix may point at the top of an application's installation directory. Those marked with (U) are intended for installations on UNIX platforms where the prefix is shared by multiple packages. This is merely a convention, so all (W) and (U) directories are still searched on all platforms. Directories marked with (A) are intended for installations on Apple platforms. The cmake variables CMAKE_FIND_FRAMEWORK and CMAKE_FIND_APPBUNDLE determine the order of preference as specified below.

    The set of installation prefixes is constructed using the following steps. If NO_DEFAULT_PATH is specified all NO_* options are enabled.

    1. Search paths specified in cmake-specific cache variables. These are intended to be used on the command line with a -DVAR=value. This can be skipped if NO_CMAKE_PATH is passed.

       CMAKE_PREFIX_PATH
       CMAKE_FRAMEWORK_PATH
       CMAKE_APPBUNDLE_PATH

    2. Search paths specified in cmake-specific environment variables. These are intended to be set in the user's shell configuration. This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.

       CMAKE_PREFIX_PATH
       CMAKE_FRAMEWORK_PATH
       CMAKE_APPBUNDLE_PATH

    3. Search paths specified by the HINTS option. These should be paths computed by system introspection, such as a hint provided by the location of another item already found. Hard-coded guesses should be specified with the PATHS option.

    4. Search the standard system environment variables. This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is passed. Path entries ending in "/bin" or "/sbin" are automatically converted to their parent directories.

       PATH

    5. Search project build trees recently configured in a CMake GUI. This can be skipped if NO_CMAKE_BUILDS_PATH is passed. It is intended for the case when a user is building multiple dependent projects one after another.

    6. Search paths stored in the CMake user package registry. This can be skipped if NO_CMAKE_PACKAGE_REGISTRY is passed. Paths are stored in the registry when CMake configures a project that invokes export(PACKAGE <name>). See the export(PACKAGE) command documentation for more details.

    7. Search cmake variables defined in the Platform files for the current system. This can be skipped if NO_CMAKE_SYSTEM_PATH is passed.

       CMAKE_SYSTEM_PREFIX_PATH
       CMAKE_SYSTEM_FRAMEWORK_PATH
       CMAKE_SYSTEM_APPBUNDLE_PATH

    8. Search paths specified by the PATHS option. These are typically hard-coded guesses.

    On Darwin or systems supporting OS X Frameworks, the cmake variable CMAKE_FIND_FRAMEWORK can be set to empty or one of the following:

       "FIRST"  - Try to find frameworks before standard
                  libraries or headers. This is the default on Darwin.
       "LAST"   - Try to find frameworks after standard
                  libraries or headers.
       "ONLY"   - Only try to find frameworks.
       "NEVER" - Never try to find frameworks.

    On Darwin or systems supporting OS X Application Bundles, the cmake variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the following:

       "FIRST"  - Try to find application bundles before standard
                  programs. This is the default on Darwin.
       "LAST"   - Try to find application bundles after standard
                  programs.
       "ONLY"   - Only try to find application bundles.
       "NEVER" - Never try to find application bundles.

    The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more directories to be prepended to all other search directories. This effectively "re-roots" the entire search under given locations. By default it is empty. It is especially useful when cross-compiling to point to the root directory of the target environment and CMake will search there too. By default at first the directories listed in CMAKE_FIND_ROOT_PATH and then the non-rooted directories will be searched. The default behavior can be adjusted by setting CMAKE_FIND_ROOT_PATH_MODE_PACKAGE. This behavior can be manually overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH the search order will be as described above. If NO_CMAKE_FIND_ROOT_PATH is used then CMAKE_FIND_ROOT_PATH will not be used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted directories will be searched.

    The default search order is designed to be most-specific to least-specific for common use cases. Projects may override the order by simply calling the command multiple times and using the NO_* options:

       find_package(<package> PATHS paths... NO_DEFAULT_PATH)
       find_package(<package>)

    Once one of the calls succeeds the result variable will be set and stored in the cache so that no call will search again.

    See the cmake_policy() command documentation for discussion of the NO_POLICY_SCOPE option.

  • find_path: Find the directory containing a file.
       find_path(<VAR> name1 [path1 path2 ...])

    This is the short-hand signature for the command that is sufficient in many cases. It is the same as find_path(<VAR> name1 [PATHS path1 path2 ...])

       find_path(
                 <VAR>
                 name | NAMES name1 [name2 ...]
                 [HINTS path1 [path2 ... ENV var]]
                 [PATHS path1 [path2 ... ENV var]]
                 [PATH_SUFFIXES suffix1 [suffix2 ...]]
                 [DOC "cache documentation string"]
                 [NO_DEFAULT_PATH]
                 [NO_CMAKE_ENVIRONMENT_PATH]
                 [NO_CMAKE_PATH]
                 [NO_SYSTEM_ENVIRONMENT_PATH]
                 [NO_CMAKE_SYSTEM_PATH]
                 [CMAKE_FIND_ROOT_PATH_BOTH |
                  ONLY_CMAKE_FIND_ROOT_PATH |
                  NO_CMAKE_FIND_ROOT_PATH]
                )

    This command is used to find a directory containing the named file. A cache entry named by <VAR> is created to store the result of this command. If the file in a directory is found the result is stored in the variable and the search will not be repeated unless the variable is cleared. If nothing is found, the result will be <VAR>-NOTFOUND, and the search will be attempted again the next time find_path is invoked with the same variable. The name of the file in a directory that is searched for is specified by the names listed after the NAMES argument. Additional search locations can be specified after the PATHS argument. If ENV var is found in the HINTS or PATHS section the environment variable var will be read and converted from a system environment variable to a cmake style list of paths. For example ENV PATH would be a way to list the system path variable. The argument after DOC will be used for the documentation string in the cache. PATH_SUFFIXES specifies additional subdirectories to check below each search path.

    If NO_DEFAULT_PATH is specified, then no additional paths are added to the search. If NO_DEFAULT_PATH is not specified, the search process is as follows:

    1. Search paths specified in cmake-specific cache variables. These are intended to be used on the command line with a -DVAR=value. This can be skipped if NO_CMAKE_PATH is passed.

       <prefix>/include for each <prefix> in CMAKE_PREFIX_PATH
       CMAKE_INCLUDE_PATH
       CMAKE_FRAMEWORK_PATH

    2. Search paths specified in cmake-specific environment variables. These are intended to be set in the user's shell configuration. This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.

       <prefix>/include for each <prefix> in CMAKE_PREFIX_PATH
       CMAKE_INCLUDE_PATH
       CMAKE_FRAMEWORK_PATH

    3. Search the paths specified by the HINTS option. These should be paths computed by system introspection, such as a hint provided by the location of another item already found. Hard-coded guesses should be specified with the PATHS option.

    4. Search the standard system environment variables. This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument.

       PATH
       INCLUDE

    5. Search cmake variables defined in the Platform files for the current system. This can be skipped if NO_CMAKE_SYSTEM_PATH is passed.

       <prefix>/include for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH
       CMAKE_SYSTEM_INCLUDE_PATH
       CMAKE_SYSTEM_FRAMEWORK_PATH

    6. Search the paths specified by the PATHS option or in the short-hand version of the command. These are typically hard-coded guesses.

    On Darwin or systems supporting OS X Frameworks, the cmake variable CMAKE_FIND_FRAMEWORK can be set to empty or one of the following:

       "FIRST"  - Try to find frameworks before standard
                  libraries or headers. This is the default on Darwin.
       "LAST"   - Try to find frameworks after standard
                  libraries or headers.
       "ONLY"   - Only try to find frameworks.
       "NEVER" - Never try to find frameworks.

    On Darwin or systems supporting OS X Application Bundles, the cmake variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the following:

       "FIRST"  - Try to find application bundles before standard
                  programs. This is the default on Darwin.
       "LAST"   - Try to find application bundles after standard
                  programs.
       "ONLY"   - Only try to find application bundles.
       "NEVER" - Never try to find application bundles.

    The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more directories to be prepended to all other search directories. This effectively "re-roots" the entire search under given locations. By default it is empty. It is especially useful when cross-compiling to point to the root directory of the target environment and CMake will search there too. By default at first the directories listed in CMAKE_FIND_ROOT_PATH and then the non-rooted directories will be searched. The default behavior can be adjusted by setting CMAKE_FIND_ROOT_PATH_MODE_INCLUDE. This behavior can be manually overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH the search order will be as described above. If NO_CMAKE_FIND_ROOT_PATH is used then CMAKE_FIND_ROOT_PATH will not be used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted directories will be searched.

    The default search order is designed to be most-specific to least-specific for common use cases. Projects may override the order by simply calling the command multiple times and using the NO_* options:

       find_path(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
       find_path(<VAR> NAMES name)

    Once one of the calls succeeds the result variable will be set and stored in the cache so that no call will search again.

    When searching for frameworks, if the file is specified as A/b.h, then the framework search will look for A.framework/Headers/b.h. If that is found the path will be set to the path to the framework. CMake will convert this to the correct -F option to include the file.

  • find_program: Find an executable program.
       find_program(<VAR> name1 [path1 path2 ...])

    This is the short-hand signature for the command that is sufficient in many cases. It is the same as find_program(<VAR> name1 [PATHS path1 path2 ...])

       find_program(
                 <VAR>
                 name | NAMES name1 [name2 ...]
                 [HINTS path1 [path2 ... ENV var]]
                 [PATHS path1 [path2 ... ENV var]]
                 [PATH_SUFFIXES suffix1 [suffix2 ...]]
                 [DOC "cache documentation string"]
                 [NO_DEFAULT_PATH]
                 [NO_CMAKE_ENVIRONMENT_PATH]
                 [NO_CMAKE_PATH]
                 [NO_SYSTEM_ENVIRONMENT_PATH]
                 [NO_CMAKE_SYSTEM_PATH]
                 [CMAKE_FIND_ROOT_PATH_BOTH |
                  ONLY_CMAKE_FIND_ROOT_PATH |
                  NO_CMAKE_FIND_ROOT_PATH]
                )

    This command is used to find a program. A cache entry named by <VAR> is created to store the result of this command. If the program is found the result is stored in the variable and the search will not be repeated unless the variable is cleared. If nothing is found, the result will be <VAR>-NOTFOUND, and the search will be attempted again the next time find_program is invoked with the same variable. The name of the program that is searched for is specified by the names listed after the NAMES argument. Additional search locations can be specified after the PATHS argument. If ENV var is found in the HINTS or PATHS section the environment variable var will be read and converted from a system environment variable to a cmake style list of paths. For example ENV PATH would be a way to list the system path variable. The argument after DOC will be used for the documentation string in the cache. PATH_SUFFIXES specifies additional subdirectories to check below each search path.

    If NO_DEFAULT_PATH is specified, then no additional paths are added to the search. If NO_DEFAULT_PATH is not specified, the search process is as follows:

    1. Search paths specified in cmake-specific cache variables. These are intended to be used on the command line with a -DVAR=value. This can be skipped if NO_CMAKE_PATH is passed.

       <prefix>/[s]bin for each <prefix> in CMAKE_PREFIX_PATH
       CMAKE_PROGRAM_PATH
       CMAKE_APPBUNDLE_PATH

    2. Search paths specified in cmake-specific environment variables. These are intended to be set in the user's shell configuration. This can be skipped if NO_CMAKE_ENVIRONMENT_PATH is passed.

       <prefix>/[s]bin for each <prefix> in CMAKE_PREFIX_PATH
       CMAKE_PROGRAM_PATH
       CMAKE_APPBUNDLE_PATH

    3. Search the paths specified by the HINTS option. These should be paths computed by system introspection, such as a hint provided by the location of another item already found. Hard-coded guesses should be specified with the PATHS option.

    4. Search the standard system environment variables. This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an argument.

       PATH

    5. Search cmake variables defined in the Platform files for the current system. This can be skipped if NO_CMAKE_SYSTEM_PATH is passed.

       <prefix>/[s]bin for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH
       CMAKE_SYSTEM_PROGRAM_PATH
       CMAKE_SYSTEM_APPBUNDLE_PATH

    6. Search the paths specified by the PATHS option or in the short-hand version of the command. These are typically hard-coded guesses.

    On Darwin or systems supporting OS X Frameworks, the cmake variable CMAKE_FIND_FRAMEWORK can be set to empty or one of the following:

       "FIRST"  - Try to find frameworks before standard
                  libraries or headers. This is the default on Darwin.
       "LAST"   - Try to find frameworks after standard
                  libraries or headers.
       "ONLY"   - Only try to find frameworks.
       "NEVER" - Never try to find frameworks.

    On Darwin or systems supporting OS X Application Bundles, the cmake variable CMAKE_FIND_APPBUNDLE can be set to empty or one of the following:

       "FIRST"  - Try to find application bundles before standard
                  programs. This is the default on Darwin.
       "LAST"   - Try to find application bundles after standard
                  programs.
       "ONLY"   - Only try to find application bundles.
       "NEVER" - Never try to find application bundles.

    The CMake variable CMAKE_FIND_ROOT_PATH specifies one or more directories to be prepended to all other search directories. This effectively "re-roots" the entire search under given locations. By default it is empty. It is especially useful when cross-compiling to point to the root directory of the target environment and CMake will search there too. By default at first the directories listed in CMAKE_FIND_ROOT_PATH and then the non-rooted directories will be searched. The default behavior can be adjusted by setting CMAKE_FIND_ROOT_PATH_MODE_PROGRAM. This behavior can be manually overridden on a per-call basis. By using CMAKE_FIND_ROOT_PATH_BOTH the search order will be as described above. If NO_CMAKE_FIND_ROOT_PATH is used then CMAKE_FIND_ROOT_PATH will not be used. If ONLY_CMAKE_FIND_ROOT_PATH is used then only the re-rooted directories will be searched.

    The default search order is designed to be most-specific to least-specific for common use cases. Projects may override the order by simply calling the command multiple times and using the NO_* options:

       find_program(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
       find_program(<VAR> NAMES name)

    Once one of the calls succeeds the result variable will be set and stored in the cache so that no call will search again.

  • fltk_wrap_ui: Create FLTK user interfaces Wrappers.
      fltk_wrap_ui(resultingLibraryName source1
                   source2 ... sourceN )

    Produce .h and .cxx files for all the .fl and .fld files listed. The resulting .h and .cxx files will be added to a variable named resultingLibraryName_FLTK_UI_SRCS which should be added to your library.

  • foreach: Evaluate a group of commands for each value in a list.
      foreach(loop_var arg1 arg2 ...)
        COMMAND1(ARGS ...)
        COMMAND2(ARGS ...)
        ...
      endforeach(loop_var)

    All commands between foreach and the matching endforeach are recorded without being invoked. Once the endforeach is evaluated, the recorded list of commands is invoked once for each argument listed in the original foreach command. Before each iteration of the loop "${loop_var}" will be set as a variable with the current value in the list.

      foreach(loop_var RANGE total)
      foreach(loop_var RANGE start stop [step])

    Foreach can also iterate over a generated range of numbers. There are three types of this iteration:

    * When specifying single number, the range will have elements 0 to "total".

    * When specifying two numbers, the range will have elements from the first number to the second number.

    * The third optional number is the increment used to iterate from the first number to the second number.

      foreach(loop_var IN [LISTS [list1 [...]]]
                          [ITEMS [item1 [...]]])

    Iterates over a precise list of items. The LISTS option names list-valued variables to be traversed, including empty elements (an empty string is a zero-length list). The ITEMS option ends argument parsing and includes all arguments following it in the iteration.

  • function: Start recording a function for later invocation as a command.
      function(<name> [arg1 [arg2 [arg3 ...]]])
        COMMAND1(ARGS ...)
        COMMAND2(ARGS ...)
        ...
      endfunction(<name>)

    Define a function named <name> that takes arguments named arg1 arg2 arg3 (...). Commands listed after function, but before the matching endfunction, are not invoked until the function is invoked. When it is invoked, the commands recorded in the function are first modified by replacing formal parameters (${arg1}) with the arguments passed, and then invoked as normal commands. In addition to referencing the formal parameters you can reference the variable ARGC which will be set to the number of arguments passed into the function as well as ARGV0 ARGV1 ARGV2 ... which will have the actual values of the arguments passed in. This facilitates creating functions with optional arguments. Additionally ARGV holds the list of all arguments given to the function and ARGN holds the list of argument past the last expected argument.

    See the cmake_policy() command documentation for the behavior of policies inside functions.

  • get_cmake_property: Get a property of the CMake instance.
      get_cmake_property(VAR property)

    Get a property from the CMake instance. The value of the property is stored in the variable VAR. If the property is not found, CMake will report an error. Some supported properties include: VARIABLES, CACHE_VARIABLES, COMMANDS, MACROS, and COMPONENTS.

  • get_directory_property: Get a property of DIRECTORY scope.
      get_directory_property(<variable> [DIRECTORY <dir>] <prop-name>)

    Store a property of directory scope in the named variable. If the property is not defined the empty-string is returned. The DIRECTORY argument specifies another directory from which to retrieve the property value. The specified directory must have already been traversed by CMake.

      get_directory_property(<variable> [DIRECTORY <dir>]
                             DEFINITION <var-name>)

    Get a variable definition from a directory. This form is useful to get a variable definition from another directory.

  • get_filename_component: Get a specific component of a full filename.
      get_filename_component(VarName FileName
                             PATH|ABSOLUTE|NAME|EXT|NAME_WE|REALPATH
                             [CACHE])

    Set VarName to be the path (PATH), file name (NAME), file extension (EXT), file name without extension (NAME_WE) of FileName, the full path (ABSOLUTE), or the full path with all symlinks resolved (REALPATH). Note that the path is converted to Unix slashes format and has no trailing slashes. The longest file extension is always considered. If the optional CACHE argument is specified, the result variable is added to the cache.

      get_filename_component(VarName FileName
                             PROGRAM [PROGRAM_ARGS ArgVar]
                             [CACHE])

    The program in FileName will be found in the system search path or left as a full path. If PROGRAM_ARGS is present with PROGRAM, then any command-line arguments present in the FileName string are split from the program name and stored in ArgVar. This is used to separate a program name from its arguments in a command line string.

  • get_property: Get a property.
      get_property(<variable>
                   <GLOBAL             |
                    DIRECTORY [dir]    |
                    TARGET    <target> |
                    SOURCE    <source> |
                    TEST      <test>   |
                    CACHE     <entry>  |
                    VARIABLE>
                   PROPERTY <name>
                   [SET | DEFINED | BRIEF_DOCS | FULL_DOCS])

    Get one property from one object in a scope. The first argument specifies the variable in which to store the result. The second argument determines the scope from which to get the property. It must be one of the following:

    GLOBAL scope is unique and does not accept a name.

    DIRECTORY scope defaults to the current directory but another directory (already processed by CMake) may be named by full or relative path.

    TARGET scope must name one existing target.

    SOURCE scope must name one source file.

    TEST scope must name one existing test.

    CACHE scope must name one cache entry.

    VARIABLE scope is unique and does not accept a name.

    The required PROPERTY option is immediately followed by the name of the property to get. If the property is not set an empty value is returned. If the SET option is given the variable is set to a boolean value indicating whether the property has been set. If the DEFINED option is given the variable is set to a boolean value indicating whether the property has been defined such as with define_property. If BRIEF_DOCS or FULL_DOCS is given then the variable is set to a string containing documentation for the requested property. If documentation is requested for a property that has not been defined NOTFOUND is returned.

  • get_source_file_property: Get a property for a source file.
      get_source_file_property(VAR file property)

    Get a property from a source file. The value of the property is stored in the variable VAR. If the property is not found, VAR will be set to "NOTFOUND". Use set_source_files_properties to set property values. Source file properties usually control how the file is built. One property that is always there is LOCATION

  • get_target_property: Get a property from a target.
      get_target_property(VAR target property)

    Get a property from a target. The value of the property is stored in the variable VAR. If the property is not found, VAR will be set to "NOTFOUND". Use set_target_properties to set property values. Properties are usually used to control how a target is built, but some query the target instead. This command can get properties for any target so far created. The targets do not need to be in the current CMakeLists.txt file.

  • get_test_property: Get a property of the test.
      get_test_property(test VAR property)

    Get a property from the Test. The value of the property is stored in the variable VAR. If the property is not found, CMake will report an error. For a list of standard properties you can type cmake --help-property-list

  • if: Conditionally execute a group of commands.
      if(expression)
        # then section.
        COMMAND1(ARGS ...)
        COMMAND2(ARGS ...)
        ...
      elseif(expression2)
        # elseif section.
        COMMAND1(ARGS ...)
        COMMAND2(ARGS ...)
        ...
      else(expression)
        # else section.
        COMMAND1(ARGS ...)
        COMMAND2(ARGS ...)
        ...
      endif(expression)

    Evaluates the given expression. If the result is true, the commands in the THEN section are invoked. Otherwise, the commands in the else section are invoked. The elseif and else sections are optional. You may have multiple elseif clauses. Note that the expression in the else and endif clause is optional. Long expressions can be used and there is a traditional order of precedence. Parenthetical expressions are evaluated first followed by unary operators such as EXISTS, COMMAND, and DEFINED. Then any EQUAL, LESS, GREATER, STRLESS, STRGREATER, STREQUAL, MATCHES will be evaluated. Then NOT operators and finally AND, OR operators will be evaluated. Possible expressions are:

      if(<constant>)

    True if the constant is 1, ON, YES, TRUE, Y, or a non-zero number. False if the constant is 0, OFF, NO, FALSE, N, IGNORE, "", or ends in the suffix '-NOTFOUND'. Named boolean constants are case-insensitive.

      if(<variable>)

    True if the variable's value is not a false constant.

      if(NOT <expression>)

    True if the expression is not true.

      if(<expr1> AND <expr2>)

    True if both expressions would be considered true individually.

      if(<expr1> OR <expr2>)

    True if either expression would be considered true individually.

      if(COMMAND command-name)

    True if the given name is a command, macro or function that can be invoked.

      if(POLICY policy-id)

    True if the given name is an existing policy (of the form CMP<NNNN>).

      if(TARGET target-name)

    True if the given name is an existing target, built or imported.

      if(EXISTS file-name)
      if(EXISTS directory-name)

    True if the named file or directory exists. Behavior is well-defined only for full paths.

      if(file1 IS_NEWER_THAN file2)

    True if file1 is newer than file2 or if one of the two files doesn't exist. Behavior is well-defined only for full paths.

      if(IS_DIRECTORY directory-name)

    True if the given name is a directory. Behavior is well-defined only for full paths.

      if(IS_ABSOLUTE path)

    True if the given path is an absolute path.

      if(variable MATCHES regex)
      if(string MATCHES regex)

    True if the given string or variable's value matches the given regular expression.

      if(variable LESS number)
      if(string LESS number)
      if(variable GREATER number)
      if(string GREATER number)
      if(variable EQUAL number)
      if(string EQUAL number)

    True if the given string or variable's value is a valid number and the inequality or equality is true.

      if(variable STRLESS string)
      if(string STRLESS string)
      if(variable STRGREATER string)
      if(string STRGREATER string)
      if(variable STREQUAL string)
      if(string STREQUAL string)

    True if the given string or variable's value is lexicographically less (or greater, or equal) than the string or variable on the right.

      if(version1 VERSION_LESS version2)
      if(version1 VERSION_EQUAL version2)
      if(version1 VERSION_GREATER version2)

    Component-wise integer version number comparison (version format is major[.minor[.patch[.tweak]]]).

      if(DEFINED variable)

    True if the given variable is defined. It does not matter if the variable is true or false just if it has been set.

      if((expression) AND (expression OR (expression)))

    The expressions inside the parenthesis are evaluated first and then the remaining expression is evaluated as in the previous examples. Where there are nested parenthesis the innermost are evaluated as part of evaluating the expression that contains them.

    The if statement was written fairly early in CMake's history and it has some convenience features that are worth covering. The if statement reduces operations until there is a single remaining value, at that point if the case insensitive value is: ON, 1, YES, TRUE, Y it returns true, if it is OFF, 0, NO, FALSE, N, NOTFOUND, *-NOTFOUND, IGNORE it will return false.

    This is fairly reasonable. The convenience feature that sometimes throws new authors is how CMake handles values that do not match the true or false list. Those values are treated as variables and are dereferenced even though they do not have the required ${} syntax. This means that if you write

      if (boobah)

    CMake will treat it as if you wrote 

      if (${boobah})

    likewise if you write 

      if (fubar AND sol)

    CMake will conveniently treat it as 

      if ("${fubar}" AND "${sol}")

    The later is really the correct way to write it, but the former will work as well. Only some operations in the if statement have this special handling of arguments. The specific details follow:

    1) The left hand argument to MATCHES is first checked to see if it is a defined variable, if so the variable's value is used, otherwise the original value is used.

    2) If the left hand argument to MATCHES is missing it returns false without error

    3) Both left and right hand arguments to LESS GREATER EQUAL are independently tested to see if they are defined variables, if so their defined values are used otherwise the original value is used.

    4) Both left and right hand arguments to STRLESS STREQUAL STRGREATER are independently tested to see if they are defined variables, if so their defined values are used otherwise the original value is used.

    5) Both left and right hand argumemnts to VERSION_LESS VERSION_EQUAL VERSION_GREATER are independently tested to see if they are defined variables, if so their defined values are used otherwise the original value is used.

    6) The right hand argument to NOT is tested to see if it is a boolean constant, if so the value is used, otherwise it is assumed to be a variable and it is dereferenced.

    7) The left and right hand arguments to AND OR are independently tested to see if they are boolean constants, if so they are used as such, otherwise they are assumed to be variables and are dereferenced.

  • include: Read CMake listfile code from the given file.
      include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>]
                            [NO_POLICY_SCOPE])

    Reads CMake listfile code from the given file. Commands in the file are processed immediately as if they were written in place of the include command. If OPTIONAL is present, then no error is raised if the file does not exist. If RESULT_VARIABLE is given the variable will be set to the full filename which has been included or NOTFOUND if it failed.

    If a module is specified instead of a file, the file with name <modulename>.cmake is searched in the CMAKE_MODULE_PATH.

    See the cmake_policy() command documentation for discussion of the NO_POLICY_SCOPE option.

  • include_directories: Add include directories to the build.
      include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)

    Add the given directories to those searched by the compiler for include files. By default the directories are appended onto the current list of directories. This default behavior can be changed by setting CMAKE_include_directories_BEFORE to ON. By using BEFORE or AFTER you can select between appending and prepending, independent from the default. If the SYSTEM option is given the compiler will be told that the directories are meant as system include directories on some platforms.

  • include_external_msproject: Include an external Microsoft project file in a workspace.
      include_external_msproject(projectname location
                                 dep1 dep2 ...)

    Includes an external Microsoft project in the generated workspace file. Currently does nothing on UNIX. This will create a target named INCLUDE_EXTERNAL_MSPROJECT_[projectname]. This can be used in the add_dependencies command to make things depend on the external project.

  • include_regular_expression: Set the regular expression used for dependency checking.
      include_regular_expression(regex_match [regex_complain])

    Set the regular expressions used in dependency checking. Only files matching regex_match will be traced as dependencies. Only files matching regex_complain will generate warnings if they cannot be found (standard header paths are not searched). The defaults are:

      regex_match    = "^.*$" (match everything)
      regex_complain = "^$" (match empty string only)
  • install: Specify rules to run at install time.

    This command generates installation rules for a project. Rules specified by calls to this command within a source directory are executed in order during installation. The order across directories is not defined.

    There are multiple signatures for this command. Some of them define installation properties for files and targets. Properties common to multiple signatures are covered here but they are valid only for signatures that specify them.

    DESTINATION arguments specify the directory on disk to which a file will be installed. If a full path (with a leading slash or drive letter) is given it is used directly. If a relative path is given it is interpreted relative to the value of CMAKE_INSTALL_PREFIX.

    PERMISSIONS arguments specify permissions for installed files. Valid permissions are OWNER_READ, OWNER_WRITE, OWNER_EXECUTE, GROUP_READ, GROUP_WRITE, GROUP_EXECUTE, WORLD_READ, WORLD_WRITE, WORLD_EXECUTE, SETUID, and SETGID. Permissions that do not make sense on certain platforms are ignored on those platforms.

    The CONFIGURATIONS argument specifies a list of build configurations for which the install rule applies (Debug, Release, etc.).

    The COMPONENT argument specifies an installation component name with which the install rule is associated, such as "runtime" or "development". During component-specific installation only install rules associated with the given component name will be executed. During a full installation all components are installed.

    The RENAME argument specifies a name for an installed file that may be different from the original file. Renaming is allowed only when a single file is installed by the command.

    The OPTIONAL argument specifies that it is not an error if the file to be installed does not exist.

    The TARGETS signature:

      install(TARGETS targets... [EXPORT <export-name>]
              [[ARCHIVE|LIBRARY|RUNTIME|FRAMEWORK|BUNDLE|
                PRIVATE_HEADER|PUBLIC_HEADER|RESOURCE]
               [DESTINATION <dir>]
               [PERMISSIONS permissions...]
               [CONFIGURATIONS [Debug|Release|...]]
               [COMPONENT <component>]
               [OPTIONAL] [NAMELINK_ONLY|NAMELINK_SKIP]
              ] [...])

    The TARGETS form specifies rules for installing targets from a project. There are five kinds of target files that may be installed: ARCHIVE, LIBRARY, RUNTIME, FRAMEWORK, and BUNDLE. Executables are treated as RUNTIME targets, except that those marked with the MACOSX_BUNDLE property are treated as BUNDLE targets on OS X. Static libraries are always treated as ARCHIVE targets. Module libraries are always treated as LIBRARY targets. For non-DLL platforms shared libraries are treated as LIBRARY targets, except that those marked with the FRAMEWORK property are treated as FRAMEWORK targets on OS X. For DLL platforms the DLL part of a shared library is treated as a RUNTIME target and the corresponding import library is treated as an ARCHIVE target. All Windows-based systems including Cygwin are DLL platforms. The ARCHIVE, LIBRARY, RUNTIME, and FRAMEWORK arguments change the type of target to which the subsequent properties apply. If none is given the installation properties apply to all target types. If only one is given then only targets of that type will be installed (which can be used to install just a DLL or just an import library).

    The PRIVATE_HEADER, PUBLIC_HEADER, and RESOURCE arguments cause subsequent properties to be applied to installing a FRAMEWORK shared library target's associated files on non-Apple platforms. Rules defined by these arguments are ignored on Apple platforms because the associated files are installed into the appropriate locations inside the framework folder. See documentation of the PRIVATE_HEADER, PUBLIC_HEADER, and RESOURCE target properties for details.

    Either NAMELINK_ONLY or NAMELINK_SKIP may be specified as a LIBRARY option. On some platforms a versioned shared library has a symbolic link such as

      lib<name>.so -> lib<name>.so.1

    where "lib<name>.so.1" is the soname of the library and "lib<name>.so" is a "namelink" allowing linkers to find the library when given "-l<name>". The NAMELINK_ONLY option causes installation of only the namelink when a library target is installed. The NAMELINK_SKIP option causes installation of library files other than the namelink when a library target is installed. When neither option is given both portions are installed. On platforms where versioned shared libraries do not have namelinks or when a library is not versioned the NAMELINK_SKIP option installs the library and the NAMELINK_ONLY option installs nothing. See the VERSION and SOVERSION target properties for details on creating versioned shared libraries.

    One or more groups of properties may be specified in a single call to the TARGETS form of this command. A target may be installed more than once to different locations. Consider hypothetical targets "myExe", "mySharedLib", and "myStaticLib". The code

        install(TARGETS myExe mySharedLib myStaticLib
                RUNTIME DESTINATION bin
                LIBRARY DESTINATION lib
                ARCHIVE DESTINATION lib/static)
        install(TARGETS mySharedLib DESTINATION /some/full/path)

    will install myExe to <prefix>/bin and myStaticLib to <prefix>/lib/static. On non-DLL platforms mySharedLib will be installed to <prefix>/lib and /some/full/path. On DLL platforms the mySharedLib DLL will be installed to <prefix>/bin and /some/full/path and its import library will be installed to <prefix>/lib/static and /some/full/path. On non-DLL platforms mySharedLib will be installed to <prefix>/lib and /some/full/path.

    The EXPORT option associates the installed target files with an export called <export-name>. It must appear before any RUNTIME, LIBRARY, or ARCHIVE options. See documentation of the install(EXPORT ...) signature below for details.

    Installing a target with EXCLUDE_FROM_ALL set to true has undefined behavior.

    The FILES signature:

      install(FILES files... DESTINATION <dir>
              [PERMISSIONS permissions...]
              [CONFIGURATIONS [Debug|Release|...]]
              [COMPONENT <component>]
              [RENAME <name>] [OPTIONAL])

    The FILES form specifies rules for installing files for a project. File names given as relative paths are interpreted with respect to the current source directory. Files installed by this form are by default given permissions OWNER_WRITE, OWNER_READ, GROUP_READ, and WORLD_READ if no PERMISSIONS argument is given.

    The PROGRAMS signature:

      install(PROGRAMS files... DESTINATION <dir>
              [PERMISSIONS permissions...]
              [CONFIGURATIONS [Debug|Release|...]]
              [COMPONENT <component>]
              [RENAME <name>] [OPTIONAL])

    The PROGRAMS form is identical to the FILES form except that the default permissions for the installed file also include OWNER_EXECUTE, GROUP_EXECUTE, and WORLD_EXECUTE. This form is intended to install programs that are not targets, such as shell scripts. Use the TARGETS form to install targets built within the project.

    The DIRECTORY signature:

      install(DIRECTORY dirs... DESTINATION <dir>
              [FILE_PERMISSIONS permissions...]
              [DIRECTORY_PERMISSIONS permissions...]
              [USE_SOURCE_PERMISSIONS] [OPTIONAL]
              [CONFIGURATIONS [Debug|Release|...]]
              [COMPONENT <component>] [FILES_MATCHING]
              [[PATTERN <pattern> | REGEX <regex>]
               [EXCLUDE] [PERMISSIONS permissions...]] [...])

    The DIRECTORY form installs contents of one or more directories to a given destination. The directory structure is copied verbatim to the destination. The last component of each directory name is appended to the destination directory but a trailing slash may be used to avoid this because it leaves the last component empty. Directory names given as relative paths are interpreted with respect to the current source directory. If no input directory names are given the destination directory will be created but nothing will be installed into it. The FILE_PERMISSIONS and DIRECTORY_PERMISSIONS options specify permissions given to files and directories in the destination. If USE_SOURCE_PERMISSIONS is specified and FILE_PERMISSIONS is not, file permissions will be copied from the source directory structure. If no permissions are specified files will be given the default permissions specified in the FILES form of the command, and the directories will be given the default permissions specified in the PROGRAMS form of the command.

    Installation of directories may be controlled with fine granularity using the PATTERN or REGEX options. These "match" options specify a globbing pattern or regular expression to match directories or files encountered within input directories. They may be used to apply certain options (see below) to a subset of the files and directories encountered. The full path to each input file or directory (with forward slashes) is matched against the expression. A PATTERN will match only complete file names: the portion of the full path matching the pattern must occur at the end of the file name and be preceded by a slash. A REGEX will match any portion of the full path but it may use '/' and '$' to simulate the PATTERN behavior. By default all files and directories are installed whether or not they are matched. The FILES_MATCHING option may be given before the first match option to disable installation of files (but not directories) not matched by any expression. For example, the code

      install(DIRECTORY src/ DESTINATION include/myproj
              FILES_MATCHING PATTERN "*.h")

    will extract and install header files from a source tree.

    Some options may follow a PATTERN or REGEX expression and are applied only to files or directories matching them. The EXCLUDE option will skip the matched file or directory. The PERMISSIONS option overrides the permissions setting for the matched file or directory. For example the code

      install(DIRECTORY icons scripts/ DESTINATION share/myproj
              PATTERN "CVS" EXCLUDE
              PATTERN "scripts/*"
              PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ
                          GROUP_EXECUTE GROUP_READ)

    will install the icons directory to share/myproj/icons and the scripts directory to share/myproj. The icons will get default file permissions, the scripts will be given specific permissions, and any CVS directories will be excluded.

    The SCRIPT and CODE signature:

      install([[SCRIPT <file>] [CODE <code>]] [...])

    The SCRIPT form will invoke the given CMake script files during installation. If the script file name is a relative path it will be interpreted with respect to the current source directory. The CODE form will invoke the given CMake code during installation. Code is specified as a single argument inside a double-quoted string. For example, the code

      install(CODE "MESSAGE(\"Sample install message.\")")

    will print a message during installation.

    The EXPORT signature:

      install(EXPORT <export-name> DESTINATION <dir>
              [NAMESPACE <namespace>] [FILE <name>.cmake]
              [PERMISSIONS permissions...]
              [CONFIGURATIONS [Debug|Release|...]]
              [COMPONENT <component>])

    The EXPORT form generates and installs a CMake file containing code to import targets from the installation tree into another project. Target installations are associated with the export <export-name> using the EXPORT option of the install(TARGETS ...) signature documented above. The NAMESPACE option will prepend <namespace> to the target names as they are written to the import file. By default the generated file will be called <export-name>.cmake but the FILE option may be used to specify a different name. The value given to the FILE option must be a file name with the ".cmake" extension. If a CONFIGURATIONS option is given then the file will only be installed when one of the named configurations is installed. Additionally, the generated import file will reference only the matching target configurations. If a COMPONENT option is specified that does not match that given to the targets associated with <export-name> the behavior is undefined. If a library target is included in the export but a target to which it links is not included the behavior is unspecified.

    The EXPORT form is useful to help outside projects use targets built and installed by the current project. For example, the code

      install(TARGETS myexe EXPORT myproj DESTINATION bin)
      install(EXPORT myproj NAMESPACE mp_ DESTINATION lib/myproj)

    will install the executable myexe to <prefix>/bin and code to import it in the file "<prefix>/lib/myproj/myproj.cmake". An outside project may load this file with the include command and reference the myexe executable from the installation tree using the imported target name mp_myexe as if the target were built in its own tree.

    NOTE: This command supercedes the INSTALL_TARGETS command and the target properties PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT. It also replaces the FILES forms of the INSTALL_FILES and INSTALL_PROGRAMS commands. The processing order of these install rules relative to those generated by INSTALL_TARGETS, INSTALL_FILES, and INSTALL_PROGRAMS commands is not defined.

  • link_directories: Specify directories in which the linker will look for libraries.
      link_directories(directory1 directory2 ...)

    Specify the paths in which the linker should search for libraries. The command will apply only to targets created after it is called. For historical reasons, relative paths given to this command are passed to the linker unchanged (unlike many CMake commands which interpret them relative to the current source directory).

  • list: List operations.
      list(LENGTH <list> <output variable>)
      list(GET <list> <element index> [<element index> ...]
           <output variable>)
      list(APPEND <list> <element> [<element> ...])
      list(FIND <list> <value> <output variable>)
      list(INSERT <list> <element_index> <element> [<element> ...])
      list(REMOVE_ITEM <list> <value> [<value> ...])
      list(REMOVE_AT <list> <index> [<index> ...])
      list(REMOVE_DUPLICATES <list>)
      list(REVERSE <list>)
      list(SORT <list>)

    LENGTH will return a given list's length.

    GET will return list of elements specified by indices from the list.

    APPEND will append elements to the list.

    FIND will return the index of the element specified in the list or -1 if it wasn't found.

    INSERT will insert elements to the list to the specified location.

    REMOVE_AT and REMOVE_ITEM will remove items from the list. The difference is that REMOVE_ITEM will remove the given items, while REMOVE_AT will remove the items at the given indices.

    REMOVE_DUPLICATES will remove duplicated items in the list.

    REVERSE reverses the contents of the list in-place.

    SORT sorts the list in-place alphabetically.

    NOTES: A list in cmake is a ; separated group of strings. To create a list the set command can be used. For example, set(var a b c d e) creates a list with a;b;c;d;e, and set(var "a b c d e") creates a string or a list with one item in it.

    When specifying index values, if <element index> is 0 or greater, it is indexed from the beginning of the list, with 0 representing the first list element. If <element index> is -1 or lesser, it is indexed from the end of the list, with -1 representing the last list element. Be careful when counting with negative indices: they do not start from 0. -0 is equivalent to 0, the first list element.

  • load_cache: Load in the values from another project's CMake cache.
      load_cache(pathToCacheFile READ_WITH_PREFIX
                 prefix entry1...)

    Read the cache and store the requested entries in variables with their name prefixed with the given prefix. This only reads the values, and does not create entries in the local project's cache.

      load_cache(pathToCacheFile [EXCLUDE entry1...]
                 [INCLUDE_INTERNALS entry1...])

    Load in the values from another cache and store them in the local project's cache as internal entries. This is useful for a project that depends on another project built in a different tree. EXCLUDE option can be used to provide a list of entries to be excluded. INCLUDE_INTERNALS can be used to provide a list of internal entries to be included. Normally, no internal entries are brought in. Use of this form of the command is strongly discouraged, but it is provided for backward compatibility.

  • load_command: Load a command into a running CMake.
      load_command(COMMAND_NAME <loc1> [loc2 ...])

    The given locations are searched for a library whose name is cmCOMMAND_NAME. If found, it is loaded as a module and the command is added to the set of available CMake commands. Usually, TRY_COMPILE is used before this command to compile the module. If the command is successfully loaded a variable named

      CMAKE_LOADED_COMMAND_<COMMAND_NAME>

    will be set to the full path of the module that was loaded. Otherwise the variable will not be set.

  • macro: Start recording a macro for later invocation as a command.
      macro(<name> [arg1 [arg2 [arg3 ...]]])
        COMMAND1(ARGS ...)
        COMMAND2(ARGS ...)
        ...
      endmacro(<name>)

    Define a macro named <name> that takes arguments named arg1 arg2 arg3 (...). Commands listed after macro, but before the matching endmacro, are not invoked until the macro is invoked. When it is invoked, the commands recorded in the macro are first modified by replacing formal parameters (${arg1}) with the arguments passed, and then invoked as normal commands. In addition to referencing the formal parameters you can reference the values ${ARGC} which will be set to the number of arguments passed into the function as well as ${ARGV0} ${ARGV1} ${ARGV2} ... which will have the actual values of the arguments passed in. This facilitates creating macros with optional arguments. Additionally ${ARGV} holds the list of all arguments given to the macro and ${ARGN} holds the list of argument past the last expected argument. Note that the parameters to a macro and values such as ARGN are not variables in the usual CMake sense. They are string replacements much like the c preprocessor would do with a macro. If you want true CMake variables you should look at the function command.

    See the cmake_policy() command documentation for the behavior of policies inside macros.

  • mark_as_advanced: Mark cmake cached variables as advanced.
      mark_as_advanced([CLEAR|FORCE] VAR VAR2 VAR...)

    Mark the named cached variables as advanced. An advanced variable will not be displayed in any of the cmake GUIs unless the show advanced option is on. If CLEAR is the first argument advanced variables are changed back to unadvanced. If FORCE is the first argument, then the variable is made advanced. If neither FORCE nor CLEAR is specified, new values will be marked as advanced, but if the variable already has an advanced/non-advanced state, it will not be changed.

    It does nothing in script mode.

  • math: Mathematical expressions.
      math(EXPR <output variable> <math expression>)

    EXPR evaluates mathematical expression and return result in the output variable. Example mathematical expression is '5 * ( 10 + 13 )'. Supported operators are + - * / % | & ^ ~ << >> * / %. They have the same meaning as they do in c code.

  • message: Display a message to the user.
      message([STATUS|WARNING|AUTHOR_WARNING|FATAL_ERROR|SEND_ERROR]
              "message to display" ...)

    The optional keyword determines the type of message:

      (none)         = Important information
      STATUS         = Incidental information
      WARNING        = CMake Warning, continue processing
      AUTHOR_WARNING = CMake Warning (dev), continue processing
      SEND_ERROR     = CMake Error, continue but skip generation
      FATAL_ERROR    = CMake Error, stop all processing

    The CMake command-line tool displays STATUS messages on stdout and all other message types on stderr. The CMake GUI displays all messages in its log area. The interactive dialogs (ccmake and CMakeSetup) show STATUS messages one at a time on a status line and other messages in interactive pop-up boxes.

    CMake Warning and Error message text displays using a simple markup language. Non-indented text is formatted in line-wrapped paragraphs delimited by newlines. Indented text is considered pre-formatted.

  • option: Provides an option that the user can optionally select.
      option(<option_variable> "help string describing option"
             [initial value])

    Provide an option for the user to select as ON or OFF. If no initial value is provided, OFF is used.

  • output_required_files: Output a list of required source files for a specified source file.
      output_required_files(srcfile outputfile)

    Outputs a list of all the source files that are required by the specified srcfile. This list is written into outputfile. This is similar to writing out the dependencies for srcfile except that it jumps from .h files into .cxx, .c and .cpp files if possible.

  • project: Set a name for the entire project.
      project(<projectname> [languageName1 languageName2 ... ] )

    Sets the name of the project. Additionally this sets the variables <projectName>_BINARY_DIR and <projectName>_SOURCE_DIR to the respective values.

    Optionally you can specify which languages your project supports. Example languages are CXX (i.e. C++), C, Fortran, etc. By default C and CXX are enabled. E.g. if you do not have a C++ compiler, you can disable the check for it by explicitely listing the languages you want to support, e.g. C. By using the special language "NONE" all checks for any language can be disabled.

  • qt_wrap_cpp: Create Qt Wrappers.
      qt_wrap_cpp(resultingLibraryName DestName
                  SourceLists ...)

    Produce moc files for all the .h files listed in the SourceLists. The moc files will be added to the library using the DestName source list.

  • qt_wrap_ui: Create Qt user interfaces Wrappers.
      qt_wrap_ui(resultingLibraryName HeadersDestName
                 SourcesDestName SourceLists ...)

    Produce .h and .cxx files for all the .ui files listed in the SourceLists. The .h files will be added to the library using the HeadersDestNamesource list. The .cxx files will be added to the library using the SourcesDestNamesource list.

  • remove_definitions: Removes -D define flags added by add_definitions.
      remove_definitions(-DFOO -DBAR ...)

    Removes flags (added by add_definitions) from the compiler command line for sources in the current directory and below.

  • return: Return from a file, directory or function.
      return()

    Returns from a file, directory or function. When this command is encountered in an included file (via include() or find_package()), it causes processing of the current file to stop and control is returned to the including file. If it is encountered in a file which is not included by another file, e.g. a CMakeLists.txt, control is returned to the parent directory if there is one. If return is called in a function, control is returned to the caller of the function. Note that a macro is not a function and does not handle return like a function does.

  • separate_arguments: Parse space-separated arguments into a semicolon-separated list.
      separate_arguments(<var> <UNIX|WINDOWS>_COMMAND "<args>")

    Parses a unix- or windows-style command-line string "<args>" and stores a semicolon-separated list of the arguments in <var>. The entire command line must be given in one "<args>" argument.

    The UNIX_COMMAND mode separates arguments by unquoted whitespace. It recognizes both single-quote and double-quote pairs. A backslash escapes the next literal character (\" is "); there are no special escapes (\n is just n).

    The WINDOWS_COMMAND mode parses a windows command-line using the same syntax the runtime library uses to construct argv at startup. It separates arguments by whitespace that is not double-quoted. Backslashes are literal unless they precede double-quotes. See the MSDN article "Parsing C Command-Line Arguments" for details.

      separate_arguments(VARIABLE)

    Convert the value of VARIABLE to a semi-colon separated list. All spaces are replaced with ';'. This helps with generating command lines.

  • set: Set a CMAKE variable to a given value.
      set(<variable> <value>
          [[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE])

    Within CMake sets <variable> to the value <value>. <value> is expanded before <variable> is set to it. If CACHE is present, then the <variable> is put in the cache. <type> and <docstring> are then required. <type> is used by the CMake GUI to choose a widget with which the user sets a value. The value for <type> may be one of

      FILEPATH = File chooser dialog.
      PATH     = Directory chooser dialog.
      STRING   = Arbitrary string.
      BOOL     = Boolean ON/OFF checkbox.
      INTERNAL = No GUI entry (used for persistent variables).

    If <type> is INTERNAL, then the <value> is always written into the cache, replacing any values existing in the cache. If it is not a cache variable, then this always writes into the current makefile. The FORCE option will overwrite the cache value removing any changes by the user.

    If PARENT_SCOPE is present, the variable will be set in the scope above the current scope. Each new directory or function creates a new scope. This command will set the value of a variable into the parent directory or calling function (whichever is applicable to the case at hand).

    If <value> is not specified then the variable is removed instead of set. See also: the unset() command.

      set(<variable> <value1> ... <valueN>)

    In this case <variable> is set to a semicolon separated list of values.

    <variable> can be an environment variable such as:

      set( ENV{PATH} /home/martink )

    in which case the environment variable will be set.

  • set_directory_properties: Set a property of the directory.
      set_directory_properties(PROPERTIES prop1 value1 prop2 value2)

    Set a property for the current directory and subdirectories. If the property is not found, CMake will report an error. The properties include: INCLUDE_DIRECTORIES, LINK_DIRECTORIES, INCLUDE_REGULAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES. ADDITIONAL_MAKE_CLEAN_FILES is a list of files that will be cleaned as a part of "make clean" stage.

  • set_property: Set a named property in a given scope.
      set_property(<GLOBAL                            |
                    DIRECTORY [dir]                   |
                    TARGET    [target1 [target2 ...]] |
                    SOURCE    [src1 [src2 ...]]       |
                    TEST      [test1 [test2 ...]]     |
                    CACHE     [entry1 [entry2 ...]]>
                   [APPEND]
                   PROPERTY <name> [value1 [value2 ...]])

    Set one property on zero or more objects of a scope. The first argument determines the scope in which the property is set. It must be one of the following:

    GLOBAL scope is unique and does not accept a name.

    DIRECTORY scope defaults to the current directory but another directory (already processed by CMake) may be named by full or relative path.

    TARGET scope may name zero or more existing targets.

    SOURCE scope may name zero or more source files.

    TEST scope may name zero or more existing tests.

    CACHE scope must name zero or more cache existing entries.

    The required PROPERTY option is immediately followed by the name of the property to set. Remaining arguments are used to compose the property value in the form of a semicolon-separated list. If the APPEND option is given the list is appended to any existing property value.

  • set_source_files_properties: Source files can have properties that affect how they are built.
      set_source_files_properties(file1 file2 ...
                                  PROPERTIES prop1 value1
                                  prop2 value2 ...)

    Set properties on a file. The syntax for the command is to list all the files you want to change, and then provide the values you want to set next. You can make up your own properties as well. The following are used by CMake. The ABSTRACT flag (boolean) is used by some class wrapping commands. If WRAP_EXCLUDE (boolean) is true then many wrapping commands will ignore this file. If GENERATED (boolean) is true then it is not an error if this source file does not exist when it is added to a target. Obviously, it must be created (presumably by a custom command) before the target is built. If the HEADER_FILE_ONLY (boolean) property is true then the file is not compiled. This is useful if you want to add extra non build files to an IDE. OBJECT_DEPENDS (string) adds dependencies to the object file. COMPILE_FLAGS (string) is passed to the compiler as additional command line arguments when the source file is compiled. LANGUAGE (string) CXX|C will change the default compiler used to compile the source file. The languages used need to be enabled in the PROJECT command. 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.

  • set_target_properties: Targets can have properties that affect how they are built.
      set_target_properties(target1 target2 ...
                            PROPERTIES prop1 value1
                            prop2 value2 ...)

    Set properties on a target. The syntax for the command is to list all the files you want to change, and then provide the values you want to set next. You can use any prop value pair you want and extract it later with the GET_TARGET_PROPERTY command.

    Properties that affect the name of a target's output file are as follows. The PREFIX and SUFFIX properties override the default target name prefix (such as "lib") and suffix (such as ".so"). IMPORT_PREFIX and IMPORT_SUFFIX are the equivalent properties for the import library corresponding to a DLL (for SHARED library targets). OUTPUT_NAME sets the real name of a target when it is built and can be used to help create two targets of the same name even though CMake requires unique logical target names. There is also a <CONFIG>_OUTPUT_NAME that can set the output name on a per-configuration basis. <CONFIG>_POSTFIX sets a postfix for the real name of the target when it is built under the configuration named by <CONFIG> (in upper-case, such as "DEBUG_POSTFIX"). The value of this property is initialized when the target is created to the value of the variable CMAKE_<CONFIG>_POSTFIX (except for executable targets because earlier CMake versions which did not use this variable for executables).

    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. 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 our outside to properly setup dllexport/dllimport decorations. The COMPILE_FLAGS property sets additional compiler flags used to build sources within the target. It may also be used to pass additional preprocessor definitions.

    The LINKER_LANGUAGE property is used to change the tool used to link an executable or shared library. The default is set the language to match the files in the library. CXX and C are common values for this property.

    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.

    There are a few properties used to specify RPATH rules. INSTALL_RPATH is a semicolon-separated list specifying the rpath to use in installed targets (for platforms that support it). 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. SKIP_BUILD_RPATH is a boolean specifying whether to skip automatic generation of an rpath allowing the target to run from the build tree. 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. 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. When the target is created the values of the variables CMAKE_INSTALL_RPATH, CMAKE_INSTALL_RPATH_USE_LINK_PATH, CMAKE_SKIP_BUILD_RPATH, CMAKE_BUILD_WITH_INSTALL_RPATH, and CMAKE_INSTALL_NAME_DIR are used to initialize these properties.

    PROJECT_LABEL can be used to change the name of the target in an IDE like visual studio. VS_KEYWORD can be set to change the visual studio keyword, for example QT integration works better if this is set to Qt4VSv1.0.

    VS_SCC_PROJECTNAME, VS_SCC_LOCALPATH, VS_SCC_PROVIDER can be set to add support for source control bindings in a Visual Studio project file.

    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.

    The EXCLUDE_FROM_DEFAULT_BUILD property is used by the visual studio generators. If it is set to 1 the target will not be part of the default build when you select "Build Solution".

  • set_tests_properties: Set a property of the tests.
      set_tests_properties(test1 [test2...] PROPERTIES prop1 value1 prop2 value2)

    Set a property for the tests. If the property is not found, CMake will report an error. The properties include:

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

    PASS_REGULAR_EXPRESSION: 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: PASS_REGULAR_EXPRESSION "TestPassed;All ok"

    FAIL_REGULAR_EXPRESSION: If set, if the output will match to one of specified regular expressions, the test will fail.

      Example: PASS_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed"

    Both PASS_REGULAR_EXPRESSION and FAIL_REGULAR_EXPRESSION expect a list of regular expressions.

    PROCESSORS: 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.

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

    RUN_SERIAL: If set to true, this test will not run in parallel with any other tests. This should be used in conjunction with the ctest_test PARALLEL_LEVEL option.

  • site_name: Set the given variable to the name of the computer.
      site_name(variable)
  • source_group: Define a grouping for sources in the makefile.
      source_group(name [REGULAR_EXPRESSION regex] [FILES src1 src2 ...])

    Defines a group into which sources will be placed in project files. This is mainly used to setup file tabs in Visual Studio. Any file whose name is listed or matches the regular expression will be placed in this group. If a file matches multiple groups, the LAST group that explicitly lists the file will be favored, if any. If no group explicitly lists the file, the LAST group whose regular expression matches the file will be favored.

    The name of the group may contain backslashes to specify subgroups:

      source_group(outer\\inner ...)

    For backwards compatibility, this command is also supports the format:

      source_group(name regex)
  • string: String operations.
      string(REGEX MATCH <regular_expression>
             <output variable> <input> [<input>...])
      string(REGEX MATCHALL <regular_expression>
             <output variable> <input> [<input>...])
      string(REGEX REPLACE <regular_expression>
             <replace_expression> <output variable>
             <input> [<input>...])
      string(REPLACE <match_string>
             <replace_string> <output variable>
             <input> [<input>...])
      string(COMPARE EQUAL <string1> <string2> <output variable>)
      string(COMPARE NOTEQUAL <string1> <string2> <output variable>)
      string(COMPARE LESS <string1> <string2> <output variable>)
      string(COMPARE GREATER <string1> <string2> <output variable>)
      string(ASCII <number> [<number> ...] <output variable>)
      string(CONFIGURE <string1> <output variable>
             [@ONLY] [ESCAPE_QUOTES])
      string(TOUPPER <string1> <output variable>)
      string(TOLOWER <string1> <output variable>)
      string(LENGTH <string> <output variable>)
      string(SUBSTRING <string> <begin> <length> <output variable>)
      string(STRIP <string> <output variable>)
      string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>]
             [RANDOM_SEED <seed>] <output variable>)

    REGEX MATCH will match the regular expression once and store the match in the output variable.

    REGEX MATCHALL will match the regular expression as many times as possible and store the matches in the output variable as a list.

    REGEX REPLACE will match the regular expression as many times as possible and substitute the replacement expression for the match in the output. The replace expression may refer to paren-delimited subexpressions of the match using \1, \2, ..., \9. Note that two backslashes (\\1) are required in CMake code to get a backslash through argument parsing.

    REPLACE will replace all occurrences of match_string in the input with replace_string and store the result in the output.

    COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the strings and store true or false in the output variable.

    ASCII will convert all numbers into corresponding ASCII characters.

    CONFIGURE will transform a string like CONFIGURE_FILE transforms a file.

    TOUPPER/TOLOWER will convert string to upper/lower characters.

    LENGTH will return a given string's length.

    SUBSTRING will return a substring of a given string.

    STRIP will return a substring of a given string with leading and trailing spaces removed.

    RANDOM will return a random string of given length consisting of characters from the given alphabet. Default length is 5 characters and default alphabet is all numbers and upper and lower case letters. If an integer RANDOM_SEED is given, its value will be used to seed the random number generator.

    The following characters have special meaning in regular expressions:

       ^         Matches at beginning of a line
       $         Matches at end of a line
       .         Matches any single character
       [ ]       Matches any character(s) inside the brackets
       [^ ]      Matches any character(s) not inside the brackets
        -        Matches any character in range on either side of a dash
       *         Matches preceding pattern zero or more times
       +         Matches preceding pattern one or more times
       ?         Matches preceding pattern zero or once only
       |         Matches a pattern on either side of the |
       ()        Saves a matched subexpression, which can be referenced 
                 in the REGEX REPLACE operation. Additionally it is saved
                 by all regular expression-related commands, including 
                 e.g. if( MATCHES ), in the variables CMAKE_MATCH_(0..9).
  • target_link_libraries: Link a target to given libraries.
      target_link_libraries(<target> [item1 [item2 [...]]]
                            [[debug|optimized|general] <item>] ...)

    Specify libraries or flags to use when linking a given target. If a library name matches that of another target in the project a dependency will automatically be added in the build system to make sure the library being linked is up-to-date before the target links. Item names starting with '-', but not '-l' or '-framework', are treated as linker flags.

    A "debug", "optimized", or "general" keyword indicates that the library immediately following it is to be used only for the corresponding build configuration. The "debug" keyword corresponds to the Debug configuration (or to configurations named in the DEBUG_CONFIGURATIONS global property if it is set). The "optimized" keyword corresponds to all other configurations. The "general" keyword corresponds to all configurations, and is purely optional (assumed if omitted). Higher granularity may be achieved for per-configuration rules by creating and linking to IMPORTED library targets. See the IMPORTED mode of the add_library command for more information.

    Library dependencies are transitive by default. When this target is linked into another target then the libraries linked to this target will appear on the link line for the other target too. See the LINK_INTERFACE_LIBRARIES target property to override the set of transitive link dependencies for a target.

      target_link_libraries(<target> LINK_INTERFACE_LIBRARIES
                            [[debug|optimized|general] <lib>] ...)

    The LINK_INTERFACE_LIBRARIES mode appends the libraries to the LINK_INTERFACE_LIBRARIES and its per-configuration equivalent target properties instead of using them for linking. Libraries specified as "debug" are appended to the the LINK_INTERFACE_LIBRARIES_DEBUG property (or to the properties corresponding to configurations listed in the DEBUG_CONFIGURATIONS global property if it is set). Libraries specified as "optimized" are appended to the the LINK_INTERFACE_LIBRARIES property. Libraries specified as "general" (or without any keyword) are treated as if specified for both "debug" and "optimized".

    The library dependency graph is normally acyclic (a DAG), but in the case of mutually-dependent STATIC libraries CMake allows the graph to contain cycles (strongly connected components). When another target links to one of the libraries CMake repeats the entire connected component. For example, the code

      add_library(A STATIC a.c)
      add_library(B STATIC b.c)
      target_link_libraries(A B)
      target_link_libraries(B A)
      add_executable(main main.c)
      target_link_libraries(main A)

    links 'main' to 'A B A B'. (While one repetition is usually sufficient, pathological object file and symbol arrangements can require more. One may handle such cases by manually repeating the component in the last target_link_libraries call. However, if two archives are really so interdependent they should probably be combined into a single archive.)

  • try_compile: Try compiling some code.
      try_compile(RESULT_VAR bindir srcdir
                  projectName <targetname> [CMAKE_FLAGS <Flags>]
                  [OUTPUT_VARIABLE var])

    Try compiling a program. In this form, srcdir should contain a complete CMake project with a CMakeLists.txt file and all sources. The bindir and srcdir will not be deleted after this command is run. If <target name> is specified then build just that target otherwise the all or ALL_BUILD target is built.

      try_compile(RESULT_VAR bindir srcfile
                  [CMAKE_FLAGS <Flags>]
                  [COMPILE_DEFINITIONS <flags> ...]
                  [OUTPUT_VARIABLE var]
                  [COPY_FILE <filename> )

    Try compiling a srcfile. In this case, the user need only supply a source file. CMake will create the appropriate CMakeLists.txt file to build the source. If COPY_FILE is used, the compiled file will be copied to the given file.

    In this version all files in bindir/CMakeFiles/CMakeTmp, will be cleaned automatically, for debugging a --debug-trycompile can be passed to cmake to avoid the clean. Some extra flags that can be included are, INCLUDE_DIRECTORIES, LINK_DIRECTORIES, and LINK_LIBRARIES. COMPILE_DEFINITIONS are -Ddefinition that will be passed to the compile line. try_compile creates a CMakeList.txt file on the fly that looks like this:

      add_definitions( <expanded COMPILE_DEFINITIONS from calling cmake>)
      include_directories(${INCLUDE_DIRECTORIES})
      link_directories(${LINK_DIRECTORIES})
      add_executable(cmTryCompileExec sources)
      target_link_libraries(cmTryCompileExec ${LINK_LIBRARIES})

    In both versions of the command, if OUTPUT_VARIABLE is specified, then the output from the build process is stored in the given variable. Return the success or failure in RESULT_VAR. CMAKE_FLAGS can be used to pass -DVAR:TYPE=VALUE flags to the cmake that is run during the build.

  • try_run: Try compiling and then running some code.
      try_run(RUN_RESULT_VAR COMPILE_RESULT_VAR
              bindir srcfile [CMAKE_FLAGS <Flags>]
              [COMPILE_DEFINITIONS <flags>]
              [COMPILE_OUTPUT_VARIABLE comp]
              [RUN_OUTPUT_VARIABLE run]
              [OUTPUT_VARIABLE var]
              [ARGS <arg1> <arg2>...])

    Try compiling a srcfile. Return TRUE or FALSE for success or failure in COMPILE_RESULT_VAR. Then if the compile succeeded, run the executable and return its exit code in RUN_RESULT_VAR. If the executable was built, but failed to run, then RUN_RESULT_VAR will be set to FAILED_TO_RUN. COMPILE_OUTPUT_VARIABLE specifies the variable where the output from the compile step goes. RUN_OUTPUT_VARIABLE specifies the variable where the output from the running executable goes.

    For compatibility reasons OUTPUT_VARIABLE is still supported, which gives you the output from the compile and run step combined.

    Cross compiling issues

    When cross compiling, the executable compiled in the first step usually cannot be run on the build host. try_run() checks the CMAKE_CROSSCOMPILING variable to detect whether CMake is in crosscompiling mode. If that's the case, it will still try to compile the executable, but it will not try to run the executable. Instead it will create cache variables which must be filled by the user or by presetting them in some CMake script file to the values the executable would have produced if it would have been run on its actual target platform. These variables are RUN_RESULT_VAR (explanation see above) and if RUN_OUTPUT_VARIABLE (or OUTPUT_VARIABLE) was used, an additional cache variable RUN_RESULT_VAR__COMPILE_RESULT_VAR__TRYRUN_OUTPUT.This is intended to hold stdout and stderr from the executable.

    In order to make cross compiling your project easier, use try_run only if really required. If you use try_run, use RUN_OUTPUT_VARIABLE (or OUTPUT_VARIABLE) only if really required. Using them will require that when crosscompiling, the cache variables will have to be set manually to the output of the executable. You can also "guard" the calls to try_run with if(CMAKE_CROSSCOMPILING) and provide an easy-to-preset alternative for this case.

  • unset: Unset a variable, cache variable, or environment variable.
      unset(<variable> [CACHE])

    Removes the specified variable causing it to become undefined. If CACHE is present then the variable is removed from the cache instead of the current scope.

    <variable> can be an environment variable such as:

      unset(ENV{LD_LIBRARY_PATH})

    in which case the variable will be removed from the current environment.

  • variable_watch: Watch the CMake variable for change.
      variable_watch(<variable name> [<command to execute>])

    If the specified variable changes, the message will be printed about the variable being changed. If the command is specified, the command will be executed. The command will receive the following arguments: COMMAND(<variable> <access> <value> <current list file> <stack>)

  • while: Evaluate a group of commands while a condition is true
      while(condition)
        COMMAND1(ARGS ...)
        COMMAND2(ARGS ...)
        ...
      endwhile(condition)

    All commands between while and the matching endwhile are recorded without being invoked. Once the endwhile is evaluated, the recorded list of commands is invoked as long as the condition is true. The condition is evaluated using the same logic as the if command.

Properties

  CMake Properties - Properties supported by CMake, the Cross-Platform Makefile Generator.

This is the documentation for the properties supported by CMake. Properties can have different scopes. They can either be assigned to a source file, a directory, a target or globally to CMake. By modifying the values of properties the behaviour of the build system can be customized.

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.

  • 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. Be 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. Be 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.

  • 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 prefix compiler commands with the given launcher command line. This is intended to allow launchers to intercept build problems with high granularity. Non-Makefile generators currently ignore this property.

  • RULE_LAUNCH_CUSTOM: Specify a launcher for custom rules.

    Makefile generators prefix custom commands with the given launcher command line. This is intended to allow launchers to intercept build problems with high granularity. Non-Makefile generators currently ignore this property.

  • RULE_LAUNCH_LINK: Specify a launcher for link rules.

    Makefile generators prefix link and archive commands with the given launcher command line. This is intended to allow launchers to intercept build problems with high granularity. Non-Makefile generators currently ignore this property.

  • 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_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.

  • __CMAKE_DELETE_CACHE_CHANGE_VARS_: Internal property

    Used to detect compiler changes, Do not set.

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: Should the output of custom commands be left.

    If this is true then the outputs of custom commands for this directory will not be removed during the "make clean" stage.

  • COMPILE_DEFINITIONS: Preprocessor definitions for compiling a directory's 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). 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"). This property will be initialized in each directory by its value in the directory's 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).

    Dislaimer: 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.

  • COMPILE_DEFINITIONS_<CONFIG>: Per-configuration preprocessor definitions in a directory.

    This is the configuration-specific version of COMPILE_DEFINITIONS. This property will be initialized in each directory by its value in the directory's parent.

  • 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 instead.

  • 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 '%'. 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's parent.

  • INCLUDE_DIRECTORIES: List of preprocessor include file search directories.

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

  • INCLUDE_REGULAR_EXPRESSION: Include file scanning regular expression.

    This read-only property specifies the regular expression used during dependency scanning to match include files that should be followed. See the include_regular_expression command.

  • 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.

  • 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.

  • 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.

Properties on Targets

  • <CONFIG>_OUTPUT_NAME: Old per-configuration target file base name.

    This is a configuration-specific version of OUTPUT_NAME. Use OUTPUT_NAME_<CONFIG> instead.

  • <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.

  • 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. There are three kinds of target files that may be built: archive, library, and runtime. Executables are always treated as runtime targets. Static libraries are always treated as archive targets. Module libraries are always treated as library targets. For non-DLL platforms shared libraries are treated as library targets. For DLL platforms the DLL part of a shared library is treated as a runtime target and the corresponding import library is treated as an archive target. All Windows-based systems including Cygwin are DLL platforms. This property is initialized by the value of the variable CMAKE_ARCHIVE_OUTPUT_DIRECTORY if it is set when a target is created.

  • 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. There are three kinds of target files that may be built: archive, library, and runtime. Executables are always treated as runtime targets. Static libraries are always treated as archive targets. Module libraries are always treated as library targets. For non-DLL platforms shared libraries are treated as library targets. For DLL platforms the DLL part of a shared library is treated as a runtime target and the corresponding import library is treated as an archive target. All Windows-based systems including Cygwin are DLL platforms.

  • ARCHIVE_OUTPUT_NAME_<CONFIG>: Per-configuration output name for ARCHIVE target files.

    This is the configuration-specific version of ARCHIVE_OUTPUT_NAME.

  • 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.

  • COMPILE_DEFINITIONS: Preprocessor definitions for compiling a target's 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). 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).

    Dislaimer: 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.

  • COMPILE_DEFINITIONS_<CONFIG>: Per-configuration preprocessor definitions on a target.

    This is the configuration-specific version of COMPILE_DEFINITIONS.

  • COMPILE_FLAGS: Additional flags to use when compiling this target's sources.

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

  • 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's 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 our outside to properly setup dllexport/dllimport decorations.

  • 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 non-DLL platforms the link rule is simply ignored since the dynamic loader will automatically bind symbols when the module is loaded. 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.

  • 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.

  • 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.

  • FRAMEWORK: This target is a framework on the Mac.

    If a shared library target has this property set to true it will be built as a framework when built on the mac. It will have the directory structure required for a framework and will be suitable to be used with the -framework option

  • 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's source directory. If the variable CMAKE_Fortran_MODULE_DIRECTORY is set when a target is created its value is used to initialize this property.

  • GENERATOR_FILE_NAME: Generator's file for this target.

    An internal property used by some generators to record the name of project or dsp file associated with this target.

  • HAS_CXX: Link the target using the C++ linker tool (obselete).

    This is equivalent to setting the LINKER_LANGUAGE property to CXX. See that property's 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 '%'. 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: 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_CONFIGURATIONS: Configurations provided for an IMPORTED target.

    Lists 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: Full path to the import library for an IMPORTED target.

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

  • IMPORTED_IMPLIB_<CONFIG>: Per-configuration version of IMPORTED_IMPLIB property.

    This property is used when loading settings for the <CONFIG> configuration of an imported target. Configuration names correspond to those provided by the project from which the target is imported.

  • 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. This property lists the dependent shared libraries of an imported library. The list should be disjoint from the list of interface libraries in the IMPORTED_LINK_INTERFACE_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_DEPENDENT_LIBRARIES_<CONFIG>: Per-configuration version of IMPORTED_LINK_DEPENDENT_LIBRARIES.

    This property is used when loading settings for the <CONFIG> configuration of an imported target. 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.

    Lists languages of soure 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_LANGUAGES_<CONFIG>: Per-configuration version of IMPORTED_LINK_INTERFACE_LANGUAGES.

    This property is used when loading settings for the <CONFIG> configuration of an imported target. 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_LIBRARIES: Transitive link interface of an IMPORTED target.

    Lists 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.

  • IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG>: Per-configuration version of IMPORTED_LINK_INTERFACE_LIBRARIES.

    This property is used when loading settings for the <CONFIG> configuration of an imported target. 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_MULTIPLICITY: Repetition count for cycles of IMPORTED static libraries.

    This is LINK_INTERFACE_MULTIPLICITY for IMPORTED targets.

  • IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG>: Per-configuration repetition count for cycles of IMPORTED archives.

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

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

    Specifies 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.

  • IMPORTED_LOCATION_<CONFIG>: Per-configuration version of IMPORTED_LOCATION property.

    This property is used when loading settings for the <CONFIG> configuration of an imported target. 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.

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

  • IMPORTED_SONAME_<CONFIG>: Per-configuration version of IMPORTED_SONAME property.

    This property is used when loading settings for the <CONFIG> configuration of an imported target. Configuration names correspond to those provided by the project from which the target is imported.

  • 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.

  • 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.

  • 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.

  • 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.

  • LABELS: Specify a list of text labels associated with a target.

    Target label semantics are currently unspecified.

  • 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. There are three kinds of target files that may be built: archive, library, and runtime. Executables are always treated as runtime targets. Static libraries are always treated as archive targets. Module libraries are always treated as library targets. For non-DLL platforms shared libraries are treated as library targets. For DLL platforms the DLL part of a shared library is treated as a runtime target and the corresponding import library is treated as an archive target. All Windows-based systems including Cygwin are DLL platforms. This property is initialized by the value of the variable CMAKE_LIBRARY_OUTPUT_DIRECTORY if it is set when a target is created.

  • 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. There are three kinds of target files that may be built: archive, library, and runtime. Executables are always treated as runtime targets. Static libraries are always treated as archive targets. Module libraries are always treated as library targets. For non-DLL platforms shared libraries are treated as library targets. For DLL platforms the DLL part of a shared library is treated as a runtime target and the corresponding import library is treated as an archive target. All Windows-based systems including Cygwin are DLL platforms.

  • LIBRARY_OUTPUT_NAME_<CONFIG>: Per-configuration output name for LIBRARY target files.

    This is the configuration-specific version of LIBRARY_OUTPUT_NAME.

  • 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.

  • 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_FLAGS_<CONFIG>: Per-configuration linker flags for a target.

    This is the configuration-specific version of LINK_FLAGS.

  • 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 property) no default transitive link dependencies are used. This property replaces the default transitive link dependencies with an explict list. When the target is linked into another target 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 ignored for STATIC libraries.

  • 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.

  • 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_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_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 the linker search type is left at -Bdynamic by the end of the library list. This property switches the final linker search type to -Bstatic.

  • 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's 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. Therefore this property is not needed for creating custom commands.

  • LOCATION_<CONFIG>: Read-only property providing a target location on disk.

    A read-only property that indicates where a target's 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.

  • MACOSX_BUNDLE: Build an executable as an application bundle on Mac OS X.

    When this property is set to true the executable when built on Mac OS X will be created as an application bundle. This makes it a GUI executable that can be launched from the Finder. See the MACOSX_BUNDLE_INFO_PLIST target property for information about creation of the Info.plist file for the application bundle.

  • MACOSX_BUNDLE_INFO_PLIST: Specify a custom Info.plist template for a Mac OS X App Bundle.

    An executable target with MACOSX_BUNDLE enabled will be built as an application bundle on Mac 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_INFO_STRING
      MACOSX_BUNDLE_ICON_FILE
      MACOSX_BUNDLE_GUI_IDENTIFIER
      MACOSX_BUNDLE_LONG_VERSION_STRING
      MACOSX_BUNDLE_BUNDLE_NAME
      MACOSX_BUNDLE_SHORT_VERSION_STRING
      MACOSX_BUNDLE_BUNDLE_VERSION
      MACOSX_BUNDLE_COPYRIGHT

    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_FRAMEWORK_INFO_PLIST: Specify a custom Info.plist template for a Mac OS X Framework.

    An library target with FRAMEWORK enabled will be built as a framework on Mac 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_ICON_FILE
      MACOSX_FRAMEWORK_IDENTIFIER
      MACOSX_FRAMEWORK_SHORT_VERSION_STRING
      MACOSX_FRAMEWORK_BUNDLE_VERSION

    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.

  • MAP_IMPORTED_CONFIG_<CONFIG>: Map from project configuration to IMPORTED target's configuration.

    List configurations of an imported target that may be used for the current project's <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 no matching configurations are available the imported target is considered to be not found. This property is ignored for non-imported targets.

  • 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.

  • OUTPUT_NAME_<CONFIG>: Per-configuration target file base name.

    This is the configuration-specific version of OUTPUT_NAME.

  • 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.

  • 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.

  • 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.

  • 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 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 stuido.

  • 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 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 shared library target.

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

  • 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: Output directory in which to build RUNTIME target files.

    This property specifies the directory into which runtime target files should be built. There are three kinds of target files that may be built: archive, library, and runtime. Executables are always treated as runtime targets. Static libraries are always treated as archive targets. Module libraries are always treated as library targets. For non-DLL platforms shared libraries are treated as library targets. For DLL platforms the DLL part of a shared library is treated as a runtime target and the corresponding import library is treated as an archive target. All Windows-based systems including Cygwin are DLL platforms. This property is initialized by the value of the variable CMAKE_RUNTIME_OUTPUT_DIRECTORY if it is set when a target is created.

  • 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. There are three kinds of target files that may be built: archive, library, and runtime. Executables are always treated as runtime targets. Static libraries are always treated as archive targets. Module libraries are always treated as library targets. For non-DLL platforms shared libraries are treated as library targets. For DLL platforms the DLL part of a shared library is treated as a runtime target and the corresponding import library is treated as an archive target. All Windows-based systems including Cygwin are DLL platforms.

  • RUNTIME_OUTPUT_NAME_<CONFIG>: Per-configuration output name for RUNTIME target files.

    This is the configuration-specific version of RUNTIME_OUTPUT_NAME.

  • 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.

  • SOURCES: Source names specified for a target.

    Read-only list of sources specified for a target. The names returned are suitable for passing to the set_source_files_properties command.

  • 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. 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: Extra flags to use when linking static libraries.

    Extra flags to use when linking a static library.

  • SUFFIX: What comes after the library name.

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

  • 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, 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.

  • VS_KEYWORD: Visual Studio project keyword.

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

  • VS_SCC_LOCALPATH: Visual Studio Source Code Control Provider.

    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.

  • 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 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.

  • XCODE_ATTRIBUTE_<an-attribute>: Set Xcode target attributes directly.

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

Properties on Tests

  • 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.For example: PASS_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed"

  • 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.

  • 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_TESTING_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.

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.

  • 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.

    Dislaimer: 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.

  • COMPILE_DEFINITIONS_<CONFIG>: 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.

  • 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.

  • 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 temrs 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 is 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.

  • 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 Mac OS X bundle or framework.

    Executable targets with the MACOSX_BUNDLE property set are built as Mac OS X application bundles on Apple platforms. Shared library targets with the FRAMEWORK property set are built as Mac OS X frameworks 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 bundles the content folder is "<name>.app/Contents". For frameworks the content folder is "<name>.framework/Versions/<version>". See the PUBLIC_HEADER, PRIVATE_HEADER, and RESOURCE target properties for specifying files meant for Headers, PrivateHeadres, or Resources directories.

  • OBJECT_DEPENDS: Additional files on which a compiled object file depends.

    Specifies a semicolon-separated list of full-paths to files on which any object files compiled from this source file depend. An object file will be recompiled if any of the named files is newer than it.

    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.

  • 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 then this source file should not be wrapped.

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.

Compatibility Commands

  CMake Compatibility Listfile Commands - Obsolete commands supported by CMake for compatibility.

This is the documentation for now obsolete listfile commands from previous CMake versions, which are still supported for compatibility reasons. You should instead use the newer, faster and shinier new commands. ;-)

  • build_name: Deprecated. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COMPILER} instead.
      build_name(variable)

    Sets the specified variable to a string representing the platform and compiler settings. These values are now available through the CMAKE_SYSTEM and CMAKE_CXX_COMPILER variables.

  • exec_program: Deprecated. Use the execute_process() command instead.

    Run an executable program during the processing of the CMakeList.txt file.

      exec_program(Executable [directory in which to run]
                   [ARGS <arguments to executable>]
                   [OUTPUT_VARIABLE <var>]
                   [RETURN_VALUE <var>])

    The executable is run in the optionally specified directory. The executable can include arguments if it is double quoted, but it is better to use the optional ARGS argument to specify arguments to the program. This is because cmake will then be able to escape spaces in the executable path. An optional argument OUTPUT_VARIABLE specifies a variable in which to store the output. To capture the return value of the execution, provide a RETURN_VALUE. If OUTPUT_VARIABLE is specified, then no output will go to the stdout/stderr of the console running cmake.

  • export_library_dependencies: Deprecated. Use INSTALL(EXPORT) or EXPORT command.

    This command generates an old-style library dependencies file. Projects requiring CMake 2.6 or later should not use the command. Use instead the install(EXPORT) command to help export targets from an installation tree and the export() command to export targets from a build tree.

    The old-style library dependencies file does not take into account per-configuration names of libraries or the LINK_INTERFACE_LIBRARIES target property.

      export_library_dependencies(<file> [APPEND])

    Create a file named <file> that can be included into a CMake listfile with the INCLUDE command. The file will contain a number of SET commands that will set all the variables needed for library dependency information. This should be the last command in the top level CMakeLists.txt file of the project. If the APPEND option is specified, the SET commands will be appended to the given file instead of replacing it.

  • install_files: Deprecated. Use the install(FILES ) command instead.

    This command has been superceded by the install command. It is provided for compatibility with older CMake code. The FILES form is directly replaced by the FILES form of the install command. The regexp form can be expressed more clearly using the GLOB form of the file command.

      install_files(<dir> extension file file ...)

    Create rules to install the listed files with the given extension into the given directory. Only files existing in the current source tree or its corresponding location in the binary tree may be listed. If a file specified already has an extension, that extension will be removed first. This is useful for providing lists of source files such as foo.cxx when you want the corresponding foo.h to be installed. A typical extension is '.h'.

      install_files(<dir> regexp)

    Any files in the current source directory that match the regular expression will be installed.

      install_files(<dir> FILES file file ...)

    Any files listed after the FILES keyword will be installed explicitly from the names given. Full paths are allowed in this form.

    The directory <dir> is relative to the installation prefix, which is stored in the variable CMAKE_INSTALL_PREFIX.

  • install_programs: Deprecated. Use the install(PROGRAMS ) command instead.

    This command has been superceded by the install command. It is provided for compatibility with older CMake code. The FILES form is directly replaced by the PROGRAMS form of the INSTALL command. The regexp form can be expressed more clearly using the GLOB form of the FILE command.

      install_programs(<dir> file1 file2 [file3 ...])
      install_programs(<dir> FILES file1 [file2 ...])

    Create rules to install the listed programs into the given directory. Use the FILES argument to guarantee that the file list version of the command will be used even when there is only one argument.

      install_programs(<dir> regexp)

    In the second form any program in the current source directory that matches the regular expression will be installed.

    This command is intended to install programs that are not built by cmake, such as shell scripts. See the TARGETS form of the INSTALL command to create installation rules for targets built by cmake.

    The directory <dir> is relative to the installation prefix, which is stored in the variable CMAKE_INSTALL_PREFIX.

  • install_targets: Deprecated. Use the install(TARGETS ) command instead.

    This command has been superceded by the install command. It is provided for compatibility with older CMake code.

      install_targets(<dir> [RUNTIME_DIRECTORY dir] target target)

    Create rules to install the listed targets into the given directory. The directory <dir> is relative to the installation prefix, which is stored in the variable CMAKE_INSTALL_PREFIX. If RUNTIME_DIRECTORY is specified, then on systems with special runtime files (Windows DLL), the files will be copied to that directory.

  • link_libraries: Deprecated. Use the target_link_libraries() command instead.

    Link libraries to all targets added later.

      link_libraries(library1 <debug | optimized> library2 ...)

    Specify a list of libraries to be linked into any following targets (typically added with the add_executable or add_library calls). This command is passed down to all subdirectories. The debug and optimized strings may be used to indicate that the next library listed is to be used only for that specific type of build.

  • make_directory: Deprecated. Use the file(MAKE_DIRECTORY ) command instead.
      make_directory(directory)

    Creates the specified directory. Full paths should be given. Any parent directories that do not exist will also be created. Use with care.

  • remove: Deprecated. Use the list(REMOVE_ITEM ) command instead.
      remove(VAR VALUE VALUE ...)

    Removes VALUE from the variable VAR. This is typically used to remove entries from a vector (e.g. semicolon separated list). VALUE is expanded.

  • subdir_depends: Deprecated. Does nothing.
      subdir_depends(subdir dep1 dep2 ...)

    Does not do anything. This command used to help projects order parallel builds correctly. This functionality is now automatic.

  • subdirs: Deprecated. Use the add_subdirectory() command instead.

    Add a list of subdirectories to the build.

      subdirs(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...]
              [PREORDER] )

    Add a list of subdirectories to the build. The add_subdirectory command should be used instead of subdirs although subdirs will still work. This will cause any CMakeLists.txt files in the sub directories to be processed by CMake. Any directories after the PREORDER flag are traversed first by makefile builds, the PREORDER flag has no effect on IDE projects. Any directories after the EXCLUDE_FROM_ALL marker will not be included in the top level makefile or project file. This is useful for having CMake create makefiles or projects for a set of examples in a project. You would want CMake to generate makefiles or project files for all the examples at the same time, but you would not want them to show up in the top level project or be built each time make is run from the top.

  • use_mangled_mesa: Copy mesa headers for use in combination with system GL.
      use_mangled_mesa(PATH_TO_MESA OUTPUT_DIRECTORY)

    The path to mesa includes, should contain gl_mangle.h. The mesa headers are copied to the specified output directory. This allows mangled mesa headers to override other GL headers by being added to the include directory path earlier.

  • utility_source: Specify the source tree of a third-party utility.
      utility_source(cache_entry executable_name
                     path_to_source [file1 file2 ...])

    When a third-party utility's source is included in the distribution, this command specifies its location and name. The cache entry will not be set unless the path_to_source and all listed files exist. It is assumed that the source tree of the utility will have been built before it is needed.

    When cross compiling CMake will print a warning if a utility_source() command is executed, because in many cases it is used to build an executable which is executed later on. This doesn't work when cross compiling, since the executable can run only on their target platform. So in this case the cache entry has to be adjusted manually so it points to an executable which is runnable on the build host.

  • variable_requires: Deprecated. Use the if() command instead.

    Assert satisfaction of an option's required variables.

      variable_requires(TEST_VARIABLE RESULT_VARIABLE
                        REQUIRED_VARIABLE1
                        REQUIRED_VARIABLE2 ...)

    The first argument (TEST_VARIABLE) is the name of the variable to be tested, if that variable is false nothing else is done. If TEST_VARIABLE is true, then the next argument (RESULT_VARIABLE) is a variable that is set to true if all the required variables are set. The rest of the arguments are variables that must be true or not set to NOTFOUND to avoid an error. If any are not true, an error is reported.

  • write_file: Deprecated. Use the file(WRITE ) command instead.
      write_file(filename "message to write"... [APPEND])

    The first argument is the file name, the rest of the arguments are messages to write. If the argument APPEND is specified, then the message will be appended.

    NOTE 1: file(WRITE ... and file(APPEND ... do exactly the same as this one but add some more functionality.

    NOTE 2: When using write_file the produced file cannot be used as an input to CMake (CONFIGURE_FILE, source file ...) because it will lead to an infinite loop. Use configure_file if you want to generate input files to CMake.

Standard CMake Modules

The following modules are provided with CMake. They can be used with INCLUDE(ModuleName).

  CMake Modules - Modules coming with CMake, the Cross-Platform Makefile Generator.

This is the documentation for the modules and scripts coming with CMake. Using these modules you can check the computer system for installed software packages, features of the compiler and the existance of headers to name just a few.

  • AddFileDependencies: ADD_FILE_DEPENDENCIES(source_file depend_files...)

    Adds the given files as dependencies to source_file

  • BundleUtilities:

    BundleUtilities.cmake

    A collection of CMake utility functions useful for dealing with .app bundles on the Mac and bundle-like directories on any OS.

    The following functions are provided by this script:

       get_bundle_main_executable
       get_dotapp_dir
       get_bundle_and_executable
       get_bundle_all_executables
       get_item_key
       clear_bundle_keys
       set_bundle_key_values
       get_bundle_keys
       copy_resolved_item_into_bundle
       fixup_bundle_item
       fixup_bundle
       copy_and_fixup_bundle
       verify_bundle_prerequisites
       verify_bundle_symlinks
       verify_app


    Requires CMake 2.6 or greater because it uses function, break and PARENT_SCOPE. Also depends on GetPrerequisites.cmake.

  • CMakeBackwardCompatibilityCXX: define a bunch of backwards compatibility variables
      CMAKE_ANSI_CXXFLAGS - flag for ansi c++ 
      CMAKE_HAS_ANSI_STRING_STREAM - has <strstream>
      INCLUDE(TestForANSIStreamHeaders)
      INCLUDE(CheckIncludeFileCXX)
      INCLUDE(TestForSTDNamespace)
      INCLUDE(TestForANSIForScope)
  • CMakeDependentOption: Macro to provide an option dependent on other options.

    This macro presents an option to the user only if a set of other conditions are true. When the option is not presented a default value is used, but any value set by the user is preserved for when the option is presented again. Example invocation:

      CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON
                             "USE_BAR;NOT USE_ZOT" OFF)

    If USE_BAR is true and USE_ZOT is false, this provides an option called USE_FOO that defaults to ON. Otherwise, it sets USE_FOO to OFF. If the status of USE_BAR or USE_ZOT ever changes, any value for the USE_FOO option is saved so that when the option is re-enabled it retains its old value.

  • CMakeDetermineVSServicePack: Includes a public function for assisting users in trying to determine the

    Visual Studio service pack in use.

    Sets the passed in variable to one of the following values or an empty string if unknown.

        vc80
        vc80sp1
        vc90
        vc90sp1


    Usage: ===========================

        if(MSVC)
           include(CMakeDetermineVSServicePack)
           DetermineVSServicePack( my_service_pack )


           if( my_service_pack )
               message(STATUS "Detected: ${my_service_pack}")
           endif()
        endif()


    ===========================

  • CMakeFindFrameworks: helper module to find OSX frameworks
  • CMakeForceCompiler:

    This module defines macros intended for use by cross-compiling toolchain files when CMake is not able to automatically detect the compiler identification.

    Macro CMAKE_FORCE_C_COMPILER has the following signature:

       CMAKE_FORCE_C_COMPILER(<compiler> <compiler-id>)

    It sets CMAKE_C_COMPILER to the given compiler and the cmake internal variable CMAKE_C_COMPILER_ID to the given compiler-id. It also bypasses the check for working compiler and basic compiler information tests.

    Macro CMAKE_FORCE_CXX_COMPILER has the following signature:

       CMAKE_FORCE_CXX_COMPILER(<compiler> <compiler-id>)

    It sets CMAKE_CXX_COMPILER to the given compiler and the cmake internal variable CMAKE_CXX_COMPILER_ID to the given compiler-id. It also bypasses the check for working compiler and basic compiler information tests.

    So a simple toolchain file could look like this:

       INCLUDE (CMakeForceCompiler)
       SET(CMAKE_SYSTEM_NAME Generic)
       CMAKE_FORCE_C_COMPILER   (chc12 MetrowerksHicross)
       CMAKE_FORCE_CXX_COMPILER (chc12 MetrowerksHicross)
  • CMakePrintSystemInformation: print system information

    This file can be used for diagnostic purposes just include it in a project to see various internal CMake variables.

  • CMakeVerifyManifest:

    CMakeVerifyManifest.cmake

    This script is used to verify that embeded manifests and side by side manifests for a project match. To run this script, cd to a directory and run the script with cmake -P. On the command line you can pass in versions that are OK even if not found in the .manifest files. For example, cmake -Dallow_versions=8.0.50608.0 -PCmakeVerifyManifest.cmake could be used to allow an embeded manifest of 8.0.50608.0 to be used in a project even if that version was not found in the .manifest file.

  • CPack: Build binary and source package installers


    The CPack module generates binary and source installers in a variety of formats using the cpack program. Inclusion of the CPack module adds two new targets to the resulting makefiles, package and package_source, which build the binary and source installers, respectively. The generated binary installers contain everything installed via CMake's INSTALL command (and the deprecated INSTALL_FILES, INSTALL_PROGRAMS, and INSTALL_TARGETS commands).

    For certain kinds of binary installers (including the graphical installers on Mac OS X and Windows), CPack generates installers that allow users to select individual application components to install. The contents of each of the components are identified by the COMPONENT argument of CMake's INSTALL command. These components can be annotated with user-friendly names and descriptions, inter-component dependencies, etc., and grouped in various ways to customize the resulting installer. See the cpack_add_* commands, described below, for more information about component-specific installations.

    Before including the CPack module, there are a variety of variables that can be set to customize the resulting installers. The most commonly-used variables are:

       CPACK_PACKAGE_NAME - The name of the package (or application). If
       not specified, defaults to the project name.


       CPACK_PACKAGE_VENDOR - The name of the package vendor (e.g.,
       "Kitware").


       CPACK_PACKAGE_VERSION_MAJOR - Package major Version


       CPACK_PACKAGE_VERSION_MINOR - Package minor Version


       CPACK_PACKAGE_VERSION_PATCH - Package patch Version


       CPACK_PACKAGE_DESCRIPTION_FILE - A text file used to describe the
       project. Used, for example, the introduction screen of a
       CPack-generated Windows installer to describe the project.


       CPACK_PACKAGE_DESCRIPTION_SUMMARY - Short description of the
       project (only a few words).


       CPACK_PACKAGE_FILE_NAME - The name of the package file to generate,
       not including the extension. For example, cmake-2.6.1-Linux-i686.


       CPACK_PACKAGE_INSTALL_DIRECTORY - Installation directory on the
       target system, e.g., "CMake 2.5".


       CPACK_RESOURCE_FILE_LICENSE - License file for the project, which
       will typically be displayed to the user (often with an explicit
       "Accept" button, for graphical installers) prior to installation.


       CPACK_RESOURCE_FILE_README - ReadMe file for the project, which
       typically describes in some detail


       CPACK_RESOURCE_FILE_WELCOME - Welcome file for the project, which
       welcomes users to this installer. Typically used in the graphical
       installers on Windows and Mac OS X.


       CPACK_MONOLITHIC_INSTALL - Disables the component-based 
       installation mechanism, so that all components are always installed.


       CPACK_GENERATOR - List of CPack generators to use. If not
       specified, CPack will create a set of options (e.g.,
       CPACK_BINARY_NSIS) allowing the user to enable/disable individual
       generators.


       CPACK_OUTPUT_CONFIG_FILE - The name of the CPack configuration file
       for binary installers that will be generated by the CPack
       module. Defaults to CPackConfig.cmake.


       CPACK_PACKAGE_EXECUTABLES - Lists each of the executables along
       with a text label, to be used to create Start Menu shortcuts on
       Windows. For example, setting this to the list ccmake;CMake will
       create a shortcut named "CMake" that will execute the installed
       executable ccmake.


       CPACK_STRIP_FILES - List of files to be stripped. Starting with
       CMake 2.6.0 CPACK_STRIP_FILES will be a boolean variable which
       enables stripping of all files (a list of files evaluates to TRUE
       in CMake, so this change is compatible).


    The following CPack variables are specific to source packages, and will not affect binary packages:

       CPACK_SOURCE_PACKAGE_FILE_NAME - The name of the source package,
       e.g., cmake-2.6.1


       CPACK_SOURCE_STRIP_FILES - List of files in the source tree that
       will be stripped. Starting with CMake 2.6.0
       CPACK_SOURCE_STRIP_FILES will be a boolean variable which enables
       stripping of all files (a list of files evaluates to TRUE in CMake,
       so this change is compatible).


       CPACK_SOURCE_GENERATOR - List of generators used for the source
       packages. As with CPACK_GENERATOR, if this is not specified then
       CPack will create a set of options (e.g., CPACK_SOURCE_ZIP)
       allowing users to select which packages will be generated.


       CPACK_SOURCE_OUTPUT_CONFIG_FILE - The name of the CPack
       configuration file for source installers that will be generated by
       the CPack module. Defaults to CPackSourceConfig.cmake.


       CPACK_SOURCE_IGNORE_FILES - Pattern of files in the source tree
       that won't be packaged when building a source package. This is a
       list of patterns, e.g., /CVS/;/\\.svn/;\\.swp$;\\.#;/#;.*~;cscope.*


    The following variables are specific to the graphical installers built on Windows using the Nullsoft Installation System.

       CPACK_PACKAGE_INSTALL_REGISTRY_KEY - Registry key used when
       installing this project.


       CPACK_NSIS_MUI_ICON - The icon file (.ico) for the generated
       install program.


       CPACK_NSIS_MUI_UNIICON - The icon file (.ico) for the generated
       uninstall program.


       CPACK_PACKAGE_ICON - A branding image that will be displayed inside
       the installer.


       CPACK_NSIS_EXTRA_INSTALL_COMMANDS - Extra NSIS commands that will
       be added to the install Section.


       CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS - Extra NSIS commands that will
       be added to the uninstall Section.


       CPACK_NSIS_COMPRESSOR - The arguments that will be passed to the
       NSIS SetCompressor command.


       CPACK_NSIS_MODIFY_PATH - If this is set to "ON", then an extra page
       will appear in the installer that will allow the user to choose
       whether the program directory should be added to the system PATH
       variable.


       CPACK_NSIS_DISPLAY_NAME - The display name string that appears in
       the Windows Add/Remove Program control panel


       CPACK_NSIS_PACKAGE_NAME - The title displayed at the top of the
       installer.


       CPACK_NSIS_INSTALLED_ICON_NAME - A path to the executable that
       contains the installer icon.


       CPACK_NSIS_HELP_LINK - URL to a web site providing assistance in
       installing your application.


       CPACK_NSIS_URL_INFO_ABOUT - URL to a web site providing more
       information about your application.


       CPACK_NSIS_CONTACT - Contact information for questions and comments
       about the installation process.


       CPACK_NSIS_CREATE_ICONS_EXTRA - Additional NSIS commands for
       creating start menu shortcuts.


       CPACK_NSIS_DELETE_ICONS_EXTRA -Additional NSIS commands to
       uninstall start menu shortcuts.


    The following variable is specific to installers build on Mac OS X using PackageMaker:

       CPACK_OSX_PACKAGE_VERSION - The version of Mac OS X that the
       resulting PackageMaker archive should be compatible
       with. Different versions of Mac OS X support different
       features. For example, CPack can only build component-based
       installers for Mac OS X 10.4 or newer, and can only build
       installers that download component son-the-fly for Mac OS X 10.5
       or newer. If left blank, this value will be set to the minimum
       version of Mac OS X that supports the requested features. Set this
       variable to some value (e.g., 10.4) only if you want to guarantee
       that your installer will work on that version of Mac OS X, and
       don't mind missing extra features available in the installer
       shipping with later versions of Mac OS X.


    The following variables are for advanced uses of CPack:

       CPACK_CMAKE_GENERATOR - What CMake generator should be used if the
       project is CMake project. Defaults to the value of CMAKE_GENERATOR;
       few users will want to change this setting.


       CPACK_INSTALL_CMAKE_PROJECTS - List of four values that specify
       what project to install. The four values are: Build directory,
       Project Name, Project Component, Directory. If omitted, CPack will
       build an installer that installers everything.


       CPACK_SYSTEM_NAME - System name, defaults to the value of
       ${CMAKE_SYSTEM_NAME}.


       CPACK_PACKAGE_VERSION - Package full version, used internally. By
       default, this is built from CPACK_PACKAGE_VERSION_MAJOR,
       CPACK_PACKAGE_VERSION_MINOR, and CPACK_PACKAGE_VERSION_PATCH.


       CPACK_TOPLEVEL_TAG - Directory for the installed files.


       CPACK_INSTALL_COMMANDS - Extra commands to install components.


       CPACK_INSTALL_DIRECTORIES - Extra directories to install.


    Component-specific installation allows users to select specific sets of components to install during the install process. Installation components are identified by the COMPONENT argument of CMake's INSTALL commands, and should be further described by the following CPack commands:

       cpack_add_component - Describes a CPack installation component
       named by the COMPONENT argument to a CMake INSTALL command.


         cpack_add_component(compname
                             [DISPLAY_NAME name]
                             [DESCRIPTION description]
                             [HIDDEN | REQUIRED | DISABLED ]
                             [GROUP group]
                             [DEPENDS comp1 comp2 ... ]
                             [INSTALL_TYPES type1 type2 ... ]
                             [DOWNLOADED]
                             [ARCHIVE_FILE filename])


       The cmake_add_component command describes an installation
       component, which the user can opt to install or remove as part of
       the graphical installation process. compname is the name of the
       component, as provided to the COMPONENT argument of one or more
       CMake INSTALL commands.


       DISPLAY_NAME is the displayed name of the component, used in
       graphical installers to display the component name. This value can
       be any string.


       DESCRIPTION is an extended description of the component, used in
       graphical installers to give the user additional information about
       the component. Descriptions can span multiple lines using "\n" as
       the line separator. Typically, these descriptions should be no
       more than a few lines long.


       HIDDEN indicates that this component will be hidden in the
       graphical installer, so that the user cannot directly change
       whether it is installed or not.


       REQUIRED indicates that this component is required, and therefore
       will always be installed. It will be visible in the graphical
       installer, but it cannot be unselected. (Typically, required
       components are shown greyed out).


       DISABLED indicates that this component should be disabled
       (unselected) by default. The user is free to select this component
       for installation, unless it is also HIDDEN.


       DEPENDS lists the components on which this component depends. If
       this component is selected, then each of the components listed
       must also be selected. The dependency information is encoded
       within the installer itself, so that users cannot install
       inconsitent sets of components.


       GROUP names the component group of which this component is a
       part. If not provided, the component will be a standalone
       component, not part of any component group. Component groups are
       described with the cpack_add_component_group command, detailed
       below.


       INSTALL_TYPES lists the installation types of which this component
       is a part. When one of these installations types is selected, this
       component will automatically be selected. Installation types are
       described with the cpack_add_install_type command, detailed below.


       DOWNLOADED indicates that this component should be downloaded
       on-the-fly by the installer, rather than packaged in with the
       installer itself. For more information, see the cpack_configure_downloads
       command.


       ARCHIVE_FILE provides a name for the archive file created by CPack
       to be used for downloaded components. If not supplied, CPack will
       create a file with some name based on CPACK_PACKAGE_FILE_NAME and
       the name of the component. See cpack_configure_downloads for more
       information.


       cpack_add_component_group - Describes a group of related CPack
       installation components.


         cpack_add_component_group(groupname
                                  [DISPLAY_NAME name]
                                  [DESCRIPTION description]
                                  [PARENT_GROUP parent]
                                  [EXPANDED]
                                  [BOLD_TITLE])


       The cpack_add_component_group describes a group of installation
       components, which will be placed together within the listing of
       options. Typically, component groups allow the user to
       select/deselect all of the components within a single group via a
       single group-level option. Use component groups to reduce the
       complexity of installers with many options. groupname is an
       arbitrary name used to identify the group in the GROUP argument of
       the cpack_add_component command, which is used to place a
       component in a group. The name of the group must not conflict with
       the name of any component.


       DISPLAY_NAME is the displayed name of the component group, used in
       graphical installers to display the component group name. This
       value can be any string.


       DESCRIPTION is an extended description of the component group,
       used in graphical installers to give the user additional
       information about the components within that group. Descriptions
       can span multiple lines using "\n" as the line
       separator. Typically, these descriptions should be no more than a
       few lines long.


       PARENT_GROUP, if supplied, names the parent group of this group. 
       Parent groups are used to establish a hierarchy of groups, 
       providing an arbitrary hierarchy of groups.


       EXPANDED indicates that, by default, the group should show up as
       "expanded", so that the user immediately sees all of the
       components within the group. Otherwise, the group will initially
       show up as a single entry.


       BOLD_TITLE indicates that the group title should appear in bold,
       to call the user's attention to the group.


       cpack_add_install_type - Add a new installation type containing a
       set of predefined component selections to the graphical installer.
                          
         cpack_add_install_type(typename
                                [DISPLAY_NAME name])   


       The cpack_add_install_type command identifies a set of preselected
       components that represents a common use case for an
       application. For example, a "Developer" install type might include
       an application along with its header and library files, while an
       "End user" install type might just include the application's
       executable. Each component identifies itself with one or more
       install types via the INSTALL_TYPES argument to
       cpack_add_component.


       DISPLAY_NAME is the displayed name of the install type, which will
       typically show up in a drop-down box within a graphical
       installer. This value can be any string.


       cpack_configure_downloads - Configure CPack to download selected
       components on-the-fly as part of the installation process.


         cpack_configure_downloads(site
                                   [UPLOAD_DIRECTORY dirname]
                                   [ALL]
                                   [ADD_REMOVE|NO_ADD_REMOVE])


       The cpack_configure_downloads command configures installation-time
       downloads of selected components. For each downloadable component,
       CPack will create an archive containing the contents of that
       component, which should be uploaded to the given site. When the
       user selects that component for installation, the installer will
       download and extract the component in place. This feature is
       useful for creating small installers that only download the
       requested components, saving bandwidth. Additionally, the
       installers are small enough that they will be installed as part of
       the normal installation process, and the "Change" button in
       Windows Add/Remove Programs control panel will allow one to add or
       remove parts of the application after the original
       installation. On Windows, the downloaded-components functionality
       requires the ZipDLL plug-in for NSIS, available at:


         http://nsis.sourceforge.net/ZipDLL_plug-in


       On Mac OS X, installers that download components on-the-fly can
       only be built and installed on system using Mac OS X 10.5 or
       later.


       The site argument is a URL where the archives for downloadable 
       components will reside, e.g., http://www.cmake.org/files/2.6.1/installer/
       All of the archives produced by CPack should be uploaded to that location.


       UPLOAD_DIRECTORY is the local directory where CPack will create the 
       various archives for each of the components. The contents of this
       directory should be uploaded to a location accessible by the URL given
       in the site argument. If omitted, CPack will use the directory 
       CPackUploads inside the CMake binary directory to store the generated
       archives.


       The ALL flag indicates that all components be downloaded. Otherwise, only 
       those components explicitly marked as DOWNLOADED or that have a specified 
       ARCHIVE_FILE will be downloaded. Additionally, the ALL option implies
       ADD_REMOVE (unless NO_ADD_REMOVE is specified).


       ADD_REMOVE indicates that CPack should install a copy of the installer
       that can be called from Windows' Add/Remove Programs dialog (via the 
       "Modify" button) to change the set of installed components. NO_ADD_REMOVE
       turns off this behavior. This option is ignored on Mac OS X.
  • CPackDeb: The builtin (binary) CPack Deb generator (Unix only)

    CPackDeb may be used to create Deb package using CPack. CPackDeb is a CPack generator thus it uses the CPACK_XXX variables used by CPack : http://www.cmake.org/Wiki/CMake:CPackConfiguration

    However CPackRPM has specific features which are controlled by the specifics CPACK_RPM_XXX variables.You'll find a detailed usage on the wiki: 

      http://www.cmake.org/Wiki/CMake:CPackPackageGenerators#DEB_.28UNIX_only.29

    However as a handy reminder here comes the list of specific variables:

      CPACK_DEBIAN_PACKAGE_NAME
         Mandatory : YES
         Default   : CPACK_PACKAGE_NAME (lower case)
         The debian package summary

    CPACK_DEBIAN_PACKAGE_VERSION

         Mandatory : YES
         Default   : CPACK_PACKAGE_VERSION
         The debian package version

    CPACK_DEBIAN_PACKAGE_ARCHITECTURE)

         Mandatory : YES
         Default   : Output of dpkg --print-architecture or i386
         The debian package architecture

    CPACK_DEBIAN_PACKAGE_DEPENDS

         Mandatory : NO
         Default   : -
         May be used to set deb dependencies.

    CPACK_DEBIAN_PACKAGE_MAINTAINER

         Mandatory : YES
         Default   : CPACK_PACKAGE_CONTACT
         The debian package maintainer

    CPACK_DEBIAN_PACKAGE_DESCRIPTION

         Mandatory : YES
         Default   : CPACK_PACKAGE_DESCRIPTION_SUMMARY
         The debian package description

    CPACK_DEBIAN_PACKAGE_SECTION

         Mandatory : YES
         Default   : 'devel'
         The debian package section

    CPACK_DEBIAN_PACKAGE_PRIORITY

         Mandatory : YES
         Default   : 'optional'
         The debian package priority
  • CPackRPM: The builtin (binary) CPack RPM generator (Unix only)

    CPackRPM may be used to create RPM package using CPack. CPackRPM is a CPack generator thus it uses the CPACK_XXX variables used by CPack : http://www.cmake.org/Wiki/CMake:CPackConfiguration

    However CPackRPM has specific features which are controlled by the specifics CPACK_RPM_XXX variables.You'll find a detailed usage on the wiki: 

      http://www.cmake.org/Wiki/CMake:CPackPackageGenerators#RPM_.28Unix_Only.29

    However as a handy reminder here comes the list of specific variables:

      CPACK_RPM_PACKAGE_SUMMARY 
         Mandatory : YES
         Default   : CPACK_PACKAGE_DESCRIPTION
         The RPM package summary
      CPACK_RPM_PACKAGE_NAME
         Mandatory : YES
         Default   : CPACK_PACKAGE_NAME
         The RPM package name
      CPACK_RPM_PACKAGE_VERSION
         Mandatory : YES
         Default   : CPACK_PACKAGE_VERSION
         The RPM package version
      CPACK_RPM_PACKAGE_ARCHITECTURE
         Mandatory : NO
         Default   : -
         The RPM package architecture. This may be set to "noarch" if you 
         know you are building a noarch package.
      CPACK_RPM_PACKAGE_RELEASE
         Mandatory : YES
         Default   : 1
         The RPM package release. This is the numbering of the RPM package 
         itself, i.e. the version of the packaging and not the version of the 
         content (see CPACK_RPM_PACKAGE_VERSION). One may change the default 
         value if the previous packaging was buggy and/or you want to put here
         a fancy Linux distro specific numbering.
      CPACK_RPM_PACKAGE_LICENSE
         Mandatory : YES
         Default   : "unknown"
         The RPM package license policy.
      CPACK_RPM_PACKAGE_GROUP
         Mandatory : YES
         Default   : "unknown"
         The RPM package group.
      CPACK_RPM_PACKAGE_VENDOR 
         Mandatory : YES
         Default   : CPACK_PACKAGE_VENDOR if set or"unknown"
         The RPM package group.
      CPACK_RPM_PACKAGE_DESCRIPTION
         Mandatory : YES
         Default   : CPACK_PACKAGE_DESCRIPTION_FILE if set or "no package description available"
      CPACK_RPM_PACKAGE_REQUIRES
         Mandatory : NO
         Default   : -
         May be used to set RPM dependencies. 
      CPACK_RPM_SPEC_INSTALL_POST
         Mandatory : NO
         Default   : -
         May be used to set an RPM post-install command inside the spec file. 
         For example setting it to "/bin/true" may be used to prevent 
         rpmbuild to strip binaries.
      CPACK_RPM_SPEC_MORE_DEFINE
         Mandatory : NO
         Default   : -
         May be used to add any %define lines to the generated spec file.
      CPACK_RPM_PACKAGE_DEBUG
         Mandatory : NO
         Default   : -
         May be set when invoking cpack in order to trace debug informations 
         during CPack RPM run. For example you may launch CPack like this 
         cpack -D CPACK_RPM_PACKAGE_DEBUG=1 -G RPM
  • CTest: Configure a project for testing with CTest/CDash

    This file configures a project to use the CTest/CDash/Dart testing/dashboard process. This module should be included in the CMakeLists.txt file at the top of a project. Typical usage:

      INCLUDE(CTest)
      IF(BUILD_TESTING)
        # ... testing related CMake code ...
      ENDIF(BUILD_TESTING)

    The BUILD_TESTING option is created by the CTest module to determine whether testing support should be enabled. The default is ON.

  • CTestScriptMode:

    This file is read by ctest in script mode (-S)

  • CheckCCompilerFlag: Check whether the C compiler supports a given flag.

    CHECK_C_COMPILER_FLAG(<flag> <var>)

      <flag> - the compiler flag
      <var>  - variable to store the result

    This internally calls the check_c_source_compiles macro. See help for CheckCSourceCompiles for a listing of variables that can modify the build.

  • CheckCSourceCompiles: Check if the given C source code compiles.

    CHECK_C_SOURCE_COMPILES(<code> <var> [FAIL_REGEX <fail-regex>])

      <code>       - source code to try to compile
      <var>        - variable to store whether the source code compiled
      <fail-regex> - fail if test output matches this regex

    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_INCLUDES = list of include directories
      CMAKE_REQUIRED_LIBRARIES = list of libraries to link
  • CheckCSourceRuns: Check if the given C source code compiles and runs.

    CHECK_C_SOURCE_RUNS(<code> <var>)

      <code>   - source code to try to compile
      <var>    - variable to store the result
                 (1 for success, empty for failure)

    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_INCLUDES = list of include directories
      CMAKE_REQUIRED_LIBRARIES = list of libraries to link
  • CheckCXXCompilerFlag: Check whether the CXX compiler supports a given flag.

    CHECK_CXX_COMPILER_FLAG(<flag> <var>)

      <flag> - the compiler flag
      <var>  - variable to store the result

    This internally calls the check_cxx_source_compiles macro. See help for CheckCXXSourceCompiles for a listing of variables that can modify the build.

  • CheckCXXSourceCompiles: Check if the given C++ source code compiles.

    CHECK_CXX_SOURCE_COMPILES(<code> <var> [FAIL_REGEX <fail-regex>])

      <code>       - source code to try to compile
      <var>        - variable to store whether the source code compiled
      <fail-regex> - fail if test output matches this regex

    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_INCLUDES = list of include directories
      CMAKE_REQUIRED_LIBRARIES = list of libraries to link
  • CheckCXXSourceRuns: Check if the given C++ source code compiles and runs.

    CHECK_CXX_SOURCE_RUNS(<code> <var>)

      <code>   - source code to try to compile
      <var>    - variable to store the result
                 (1 for success, empty for failure)

    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_INCLUDES = list of include directories
      CMAKE_REQUIRED_LIBRARIES = list of libraries to link
  • CheckFortranFunctionExists: macro which checks if the Fortran function exists

    CHECK_FORTRAN_FUNCTION_EXISTS(FUNCTION VARIABLE)

      FUNCTION - the name of the Fortran function
      VARIABLE - variable to store the result


    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_LIBRARIES = list of libraries to link
  • CheckFunctionExists: macro which checks if the function exists

    CHECK_FUNCTION_EXISTS(FUNCTION VARIABLE)

      FUNCTION - the name of the function
      VARIABLE - variable to store the result


    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_INCLUDES = list of include directories
      CMAKE_REQUIRED_LIBRARIES = list of libraries to link
  • CheckIncludeFile: macro which checks the include file exists.

    CHECK_INCLUDE_FILE(INCLUDE VARIABLE)

      INCLUDE  - name of include file
      VARIABLE - variable to return result

    an optional third argument is the CFlags to add to the compile line or you can use CMAKE_REQUIRED_FLAGS

    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_INCLUDES = list of include directories


  • CheckIncludeFileCXX: Check if the include file exists.
      CHECK_INCLUDE_FILE_CXX(INCLUDE VARIABLE)


      INCLUDE  - name of include file
      VARIABLE - variable to return result

    An optional third argument is the CFlags to add to the compile line or you can use CMAKE_REQUIRED_FLAGS.

    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_INCLUDES = list of include directories


  • CheckIncludeFiles: Check if the files can be included


    CHECK_INCLUDE_FILES(INCLUDE VARIABLE)

      INCLUDE  - list of files to include
      VARIABLE - variable to return result


    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_INCLUDES = list of include directories
  • CheckLibraryExists: Check if the function exists.

    CHECK_LIBRARY_EXISTS (LIBRARY FUNCTION LOCATION VARIABLE)

      LIBRARY  - the name of the library you are looking for
      FUNCTION - the name of the function
      LOCATION - location where the library should be found
      VARIABLE - variable to store the result


    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_LIBRARIES = list of libraries to link
  • CheckStructHasMember: Check if the given struct or class has the specified member variable

    CHECK_STRUCT_HAS_MEMBER (STRUCT MEMBER HEADER VARIABLE)

      STRUCT - the name of the struct or class you are interested in
      MEMBER - the member which existence you want to check
      HEADER - the header(s) where the prototype should be declared
      VARIABLE - variable to store the result


    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_INCLUDES = list of include directories


    Example: CHECK_STRUCT_HAS_MEMBER("struct timeval" tv_sec sys/select.h HAVE_TIMEVAL_TV_SEC)

  • CheckSymbolExists: Check if the symbol exists in include files

    CHECK_SYMBOL_EXISTS(SYMBOL FILES VARIABLE)

      SYMBOL   - symbol
      FILES    - include files to check
      VARIABLE - variable to return result


    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_INCLUDES = list of include directories
      CMAKE_REQUIRED_LIBRARIES = list of libraries to link
  • CheckTypeSize: Check sizeof a type
      CHECK_TYPE_SIZE(TYPE VARIABLE [BUILTIN_TYPES_ONLY])

    Check if the type exists and determine size of type. if the type exists, the size will be stored to the variable. This also calls check_include_file for sys/types.h stdint.h and stddef.h, setting HAVE_SYS_TYPES_H, HAVE_STDINT_H, and HAVE_STDDEF_H. This is because many types are stored in these include files. 

      VARIABLE - variable to store size if the type exists.
      HAVE_${VARIABLE} - does the variable exists or not
      BUILTIN_TYPES_ONLY - The third argument is optional and if 
                           it is set to the string BUILTIN_TYPES_ONLY
                           this macro will not check for any header files.

    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_INCLUDES = list of include directories
      CMAKE_REQUIRED_LIBRARIES = list of libraries to link
  • CheckVariableExists: Check if the variable exists.
      CHECK_VARIABLE_EXISTS(VAR VARIABLE)
      
      VAR      - the name of the variable
      VARIABLE - variable to store the result


    This macro is only for C variables.

    The following variables may be set before calling this macro to modify the way the check is run:

      CMAKE_REQUIRED_FLAGS = string of compile command line flags
      CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
      CMAKE_REQUIRED_LIBRARIES = list of libraries to link
  • Dart: Configure a project for testing with CTest or old Dart Tcl Client

    This file is the backwards-compatibility version of the CTest module. It supports using the old Dart 1 Tcl client for driving dashboard submissions as well as testing with CTest. This module should be included in the CMakeLists.txt file at the top of a project. Typical usage:

      INCLUDE(Dart)
      IF(BUILD_TESTING)
        # ... testing related CMake code ...
      ENDIF(BUILD_TESTING)

    The BUILD_TESTING option is created by the Dart module to determine whether testing support should be enabled. The default is ON.

  • Documentation: DocumentationVTK.cmake

    This file provides support for the VTK documentation framework. It relies on several tools (Doxygen, Perl, etc).

  • ExternalProject: Create custom targets to build projects in external trees

    The 'ExternalProject_Add' function creates a custom target to drive download, update/patch, configure, build, install and test steps of an external project:

      ExternalProject_Add(<name>    # Name for custom target
        [DEPENDS projects...]       # Targets on which the project depends
        [PREFIX dir]                # Root dir for entire project
        [LIST_SEPARATOR sep]        # Sep to be replaced by ; in cmd lines
        [TMP_DIR dir]               # Directory to store temporary files
        [STAMP_DIR dir]             # Directory to store step timestamps
       #--Download step--------------
        [DOWNLOAD_DIR dir]          # Directory to store downloaded files
        [DOWNLOAD_COMMAND cmd...]   # Command to download source tree
        [CVS_REPOSITORY cvsroot]    # CVSROOT of CVS repository
        [CVS_MODULE mod]            # Module to checkout from CVS repo
        [CVS_TAG tag]               # Tag to checkout from CVS repo
        [SVN_REPOSITORY url]        # URL of Subversion repo
        [SVN_REVISION rev]          # Revision to checkout from Subversion repo
        [URL /.../src.tgz]          # Full path or URL of source
       #--Update/Patch step----------
        [UPDATE_COMMAND cmd...]     # Source work-tree update command
        [PATCH_COMMAND cmd...]      # Command to patch downloaded source
       #--Configure step-------------
        [SOURCE_DIR dir]            # Source dir to be used for build
        [CONFIGURE_COMMAND cmd...]  # Build tree configuration command
        [CMAKE_COMMAND /.../cmake]  # Specify alternative cmake executable
        [CMAKE_GENERATOR gen]       # Specify generator for native build
        [CMAKE_ARGS args...]        # Arguments to CMake command line
       #--Build step-----------------
        [BINARY_DIR dir]            # Specify build dir location
        [BUILD_COMMAND cmd...]      # Command to drive the native build
        [BUILD_IN_SOURCE 1]         # Use source dir for build dir
       #--Install step---------------
        [INSTALL_DIR dir]           # Installation prefix
        [INSTALL_COMMAND cmd...]    # Command to drive install after build
       #--Test step---------------
        [TEST_BEFORE_INSTALL 1]     # Add test step executed before install step
        [TEST_AFTER_INSTALL 1]      # Add test step executed after install step
        [TEST_COMMAND cmd...]       # Command to drive test
        )

    The *_DIR options specify directories for the project, with default directories computed as follows. If the PREFIX option is given to ExternalProject_Add() or the EP_PREFIX directory property is set, then an external project is built and installed under the specified prefix:

       TMP_DIR      = <prefix>/tmp
       STAMP_DIR    = <prefix>/src/<name>-stamp
       DOWNLOAD_DIR = <prefix>/src
       SOURCE_DIR   = <prefix>/src/<name>
       BINARY_DIR   = <prefix>/src/<name>-build
       INSTALL_DIR  = <prefix>

    Otherwise, if the EP_BASE directory property is set then components of an external project are stored under the specified base:

       TMP_DIR      = <base>/tmp/<name>
       STAMP_DIR    = <base>/Stamp/<name>
       DOWNLOAD_DIR = <base>/Download/<name>
       SOURCE_DIR   = <base>/Source/<name>
       BINARY_DIR   = <base>/Build/<name>
       INSTALL_DIR  = <base>/Install/<name>

    If no PREFIX, EP_PREFIX, or EP_BASE is specified then the default is to set PREFIX to "<name>-prefix". Relative paths are interpreted with respect to the build directory corresponding to the source directory in which ExternalProject_Add is invoked.

    If SOURCE_DIR is explicitly set to an existing directory the project will be built from it. Otherwise a download step must be specified using one of the DOWNLOAD_COMMAND, CVS_*, SVN_*, or URL options. The URL option may refer locally to a directory or source tarball, or refer to a remote tarball (e.g. http://.../src.tgz).

    The 'ExternalProject_Add_Step' function adds a custom step to an external project:

      ExternalProject_Add_Step(<name> <step> # Names of project and custom step
        [COMMAND cmd...]        # Command line invoked by this step
        [COMMENT "text..."]     # Text printed when step executes
        [DEPENDEES steps...]    # Steps on which this step depends
        [DEPENDERS steps...]    # Steps that depend on this step
        [DEPENDS files...]      # Files on which this step depends
        [ALWAYS 1]              # No stamp file, step always runs
        [WORKING_DIRECTORY dir] # Working directory for command
        )

    The command line, comment, and working directory of every standard and custom step is processed to replace tokens <SOURCE_DIR>, <BINARY_DIR>, <INSTALL_DIR>, and <TMP_DIR> with corresponding property values.

    The 'ExternalProject_Get_Property' function retrieves external project target properties:

      ExternalProject_Get_Property(<name> [prop1 [prop2 [...]]])

    It stores property values in variables of the same name. Property names correspond to the keyword argument names of 'ExternalProject_Add'.

  • FeatureSummary: Macros for generating a summary of enabled/disabled features


    PRINT_ENABLED_FEATURES()

       Print a summary of all enabled features. By default all successfull
       FIND_PACKAGE() calls will appear here, except the ones which used the
       QUIET keyword. Additional features can be added by appending an entry
       to the global ENABLED_FEATURES property. If SET_FEATURE_INFO() is
       used for that feature, the output will be much more informative.


    PRINT_DISABLED_FEATURES()

       Same as PRINT_ENABLED_FEATURES(), but for disabled features. It can
       be extended the same way by adding to the global property 
       DISABLED_FEATURES.


    SET_FEATURE_INFO(NAME DESCRIPTION [URL [COMMENT] ] )

        Use this macro to set up information about the named feature, which will
        then be displayed by PRINT_ENABLED/DISABLED_FEATURES().
        Example: SET_FEATURE_INFO(LibXml2 "XML processing library." 
        "http://xmlsoft.org/")


  • FindALSA: Find alsa

    Find the alsa libraries (asound)

      This module defines the following variables:
         ALSA_FOUND       - True if ALSA_INCLUDE_DIR & ALSA_LIBRARY are found
         ALSA_LIBRARIES   - Set when ALSA_LIBRARY is found
         ALSA_INCLUDE_DIRS - Set when ALSA_INCLUDE_DIR is found


         ALSA_INCLUDE_DIR - where to find asoundlib.h, etc.
         ALSA_LIBRARY     - the asound library


  • FindASPELL: Try to find ASPELL

    Once done this will define

      ASPELL_FOUND - system has ASPELL
      ASPELL_INCLUDE_DIR - the ASPELL include directory
      ASPELL_LIBRARIES - The libraries needed to use ASPELL
      ASPELL_DEFINITIONS - Compiler switches required for using ASPELL
  • FindAVIFile: Locate AVIFILE library and include paths

    AVIFILE (http://avifile.sourceforge.net/)is a set of libraries for i386 machines to use various AVI codecs. Support is limited beyond Linux. Windows provides native AVI support, and so doesn't need this library. This module defines

      AVIFILE_INCLUDE_DIR, where to find avifile.h , etc.
      AVIFILE_LIBRARIES, the libraries to link against
      AVIFILE_DEFINITIONS, definitions to use when compiling
      AVIFILE_FOUND, If false, don't try to use AVIFILE
  • FindBISON: Find bison executable and provides macros to generate custom build rules

    The module defines the following variables:

      BISON_EXECUTABLE - path to the bison program
      BISON_VERSION - version of bison
      BISON_FOUND - true if the program was found


    If bison is found, the module defines the macros:

      BISON_TARGET(<Name> <YaccInput> <CodeOutput> [VERBOSE <file>]
                  [COMPILE_FLAGS <string>])

    which will create a custom rule to generate a parser. <YaccInput> is the path to a yacc file. <CodeOutput> is the name of the source file generated by bison. A header file is also be generated, and contains the token list. If COMPILE_FLAGS option is specified, the next parameter is added in the bison command line. if VERBOSE option is specified, <file> is created and contains verbose descriptions of the grammar and parser. The macro defines a set of variables:

      BISON_${Name}_DEFINED - true is the macro ran successfully
      BISON_${Name}_INPUT - The input source file, an alias for <YaccInput>
      BISON_${Name}_OUTPUT_SOURCE - The source file generated by bison
      BISON_${Name}_OUTPUT_HEADER - The header file generated by bison
      BISON_${Name}_OUTPUTS - The sources files generated by bison
      BISON_${Name}_COMPILE_FLAGS - Options used in the bison command line


      ====================================================================
      Example:


       find_package(BISON)
       BISON_TARGET(MyParser parser.y ${CMAKE_CURRENT_BINARY_DIR}/parser.cpp)
       add_executable(Foo main.cpp ${BISON_MyParser_OUTPUTS})
      ====================================================================
  • FindBLAS: Find BLAS library

    This module finds an installed fortran library that implements the BLAS linear-algebra interface (see http://www.netlib.org/blas/). The list of libraries searched for is taken from the autoconf macro file, acx_blas.m4 (distributed at http://ac-archive.sourceforge.net/ac-archive/acx_blas.html).

    This module sets the following variables:

      BLAS_FOUND - set to true if a library implementing the BLAS interface
        is found
      BLAS_LINKER_FLAGS - uncached list of required linker flags (excluding -l
        and -L).
      BLAS_LIBRARIES - uncached list of libraries (using full path name) to
        link against to use BLAS
      BLAS95_LIBRARIES - uncached list of libraries (using full path name)
        to link against to use BLAS95 interface
      BLAS95_FOUND - set to true if a library implementing the BLAS f95 interface
        is found
      BLA_STATIC  if set on this determines what kind of linkage we do (static)
      BLA_VENDOR  if set checks only the specified vendor, if not set checks
         all the possibilities
      BLA_F95     if set on tries to find the f95 interfaces for BLAS/LAPACK

    ######### ## List of vendors (BLA_VENDOR) valid in this module # ATLAS, PhiPACK,CXML,DXML,SunPerf,SCSL,SGIMATH,IBMESSL,Intel10_32 (intel mkl v10 32 bit),Intel10_64lp (intel mkl v10 64 bit,lp thread model, lp64 model), # Intel( older versions of mkl 32 and 64 bit), ACML,Apple, NAS, Generic C/CXX should be enabled to use Intel mkl

  • FindBZip2: Try to find BZip2

    Once done this will define

      BZIP2_FOUND - system has BZip2
      BZIP2_INCLUDE_DIR - the BZip2 include directory
      BZIP2_LIBRARIES - Link these to use BZip2
      BZIP2_DEFINITIONS - Compiler switches required for using BZip2
      BZIP2_NEED_PREFIX - this is set if the functions are prefixed with BZ2_
  • FindBoost: Try to find Boost include dirs and libraries

    Usage of this module as follows:

    NOTE: Take note of the Boost_ADDITIONAL_VERSIONS variable below. Due to Boost naming conventions and limitations in CMake this find module is NOT future safe with respect to Boost version numbers, and may break.

    == Using Header-Only libraries from within Boost: ==

       find_package( Boost 1.36.0 )
       if(Boost_FOUND)
          include_directories(${Boost_INCLUDE_DIRS})
          add_executable(foo foo.cc)
       endif()



    == Using actual libraries from within Boost: ==

       set(Boost_USE_STATIC_LIBS   ON)
       set(Boost_USE_MULTITHREADED ON)
       find_package( Boost 1.36.0 COMPONENTS date_time filesystem system ... )


       if(Boost_FOUND)
          include_directories(${Boost_INCLUDE_DIRS})
          add_executable(foo foo.cc)
          target_link_libraries(foo ${Boost_LIBRARIES})
       endif()



    The components list needs to contain actual names of boost libraries only, such as "date_time" for "libboost_date_time". If you're using parts of Boost that contain header files only (e.g. foreach) you do not need to specify COMPONENTS.

    You should provide a minimum version number that should be used. If you provide this version number and specify the REQUIRED attribute, this module will fail if it can't find the specified or a later version. If you specify a version number this is automatically put into the considered list of version numbers and thus doesn't need to be specified in the Boost_ADDITIONAL_VERSIONS variable (see below).

    NOTE for Visual Studio Users:

         Automatic linking is used on MSVC & Borland compilers by default when
         #including things in Boost.  It's important to note that setting
         Boost_USE_STATIC_LIBS to OFF is NOT enough to get you dynamic linking,
         should you need this feature.  Automatic linking typically uses static
         libraries with a few exceptions (Boost.Python is one).


         Please see the section below near Boost_LIB_DIAGNOSTIC_DEFINITIONS for
         more details.  Adding a TARGET_LINK_LIBRARIES() as shown in the example
         above appears to cause VS to link dynamically if Boost_USE_STATIC_LIBS
         gets set to OFF.  It is suggested you avoid automatic linking since it
         will make your application less portable.


    =========== The mess that is Boost_ADDITIONAL_VERSIONS (sorry?) ============

    OK, so the Boost_ADDITIONAL_VERSIONS variable can be used to specify a list of boost version numbers that should be taken into account when searching for Boost. Unfortunately boost puts the version number into the actual filename for the libraries, so this variable will certainly be needed in the future when new Boost versions are released.

    Currently this module searches for the following version numbers: 1.33, 1.33.0, 1.33.1, 1.34, 1.34.0, 1.34.1, 1.35, 1.35.0, 1.35.1, 1.36, 1.36.0, 1.36.1, 1.37, 1.37.0, 1.38, 1.38.0, 1.39, 1.39.0, 1.40, 1.40.0

    NOTE: If you add a new major 1.x version in Boost_ADDITIONAL_VERSIONS you should add both 1.x and 1.x.0 as shown above. Official Boost include directories omit the 3rd version number from include paths if it is 0 although not all binary Boost releases do so.

    SET(Boost_ADDITIONAL_VERSIONS "1.78" "1.78.0" "1.79" "1.79.0")

    ===================================== ============= ========================

    Variables used by this module, they can change the default behaviour and need to be set before calling find_package:

       Boost_USE_MULTITHREADED      Can be set to OFF to use the non-multithreaded
                                    boost libraries.  If not specified, defaults
                                    to ON.


       Boost_USE_STATIC_LIBS        Can be set to ON to force the use of the static
                                    boost libraries. Defaults to OFF.


    Other Variables used by this module which you may want to set.

       Boost_ADDITIONAL_VERSIONS    A list of version numbers to use for searching
                                    the boost include directory.  Please see
                                    the documentation above regarding this
                                    annoying, but necessary variable :(


       Boost_DEBUG                  Set this to TRUE to enable debugging output
                                    of FindBoost.cmake if you are having problems.
                                    Please enable this before filing any bug
                                    reports.


       Boost_DETAILED_FAILURE_MSG   FindBoost doesn't output detailed information
                                    about why it failed or how to fix the problem
                                    unless this is set to TRUE or the REQUIRED
                                    keyword is specified in find_package().
                                      [Since CMake 2.8.0]


       Boost_COMPILER               Set this to the compiler suffix used by Boost
                                    (e.g. "-gcc43") if FindBoost has problems finding
                                    the proper Boost installation


    These last three variables are available also as environment variables:

       BOOST_ROOT or BOOSTROOT      The preferred installation prefix for searching for
                                    Boost.  Set this if the module has problems finding
                                    the proper Boost installation.


       BOOST_INCLUDEDIR             Set this to the include directory of Boost, if the
                                    module has problems finding the proper Boost installation


       BOOST_LIBRARYDIR             Set this to the lib directory of Boost, if the
                                    module has problems finding the proper Boost installation


    Variables defined by this module:

       Boost_FOUND                         System has Boost, this means the include dir was
                                           found, as well as all the libraries specified in
                                           the COMPONENTS list.


       Boost_INCLUDE_DIRS                  Boost include directories: not cached


       Boost_INCLUDE_DIR                   This is almost the same as above, but this one is
                                           cached and may be modified by advanced users


       Boost_LIBRARIES                     Link to these to use the Boost libraries that you
                                           specified: not cached


       Boost_LIBRARY_DIRS                  The path to where the Boost library files are.


       Boost_VERSION                       The version number of the boost libraries that
                                           have been found, same as in version.hpp from Boost


       Boost_LIB_VERSION                   The version number in filename form as
                                           it's appended to the library filenames


       Boost_MAJOR_VERSION                 major version number of boost
       Boost_MINOR_VERSION                 minor version number of boost
       Boost_SUBMINOR_VERSION              subminor version number of boost


       Boost_LIB_DIAGNOSTIC_DEFINITIONS    [WIN32 Only] You can call
                                           add_definitions(${Boost_LIB_DIAGNOSTIC_DEFINITIONS})
                                           to have diagnostic information about Boost's
                                           automatic linking outputted during compilation time.


    For each component you specify in find_package(), the following (UPPER-CASE) variables are set. You can use these variables if you would like to pick and choose components for your targets instead of just using Boost_LIBRARIES.

       Boost_${COMPONENT}_FOUND            True IF the Boost library "component" was found.


       Boost_${COMPONENT}_LIBRARY          Contains the libraries for the specified Boost
                                           "component" (includes debug and optimized keywords
                                           when needed).
  • FindBullet: Try to find the Bullet physics engine


      This module defines the following variables


      BULLET_FOUND - Was bullet found
      BULLET_INCLUDE_DIRS - the Bullet include directories
      BULLET_LIBRARIES - Link to this, by default it includes
                         all bullet components (Dynamics,
                         Collision, LinearMath, & SoftBody)


      This module accepts the following variables


      BULLET_ROOT - Can be set to bullet install path or Windows build path


  • FindCABLE: Find CABLE

    This module finds if CABLE is installed and determines where the include files and libraries are. This code sets the following variables:

      CABLE             the path to the cable executable
      CABLE_TCL_LIBRARY the path to the Tcl wrapper library
      CABLE_INCLUDE_DIR the path to the include directory


    To build Tcl wrappers, you should add shared library and link it to ${CABLE_TCL_LIBRARY}. You should also add ${CABLE_INCLUDE_DIR} as an include directory.

  • FindCUDA: Tools for building CUDA C files: libraries and build dependencies.

    This script locates the NVIDIA CUDA C tools. It should work on linux, windows, and mac and should be reasonably up to date with CUDA C releases.

    This script makes use of the standard find_package arguments of <VERSION>, REQUIRED and QUIET. CUDA_FOUND will report if an acceptable version of CUDA was found.

    The script will prompt the user to specify CUDA_TOOLKIT_ROOT_DIR if the prefix cannot be determined by the location of nvcc in the system path and REQUIRED is specified to find_package(). To use a different installed version of the toolkit set the environment variable CUDA_BIN_PATH before running cmake (e.g. CUDA_BIN_PATH=/usr/local/cuda1.0 instead of the default /usr/local/cuda) or set CUDA_TOOLKIT_ROOT_DIR after configuring. If you change the value of CUDA_TOOLKIT_ROOT_DIR, various components that depend on the path will be relocated.

    It might be necessary to set CUDA_TOOLKIT_ROOT_DIR manually on certain platforms, or to use a cuda runtime not installed in the default location. In newer versions of the toolkit the cuda library is included with the graphics driver- be sure that the driver version matches what is needed by the cuda runtime version.

    The following variables affect the behavior of the macros in the script (in alphebetical order). Note that any of these flags can be changed multiple times in the same directory before calling CUDA_ADD_EXECUTABLE, CUDA_ADD_LIBRARY, CUDA_COMPILE, CUDA_COMPILE_PTX or CUDA_WRAP_SRCS.

      CUDA_64_BIT_DEVICE_CODE (Default matches host bit size)
      -- Set to ON to compile for 64 bit device code, OFF for 32 bit device code.
         Note that making this different from the host code when generating object
         or C files from CUDA code just won't work, because size_t gets defined by
         nvcc in the generated source.  If you compile to PTX and then load the
         file yourself, you can mix bit sizes between device and host.


      CUDA_ATTACH_VS_BUILD_RULE_TO_CUDA_FILE (Default ON)
      -- Set to ON if you want the custom build rule to be attached to the source
         file in Visual Studio.  Turn OFF if you add the same cuda file to multiple
         targets.


         This allows the user to build the target from the CUDA file; however, bad
         things can happen if the CUDA source file is added to multiple targets.
         When performing parallel builds it is possible for the custom build
         command to be run more than once and in parallel causing cryptic build
         errors.  VS runs the rules for every source file in the target, and a
         source can have only one rule no matter how many projects it is added to.
         When the rule is run from multiple targets race conditions can occur on
         the generated file.  Eventually everything will get built, but if the user
         is unaware of this behavior, there may be confusion.  It would be nice if
         this script could detect the reuse of source files across multiple targets
         and turn the option off for the user, but no good solution could be found.


      CUDA_BUILD_CUBIN (Default OFF)
      -- Set to ON to enable and extra compilation pass with the -cubin option in
         Device mode. The output is parsed and register, shared memory usage is
         printed during build.


      CUDA_BUILD_EMULATION (Default OFF for device mode)
      -- Set to ON for Emulation mode. -D_DEVICEEMU is defined for CUDA C files
         when CUDA_BUILD_EMULATION is TRUE.


      CUDA_GENERATED_OUTPUT_DIR (Default CMAKE_CURRENT_BINARY_DIR)
      -- Set to the path you wish to have the generated files placed.  If it is
         blank output files will be placed in CMAKE_CURRENT_BINARY_DIR.
         Intermediate files will always be placed in
         CMAKE_CURRENT_BINARY_DIR/CMakeFiles.


      CUDA_HOST_COMPILATION_CPP (Default ON)
      -- Set to OFF for C compilation of host code.


      CUDA_NVCC_FLAGS
      CUDA_NVCC_FLAGS_<CONFIG>
      -- Additional NVCC command line arguments.  NOTE: multiple arguments must be
         semi-colon delimited (e.g. --compiler-options;-Wall)


      CUDA_PROPAGATE_HOST_FLAGS (Default ON)
      -- Set to ON to propagate CMAKE_{C,CXX}_FLAGS and their configuration
         dependent counterparts (e.g. CMAKE_C_FLAGS_DEBUG) automatically to the
         host compiler through nvcc's -Xcompiler flag.  This helps make the
         generated host code match the rest of the system better.  Sometimes
         certain flags give nvcc problems, and this will help you turn the flag
         propagation off.  This does not affect the flags supplied directly to nvcc
         via CUDA_NVCC_FLAGS or through the OPTION flags specified through
         CUDA_ADD_LIBRARY, CUDA_ADD_EXECUTABLE, or CUDA_WRAP_SRCS.  Flags used for
         shared library compilation are not affected by this flag.


      CUDA_VERBOSE_BUILD (Default OFF)
      -- Set to ON to see all the commands used when building the CUDA file.  When
         using a Makefile generator the value defaults to VERBOSE (run make
         VERBOSE=1 to see output), although setting CUDA_VERBOSE_BUILD to ON will
         always print the output.


    The script creates the following macros (in alphebetical order):

      CUDA_ADD_CUFFT_TO_TARGET( cuda_target )
      -- Adds the cufft library to the target (can be any target).  Handles whether
         you are in emulation mode or not.


      CUDA_ADD_CUBLAS_TO_TARGET( cuda_target )
      -- Adds the cublas library to the target (can be any target).  Handles
         whether you are in emulation mode or not.


      CUDA_ADD_EXECUTABLE( cuda_target file0 file1 ...
                           [WIN32] [MACOSX_BUNDLE] [EXCLUDE_FROM_ALL] [OPTIONS ...] )
      -- Creates an executable "cuda_target" which is made up of the files
         specified.  All of the non CUDA C files are compiled using the standard
         build rules specified by CMAKE and the cuda files are compiled to object
         files using nvcc and the host compiler.  In addition CUDA_INCLUDE_DIRS is
         added automatically to include_directories().  Standard CMake target calls
         can be used on the target after calling this macro
         (e.g. set_target_properties and target_link_libraries).


      CUDA_ADD_LIBRARY( cuda_target file0 file1 ...
                        [STATIC | SHARED | MODULE] [EXCLUDE_FROM_ALL] [OPTIONS ...] )
      -- Same as CUDA_ADD_EXECUTABLE except that a library is created.


      CUDA_BUILD_CLEAN_TARGET()
      -- Creates a convience target that deletes all the dependency files
         generated.  You should make clean after running this target to ensure the
         dependency files get regenerated.


      CUDA_COMPILE( generated_files file0 file1 ... [STATIC | SHARED | MODULE]
                    [OPTIONS ...] )
      -- Returns a list of generated files from the input source files to be used
         with ADD_LIBRARY or ADD_EXECUTABLE.


      CUDA_COMPILE_PTX( generated_files file0 file1 ... [OPTIONS ...] )
      -- Returns a list of PTX files generated from the input source files.


      CUDA_INCLUDE_DIRECTORIES( path0 path1 ... )
      -- Sets the directories that should be passed to nvcc
         (e.g. nvcc -Ipath0 -Ipath1 ... ). These paths usually contain other .cu
         files.


      CUDA_WRAP_SRCS ( cuda_target format generated_files file0 file1 ...
                       [STATIC | SHARED | MODULE] [OPTIONS ...] )
      -- This is where all the magic happens.  CUDA_ADD_EXECUTABLE,
         CUDA_ADD_LIBRARY, CUDA_COMPILE, and CUDA_COMPILE_PTX all call this
         function under the hood.


         Given the list of files (file0 file1 ... fileN) this macro generates
         custom commands that generate either PTX or linkable objects (use "PTX" or
         "OBJ" for the format argument to switch).  Files that don't end with .cu
         or have the HEADER_FILE_ONLY property are ignored.


         The arguments passed in after OPTIONS are extra command line options to
         give to nvcc.  You can also specify per configuration options by
         specifying the name of the configuration followed by the options.  General
         options must preceed configuration specific options.  Not all
         configurations need to be specified, only the ones provided will be used.


            OPTIONS -DFLAG=2 "-DFLAG_OTHER=space in flag"
            DEBUG -g
            RELEASE --use_fast_math
            RELWITHDEBINFO --use_fast_math;-g
            MINSIZEREL --use_fast_math


         For certain configurations (namely VS generating object files with
         CUDA_ATTACH_VS_BUILD_RULE_TO_CUDA_FILE set to ON), no generated file will
         be produced for the given cuda file.  This is because when you add the
         cuda file to Visual Studio it knows that this file produces an object file
         and will link in the resulting object file automatically.


         This script will also generate a separate cmake script that is used at
         build time to invoke nvcc.  This is for serveral reasons.


           1. nvcc can return negative numbers as return values which confuses
           Visual Studio into thinking that the command succeeded.  The script now
           checks the error codes and produces errors when there was a problem.


           2. nvcc has been known to not delete incomplete results when it
           encounters problems.  This confuses build systems into thinking the
           target was generated when in fact an unusable file exists.  The script
           now deletes the output files if there was an error.


           3. By putting all the options that affect the build into a file and then
           make the build rule dependent on the file, the output files will be
           regenerated when the options change.


         This script also looks at optional arguments STATIC, SHARED, or MODULE to
         determine when to target the object compilation for a shared library.
         BUILD_SHARED_LIBS is ignored in CUDA_WRAP_SRCS, but it is respected in
         CUDA_ADD_LIBRARY.  On some systems special flags are added for building
         objects intended for shared libraries.  A preprocessor macro,
         <target_name>_EXPORTS is defined when a shared library compilation is
         detected.


         Flags passed into add_definitions with -D or /D are passed along to nvcc.


    The script defines the following variables:

      CUDA_VERSION_MAJOR    -- The major version of cuda as reported by nvcc.
      CUDA_VERSION_MINOR    -- The minor version.
      CUDA_VERSION
      CUDA_VERSION_STRING   -- CUDA_VERSION_MAJOR.CUDA_VERSION_MINOR


      CUDA_TOOLKIT_ROOT_DIR -- Path to the CUDA Toolkit (defined if not set).
      CUDA_SDK_ROOT_DIR     -- Path to the CUDA SDK.  Use this to find files in the
                               SDK.  This script will not directly support finding
                               specific libraries or headers, as that isn't
                               supported by NVIDIA.  If you want to change
                               libraries when the path changes see the
                               FindCUDA.cmake script for an example of how to clear
                               these variables.  There are also examples of how to
                               use the CUDA_SDK_ROOT_DIR to locate headers or
                               libraries, if you so choose (at your own risk).
      CUDA_INCLUDE_DIRS     -- Include directory for cuda headers.  Added automatically
                               for CUDA_ADD_EXECUTABLE and CUDA_ADD_LIBRARY.
      CUDA_LIBRARIES        -- Cuda RT library.
      CUDA_CUFFT_LIBRARIES  -- Device or emulation library for the Cuda FFT
                               implementation (alternative to:
                               CUDA_ADD_CUFFT_TO_TARGET macro)
      CUDA_CUBLAS_LIBRARIES -- Device or emulation library for the Cuda BLAS
                               implementation (alterative to:
                               CUDA_ADD_CUBLAS_TO_TARGET macro).



      James Bigler, NVIDIA Corp (nvidia.com - jbigler)
      Abe Stephens, SCI Institute -- http://www.sci.utah.edu/~abe/FindCuda.html


      Copyright (c) 2008 - 2009 NVIDIA Corporation.  All rights reserved.


      Copyright (c) 2007-2009
      Scientific Computing and Imaging Institute, University of Utah


      This code is licensed under the MIT License.  See the FindCUDA.cmake script
      for the text of the license.
  • FindCURL: Find curl

    Find the native CURL headers and libraries.

      CURL_INCLUDE_DIRS - where to find curl/curl.h, etc.
      CURL_LIBRARIES    - List of libraries when using curl.
      CURL_FOUND        - True if curl found.
  • FindCVS:

    The module defines the following variables:

       CVS_EXECUTABLE - path to cvs command line client
       CVS_FOUND - true if the command line client was found

    Example usage:

       find_package(CVS)
       if(CVS_FOUND)
         message("CVS found: ${CVS_EXECUTABLE}")
       endif(CVS_FOUND)
  • FindCoin3D: Find Coin3D (Open Inventor)

    Coin3D is an implementation of the Open Inventor API. It provides data structures and algorithms for 3D visualization http://www.coin3d.org/

    This module defines the following variables

      COIN3D_FOUND         - system has Coin3D - Open Inventor
      COIN3D_INCLUDE_DIRS  - where the Inventor include directory can be found
      COIN3D_LIBRARIES     - Link to this to use Coin3D


  • FindCups: Try to find the Cups printing system

    Once done this will define

      CUPS_FOUND - system has Cups
      CUPS_INCLUDE_DIR - the Cups include directory
      CUPS_LIBRARIES - Libraries needed to use Cups
      Set CUPS_REQUIRE_IPP_DELETE_ATTRIBUTE to TRUE if you need a version which 
      features this function (i.e. at least 1.1.19)
  • FindCurses: Find the curses include file and library


      CURSES_FOUND - system has Curses
      CURSES_INCLUDE_DIR - the Curses include directory
      CURSES_LIBRARIES - The libraries needed to use Curses
      CURSES_HAVE_CURSES_H - true if curses.h is available
      CURSES_HAVE_NCURSES_H - true if ncurses.h is available
      CURSES_HAVE_NCURSES_NCURSES_H - true if ncurses/ncurses.h is available
      CURSES_HAVE_NCURSES_CURSES_H - true if ncurses/curses.h is available
      CURSES_LIBRARY - set for backwards compatibility with 2.4 CMake


    Set CURSES_NEED_NCURSES to TRUE before the FIND_PACKAGE() command if NCurses functionality is required.

  • FindCxxTest: Find CxxTest

    Find the CxxTest suite and declare a helper macro for creating unit tests and integrating them with CTest. For more details on CxxTest see http://cxxtest.tigris.org

    INPUT Variables

       CXXTEST_USE_PYTHON
           If true, the CXXTEST_ADD_TEST macro will use
           the Python test generator instead of Perl.


    OUTPUT Variables

       CXXTEST_FOUND
           True if the CxxTest framework was found
       CXXTEST_INCLUDE_DIR
           Where to find the CxxTest include directory
       CXXTEST_PERL_TESTGEN_EXECUTABLE
           The perl-based test generator.
       CXXTEST_PYTHON_TESTGEN_EXECUTABLE
           The python-based test generator.


    MACROS for optional use by CMake users:

        CXXTEST_ADD_TEST(<test_name> <gen_source_file> <input_files_to_testgen...>)
           Creates a CxxTest runner and adds it to the CTest testing suite
           Parameters:
               test_name               The name of the test
               gen_source_file         The generated source filename to be generated by CxxTest
               input_files_to_testgen  The list of header files containing the
                                       CxxTest::TestSuite's to be included in this runner
               
           #==============
           Example Usage:


               find_package(CxxTest)
               if(CXXTEST_FOUND)
                   include_directories(${CXXTEST_INCLUDE_DIR})
                   enable_testing()


                   CXXTEST_ADD_TEST(unittest_foo foo_test.cc
                                     ${CMAKE_CURRENT_SOURCE_DIR}/foo_test.h)
                   target_link_libraries(unittest_foo foo) # as needed
               endif()


                  This will (if CxxTest is found):
                  1. Invoke the testgen executable to autogenerate foo_test.cc in the
                     binary tree from "foo_test.h" in the current source directory.
                  2. Create an executable and test called unittest_foo.
                   
          #=============
          Example foo_test.h:


              #include <cxxtest/TestSuite.h>
              
              class MyTestSuite : public CxxTest::TestSuite 
              {
              public:
                 void testAddition( void )
                 {
                    TS_ASSERT( 1 + 1 > 1 );
                    TS_ASSERT_EQUALS( 1 + 1, 2 );
                 }
              };


  • FindCygwin: this module looks for Cygwin


  • FindDCMTK: find DCMTK libraries


  • FindDart: Find DART

    This module looks for the dart testing software and sets DART_ROOT to point to where it found it.

  • FindDevIL:

    This module locates the developer's image library. http://openil.sourceforge.net/

    This module sets: IL_LIBRARIES the name of the IL library. These include the full path to the core DevIL library. This one has to be linked into the application. ILU_LIBRARIES the name of the ILU library. Again, the full path. This library is for filters and effects, not actual loading. It doesn't have to be linked if the functionality it provides is not used. ILUT_LIBRARIES the name of the ILUT library. Full path. This part of the library interfaces with OpenGL. It is not strictly needed in applications. IL_INCLUDE_DIR where to find the il.h, ilu.h and ilut.h files. IL_FOUND this is set to TRUE if all the above variables were set. This will be set to false if ILU or ILUT are not found, even if they are not needed. In most systems, if one library is found all the others are as well. That's the way the DevIL developers release it.

  • FindDoxygen: This module looks for Doxygen and the path to Graphviz's dot

    Doxygen is a documentation generation tool. Please see http://www.doxygen.org

    This module accepts the following optional variables:

       DOXYGEN_SKIP_DOT       = If true this module will skip trying to find Dot
                                (an optional component often used by Doxygen)


    This modules defines the following variables:

       DOXYGEN_EXECUTABLE     = The path to the doxygen command.
       DOXYGEN_FOUND          = Was Doxygen found or not?


       DOXYGEN_DOT_EXECUTABLE = The path to the dot program used by doxygen.
       DOXYGEN_DOT_FOUND      = Was Dot found or not?
       DOXYGEN_DOT_PATH       = The path to dot not including the executable



  • FindEXPAT: Find expat

    Find the native EXPAT headers and libraries.

      EXPAT_INCLUDE_DIRS - where to find expat.h, etc.
      EXPAT_LIBRARIES    - List of libraries when using expat.
      EXPAT_FOUND        - True if expat found.
  • FindFLEX: Find flex executable and provides a macro to generate custom build rules


    The module defines the following variables:

      FLEX_FOUND - true is flex executable is found
      FLEX_EXECUTABLE - the path to the flex executable
      FLEX_VERSION - the version of flex
      FLEX_LIBRARIES - The flex libraries


    If flex is found on the system, the module provides the macro:

      FLEX_TARGET(Name FlexInput FlexOutput [COMPILE_FLAGS <string>])

    which creates a custom command to generate the <FlexOutput> file from the <FlexInput> file. If COMPILE_FLAGS option is specified, the next parameter is added to the flex command line. Name is an alias used to get details of this custom command. Indeed the macro defines the following variables:

      FLEX_${Name}_DEFINED - true is the macro ran successfully
      FLEX_${Name}_OUTPUTS - the source file generated by the custom rule, an
      alias for FlexOutput
      FLEX_${Name}_INPUT - the flex source file, an alias for ${FlexInput}


    Flex scanners oftenly use tokens defined by Bison: the code generated by Flex depends of the header generated by Bison. This module also defines a macro:

      ADD_FLEX_BISON_DEPENDENCY(FlexTarget BisonTarget)

    which adds the required dependency between a scanner and a parser where <FlexTarget> and <BisonTarget> are the first parameters of respectively FLEX_TARGET and BISON_TARGET macros.

      ====================================================================
      Example:


       find_package(BISON)
       find_package(FLEX)


       BISON_TARGET(MyParser parser.y ${CMAKE_CURRENT_BINARY_DIR}/parser.cpp
       FLEX_TARGET(MyScanner lexer.l  ${CMAKE_CURRENT_BIANRY_DIR}/lexer.cpp)
       ADD_FLEX_BISON_DEPENDENCY(MyScanner MyParser)


       include_directories(${CMAKE_CURRENT_BINARY_DIR})
       add_executable(Foo
          Foo.cc
          ${BISON_MyParser_OUTPUTS}
          ${FLEX_MyScanner_OUTPUTS}
       )
      ====================================================================
  • FindFLTK: Find the native FLTK includes and library


    By default FindFLTK.cmake will search for all of the FLTK components and add them to the FLTK_LIBRARIES variable.

       You can limit the components which get placed in FLTK_LIBRARIES by
       defining one or more of the following three options:


         FLTK_SKIP_OPENGL, set to true to disable searching for opengl and
                           the FLTK GL library
         FLTK_SKIP_FORMS, set to true to disable searching for fltk_forms
         FLTK_SKIP_IMAGES, set to true to disable searching for fltk_images


         FLTK_SKIP_FLUID, set to true if the fluid binary need not be present
                          at build time


    The following variables will be defined:

         FLTK_FOUND, True if all components not skipped were found
         FLTK_INCLUDE_DIR, where to find include files
         FLTK_LIBRARIES, list of fltk libraries you should link against
         FLTK_FLUID_EXECUTABLE, where to find the Fluid tool
         FLTK_WRAP_UI, This enables the FLTK_WRAP_UI command


    The following cache variables are assigned but should not be used. See the FLTK_LIBRARIES variable instead.

         FLTK_BASE_LIBRARY   = the full path to fltk.lib
         FLTK_GL_LIBRARY     = the full path to fltk_gl.lib
         FLTK_FORMS_LIBRARY  = the full path to fltk_forms.lib
         FLTK_IMAGES_LIBRARY = the full path to fltk_images.lib
  • FindFLTK2: Find the native FLTK2 includes and library

    The following settings are defined

      FLTK2_FLUID_EXECUTABLE, where to find the Fluid tool
      FLTK2_WRAP_UI, This enables the FLTK2_WRAP_UI command
      FLTK2_INCLUDE_DIR, where to find include files
      FLTK2_LIBRARIES, list of fltk2 libraries
      FLTK2_FOUND, Don't use FLTK2 if false.

    The following settings should not be used in general.

      FLTK2_BASE_LIBRARY   = the full path to fltk2.lib
      FLTK2_GL_LIBRARY     = the full path to fltk2_gl.lib
      FLTK2_IMAGES_LIBRARY = the full path to fltk2_images.lib
  • FindFreetype: Locate FreeType library

    This module defines

      FREETYPE_LIBRARIES, the library to link against
      FREETYPE_FOUND, if false, do not try to link to FREETYPE
      FREETYPE_INCLUDE_DIRS, where to find headers.
      This is the concatenation of the paths:
      FREETYPE_INCLUDE_DIR_ft2build
      FREETYPE_INCLUDE_DIR_freetype2


    $FREETYPE_DIR is an environment variable that would correspond to the ./configure --prefix=$FREETYPE_DIR used in building FREETYPE.

  • FindGCCXML: Find the GCC-XML front-end executable.
  • FindGDAL:

    Locate gdal

    This module accepts the following environment variables:

        GDAL_DIR or GDAL_ROOT - Specify the location of GDAL


    This module defines the following CMake variables:

        GDAL_FOUND - True if libgdal is found
        GDAL_LIBRARY - A variable pointing to the GDAL library
        GDAL_INCLUDE_DIR - Where to find the headers
  • FindGIF:

    This module defines GIF_LIBRARIES - libraries to link to in order to use GIF GIF_FOUND, if false, do not try to link GIF_INCLUDE_DIR, where to find the headers

    $GIF_DIR is an environment variable that would correspond to the ./configure --prefix=$GIF_DIR

  • FindGLUT: try to find glut library and include files
      GLUT_INCLUDE_DIR, where to find GL/glut.h, etc.
      GLUT_LIBRARIES, the libraries to link against
      GLUT_FOUND, If false, do not try to use GLUT.

    Also defined, but not for general use are:

      GLUT_glut_LIBRARY = the full path to the glut library.
      GLUT_Xmu_LIBRARY  = the full path to the Xmu library.
      GLUT_Xi_LIBRARY   = the full path to the Xi Library.
  • FindGTK: try to find GTK (and glib) and GTKGLArea
      GTK_INCLUDE_DIR   - Directories to include to use GTK
      GTK_LIBRARIES     - Files to link against to use GTK
      GTK_FOUND         - GTK was found
      GTK_GL_FOUND      - GTK's GL features were found
  • FindGTK2: FindGTK2.cmake

    This module can find the GTK2 widget libraries and several of its other optional components like gtkmm, glade, and glademm.

    NOTE: If you intend to use version checking, CMake 2.6.2 or later is

           required.


    Specify one or more of the following components as you call this find module. See example below.

       gtk
       gtkmm
       glade
       glademm


    The following variables will be defined for your use

       GTK2_FOUND - Were all of your specified components found?
       GTK2_INCLUDE_DIRS - All include directories
       GTK2_LIBRARIES - All libraries


       GTK2_VERSION - The version of GTK2 found (x.y.z)
       GTK2_MAJOR_VERSION - The major version of GTK2
       GTK2_MINOR_VERSION - The minor version of GTK2
       GTK2_PATCH_VERSION - The patch version of GTK2


    Optional variables you can define prior to calling this module:

       GTK2_DEBUG - Enables verbose debugging of the module
       GTK2_SKIP_MARK_AS_ADVANCED - Disable marking cache variables as advanced


    ================= Example Usage:

       Call find_package() once, here are some examples to pick from:


       Require GTK 2.6 or later
           find_package(GTK2 2.6 REQUIRED gtk)


       Require GTK 2.10 or later and Glade
           find_package(GTK2 2.10 REQUIRED gtk glade)


       Search for GTK/GTKMM 2.8 or later
           find_package(GTK2 2.8 COMPONENTS gtk gtkmm)


       if(GTK2_FOUND)
          include_directories(${GTK2_INCLUDE_DIRS})
          add_executable(mygui mygui.cc)
          target_link_libraries(mygui ${GTK2_LIBRARIES})
       endif()


  • FindGTest: --------------------

    Locate the Google C++ Testing Framework.

    Defines the following variables:

       GTEST_FOUND - Found the Google Testing framework
       GTEST_INCLUDE_DIRS - Include directories


    Also defines the library variables below as normal variables. These contain debug/optimized keywords when a debugging library is found.

       GTEST_BOTH_LIBRARIES - Both libgtest & libgtest-main
       GTEST_LIBRARIES - libgtest
       GTEST_MAIN_LIBRARIES - libgtest-main


    Accepts the following variables as input:

       GTEST_ROOT - (as CMake or env. variable)
                    The root directory of the gtest install prefix


       GTEST_MSVC_SEARCH - If on MSVC, enables searching the build tree of
                           GTest if set to MD or MT (defaults: MD)


    Example Usage:

        enable_testing(true)
        find_package(GTest REQUIRED)
        include_directories(${GTEST_INCLUDE_DIRS})


        add_executable(foo foo.cc)
        target_link_libraries(foo ${GTEST_BOTH_LIBRARIES})


        add_test(AllTestsInFoo foo)



    If you would like each Google test to show up in CTest as a test you may use the following macro. NOTE: It WILL slow down your tests, so be warned.

    GTEST_ADD_TESTS(executable extra_args ARGN)

        executable = The path to the test executable
        extra_args = Pass a list of extra arguments to be passed to
                     executable enclosed in quotes (or "" for none)
        ARGN =       A list of source files to search for tests & test
                     fixtures.


      Example:
         set(FooTestArgs --foo 1 --bar 2)
         add_executable(FooTest FooUnitTest.cc)
         GTEST_ADD_TESTS(FooTest "${FooTestArgs}" FooUnitTest.cc)
  • FindGettext: Find GNU gettext tools

    This module looks for the GNU gettext tools. This module defines the following values:

      GETTEXT_MSGMERGE_EXECUTABLE: the full path to the msgmerge tool.
      GETTEXT_MSGFMT_EXECUTABLE: the full path to the msgfmt tool.
      GETTEXT_FOUND: True if gettext has been found.


    Additionally it provides the following macros: GETTEXT_CREATE_TRANSLATIONS ( outputFile [ALL] file1 ... fileN )

        This will create a target "translations" which will convert the 
        given input po files into the binary output mo file. If the 
        ALL option is used, the translations will also be created when
        building the default target.
  • FindGnuTLS: Try to find the GNU Transport Layer Security library (gnutls)


    Once done this will define

      GNUTLS_FOUND - System has gnutls
      GNUTLS_INCLUDE_DIR - The gnutls include directory
      GNUTLS_LIBRARIES - The libraries needed to use gnutls
      GNUTLS_DEFINITIONS - Compiler switches required for using gnutls
  • FindGnuplot: this module looks for gnuplot


    Once done this will define

      GNUPLOT_FOUND - system has Gnuplot
      GNUPLOT_EXECUTABLE - the Gnuplot executable
  • FindHDF5: Find HDF5, a library for reading and writing self describing array data.


    This module invokes the HDF5 wrapper compiler that should be installed alongside HDF5. Depending upon the HDF5 Configuration, the wrapper compiler is called either h5cc or h5pcc. If this succeeds, the module will then call the compiler with the -show argument to see what flags are used when compiling an HDF5 client application.

    The module will optionally accept the COMPONENTS argument. If no COMPONENTS are specified, then the find module will default to finding only the HDF5 C library. If one or more COMPONENTS are specified, the module will attempt to find the language bindings for the specified components. Currently, the only valid components are C and CXX. The module does not yet support finding the Fortran bindings. If the COMPONENTS argument is not given, the module will attempt to find only the C bindings.

    On UNIX systems, this module will read the variable HDF5_USE_STATIC_LIBRARIES to determine whether or not to prefer a static link to a dynamic link for HDF5 and all of it's dependencies. To use this feature, make sure that the HDF5_USE_STATIC_LIBRARIES variable is set before the call to find_package.

    To provide the module with a hint about where to find your HDF5 installation, you can set the environment variable HDF5_ROOT. The Find module will then look in this path when searching for HDF5 executables, paths, and libraries.

    In addition to finding the includes and libraries required to compile an HDF5 client application, this module also makes an effort to find tools that come with the HDF5 distribution that may be useful for regression testing.

    This module will define the following variables:

      HDF5_INCLUDE_DIR - Location of the hdf5 includes
      HDF5_DEFINITIONS - Required compiler definitions for HDF5
      HDF5_C_LIBRARIES - Required libraries for the HDF5 C bindings.
      HDF5_CXX_LIBRARIES - Required libraries for the HDF5 C++ bindings
      HDF5_LIBRARIES - Required libraries for all requested bindings
      HDF5_FOUND - true if HDF5 was found on the system
      HDF5_LIBRARY_DIRS - the full set of library directories
      HDF5_IS_PARALLEL - Whether or not HDF5 was found with parallel IO support
      HDF5_C_COMPILER_EXECUTABLE - the path to the HDF5 C wrapper compiler
      HDF5_CXX_COMPILER_EXECUTABLE - the path to the HDF5 C++ wrapper compiler
      HDF5_DIFF_EXECUTABLE - the path to the HDF5 dataset comparison tool
  • FindHSPELL: Try to find HSPELL

    Once done this will define

      HSPELL_FOUND - system has HSPELL
      HSPELL_INCLUDE_DIR - the HSPELL include directory
      HSPELL_LIBRARIES - The libraries needed to use HSPELL
      HSPELL_DEFINITIONS - Compiler switches required for using HSPELL
  • FindHTMLHelp: This module looks for Microsoft HTML Help Compiler

    It defines:

       HTML_HELP_COMPILER     : full path to the Compiler (hhc.exe)
       HTML_HELP_INCLUDE_PATH : include path to the API (htmlhelp.h)
       HTML_HELP_LIBRARY      : full path to the library (htmlhelp.lib)


  • FindITK: Find an ITK installation or build tree.
  • FindImageMagick: Find the ImageMagick binary suite.

    This module will search for a set of ImageMagick tools specified as components in the FIND_PACKAGE call. Typical components include, but are not limited to (future versions of ImageMagick might have additional components not listed here):

      animate
      compare
      composite
      conjure
      convert
      display
      identify
      import
      mogrify
      montage
      stream


    If no component is specified in the FIND_PACKAGE call, then it only searches for the ImageMagick executable directory. This code defines the following variables:

      ImageMagick_FOUND                  - TRUE if all components are found.
      ImageMagick_EXECUTABLE_DIR         - Full path to executables directory.
      ImageMagick_<component>_FOUND      - TRUE if <component> is found.
      ImageMagick_<component>_EXECUTABLE - Full path to <component> executable.


    There are also components for the following ImageMagick APIs:

      Magick++
      MagickWand
      MagickCore


    For these components the following variables are set:

      ImageMagick_FOUND                    - TRUE if all components are found.
      ImageMagick_INCLUDE_DIRS             - Full paths to all include dirs.
      ImageMagick_LIBRARIES                - Full paths to all libraries.
      ImageMagick_<component>_FOUND        - TRUE if <component> is found.
      ImageMagick_<component>_INCLUDE_DIRS - Full path to <component> include dirs.
      ImageMagick_<component>_LIBRARIES    - Full path to <component> libraries.


    Example Usages:

      FIND_PACKAGE(ImageMagick)
      FIND_PACKAGE(ImageMagick COMPONENTS convert)
      FIND_PACKAGE(ImageMagick COMPONENTS convert mogrify display)
      FIND_PACKAGE(ImageMagick COMPONENTS Magick++)
      FIND_PACKAGE(ImageMagick COMPONENTS Magick++ convert)


    Note that the standard FIND_PACKAGE features are supported (i.e., QUIET, REQUIRED, etc.).

  • FindJNI: Find JNI java libraries.

    This module finds if Java is installed and determines where the include files and libraries are. It also determines what the name of the library is. This code sets the following variables:

       
      JNI_INCLUDE_DIRS      = the include dirs to use
      JNI_LIBRARIES         = the libraries to use
      JAVA_AWT_LIBRARY      = the path to the jawt library
      JAVA_JVM_LIBRARY      = the path to the jvm library
      JAVA_INCLUDE_PATH     = the include path to jni.h
      JAVA_INCLUDE_PATH2    = the include path to jni_md.h
      JAVA_AWT_INCLUDE_PATH = the include path to jawt.h


  • FindJPEG: Find JPEG

    Find the native JPEG includes and library This module defines

      JPEG_INCLUDE_DIR, where to find jpeglib.h, etc.
      JPEG_LIBRARIES, the libraries needed to use JPEG.
      JPEG_FOUND, If false, do not try to use JPEG.

    also defined, but not for general use are

      JPEG_LIBRARY, where to find the JPEG library.
  • FindJasper: Try to find the Jasper JPEG2000 library

    Once done this will define

      JASPER_FOUND - system has Jasper
      JASPER_INCLUDE_DIR - the Jasper include directory
      JASPER_LIBRARIES - The libraries needed to use Jasper
  • FindJava: Find Java

    This module finds if Java is installed and determines where the include files and libraries are. This code sets the following variables:

      JAVA_RUNTIME    = the full path to the Java runtime
      JAVA_COMPILE    = the full path to the Java compiler
      JAVA_ARCHIVE    = the full path to the Java archiver


  • FindKDE3: Find the KDE3 include and library dirs, KDE preprocessors and define a some macros


    This module defines the following variables:

      KDE3_DEFINITIONS         - compiler definitions required for compiling KDE software
      KDE3_INCLUDE_DIR         - the KDE include directory
      KDE3_INCLUDE_DIRS        - the KDE and the Qt include directory, for use with INCLUDE_DIRECTORIES()
      KDE3_LIB_DIR             - the directory where the KDE libraries are installed, for use with LINK_DIRECTORIES()
      QT_AND_KDECORE_LIBS      - this contains both the Qt and the kdecore library
      KDE3_DCOPIDL_EXECUTABLE  - the dcopidl executable
      KDE3_DCOPIDL2CPP_EXECUTABLE - the dcopidl2cpp executable
      KDE3_KCFGC_EXECUTABLE    - the kconfig_compiler executable
      KDE3_FOUND               - set to TRUE if all of the above has been found


    The following user adjustable options are provided:

      KDE3_BUILD_TESTS - enable this to build KDE testcases



    It also adds the following macros (from KDE3Macros.cmake) SRCS_VAR is always the variable which contains the list of source files for your application or library.

    KDE3_AUTOMOC(file1 ... fileN)

        Call this if you want to have automatic moc file handling.
        This means if you include "foo.moc" in the source file foo.cpp
        a moc file for the header foo.h will be created automatically.
        You can set the property SKIP_AUTOMAKE using SET_SOURCE_FILES_PROPERTIES()
        to exclude some files in the list from being processed.


    KDE3_ADD_MOC_FILES(SRCS_VAR file1 ... fileN )

        If you don't use the KDE3_AUTOMOC() macro, for the files
        listed here moc files will be created (named "foo.moc.cpp")


    KDE3_ADD_DCOP_SKELS(SRCS_VAR header1.h ... headerN.h )

        Use this to generate DCOP skeletions from the listed headers.


    KDE3_ADD_DCOP_STUBS(SRCS_VAR header1.h ... headerN.h )

         Use this to generate DCOP stubs from the listed headers.


    KDE3_ADD_UI_FILES(SRCS_VAR file1.ui ... fileN.ui )

        Use this to add the Qt designer ui files to your application/library.


    KDE3_ADD_KCFG_FILES(SRCS_VAR file1.kcfgc ... fileN.kcfgc )

        Use this to add KDE kconfig compiler files to your application/library.


    KDE3_INSTALL_LIBTOOL_FILE(target)

        This will create and install a simple libtool file for the given target.


    KDE3_ADD_EXECUTABLE(name file1 ... fileN )

        Currently identical to ADD_EXECUTABLE(), may provide some advanced features in the future.


    KDE3_ADD_KPART(name [WITH_PREFIX] file1 ... fileN )

        Create a KDE plugin (KPart, kioslave, etc.) from the given source files.
        If WITH_PREFIX is given, the resulting plugin will have the prefix "lib", otherwise it won't.
        It creates and installs an appropriate libtool la-file.


    KDE3_ADD_KDEINIT_EXECUTABLE(name file1 ... fileN )

        Create a KDE application in the form of a module loadable via kdeinit.
        A library named kdeinit_<name> will be created and a small executable which links to it.


    The option KDE3_ENABLE_FINAL to enable all-in-one compilation is no longer supported.


    Author: Alexander Neundorf <neundorf@kde.org>

  • FindKDE4:

    Find KDE4 and provide all necessary variables and macros to compile software for it. It looks for KDE 4 in the following directories in the given order:

      CMAKE_INSTALL_PREFIX
      KDEDIRS
      /opt/kde4


    Please look in FindKDE4Internal.cmake and KDE4Macros.cmake for more information. They are installed with the KDE 4 libraries in $KDEDIRS/share/apps/cmake/modules/.

    Author: Alexander Neundorf <neundorf@kde.org>

  • FindLAPACK: Find LAPACK library

    This module finds an installed fortran library that implements the LAPACK linear-algebra interface (see http://www.netlib.org/lapack/).

    The approach follows that taken for the autoconf macro file, acx_lapack.m4 (distributed at http://ac-archive.sourceforge.net/ac-archive/acx_lapack.html).

    This module sets the following variables:

      LAPACK_FOUND - set to true if a library implementing the LAPACK interface
        is found
      LAPACK_LINKER_FLAGS - uncached list of required linker flags (excluding -l
        and -L).
      LAPACK_LIBRARIES - uncached list of libraries (using full path name) to
        link against to use LAPACK
      LAPACK95_LIBRARIES - uncached list of libraries (using full path name) to
        link against to use LAPACK95
      LAPACK95_FOUND - set to true if a library implementing the LAPACK f95
        interface is found
      BLA_STATIC  if set on this determines what kind of linkage we do (static)
      BLA_VENDOR  if set checks only the specified vendor, if not set checks
         all the possibilities
      BLA_F95     if set on tries to find the f95 interfaces for BLAS/LAPACK

    ## List of vendors (BLA_VENDOR) valid in this module # Intel(mkl), ACML,Apple, NAS, Generic

  • FindLATEX: Find Latex

    This module finds if Latex is installed and determines where the executables are. This code sets the following variables:

      
      LATEX_COMPILER:       path to the LaTeX compiler
      PDFLATEX_COMPILER:    path to the PdfLaTeX compiler
      BIBTEX_COMPILER:      path to the BibTeX compiler
      MAKEINDEX_COMPILER:   path to the MakeIndex compiler
      DVIPS_CONVERTER:      path to the DVIPS converter
      PS2PDF_CONVERTER:     path to the PS2PDF converter
      LATEX2HTML_CONVERTER: path to the LaTeX2Html converter


  • FindLibXml2: Try to find LibXml2

    Once done this will define

      LIBXML2_FOUND - System has LibXml2
      LIBXML2_INCLUDE_DIR - The LibXml2 include directory
      LIBXML2_LIBRARIES - The libraries needed to use LibXml2
      LIBXML2_DEFINITIONS - Compiler switches required for using LibXml2
      LIBXML2_XMLLINT_EXECUTABLE - The XML checking tool xmllint coming with LibXml2
  • FindLibXslt: Try to find LibXslt

    Once done this will define

      LIBXSLT_FOUND - system has LibXslt
      LIBXSLT_INCLUDE_DIR - the LibXslt include directory
      LIBXSLT_LIBRARIES - Link these to LibXslt
      LIBXSLT_DEFINITIONS - Compiler switches required for using LibXslt
  • FindLua50:

    Locate Lua library This module defines

      LUA50_FOUND, if false, do not try to link to Lua 
      LUA_LIBRARIES, both lua and lualib
      LUA_INCLUDE_DIR, where to find lua.h and lualib.h (and probably lauxlib.h)


    Note that the expected include convention is

      #include "lua.h"

    and not

      #include <lua/lua.h>

    This is because, the lua location is not standardized and may exist in locations other than lua/

  • FindLua51:

    Locate Lua library This module defines

      LUA51_FOUND, if false, do not try to link to Lua 
      LUA_LIBRARIES
      LUA_INCLUDE_DIR, where to find lua.h


    Note that the expected include convention is

      #include "lua.h"

    and not

      #include <lua/lua.h>

    This is because, the lua location is not standardized and may exist in locations other than lua/

  • FindMFC: Find MFC on Windows

    Find the native MFC - i.e. decide if an application can link to the MFC libraries.

      MFC_FOUND - Was MFC support found

    You don't need to include anything or link anything to use it.

  • FindMPEG: Find the native MPEG includes and library

    This module defines

      MPEG_INCLUDE_DIR, where to find MPEG.h, etc.
      MPEG_LIBRARIES, the libraries required to use MPEG.
      MPEG_FOUND, If false, do not try to use MPEG.

    also defined, but not for general use are

      MPEG_mpeg2_LIBRARY, where to find the MPEG library.
      MPEG_vo_LIBRARY, where to find the vo library.
  • FindMPEG2: Find the native MPEG2 includes and library

    This module defines

      MPEG2_INCLUDE_DIR, path to mpeg2dec/mpeg2.h, etc.
      MPEG2_LIBRARIES, the libraries required to use MPEG2.
      MPEG2_FOUND, If false, do not try to use MPEG2.

    also defined, but not for general use are

      MPEG2_mpeg2_LIBRARY, where to find the MPEG2 library.
      MPEG2_vo_LIBRARY, where to find the vo library.
  • FindMPI: Message Passing Interface (MPI) module.


    The Message Passing Interface (MPI) is a library used to write high-performance parallel applications that use message passing, and is typically deployed on a cluster. MPI is a standard interface (defined by the MPI forum) for which many implementations are available. All of these implementations have somewhat different compilation approaches (different include paths, libraries to link against, etc.), and this module tries to smooth out those differences.

    This module will set the following variables:

       MPI_FOUND                  TRUE if we have found MPI
       MPI_COMPILE_FLAGS          Compilation flags for MPI programs
       MPI_INCLUDE_PATH           Include path(s) for MPI header
       MPI_LINK_FLAGS             Linking flags for MPI programs
       MPI_LIBRARY                First MPI library to link against (cached)
       MPI_EXTRA_LIBRARY          Extra MPI libraries to link against (cached)
       MPI_LIBRARIES              All libraries to link MPI programs against
       MPIEXEC                    Executable for running MPI programs
       MPIEXEC_NUMPROC_FLAG       Flag to pass to MPIEXEC before giving it the
                                  number of processors to run on
       MPIEXEC_PREFLAGS           Flags to pass to MPIEXEC directly before the
                                  executable to run.
       MPIEXEC_POSTFLAGS          Flags to pass to MPIEXEC after all other flags.


    This module will attempt to auto-detect these settings, first by looking for a MPI compiler, which many MPI implementations provide as a pass-through to the native compiler to simplify the compilation of MPI programs. The MPI compiler is stored in the cache variable MPI_COMPILER, and will attempt to look for commonly-named drivers mpic++, mpicxx, mpiCC, or mpicc. If the compiler driver is found and recognized, it will be used to set all of the module variables. To skip this auto-detection, set MPI_LIBRARY and MPI_INCLUDE_PATH in the CMake cache.

    If no compiler driver is found or the compiler driver is not recognized, this module will then search for common include paths and library names to try to detect MPI.

    If CMake initially finds a different MPI than was intended, and you want to use the MPI compiler auto-detection for a different MPI implementation, set MPI_COMPILER to the MPI compiler driver you want to use (e.g., mpicxx) and then set MPI_LIBRARY to the string MPI_LIBRARY-NOTFOUND. When you re-configure, auto-detection of MPI will run again with the newly-specified MPI_COMPILER.

    When using MPIEXEC to execute MPI applications, you should typically use all of the MPIEXEC flags as follows:

       ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} PROCS ${MPIEXEC_PREFLAGS} EXECUTABLE
         ${MPIEXEC_POSTFLAGS} ARGS

    where PROCS is the number of processors on which to execute the program, EXECUTABLE is the MPI program, and ARGS are the arguments to pass to the MPI program.

  • FindMatlab: this module looks for Matlab

    Defines:

      MATLAB_INCLUDE_DIR: include path for mex.h, engine.h
      MATLAB_LIBRARIES:   required libraries: libmex, etc
      MATLAB_MEX_LIBRARY: path to libmex.lib
      MATLAB_MX_LIBRARY:  path to libmx.lib
      MATLAB_ENG_LIBRARY: path to libeng.lib
  • FindMotif: Try to find Motif (or lesstif)

    Once done this will define:

      MOTIF_FOUND        - system has MOTIF
      MOTIF_INCLUDE_DIR  - include paths to use Motif
      MOTIF_LIBRARIES    - Link these to use Motif
  • FindOpenAL:

    Locate OpenAL This module defines OPENAL_LIBRARY OPENAL_FOUND, if false, do not try to link to OpenAL OPENAL_INCLUDE_DIR, where to find the headers

    $OPENALDIR is an environment variable that would correspond to the ./configure --prefix=$OPENALDIR used in building OpenAL.

    Created by Eric Wing. This was influenced by the FindSDL.cmake module.

  • FindOpenGL: Try to find OpenGL

    Once done this will define

      
      OPENGL_FOUND        - system has OpenGL
      OPENGL_XMESA_FOUND  - system has XMESA
      OPENGL_GLU_FOUND    - system has GLU
      OPENGL_INCLUDE_DIR  - the GL include directory
      OPENGL_LIBRARIES    - Link these to use OpenGL and GLU

    If you want to use just GL you can use these values

      OPENGL_gl_LIBRARY   - Path to OpenGL Library
      OPENGL_glu_LIBRARY  - Path to GLU Library

    On OSX default to using the framework version of opengl People will have to change the cache values of OPENGL_glu_LIBRARY and OPENGL_gl_LIBRARY to use OpenGL with X11 on OSX

  • FindOpenMP: Finds OpenMP support

    This module can be used to detect OpenMP support in a compiler. If the compiler supports OpenMP, the flags required to compile with openmp support are set.

    The following variables are set:

       OpenMP_C_FLAGS - flags to add to the C compiler for OpenMP support
       OpenMP_CXX_FLAGS - flags to add to the CXX compiler for OpenMP support
       OPENMP_FOUND - true if openmp is detected


    Supported compilers can be found at http://openmp.org/wp/openmp-compilers/

  • FindOpenSSL: Try to find the OpenSSL encryption library

    Once done this will define

      OPENSSL_FOUND - system has the OpenSSL library
      OPENSSL_INCLUDE_DIR - the OpenSSL include directory
      OPENSSL_LIBRARIES - The libraries needed to use OpenSSL
  • FindOpenSceneGraph: Find OpenSceneGraph

    This module searches for the OpenSceneGraph core "osg" library as well as OpenThreads, and whatever additional COMPONENTS (nodekits) that you specify.

        See http://www.openscenegraph.org


    NOTE: To use this module effectively you must either require CMake >= 2.6.3 with cmake_minimum_required(VERSION 2.6.3) or download and place FindOpenThreads.cmake, Findosg_functions.cmake, Findosg.cmake, and Find<etc>.cmake files into your CMAKE_MODULE_PATH.

    ==================================

    This module accepts the following variables (note mixed case)

        OpenSceneGraph_DEBUG - Enable debugging output


        OpenSceneGraph_MARK_AS_ADVANCED - Mark cache variables as advanced 
                                          automatically


    The following environment variables are also respected for finding the OSG and it's various components. CMAKE_PREFIX_PATH can also be used for this (see find_library() CMake documentation).

        <MODULE>_DIR (where MODULE is of the form "OSGVOLUME" and there is a FindosgVolume.cmake file)
        OSG_DIR
        OSGDIR
        OSG_ROOT


    This module defines the following output variables:

        OPENSCENEGRAPH_FOUND - Was the OSG and all of the specified components found?


        OPENSCENEGRAPH_VERSION - The version of the OSG which was found


        OPENSCENEGRAPH_INCLUDE_DIRS - Where to find the headers


        OPENSCENEGRAPH_LIBRARIES - The OSG libraries


    ================================== Example Usage:

      find_package(OpenSceneGraph 2.0.0 REQUIRED osgDB osgUtil)
          # libOpenThreads & libosg automatically searched
      include_directories(${OPENSCENEGRAPH_INCLUDE_DIRS})


      add_executable(foo foo.cc)
      target_link_libraries(foo ${OPENSCENEGRAPH_LIBRARIES})


  • FindOpenThreads:

    OpenThreads is a C++ based threading library. Its largest userbase seems to OpenSceneGraph so you might notice I accept OSGDIR as an environment path. I consider this part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module.

    Locate OpenThreads This module defines OPENTHREADS_LIBRARY OPENTHREADS_FOUND, if false, do not try to link to OpenThreads OPENTHREADS_INCLUDE_DIR, where to find the headers

    $OPENTHREADS_DIR is an environment variable that would correspond to the ./configure --prefix=$OPENTHREADS_DIR used in building osg.

    Created by Eric Wing.

  • FindPHP4: Find PHP4

    This module finds if PHP4 is installed and determines where the include files and libraries are. It also determines what the name of the library is. This code sets the following variables:

      PHP4_INCLUDE_PATH       = path to where php.h can be found
      PHP4_EXECUTABLE         = full path to the php4 binary


  • FindPNG: Find the native PNG includes and library


    This module defines

      PNG_INCLUDE_DIR, where to find png.h, etc.
      PNG_LIBRARIES, the libraries to link against to use PNG.
      PNG_DEFINITIONS - You should add_definitons(${PNG_DEFINITIONS}) before compiling code that includes png library files.
      PNG_FOUND, If false, do not try to use PNG.

    also defined, but not for general use are

      PNG_LIBRARY, where to find the PNG library.

    None of the above will be defined unles zlib can be found. PNG depends on Zlib

  • FindPackageHandleStandardArgs:

    FIND_PACKAGE_HANDLE_STANDARD_ARGS(NAME (DEFAULT_MSG|"Custom failure message") VAR1 ... )

        This macro is intended to be used in FindXXX.cmake modules files.
        It handles the REQUIRED and QUIET argument to FIND_PACKAGE() and
        it also sets the <UPPERCASED_NAME>_FOUND variable.
        The package is found if all variables listed are TRUE.
        Example:


        FIND_PACKAGE_HANDLE_STANDARD_ARGS(LibXml2 DEFAULT_MSG LIBXML2_LIBRARIES LIBXML2_INCLUDE_DIR)


        LibXml2 is considered to be found, if both LIBXML2_LIBRARIES and 
        LIBXML2_INCLUDE_DIR are valid. Then also LIBXML2_FOUND is set to TRUE.
        If it is not found and REQUIRED was used, it fails with FATAL_ERROR, 
        independent whether QUIET was used or not.
        If it is found, the location is reported using the VAR1 argument, so 
        here a message "Found LibXml2: /usr/lib/libxml2.so" will be printed out.
        If the second argument is DEFAULT_MSG, the message in the failure case will 
        be "Could NOT find LibXml2", if you don't like this message you can specify
        your own custom failure message there.
  • FindPackageMessage:

    FIND_PACKAGE_MESSAGE(<name> "message for user" "find result details")

    This macro is intended to be used in FindXXX.cmake modules files. It will print a message once for each unique find result. This is useful for telling the user where a package was found. The first argument specifies the name (XXX) of the package. The second argument specifies the message to display. The third argument lists details about the find result so that if they change the message will be displayed again. The macro also obeys the QUIET argument to the find_package command.

    Example:

      IF(X11_FOUND)
        FIND_PACKAGE_MESSAGE(X11 "Found X11: ${X11_X11_LIB}"
          "[${X11_X11_LIB}][${X11_INCLUDE_DIR}]")
      ELSE(X11_FOUND)
       ...
      ENDIF(X11_FOUND)
  • FindPerl: Find perl

    this module looks for Perl

      PERL_EXECUTABLE - the full path to perl
      PERL_FOUND      - If false, don't attempt to use perl.
  • FindPerlLibs: Find Perl libraries

    This module finds if PERL is installed and determines where the include files and libraries are. It also determines what the name of the library is. This code sets the following variables:

      PERLLIBS_FOUND    = True if perl.h & libperl were found
      PERL_INCLUDE_PATH = path to where perl.h is found
      PERL_LIBRARY      = path to libperl
      PERL_EXECUTABLE   = full path to the perl binary


      The following variables are also available if needed
      (introduced after CMake 2.6.4)


      PERL_SITESEARCH    = path to the sitesearch install dir
      PERL_SITELIB       = path to the sitelib install directory
      PERL_VENDORARCH    = path to the vendor arch install directory
      PERL_VENDORLIB     = path to the vendor lib install directory
      PERL_ARCHLIB       = path to the arch lib install directory
      PERL_PRIVLIB       = path to the priv lib install directory
      PERL_EXTRA_C_FLAGS = Compilation flags used to build perl


  • FindPhysFS:

    Locate PhysFS library This module defines PHYSFS_LIBRARY, the name of the library to link against PHYSFS_FOUND, if false, do not try to link to PHYSFS PHYSFS_INCLUDE_DIR, where to find physfs.h

    $PHYSFSDIR is an environment variable that would correspond to the ./configure --prefix=$PHYSFSDIR used in building PHYSFS.

    Created by Eric Wing.

  • FindPike: Find Pike

    This module finds if PIKE is installed and determines where the include files and libraries are. It also determines what the name of the library is. This code sets the following variables:

      PIKE_INCLUDE_PATH       = path to where program.h is found
      PIKE_EXECUTABLE         = full path to the pike binary


  • FindPkgConfig: a pkg-config module for CMake


    Usage:

       pkg_check_modules(<PREFIX> [REQUIRED] <MODULE> [<MODULE>]*)
         checks for all the given modules


       pkg_search_module(<PREFIX> [REQUIRED] <MODULE> [<MODULE>]*)
         checks for given modules and uses the first working one


    When the 'REQUIRED' argument was set, macros will fail with an error when module(s) could not be found

    It sets the following variables:

       PKG_CONFIG_FOUND         ... true if pkg-config works on the system
       PKG_CONFIG_EXECUTABLE    ... pathname of the pkg-config program
       <PREFIX>_FOUND           ... set to 1 if module(s) exist


    For the following variables two sets of values exist; first one is the common one and has the given PREFIX. The second set contains flags which are given out when pkgconfig was called with the '--static' option.

       <XPREFIX>_LIBRARIES      ... only the libraries (w/o the '-l')
       <XPREFIX>_LIBRARY_DIRS   ... the paths of the libraries (w/o the '-L')
       <XPREFIX>_LDFLAGS        ... all required linker flags
       <XPREFIX>_LDFLAGS_OTHER  ... all other linker flags
       <XPREFIX>_INCLUDE_DIRS   ... the '-I' preprocessor flags (w/o the '-I')
       <XPREFIX>_CFLAGS         ... all required cflags
       <XPREFIX>_CFLAGS_OTHER   ... the other compiler flags


       <XPREFIX> = <PREFIX>        for common case
       <XPREFIX> = <PREFIX>_STATIC for static linking


    There are some special variables whose prefix depends on the count of given modules. When there is only one module, <PREFIX> stays unchanged. When there are multiple modules, the prefix will be changed to <PREFIX>_<MODNAME>:

       <XPREFIX>_VERSION    ... version of the module
       <XPREFIX>_PREFIX     ... prefix-directory of the module
       <XPREFIX>_INCLUDEDIR ... include-dir of the module
       <XPREFIX>_LIBDIR     ... lib-dir of the module


       <XPREFIX> = <PREFIX>  when |MODULES| == 1, else
       <XPREFIX> = <PREFIX>_<MODNAME>


    A <MODULE> parameter can have the following formats:

       {MODNAME}            ... matches any version
       {MODNAME}>={VERSION} ... at least version <VERSION> is required
       {MODNAME}={VERSION}  ... exactly version <VERSION> is required
       {MODNAME}<={VERSION} ... modules must not be newer than <VERSION>


    Examples

       pkg_check_modules (GLIB2   glib-2.0)


       pkg_check_modules (GLIB2   glib-2.0>=2.10)
         requires at least version 2.10 of glib2 and defines e.g.
           GLIB2_VERSION=2.10.3


       pkg_check_modules (FOO     glib-2.0>=2.10 gtk+-2.0)
         requires both glib2 and gtk2, and defines e.g.
           FOO_glib-2.0_VERSION=2.10.3
           FOO_gtk+-2.0_VERSION=2.8.20


       pkg_check_modules (XRENDER REQUIRED xrender)
         defines e.g.:
           XRENDER_LIBRARIES=Xrender;X11
           XRENDER_STATIC_LIBRARIES=Xrender;X11;pthread;Xau;Xdmcp


       pkg_search_module (BAR     libxml-2.0 libxml2 libxml>=2)
  • FindProducer:

    Though Producer isn't directly part of OpenSceneGraph, its primary user is OSG so I consider this part of the Findosg* suite used to find OpenSceneGraph components. You'll notice that I accept OSGDIR as an environment path.

    Each component is separate and you must opt in to each module. You must also opt into OpenGL (and OpenThreads?) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate Producer This module defines PRODUCER_LIBRARY PRODUCER_FOUND, if false, do not try to link to Producer PRODUCER_INCLUDE_DIR, where to find the headers

    $PRODUCER_DIR is an environment variable that would correspond to the ./configure --prefix=$PRODUCER_DIR used in building osg.

    Created by Eric Wing.

  • FindProtobuf:

    Locate and configure the Google Protocol Buffers library. Defines the following variables:

       PROTOBUF_FOUND - Found the Google Protocol Buffers library
       PROTOBUF_INCLUDE_DIRS - Include directories for Google Protocol Buffers
       PROTOBUF_LIBRARIES - The protobuf library


    The following cache variables are also defined:

       PROTOBUF_LIBRARY - The protobuf library
       PROTOBUF_PROTOC_LIBRARY   - The protoc library
       PROTOBUF_INCLUDE_DIR - The include directory for protocol buffers
       PROTOBUF_PROTOC_EXECUTABLE - The protoc compiler


      ====================================================================
      Example:


       find_package(Protobuf REQUIRED)
       include_directories(${PROTOBUF_INCLUDE_DIRS})


       include_directories(${CMAKE_CURRENT_BINARY_DIR})
       PROTOBUF_GENERATE_CPP(PROTO_SRCS PROTO_HDRS foo.proto)
       add_executable(bar bar.cc ${PROTO_SRCS} ${PROTO_HDRS})
       target_link_libraries(bar ${PROTOBUF_LIBRARY})


    NOTE: You may need to link against pthreads, depending on the platform.

      ====================================================================


    PROTOBUF_GENERATE_CPP (public function)

       SRCS = Variable to define with autogenerated
              source files
       HDRS = Variable to define with autogenerated
              header files
       ARGN = proto files


      ====================================================================
  • FindPythonInterp: Find python interpreter

    This module finds if Python interpreter is installed and determines where the executables are. This code sets the following variables:

      PYTHONINTERP_FOUND - Was the Python executable found
      PYTHON_EXECUTABLE  - path to the Python interpreter


  • FindPythonLibs: Find python libraries

    This module finds if Python is installed and determines where the include files and libraries are. It also determines what the name of the library is. This code sets the following variables:

      PYTHONLIBS_FOUND       - have the Python libs been found
      PYTHON_LIBRARIES       - path to the python library
      PYTHON_INCLUDE_PATH    - path to where Python.h is found (deprecated)
      PYTHON_INCLUDE_DIRS    - path to where Python.h is found
      PYTHON_DEBUG_LIBRARIES - path to the debug library


  • FindQt: Searches for all installed versions of QT.

    This should only be used if your project can work with multiple versions of QT. If not, you should just directly use FindQt4 or FindQt3. If multiple versions of QT are found on the machine, then The user must set the option DESIRED_QT_VERSION to the version they want to use. If only one version of qt is found on the machine, then the DESIRED_QT_VERSION is set to that version and the matching FindQt3 or FindQt4 module is included. Once the user sets DESIRED_QT_VERSION, then the FindQt3 or FindQt4 module is included.

      QT_REQUIRED if this is set to TRUE then if CMake can 
                  not find QT4 or QT3 an error is raised 
                  and a message is sent to the user.


      DESIRED_QT_VERSION OPTION is created
      QT4_INSTALLED is set to TRUE if qt4 is found.
      QT3_INSTALLED is set to TRUE if qt3 is found.
  • FindQt3: Locate Qt include paths and libraries

    This module defines:

      QT_INCLUDE_DIR - where to find qt.h, etc.
      QT_LIBRARIES   - the libraries to link against to use Qt.
      QT_DEFINITIONS - definitions to use when
                       compiling code that uses Qt.
      QT_FOUND       - If false, don't try to use Qt.


    If you need the multithreaded version of Qt, set QT_MT_REQUIRED to TRUE

    Also defined, but not for general use are:

      QT_MOC_EXECUTABLE, where to find the moc tool.
      QT_UIC_EXECUTABLE, where to find the uic tool.
      QT_QT_LIBRARY, where to find the Qt library.
      QT_QTMAIN_LIBRARY, where to find the qtmain
       library. This is only required by Qt3 on Windows.
  • FindQt4: Find QT 4

    This module can be used to find Qt4. The most important issue is that the Qt4 qmake is available via the system path. This qmake is then used to detect basically everything else. This module defines a number of key variables and macros. The variable QT_USE_FILE is set which is the path to a CMake file that can be included to compile Qt 4 applications and libraries. It sets up the compilation environment for include directories, preprocessor defines and populates a QT_LIBRARIES variable.

    Typical usage could be something like:

       find_package(Qt4 4.4.3 COMPONENTS QtCore QtGui QtXml REQUIRED )
       include(${QT_USE_FILE})
       add_executable(myexe main.cpp)
       target_link_libraries(myexe ${QT_LIBRARIES})


    The minimum required version can be specified using the standard find_package()-syntax (see example above). For compatibility with older versions of FindQt4.cmake it is also possible to set the variable QT_MIN_VERSION to the minimum required version of Qt4 before the find_package(Qt4) command. If both are used, the version used in the find_package() command overrides the one from QT_MIN_VERSION.

    When using the components argument, QT_USE_QT* variables are automatically set for the QT_USE_FILE to pick up. If one wishes to manually set them, the available ones to set include:

                        QT_DONT_USE_QTCORE
                        QT_DONT_USE_QTGUI
                        QT_USE_QT3SUPPORT
                        QT_USE_QTASSISTANT
                        QT_USE_QAXCONTAINER
                        QT_USE_QAXSERVER
                        QT_USE_QTDESIGNER
                        QT_USE_QTMOTIF
                        QT_USE_QTMAIN
                        QT_USE_QTNETWORK
                        QT_USE_QTNSPLUGIN
                        QT_USE_QTOPENGL
                        QT_USE_QTSQL
                        QT_USE_QTXML
                        QT_USE_QTSVG
                        QT_USE_QTTEST
                        QT_USE_QTUITOOLS
                        QT_USE_QTDBUS
                        QT_USE_QTSCRIPT
                        QT_USE_QTASSISTANTCLIENT
                        QT_USE_QTHELP
                        QT_USE_QTWEBKIT
                        QT_USE_QTXMLPATTERNS
                        QT_USE_PHONON
                        QT_USE_QTSCRIPTTOOLS


    There are also some files that need processing by some Qt tools such as moc and uic. Listed below are macros that may be used to process those files.

      
      macro QT4_WRAP_CPP(outfiles inputfile ... OPTIONS ...)
            create moc code from a list of files containing Qt class with
            the Q_OBJECT declaration.  Per-direcotry preprocessor definitions 
            are also added.  Options may be given to moc, such as those found
            when executing "moc -help".  


      macro QT4_WRAP_UI(outfiles inputfile ... OPTIONS ...)
            create code from a list of Qt designer ui files.
            Options may be given to uic, such as those found
            when executing "uic -help"


      macro QT4_ADD_RESOURCES(outfiles inputfile ... OPTIONS ...)
            create code from a list of Qt resource files.
            Options may be given to rcc, such as those found
            when executing "rcc -help"


      macro QT4_GENERATE_MOC(inputfile outputfile )
            creates a rule to run moc on infile and create outfile.
            Use this if for some reason QT4_WRAP_CPP() isn't appropriate, e.g.
            because you need a custom filename for the moc file or something similar.


      macro QT4_AUTOMOC(sourcefile1 sourcefile2 ... )
            This macro is still experimental.
            It can be used to have moc automatically handled.
            So if you have the files foo.h and foo.cpp, and in foo.h a 
            a class uses the Q_OBJECT macro, moc has to run on it. If you don't
            want to use QT4_WRAP_CPP() (which is reliable and mature), you can insert
            #include "foo.moc"
            in foo.cpp and then give foo.cpp as argument to QT4_AUTOMOC(). This will the
            scan all listed files at cmake-time for such included moc files and if it finds
            them cause a rule to be generated to run moc at build time on the 
            accompanying header file foo.h.
            If a source file has the SKIP_AUTOMOC property set it will be ignored by this macro.


      macro QT4_ADD_DBUS_INTERFACE(outfiles interface basename)
            create a the interface header and implementation files with the 
            given basename from the given interface xml file and add it to 
            the list of sources


      macro QT4_ADD_DBUS_INTERFACES(outfiles inputfile ... )
            create the interface header and implementation files 
            for all listed interface xml files
            the name will be automatically determined from the name of the xml file


      macro QT4_ADD_DBUS_ADAPTOR(outfiles xmlfile parentheader parentclassname [basename] [classname])
            create a dbus adaptor (header and implementation file) from the xml file
            describing the interface, and add it to the list of sources. The adaptor
            forwards the calls to a parent class, defined in parentheader and named
            parentclassname. The name of the generated files will be
            <basename>adaptor.{cpp,h} where basename defaults to the basename of the xml file.
            If <classname> is provided, then it will be used as the classname of the
            adaptor itself.


      macro QT4_GENERATE_DBUS_INTERFACE( header [interfacename] OPTIONS ...)
            generate the xml interface file from the given header.
            If the optional argument interfacename is omitted, the name of the 
            interface file is constructed from the basename of the header with
            the suffix .xml appended.
            Options may be given to qdbuscpp2xml, such as those found when executing "qdbuscpp2xml --help"


      macro QT4_CREATE_TRANSLATION( qm_files directories ... sources ... 
                                    ts_files ... OPTIONS ...)
            out: qm_files
            in:  directories sources ts_files
            options: flags to pass to lupdate, such as -extensions to specify
            extensions for a directory scan.
            generates commands to create .ts (vie lupdate) and .qm
            (via lrelease) - files from directories and/or sources. The ts files are 
            created and/or updated in the source tree (unless given with full paths).
            The qm files are generated in the build tree.
            Updating the translations can be done by adding the qm_files
            to the source list of your library/executable, so they are
            always updated, or by adding a custom target to control when
            they get updated/generated.


      macro QT4_ADD_TRANSLATION( qm_files ts_files ... )
            out: qm_files
            in:  ts_files
            generates commands to create .qm from .ts - files. The generated
            filenames can be found in qm_files. The ts_files
            must exists and are not updated in any way.



      Below is a detailed list of variables that FindQt4.cmake sets.
      QT_FOUND         If false, don't try to use Qt.
      QT4_FOUND        If false, don't try to use Qt 4.


      QT_VERSION_MAJOR The major version of Qt found.
      QT_VERSION_MINOR The minor version of Qt found.
      QT_VERSION_PATCH The patch version of Qt found.


      QT_EDITION               Set to the edition of Qt (i.e. DesktopLight)
      QT_EDITION_DESKTOPLIGHT  True if QT_EDITION == DesktopLight
      QT_QTCORE_FOUND          True if QtCore was found.
      QT_QTGUI_FOUND           True if QtGui was found.
      QT_QT3SUPPORT_FOUND      True if Qt3Support was found.
      QT_QTASSISTANT_FOUND     True if QtAssistant was found.
      QT_QAXCONTAINER_FOUND     True if QAxContainer was found (Windows only).
      QT_QAXSERVER_FOUND          True if QAxServer was found (Windows only).
      QT_QTDBUS_FOUND          True if QtDBus was found.
      QT_QTDESIGNER_FOUND      True if QtDesigner was found.
      QT_QTDESIGNERCOMPONENTS  True if QtDesignerComponents was found.
      QT_QTMOTIF_FOUND         True if QtMotif was found.
      QT_QTNETWORK_FOUND       True if QtNetwork was found.
      QT_QTNSPLUGIN_FOUND      True if QtNsPlugin was found.
      QT_QTOPENGL_FOUND        True if QtOpenGL was found.
      QT_QTSQL_FOUND           True if QtSql was found.
      QT_QTXML_FOUND           True if QtXml was found.
      QT_QTSVG_FOUND           True if QtSvg was found.
      QT_QTSCRIPT_FOUND        True if QtScript was found.
      QT_QTTEST_FOUND          True if QtTest was found.
      QT_QTUITOOLS_FOUND       True if QtUiTools was found.
      QT_QTASSISTANTCLIENT_FOUND  True if QtAssistantClient was found.
      QT_QTHELP_FOUND          True if QtHelp was found.
      QT_QTWEBKIT_FOUND        True if QtWebKit was found.
      QT_QTXMLPATTERNS_FOUND   True if QtXmlPatterns was found.
      QT_PHONON_FOUND          True if phonon was found.
      QT_QTSCRIPTTOOLS_FOUND   True if QtScriptTools was found.


      QT_MAC_USE_COCOA    For Mac OS X, its whether Cocoa or Carbon is used.
                          In general, this should not be used, but its useful
                          when having platform specific code.


      QT_DEFINITIONS   Definitions to use when compiling code that uses Qt.
                       You do not need to use this if you include QT_USE_FILE.
                       The QT_USE_FILE will also define QT_DEBUG and QT_NO_DEBUG
                       to fit your current build type.  Those are not contained
                       in QT_DEFINITIONS.
                      
      QT_INCLUDES      List of paths to all include directories of 
                       Qt4 QT_INCLUDE_DIR and QT_QTCORE_INCLUDE_DIR are
                       always in this variable even if NOTFOUND,
                       all other INCLUDE_DIRS are
                       only added if they are found.
                       You do not need to use this if you include QT_USE_FILE.
       


      Include directories for the Qt modules are listed here.
      You do not need to use these variables if you include QT_USE_FILE.


      QT_INCLUDE_DIR              Path to "include" of Qt4
      QT_QT3SUPPORT_INCLUDE_DIR   Path to "include/Qt3Support" 
      QT_QTASSISTANT_INCLUDE_DIR  Path to "include/QtAssistant" 
      QT_QTASSISTANTCLIENT_INCLUDE_DIR       Path to "include/QtAssistant"
      QT_QAXCONTAINER_INCLUDE_DIR  Path to "include/ActiveQt" (Windows only)
      QT_QAXSERVER_INCLUDE_DIR  Path to "include/ActiveQt" (Windows only)
      QT_QTCORE_INCLUDE_DIR       Path to "include/QtCore"         
      QT_QTDESIGNER_INCLUDE_DIR   Path to "include/QtDesigner" 
      QT_QTDESIGNERCOMPONENTS_INCLUDE_DIR   Path to "include/QtDesigner"
      QT_QTDBUS_INCLUDE_DIR       Path to "include/QtDBus" 
      QT_QTGUI_INCLUDE_DIR        Path to "include/QtGui" 
      QT_QTHELP_INCLUDE_DIR       Path to "include/QtHelp"
      QT_QTMOTIF_INCLUDE_DIR      Path to "include/QtMotif" 
      QT_QTNETWORK_INCLUDE_DIR    Path to "include/QtNetwork" 
      QT_QTNSPLUGIN_INCLUDE_DIR   Path to "include/QtNsPlugin" 
      QT_QTOPENGL_INCLUDE_DIR     Path to "include/QtOpenGL" 
      QT_QTSCRIPT_INCLUDE_DIR     Path to "include/QtScript"
      QT_QTSQL_INCLUDE_DIR        Path to "include/QtSql" 
      QT_QTSVG_INCLUDE_DIR        Path to "include/QtSvg"
      QT_QTTEST_INCLUDE_DIR       Path to "include/QtTest"
      QT_QTWEBKIT_INCLUDE_DIR     Path to "include/QtWebKit"
      QT_QTXML_INCLUDE_DIR        Path to "include/QtXml" 
      QT_QTXMLPATTERNS_INCLUDE_DIR  Path to "include/QtXmlPatterns"
      QT_PHONON_INCLUDE_DIR       Path to "include/phonon"
      QT_QTSCRIPTTOOLS_INCLUDE_DIR       Path to "include/QtScriptTools"
                                
      QT_BINARY_DIR               Path to "bin" of Qt4
      QT_LIBRARY_DIR              Path to "lib" of Qt4
      QT_PLUGINS_DIR              Path to "plugins" for Qt4
      QT_TRANSLATIONS_DIR         Path to "translations" of Qt4
      QT_DOC_DIR                  Path to "doc" of Qt4
      QT_MKSPECS_DIR              Path to "mkspecs" of Qt4


    The Qt toolkit may contain both debug and release libraries. In that case, the following library variables will contain both. You do not need to use these variables if you include QT_USE_FILE, and use QT_LIBRARIES.

      QT_QT3SUPPORT_LIBRARY            The Qt3Support library
      QT_QTASSISTANT_LIBRARY           The QtAssistant library
      QT_QTASSISTANTCLIENT_LIBRARY     The QtAssistantClient library
      QT_QAXCONTAINER_LIBRARY           The QAxContainer library (Windows only)
      QT_QAXSERVER_LIBRARY                The QAxServer library (Windows only)
      QT_QTCORE_LIBRARY                The QtCore library
      QT_QTDBUS_LIBRARY                The QtDBus library
      QT_QTDESIGNER_LIBRARY            The QtDesigner library
      QT_QTDESIGNERCOMPONENTS_LIBRARY  The QtDesignerComponents library
      QT_QTGUI_LIBRARY                 The QtGui library
      QT_QTHELP_LIBRARY                The QtHelp library
      QT_QTMOTIF_LIBRARY               The QtMotif library
      QT_QTNETWORK_LIBRARY             The QtNetwork library
      QT_QTNSPLUGIN_LIBRARY            The QtNsPLugin library
      QT_QTOPENGL_LIBRARY              The QtOpenGL library
      QT_QTSCRIPT_LIBRARY              The QtScript library
      QT_QTSQL_LIBRARY                 The QtSql library
      QT_QTSVG_LIBRARY                 The QtSvg library
      QT_QTTEST_LIBRARY                The QtTest library
      QT_QTUITOOLS_LIBRARY             The QtUiTools library
      QT_QTWEBKIT_LIBRARY              The QtWebKit library
      QT_QTXML_LIBRARY                 The QtXml library
      QT_QTXMLPATTERNS_LIBRARY         The QtXmlPatterns library
      QT_QTMAIN_LIBRARY                The qtmain library for Windows
      QT_PHONON_LIBRARY                The phonon library
      QT_QTSCRIPTTOOLS_LIBRARY         The QtScriptTools library

    also defined, but NOT for general use are

      QT_MOC_EXECUTABLE                   Where to find the moc tool.
      QT_UIC_EXECUTABLE                   Where to find the uic tool.
      QT_UIC3_EXECUTABLE                  Where to find the uic3 tool.
      QT_RCC_EXECUTABLE                   Where to find the rcc tool
      QT_DBUSCPP2XML_EXECUTABLE           Where to find the qdbuscpp2xml tool.
      QT_DBUSXML2CPP_EXECUTABLE           Where to find the qdbusxml2cpp tool.
      QT_LUPDATE_EXECUTABLE               Where to find the lupdate tool.
      QT_LRELEASE_EXECUTABLE              Where to find the lrelease tool.
      QT_QCOLLECTIONGENERATOR_EXECUTABLE  Where to find the qcollectiongenerator tool.


    These are around for backwards compatibility they will be set

      QT_WRAP_CPP  Set true if QT_MOC_EXECUTABLE is found
      QT_WRAP_UI   Set true if QT_UIC_EXECUTABLE is found

    These variables do _NOT_ have any effect anymore (compared to FindQt.cmake)

      QT_MT_REQUIRED         Qt4 is now always multithreaded

    These variables are set to "" Because Qt structure changed (They make no sense in Qt4)

      QT_QT_LIBRARY        Qt-Library is now split
  • FindQuickTime:

    Locate QuickTime This module defines QUICKTIME_LIBRARY QUICKTIME_FOUND, if false, do not try to link to gdal QUICKTIME_INCLUDE_DIR, where to find the headers

    $QUICKTIME_DIR is an environment variable that would correspond to the ./configure --prefix=$QUICKTIME_DIR

    Created by Eric Wing.

  • FindRTI: Try to find M&S HLA RTI libraries

    This module finds if any HLA RTI is installed and locates the standard RTI include files and libraries.

    RTI is a simulation infrastructure standardized by IEEE and SISO. It has a well defined C++ API that assures that simulation applications are independent on a particular RTI implementation.

      http://en.wikipedia.org/wiki/Run-Time_Infrastructure_(simulation)


    This code sets the following variables:

      RTI_INCLUDE_DIR = the directory where RTI includes file are found
      RTI_LIBRARIES = The libraries to link against to use RTI
      RTI_DEFINITIONS = -DRTI_USES_STD_FSTREAM
      RTI_FOUND = Set to FALSE if any HLA RTI was not found


    Report problems to <certi-devel@nongnu.org>

  • FindRuby: Find Ruby

    This module finds if Ruby is installed and determines where the include files and libraries are. Ruby 1.8 and 1.9 are supported. The minimum required version specified in the find_package() command is honored. It also determines what the name of the library is. This code sets the following variables:

      RUBY_EXECUTABLE   = full path to the ruby binary
      RUBY_INCLUDE_DIRS = include dirs to be used when using the ruby library
      RUBY_LIBRARY      = full path to the ruby library
      RUBY_VERSION      = the version of ruby which was found, e.g. "1.8.7"
      RUBY_FOUND        = set to true if ruby ws found successfully


      RUBY_INCLUDE_PATH = same as RUBY_INCLUDE_DIRS, only provided for compatibility reasons, don't use it
  • FindSDL:

    Locate SDL library This module defines SDL_LIBRARY, the name of the library to link against SDL_FOUND, if false, do not try to link to SDL SDL_INCLUDE_DIR, where to find SDL.h

    This module responds to the the flag: SDL_BUILDING_LIBRARY If this is defined, then no SDL_main will be linked in because only applications need main(). Otherwise, it is assumed you are building an application and this module will attempt to locate and set the the proper link flags as part of the returned SDL_LIBRARY variable.

    Don't forget to include SDLmain.h and SDLmain.m your project for the OS X framework based version. (Other versions link to -lSDLmain which this module will try to find on your behalf.) Also for OS X, this module will automatically add the -framework Cocoa on your behalf.


    Additional Note: If you see an empty SDL_LIBRARY_TEMP in your configuration and no SDL_LIBRARY, it means CMake did not find your SDL library (SDL.dll, libsdl.so, SDL.framework, etc). Set SDL_LIBRARY_TEMP to point to your SDL library, and configure again. Similarly, if you see an empty SDLMAIN_LIBRARY, you should set this value as appropriate. These values are used to generate the final SDL_LIBRARY variable, but when these values are unset, SDL_LIBRARY does not get created.


    $SDLDIR is an environment variable that would correspond to the ./configure --prefix=$SDLDIR used in building SDL. l.e.galup 9-20-02

    Modified by Eric Wing. Added code to assist with automated building by using environmental variables and providing a more controlled/consistent search behavior. Added new modifications to recognize OS X frameworks and additional Unix paths (FreeBSD, etc). Also corrected the header search path to follow "proper" SDL guidelines. Added a search for SDLmain which is needed by some platforms. Added a search for threads which is needed by some platforms. Added needed compile switches for MinGW.

    On OSX, this will prefer the Framework version (if found) over others. People will have to manually change the cache values of SDL_LIBRARY to override this selection or set the CMake environment CMAKE_INCLUDE_PATH to modify the search paths.

    Note that the header path has changed from SDL/SDL.h to just SDL.h This needed to change because "proper" SDL convention is #include "SDL.h", not <SDL/SDL.h>. This is done for portability reasons because not all systems place things in SDL/ (see FreeBSD).

  • FindSDL_image:

    Locate SDL_image library This module defines SDLIMAGE_LIBRARY, the name of the library to link against SDLIMAGE_FOUND, if false, do not try to link to SDL SDLIMAGE_INCLUDE_DIR, where to find SDL/SDL.h

    $SDLDIR is an environment variable that would correspond to the ./configure --prefix=$SDLDIR used in building SDL.

    Created by Eric Wing. This was influenced by the FindSDL.cmake module, but with modifications to recognize OS X frameworks and additional Unix paths (FreeBSD, etc).

  • FindSDL_mixer:

    Locate SDL_mixer library This module defines SDLMIXER_LIBRARY, the name of the library to link against SDLMIXER_FOUND, if false, do not try to link to SDL SDLMIXER_INCLUDE_DIR, where to find SDL/SDL.h

    $SDLDIR is an environment variable that would correspond to the ./configure --prefix=$SDLDIR used in building SDL.

    Created by Eric Wing. This was influenced by the FindSDL.cmake module, but with modifications to recognize OS X frameworks and additional Unix paths (FreeBSD, etc).

  • FindSDL_net:

    Locate SDL_net library This module defines SDLNET_LIBRARY, the name of the library to link against SDLNET_FOUND, if false, do not try to link against SDLNET_INCLUDE_DIR, where to find the headers

    $SDLDIR is an environment variable that would correspond to the ./configure --prefix=$SDLDIR used in building SDL.

    Created by Eric Wing. This was influenced by the FindSDL.cmake module, but with modifications to recognize OS X frameworks and additional Unix paths (FreeBSD, etc).

  • FindSDL_sound:

    Locates the SDL_sound library

  • FindSDL_ttf:

    Locate SDL_ttf library This module defines SDLTTF_LIBRARY, the name of the library to link against SDLTTF_FOUND, if false, do not try to link to SDL SDLTTF_INCLUDE_DIR, where to find SDL/SDL.h

    $SDLDIR is an environment variable that would correspond to the ./configure --prefix=$SDLDIR used in building SDL.

    Created by Eric Wing. This was influenced by the FindSDL.cmake module, but with modifications to recognize OS X frameworks and additional Unix paths (FreeBSD, etc).

  • FindSWIG: Find SWIG

    This module finds an installed SWIG. It sets the following variables:

      SWIG_FOUND - set to true if SWIG is found
      SWIG_DIR - the directory where swig is installed
      SWIG_EXECUTABLE - the path to the swig executable
      SWIG_VERSION   - the version number of the swig executable


    All informations are collected from the SWIG_EXECUTABLE so the version to be found can be changed from the command line by means of setting SWIG_EXECUTABLE

  • FindSelfPackers: Find upx

    This module looks for some executable packers (i.e. softwares that compress executables or shared libs into on-the-fly self-extracting executables or shared libs. Examples:

      UPX: http://wildsau.idv.uni-linz.ac.at/mfx/upx.html
  • FindSquish: -- Typical Use


    This module can be used to find Squish (currently support is aimed at version 3).

      SQUISH_FOUND                    If false, don't try to use Squish
      SQUISH_VERSION_MAJOR            The major version of Squish found
      SQUISH_VERSION_MINOR            The minor version of Squish found
      SQUISH_VERSION_PATCH            The patch version of Squish found


      SQUISH_INSTALL_DIR              The Squish installation directory (containing bin, lib, etc)
      SQUISH_SERVER_EXECUTABLE        The squishserver executable
      SQUISH_CLIENT_EXECUTABLE        The squishrunner executable


      SQUISH_INSTALL_DIR_FOUND        Was the install directory found?
      SQUISH_SERVER_EXECUTABLE_FOUND  Was the server executable found?
      SQUISH_CLIENT_EXECUTABLE_FOUND  Was the client executable found?


    macro SQUISH_ADD_TEST(testName applicationUnderTest testSuite testCase)

      ENABLE_TESTING()
      FIND_PACKAGE(Squish)
      IF (SQUISH_FOUND)
        SQUISH_ADD_TEST(myTestName myApplication testSuiteName testCaseName)
      ENDIF (SQUISH_FOUND)


  • FindSubversion: Extract information from a subversion working copy

    The module defines the following variables:

      Subversion_SVN_EXECUTABLE - path to svn command line client
      Subversion_VERSION_SVN - version of svn command line client
      Subversion_FOUND - true if the command line client was found

    If the command line client executable is found the macro

      Subversion_WC_INFO(<dir> <var-prefix>)

    is defined to extract information of a subversion working copy at a given location. The macro defines the following variables:

      <var-prefix>_WC_URL - url of the repository (at <dir>)
      <var-prefix>_WC_ROOT - root url of the repository
      <var-prefix>_WC_REVISION - current revision
      <var-prefix>_WC_LAST_CHANGED_AUTHOR - author of last commit
      <var-prefix>_WC_LAST_CHANGED_DATE - date of last commit
      <var-prefix>_WC_LAST_CHANGED_REV - revision of last commit
      <var-prefix>_WC_LAST_CHANGED_LOG - last log of base revision
      <var-prefix>_WC_INFO - output of command `svn info <dir>'

    Example usage:

      FIND_PACKAGE(Subversion)
      IF(Subversion_FOUND)
        Subversion_WC_INFO(${PROJECT_SOURCE_DIR} Project)
        MESSAGE("Current revision is ${Project_WC_REVISION}")
        Subversion_WC_LOG(${PROJECT_SOURCE_DIR} Project)
        MESSAGE("Last changed log is ${Project_LAST_CHANGED_LOG}")
      ENDIF(Subversion_FOUND)
  • FindTCL: TK_INTERNAL_PATH was removed.

    This module finds if Tcl is installed and determines where the include files and libraries are. It also determines what the name of the library is. This code sets the following variables:

      TCL_FOUND              = Tcl was found
      TK_FOUND               = Tk was found
      TCLTK_FOUND            = Tcl and Tk were found
      TCL_LIBRARY            = path to Tcl library (tcl tcl80)
      TCL_INCLUDE_PATH       = path to where tcl.h can be found
      TCL_TCLSH              = path to tclsh binary (tcl tcl80)
      TK_LIBRARY             = path to Tk library (tk tk80 etc)
      TK_INCLUDE_PATH        = path to where tk.h can be found
      TK_WISH                = full path to the wish executable


    In an effort to remove some clutter and clear up some issues for people who are not necessarily Tcl/Tk gurus/developpers, some variables were moved or removed. Changes compared to CMake 2.4 are:

       => they were only useful for people writing Tcl/Tk extensions.
       => these libs are not packaged by default with Tcl/Tk distributions. 
          Even when Tcl/Tk is built from source, several flavors of debug libs
          are created and there is no real reason to pick a single one
          specifically (say, amongst tcl84g, tcl84gs, or tcl84sgx). 
          Let's leave that choice to the user by allowing him to assign 
          TCL_LIBRARY to any Tcl library, debug or not.
       => this ended up being only a Win32 variable, and there is a lot of
          confusion regarding the location of this file in an installed Tcl/Tk
          tree anyway (see 8.5 for example). If you need the internal path at
          this point it is safer you ask directly where the *source* tree is
          and dig from there.
  • FindTIFF: Find TIFF library

    Find the native TIFF includes and library This module defines

      TIFF_INCLUDE_DIR, where to find tiff.h, etc.
      TIFF_LIBRARIES, libraries to link against to use TIFF.
      TIFF_FOUND, If false, do not try to use TIFF.

    also defined, but not for general use are

      TIFF_LIBRARY, where to find the TIFF library.
  • FindTclStub: TCL_STUB_LIBRARY_DEBUG and TK_STUB_LIBRARY_DEBUG were removed.

    This module finds Tcl stub libraries. It first finds Tcl include files and libraries by calling FindTCL.cmake. How to Use the Tcl Stubs Library:

       http://tcl.activestate.com/doc/howto/stubs.html

    Using Stub Libraries:

       http://safari.oreilly.com/0130385603/ch48lev1sec3

    This code sets the following variables:

      TCL_STUB_LIBRARY       = path to Tcl stub library
      TK_STUB_LIBRARY        = path to Tk stub library
      TTK_STUB_LIBRARY       = path to ttk stub library


    In an effort to remove some clutter and clear up some issues for people who are not necessarily Tcl/Tk gurus/developpers, some variables were moved or removed. Changes compared to CMake 2.4 are:

       => these libs are not packaged by default with Tcl/Tk distributions. 
          Even when Tcl/Tk is built from source, several flavors of debug libs
          are created and there is no real reason to pick a single one
          specifically (say, amongst tclstub84g, tclstub84gs, or tclstub84sgx). 
          Let's leave that choice to the user by allowing him to assign 
          TCL_STUB_LIBRARY to any Tcl library, debug or not.
  • FindTclsh: Find tclsh

    This module finds if TCL is installed and determines where the include files and libraries are. It also determines what the name of the library is. This code sets the following variables:

      TCLSH_FOUND = TRUE if tclsh has been found
      TCL_TCLSH = the path to the tclsh executable

    In cygwin, look for the cygwin version first. Don't look for it later to avoid finding the cygwin version on a Win32 build.

  • FindThreads: This module determines the thread library of the system.

    The following variables are set

      CMAKE_THREAD_LIBS_INIT     - the thread library
      CMAKE_USE_SPROC_INIT       - are we using sproc?
      CMAKE_USE_WIN32_THREADS_INIT - using WIN32 threads?
      CMAKE_USE_PTHREADS_INIT    - are we using pthreads
      CMAKE_HP_PTHREADS_INIT     - are we using hp pthreads
  • FindUnixCommands: Find unix commands from cygwin

    This module looks for some usual Unix commands.

  • FindVTK: Find a VTK installation or build tree.

    The following variables are set if VTK is found. If VTK is not found, VTK_FOUND is set to false.

      VTK_FOUND         - Set to true when VTK is found.
      VTK_USE_FILE      - CMake file to use VTK.
      VTK_MAJOR_VERSION - The VTK major version number.
      VTK_MINOR_VERSION - The VTK minor version number 
                           (odd non-release).
      VTK_BUILD_VERSION - The VTK patch level 
                           (meaningless for odd minor).
      VTK_INCLUDE_DIRS  - Include directories for VTK
      VTK_LIBRARY_DIRS  - Link directories for VTK libraries
      VTK_KITS          - List of VTK kits, in CAPS 
                          (COMMON,IO,) etc.
      VTK_LANGUAGES     - List of wrapped languages, in CAPS
                          (TCL, PYHTON,) etc.

    The following cache entries must be set by the user to locate VTK:

      VTK_DIR  - The directory containing VTKConfig.cmake.  
                 This is either the root of the build tree,
                 or the lib/vtk directory.  This is the 
                 only cache entry.

    The following variables are set for backward compatibility and should not be used in new code:

      USE_VTK_FILE - The full path to the UseVTK.cmake file.
                     This is provided for backward 
                     compatibility.  Use VTK_USE_FILE 
                     instead.


  • FindWget: Find wget

    This module looks for wget. This module defines the following values:

      WGET_EXECUTABLE: the full path to the wget tool.
      WGET_FOUND: True if wget has been found.
  • FindWish: Find wish installation

    This module finds if TCL is installed and determines where the include files and libraries are. It also determines what the name of the library is. This code sets the following variables:

      TK_WISH = the path to the wish executable


    if UNIX is defined, then it will look for the cygwin version first

  • FindX11: Find X11 installation

    Try to find X11 on UNIX systems. The following values are defined

      X11_FOUND        - True if X11 is available
      X11_INCLUDE_DIR  - include directories to use X11
      X11_LIBRARIES    - link against these to use X11


    and also the following more fine grained variables: Include paths: X11_ICE_INCLUDE_PATH, X11_ICE_LIB, X11_ICE_FOUND

                    X11_Xaccessrules_INCLUDE_PATH,                     X11_Xaccess_FOUND
                    X11_Xaccessstr_INCLUDE_PATH,                       X11_Xaccess_FOUND
                    X11_Xau_INCLUDE_PATH,          X11_Xau_LIB,        X11_Xau_FOUND
                    X11_Xcomposite_INCLUDE_PATH,   X11_Xcomposite_LIB, X11_Xcomposite_FOUND
                    X11_Xcursor_INCLUDE_PATH,      X11_Xcursor_LIB,    X11_Xcursor_FOUND
                    X11_Xdamage_INCLUDE_PATH,      X11_Xdamage_LIB,    X11_Xdamage_FOUND
                    X11_Xdmcp_INCLUDE_PATH,        X11_Xdmcp_LIB,      X11_Xdmcp_FOUND
                                                   X11_Xext_LIB,       X11_Xext_FOUND
                    X11_dpms_INCLUDE_PATH,         (in X11_Xext_LIB),  X11_dpms_FOUND
                    X11_XShm_INCLUDE_PATH,         (in X11_Xext_LIB),  X11_XShm_FOUND
                    X11_Xshape_INCLUDE_PATH,       (in X11_Xext_LIB),  X11_Xshape_FOUND
                    X11_xf86misc_INCLUDE_PATH,     X11_Xxf86misc_LIB,  X11_xf86misc_FOUND
                    X11_xf86vmode_INCLUDE_PATH,                        X11_xf86vmode_FOUND
                    X11_Xfixes_INCLUDE_PATH,       X11_Xfixes_LIB,     X11_Xfixes_FOUND
                    X11_Xft_INCLUDE_PATH,          X11_Xft_LIB,        X11_Xft_FOUND
                    X11_Xinerama_INCLUDE_PATH,     X11_Xinerama_LIB,   X11_Xinerama_FOUND
                    X11_Xinput_INCLUDE_PATH,       X11_Xinput_LIB,     X11_Xinput_FOUND
                    X11_Xkb_INCLUDE_PATH,                              X11_Xkb_FOUND
                    X11_Xkblib_INCLUDE_PATH,                           X11_Xkb_FOUND
                    X11_Xpm_INCLUDE_PATH,          X11_Xpm_LIB,        X11_Xpm_FOUND
                    X11_XTest_INCLUDE_PATH,        X11_XTest_LIB,      X11_XTest_FOUND
                    X11_Xrandr_INCLUDE_PATH,       X11_Xrandr_LIB,     X11_Xrandr_FOUND
                    X11_Xrender_INCLUDE_PATH,      X11_Xrender_LIB,    X11_Xrender_FOUND
                    X11_Xscreensaver_INCLUDE_PATH, X11_Xscreensaver_LIB, X11_Xscreensaver_FOUND
                    X11_Xt_INCLUDE_PATH,           X11_Xt_LIB,         X11_Xt_FOUND
                    X11_Xutil_INCLUDE_PATH,                            X11_Xutil_FOUND
                    X11_Xv_INCLUDE_PATH,           X11_Xv_LIB,         X11_Xv_FOUND
  • FindXMLRPC: Find xmlrpc

    Find the native XMLRPC headers and libraries.

      XMLRPC_INCLUDE_DIRS      - where to find xmlrpc.h, etc.
      XMLRPC_LIBRARIES         - List of libraries when using xmlrpc.
      XMLRPC_FOUND             - True if xmlrpc found.

    XMLRPC modules may be specified as components for this find module. Modules may be listed by running "xmlrpc-c-config". Modules include:

      c++            C++ wrapper code
      libwww-client  libwww-based client
      cgi-server     CGI-based server
      abyss-server   ABYSS-based server

    Typical usage:

      FIND_PACKAGE(XMLRPC REQUIRED libwww-client)
  • FindZLIB: Find zlib

    Find the native ZLIB includes and library

      ZLIB_INCLUDE_DIRS - where to find zlib.h, etc.
      ZLIB_LIBRARIES    - List of libraries when using zlib.
      ZLIB_FOUND        - True if zlib found.
  • Findosg:


    NOTE: It is highly recommended that you use the new FindOpenSceneGraph.cmake introduced in CMake 2.6.3 and not use this Find module directly.

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osg This module defines

    OSG_FOUND - Was the Osg found? OSG_INCLUDE_DIR - Where to find the headers OSG_LIBRARIES - The libraries to link against for the OSG (use this)

    OSG_LIBRARY - The OSG library OSG_LIBRARY_DEBUG - The OSG debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgAnimation:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgAnimation This module defines

    OSGANIMATION_FOUND - Was osgAnimation found? OSGANIMATION_INCLUDE_DIR - Where to find the headers OSGANIMATION_LIBRARIES - The libraries to link against for the OSG (use this)

    OSGANIMATION_LIBRARY - The OSG library OSGANIMATION_LIBRARY_DEBUG - The OSG debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgDB:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgDB This module defines

    OSGDB_FOUND - Was osgDB found? OSGDB_INCLUDE_DIR - Where to find the headers OSGDB_LIBRARIES - The libraries to link against for the osgDB (use this)

    OSGDB_LIBRARY - The osgDB library OSGDB_LIBRARY_DEBUG - The osgDB debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgFX:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgFX This module defines

    OSGFX_FOUND - Was osgFX found? OSGFX_INCLUDE_DIR - Where to find the headers OSGFX_LIBRARIES - The libraries to link against for the osgFX (use this)

    OSGFX_LIBRARY - The osgFX library OSGFX_LIBRARY_DEBUG - The osgFX debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgGA:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgGA This module defines

    OSGGA_FOUND - Was osgGA found? OSGGA_INCLUDE_DIR - Where to find the headers OSGGA_LIBRARIES - The libraries to link against for the osgGA (use this)

    OSGGA_LIBRARY - The osgGA library OSGGA_LIBRARY_DEBUG - The osgGA debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgIntrospection:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgINTROSPECTION This module defines

    OSGINTROSPECTION_FOUND - Was osgIntrospection found? OSGINTROSPECTION_INCLUDE_DIR - Where to find the headers OSGINTROSPECTION_LIBRARIES - The libraries to link for osgIntrospection (use this)

    OSGINTROSPECTION_LIBRARY - The osgIntrospection library OSGINTROSPECTION_LIBRARY_DEBUG - The osgIntrospection debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgManipulator:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgManipulator This module defines

    OSGMANIPULATOR_FOUND - Was osgManipulator found? OSGMANIPULATOR_INCLUDE_DIR - Where to find the headers OSGMANIPULATOR_LIBRARIES - The libraries to link for osgManipulator (use this)

    OSGMANIPULATOR_LIBRARY - The osgManipulator library OSGMANIPULATOR_LIBRARY_DEBUG - The osgManipulator debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgParticle:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgParticle This module defines

    OSGPARTICLE_FOUND - Was osgParticle found? OSGPARTICLE_INCLUDE_DIR - Where to find the headers OSGPARTICLE_LIBRARIES - The libraries to link for osgParticle (use this)

    OSGPARTICLE_LIBRARY - The osgParticle library OSGPARTICLE_LIBRARY_DEBUG - The osgParticle debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgProducer:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgProducer This module defines

    OSGPRODUCER_FOUND - Was osgProducer found? OSGPRODUCER_INCLUDE_DIR - Where to find the headers OSGPRODUCER_LIBRARIES - The libraries to link for osgProducer (use this)

    OSGPRODUCER_LIBRARY - The osgProducer library OSGPRODUCER_LIBRARY_DEBUG - The osgProducer debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgShadow:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgShadow This module defines

    OSGSHADOW_FOUND - Was osgShadow found? OSGSHADOW_INCLUDE_DIR - Where to find the headers OSGSHADOW_LIBRARIES - The libraries to link for osgShadow (use this)

    OSGSHADOW_LIBRARY - The osgShadow library OSGSHADOW_LIBRARY_DEBUG - The osgShadow debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgSim:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgSim This module defines

    OSGSIM_FOUND - Was osgSim found? OSGSIM_INCLUDE_DIR - Where to find the headers OSGSIM_LIBRARIES - The libraries to link for osgSim (use this)

    OSGSIM_LIBRARY - The osgSim library OSGSIM_LIBRARY_DEBUG - The osgSim debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgTerrain:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgTerrain This module defines

    OSGTERRAIN_FOUND - Was osgTerrain found? OSGTERRAIN_INCLUDE_DIR - Where to find the headers OSGTERRAIN_LIBRARIES - The libraries to link for osgTerrain (use this)

    OSGTERRAIN_LIBRARY - The osgTerrain library OSGTERRAIN_LIBRARY_DEBUG - The osgTerrain debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgText:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgText This module defines

    OSGTEXT_FOUND - Was osgText found? OSGTEXT_INCLUDE_DIR - Where to find the headers OSGTEXT_LIBRARIES - The libraries to link for osgText (use this)

    OSGTEXT_LIBRARY - The osgText library OSGTEXT_LIBRARY_DEBUG - The osgText debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgUtil:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgUtil This module defines

    OSGUTIL_FOUND - Was osgUtil found? OSGUTIL_INCLUDE_DIR - Where to find the headers OSGUTIL_LIBRARIES - The libraries to link for osgUtil (use this)

    OSGUTIL_LIBRARY - The osgUtil library OSGUTIL_LIBRARY_DEBUG - The osgUtil debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgViewer:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgViewer This module defines

    OSGVIEWER_FOUND - Was osgViewer found? OSGVIEWER_INCLUDE_DIR - Where to find the headers OSGVIEWER_LIBRARIES - The libraries to link for osgViewer (use this)

    OSGVIEWER_LIBRARY - The osgViewer library OSGVIEWER_LIBRARY_DEBUG - The osgViewer debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgVolume:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgVolume This module defines

    OSGVOLUME_FOUND - Was osgVolume found? OSGVOLUME_INCLUDE_DIR - Where to find the headers OSGVOLUME_LIBRARIES - The libraries to link for osgVolume (use this)

    OSGVOLUME_LIBRARY - The osgVolume library OSGVOLUME_LIBRARY_DEBUG - The osgVolume debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    Created by Eric Wing.

  • FindosgWidget:

    This is part of the Findosg* suite used to find OpenSceneGraph components. Each component is separate and you must opt in to each module. You must also opt into OpenGL and OpenThreads (and Producer if needed) as these modules won't do it for you. This is to allow you control over your own system piece by piece in case you need to opt out of certain components or change the Find behavior for a particular module (perhaps because the default FindOpenGL.cmake module doesn't work with your system as an example). If you want to use a more convenient module that includes everything, use the FindOpenSceneGraph.cmake instead of the Findosg*.cmake modules.

    Locate osgWidget This module defines

    OSGWIDGET_FOUND - Was osgWidget found? OSGWIDGET_INCLUDE_DIR - Where to find the headers OSGWIDGET_LIBRARIES - The libraries to link for osgWidget (use this)

    OSGWIDGET_LIBRARY - The osgWidget library OSGWIDGET_LIBRARY_DEBUG - The osgWidget debug library

    $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg.

    FindosgWidget.cmake tweaked from Findosg* suite as created by Eric Wing.

  • Findosg_functions:


    This CMake file contains two macros to assist with searching for OSG libraries and nodekits.

  • FindwxWidgets: Find a wxWidgets (a.k.a., wxWindows) installation.

    This module finds if wxWidgets is installed and selects a default configuration to use. wxWidgets is a modular library. To specify the modules that you will use, you need to name them as components to the package:

    FIND_PACKAGE(wxWidgets COMPONENTS base core ...)

    There are two search branches: a windows style and a unix style. For windows, the following variables are searched for and set to defaults in case of multiple choices. Change them if the defaults are not desired (i.e., these are the only variables you should change to select a configuration):

      wxWidgets_ROOT_DIR      - Base wxWidgets directory
                                (e.g., C:/wxWidgets-2.6.3).
      wxWidgets_LIB_DIR       - Path to wxWidgets libraries
                                (e.g., C:/wxWidgets-2.6.3/lib/vc_lib).
      wxWidgets_CONFIGURATION - Configuration to use
                                (e.g., msw, mswd, mswu, mswunivud, etc.)


    For unix style it uses the wx-config utility. You can select between debug/release, unicode/ansi, universal/non-universal, and static/shared in the QtDialog or ccmake interfaces by turning ON/OFF the following variables:

      wxWidgets_USE_DEBUG
      wxWidgets_USE_UNICODE
      wxWidgets_USE_UNIVERSAL
      wxWidgets_USE_STATIC

    The following are set after the configuration is done for both windows and unix style:

      wxWidgets_FOUND            - Set to TRUE if wxWidgets was found.
      wxWidgets_INCLUDE_DIRS     - Include directories for WIN32
                                   i.e., where to find "wx/wx.h" and
                                   "wx/setup.h"; possibly empty for unices.
      wxWidgets_LIBRARIES        - Path to the wxWidgets libraries.
      wxWidgets_LIBRARY_DIRS     - compile time link dirs, useful for
                                   rpath on UNIX. Typically an empty string
                                   in WIN32 environment.
      wxWidgets_DEFINITIONS      - Contains defines required to compile/link
                                   against WX, e.g. WXUSINGDLL
      wxWidgets_DEFINITIONS_DEBUG- Contains defines required to compile/link
                                   against WX debug builds, e.g. __WXDEBUG__
      wxWidgets_CXX_FLAGS        - Include dirs and compiler flags for
                                   unices, empty on WIN32. Essentially
                                   "`wx-config --cxxflags`".
      wxWidgets_USE_FILE         - Convenience include file.


    Sample usage:

       FIND_PACKAGE(wxWidgets COMPONENTS base core gl net)
       IF(wxWidgets_FOUND)
         INCLUDE(${wxWidgets_USE_FILE})
         # and for each of your dependant executable/library targets:
         TARGET_LINK_LIBRARIES(<YourTarget> ${wxWidgets_LIBRARIES})
       ENDIF(wxWidgets_FOUND)


    If wxWidgets is required (i.e., not an optional part):

       FIND_PACKAGE(wxWidgets REQUIRED base core gl net)
       INCLUDE(${wxWidgets_USE_FILE})
       # and for each of your dependant executable/library targets:
       TARGET_LINK_LIBRARIES(<YourTarget> ${wxWidgets_LIBRARIES})
  • FindwxWindows: Find wxWindows (wxWidgets) installation

    This module finds if wxWindows/wxWidgets is installed and determines where the include files and libraries are. It also determines what the name of the library is. Please note this file is DEPRECATED and replaced by FindwxWidgets.cmake. This code sets the following variables:

      WXWINDOWS_FOUND     = system has WxWindows
      WXWINDOWS_LIBRARIES = path to the wxWindows libraries
                            on Unix/Linux with additional
                            linker flags from
                            "wx-config --libs"
      CMAKE_WXWINDOWS_CXX_FLAGS  = Compiler flags for wxWindows,
                                   essentially "`wx-config --cxxflags`"
                                   on Linux
      WXWINDOWS_INCLUDE_DIR      = where to find "wx/wx.h" and "wx/setup.h"
      WXWINDOWS_LINK_DIRECTORIES = link directories, useful for rpath on
                                    Unix
      WXWINDOWS_DEFINITIONS      = extra defines


    OPTIONS If you need OpenGL support please

      SET(WXWINDOWS_USE_GL 1)

    in your CMakeLists.txt *before* you include this file.

      HAVE_ISYSTEM      - true required to replace -I by -isystem on g++


    For convenience include Use_wxWindows.cmake in your project's CMakeLists.txt using INCLUDE(Use_wxWindows).

    USAGE

      SET(WXWINDOWS_USE_GL 1)
      FIND_PACKAGE(wxWindows)


    NOTES wxWidgets 2.6.x is supported for monolithic builds e.g. compiled in wx/build/msw dir as:

      nmake -f makefile.vc BUILD=debug SHARED=0 USE_OPENGL=1 MONOLITHIC=1


    DEPRECATED

      CMAKE_WX_CAN_COMPILE
      WXWINDOWS_LIBRARY
      CMAKE_WX_CXX_FLAGS
      WXWINDOWS_INCLUDE_PATH


    AUTHOR Jan Woetzel <http://www.mip.informatik.uni-kiel.de/~jw> (07/2003-01/2006)

  • FortranCInterface: Fortran/C Interface Detection

    This module automatically detects the API by which C and Fortran languages interact. Variables indicate if the mangling is found:

       FortranCInterface_GLOBAL_FOUND = Global subroutines and functions
       FortranCInterface_MODULE_FOUND = Module subroutines and functions
                                        (declared by "MODULE PROCEDURE")

    A function is provided to generate a C header file containing macros to mangle symbol names:

       FortranCInterface_HEADER(<file>
                                [MACRO_NAMESPACE <macro-ns>]
                                [SYMBOL_NAMESPACE <ns>]
                                [SYMBOLS [<module>:]<function> ...])

    It generates in <file> definitions of the following macros:

       #define FortranCInterface_GLOBAL (name,NAME) ...
       #define FortranCInterface_GLOBAL_(name,NAME) ...
       #define FortranCInterface_MODULE (mod,name, MOD,NAME) ...
       #define FortranCInterface_MODULE_(mod,name, MOD,NAME) ...

    These macros mangle four categories of Fortran symbols, respectively:

       - Global symbols without '_': call mysub()
       - Global symbols with '_'   : call my_sub()
       - Module symbols without '_': use mymod; call mysub()
       - Module symbols with '_'   : use mymod; call my_sub()

    If mangling for a category is not known, its macro is left undefined. All macros require raw names in both lower case and upper case. The MACRO_NAMESPACE option replaces the default "FortranCInterface_" prefix with a given namespace "<macro-ns>".

    The SYMBOLS option lists symbols to mangle automatically with C preprocessor definitions:

       <function>          ==> #define <ns><function> ...
       <module>:<function> ==> #define <ns><module>_<function> ...

    If the mangling for some symbol is not known then no preprocessor definition is created, and a warning is displayed. The SYMBOL_NAMESPACE option prefixes all preprocessor definitions generated by the SYMBOLS option with a given namespace "<ns>".

    Example usage:

       include(FortranCInterface)
       FortranCInterface_HEADER(FC.h MACRO_NAMESPACE "FC_")

    This creates a "FC.h" header that defines mangling macros FC_GLOBAL(), FC_GLOBAL_(), FC_MODULE(), and FC_MODULE_().

    Example usage:

       include(FortranCInterface)
       FortranCInterface_HEADER(FCMangle.h
                                MACRO_NAMESPACE "FC_"
                                SYMBOL_NAMESPACE "FC_"
                                SYMBOLS mysub mymod:my_sub)

    This creates a "FC.h" header that defines the same FC_*() mangling macros as the previous example plus preprocessor symbols FC_mysub and FC_mymod_my_sub.

    Another function is provided to verify that the Fortran and C/C++ compilers work together:

       FortranCInterface_VERIFY([CXX] [QUIET])

    It tests whether a simple test executable using Fortran and C (and C++ when the CXX option is given) compiles and links successfully. The result is stored in the cache entry FortranCInterface_VERIFIED_C (or FortranCInterface_VERIFIED_CXX if CXX is given) as a boolean. If the check fails and QUIET is not given the function terminates with a FATAL_ERROR message describing the problem. The purpose of this check is to stop a build early for incompatible compiler combinations.

    FortranCInterface is aware of possible GLOBAL and MODULE manglings for many Fortran compilers, but it also provides an interface to specify new possible manglings. Set the variables

       FortranCInterface_GLOBAL_SYMBOLS
       FortranCInterface_MODULE_SYMBOLS

    before including FortranCInterface to specify manglings of the symbols "MySub", "My_Sub", "MyModule:MySub", and "My_Module:My_Sub". For example, the code:

       set(FortranCInterface_GLOBAL_SYMBOLS mysub_ my_sub__ MYSUB_)
         #                                  ^^^^^  ^^^^^^   ^^^^^
       set(FortranCInterface_MODULE_SYMBOLS
           __mymodule_MOD_mysub __my_module_MOD_my_sub)
         #   ^^^^^^^^     ^^^^^   ^^^^^^^^^     ^^^^^^
       include(FortranCInterface)

    tells FortranCInterface to try given GLOBAL and MODULE manglings. (The carets point at raw symbol names for clarity in this example but are not needed.)

  • GetPrerequisites:

    GetPrerequisites.cmake

    This script provides functions to list the .dll, .dylib or .so files that an executable or shared library file depends on. (Its prerequisites.)

    It uses various tools to obtain the list of required shared library files:

       dumpbin (Windows)
       ldd (Linux/Unix)
       otool (Mac OSX)


    The following functions are provided by this script:

       gp_append_unique
       is_file_executable
       gp_item_default_embedded_path
         (projects can override with gp_item_default_embedded_path_override)
       gp_resolve_item
         (projects can override with gp_resolve_item_override)
       gp_resolved_file_type
       gp_file_type
       get_prerequisites
       list_prerequisites
       list_prerequisites_by_glob


    Requires CMake 2.6 or greater because it uses function, break, return and PARENT_SCOPE.

  • InstallRequiredSystemLibraries:

    By including this file, all files in the CMAKE_INSTALL_DEBUG_LIBRARIES, will be installed with INSTALL_PROGRAMS into /bin for WIN32 and /lib for non-win32. If CMAKE_SKIP_INSTALL_RULES is set to TRUE before including this file, then the INSTALL command is not called. The use can use the variable CMAKE_INSTALL_SYSTEM_RUNTIME_LIBS to use a custom install command and install them into any directory they want. If it is the MSVC compiler, then the microsoft run time libraries will be found add automatically added to the CMAKE_INSTALL_DEBUG_LIBRARIES, and installed. If CMAKE_INSTALL_DEBUG_LIBRARIES is set and it is the MSVC compiler, then the debug libraries are installed when available. If CMAKE_INSTALL_MFC_LIBRARIES is set then the MFC run time libraries are installed as well as the CRT run time libraries.

  • MacroAddFileDependencies: MACRO_ADD_FILE_DEPENDENCIES(<_file> depend_files...)

    Using the macro MACRO_ADD_FILE_DEPENDENCIES() is discouraged. There are usually better ways to specifiy the correct dependencies.

    MACRO_ADD_FILE_DEPENDENCIES(<_file> depend_files...) is just a convenience wrapper around the OBJECT_DEPENDS source file property. You can just use SET_PROPERTY(SOURCE <file> APPEND PROPERTY OBJECT_DEPENDS depend_files) instead.

  • SelectLibraryConfigurations:

    select_library_configurations( basename )

    This macro takes a library base name as an argument, and will choose good values for basename_LIBRARY, basename_LIBRARIES, basename_LIBRARY_DEBUG, and basename_LIBRARY_RELEASE depending on what has been found and set. If only basename_LIBRARY_RELEASE is defined, basename_LIBRARY, basename_LIBRARY_DEBUG, and basename_LIBRARY_RELEASE will be set to the release value. If only basename_LIBRARY_DEBUG is defined, then basename_LIBRARY, basename_LIBRARY_DEBUG and basename_LIBRARY_RELEASE will take the debug value.

    If the generator supports configuration types, then basename_LIBRARY and basename_LIBRARIES will be set with debug and optimized flags specifying the library to be used for the given configuration. If no build type has been set or the generator in use does not support configuration types, then basename_LIBRARY and basename_LIBRARIES will take only the release values.

  • SquishTestScript:


    This script launches a GUI test using Squish. You should not call the script directly; instead, you should access it via the SQUISH_ADD_TEST macro that is defined in FindSquish.cmake.

    This script starts the Squish server, launches the test on the client, and finally stops the squish server. If any of these steps fail (including if the tests do not pass) then a fatal error is raised.

  • TestBigEndian: Define macro to determine endian type

    Check if the system is big endian or little endian

      TEST_BIG_ENDIAN(VARIABLE)
      VARIABLE - variable to store the result to


  • TestCXXAcceptsFlag: Test CXX compiler for a flag

    Check if the CXX compiler accepts a flag

      Macro CHECK_CXX_ACCEPTS_FLAG(FLAGS VARIABLE) -
         checks if the function exists
      FLAGS - the flags to try
      VARIABLE - variable to store the result


  • TestForANSIForScope: Check for ANSI for scope support

    Check if the compiler restricts the scope of variables declared in a for-init-statement to the loop body.

      CMAKE_NO_ANSI_FOR_SCOPE - holds result


  • TestForANSIStreamHeaders: Test for compiler support of ANSI stream headers iostream, etc.

    check if the compiler supports the standard ANSI iostream header (without the .h)

      CMAKE_NO_ANSI_STREAM_HEADERS - defined by the results


  • TestForSSTREAM: Test for compiler support of ANSI sstream header

    check if the compiler supports the standard ANSI sstream header

      CMAKE_NO_ANSI_STRING_STREAM - defined by the results


  • TestForSTDNamespace: Test for std:: namespace support

    check if the compiler supports std:: on stl classes

      CMAKE_NO_STD_NAMESPACE - defined by the results


  • UseEcos: This module defines variables and macros required to build eCos application.

    This file contains the following macros: ECOS_ADD_INCLUDE_DIRECTORIES() - add the eCos include dirs ECOS_ADD_EXECUTABLE(name source1 ... sourceN ) - create an eCos executable ECOS_ADJUST_DIRECTORY(VAR source1 ... sourceN ) - adjusts the path of the source files and puts the result into VAR

    Macros for selecting the toolchain: ECOS_USE_ARM_ELF_TOOLS() - enable the ARM ELF toolchain for the directory where it is called ECOS_USE_I386_ELF_TOOLS() - enable the i386 ELF toolchain for the directory where it is called ECOS_USE_PPC_EABI_TOOLS() - enable the PowerPC toolchain for the directory where it is called

    It contains the following variables: ECOS_DEFINITIONS ECOSCONFIG_EXECUTABLE ECOS_CONFIG_FILE - defaults to ecos.ecc, if your eCos configuration file has a different name, adjust this variable for internal use only:

      ECOS_ADD_TARGET_LIB
  • UsePkgConfig: obsolete pkg-config module for CMake


    Defines the following macros:

    PKGCONFIG(package includedir libdir linkflags cflags)

    Calling PKGCONFIG will fill the desired information into the 4 given arguments, e.g. PKGCONFIG(libart-2.0 LIBART_INCLUDE_DIR LIBART_LINK_DIR LIBART_LINK_FLAGS LIBART_CFLAGS) if pkg-config was NOT found or the specified software package doesn't exist, the variable will be empty when the function returns, otherwise they will contain the respective information

  • UseQt4: Use Module for QT4

    Sets up C and C++ to use Qt 4. It is assumed that FindQt.cmake has already been loaded. See FindQt.cmake for information on how to load Qt 4 into your CMake project.

  • UseSWIG: SWIG module for CMake

    Defines the following macros:

       SWIG_ADD_MODULE(name language [ files ])
         - Define swig module with given name and specified language
       SWIG_LINK_LIBRARIES(name [ libraries ])
         - Link libraries to swig module

    All other macros are for internal use only. To get the actual name of the swig module, use: ${SWIG_MODULE_${name}_REAL_NAME}. Set Source files properties such as CPLUSPLUS and SWIG_FLAGS to specify special behavior of SWIG. Also global CMAKE_SWIG_FLAGS can be used to add special flags to all swig calls. Another special variable is CMAKE_SWIG_OUTDIR, it allows one to specify where to write all the swig generated module (swig -outdir option) The name-specific variable SWIG_MODULE_<name>_EXTRA_DEPS may be used to specify extra dependencies for the generated modules. If the source file generated by swig need some special flag you can use SET_SOURCE_FILES_PROPERTIES( ${swig_generated_file_fullname}

            PROPERTIES COMPILE_FLAGS "-bla")
  • Use_wxWindows: ---------------------------------------------------


    This convenience include finds if wxWindows is installed and set the appropriate libs, incdirs, flags etc. author Jan Woetzel <jw -at- mip.informatik.uni-kiel.de> (07/2003)

    USAGE:

       just include Use_wxWindows.cmake
       in your projects CMakeLists.txt

    INCLUDE( ${CMAKE_MODULE_PATH}/Use_wxWindows.cmake)

       if you are sure you need GL then

    SET(WXWINDOWS_USE_GL 1)

       *before* you include this file.
  • UsewxWidgets: Convenience include for using wxWidgets library

    Finds if wxWidgets is installed and set the appropriate libs, incdirs, flags etc. INCLUDE_DIRECTORIES, LINK_DIRECTORIES and ADD_DEFINITIONS are called.

    USAGE

      SET( wxWidgets_USE_LIBS  gl xml xrc ) # optionally: more than wx std libs
      FIND_PACKAGE(wxWidgets REQUIRED)
      INCLUDE( ${xWidgets_USE_FILE} )
      ... add your targets here, e.g. ADD_EXECUTABLE/ ADD_LIBRARY ...
      TARGET_LINK_LIBRARIERS( <yourWxDependantTarget>  ${wxWidgets_LIBRARIES})


    DEPRECATED

      LINK_LIBRARIES is not called in favor of adding dependencies per target.


    AUTHOR

      Jan Woetzel <jw -at- mip.informatik.uni-kiel.de>

Policies

  • CMP0000: A minimum required CMake version must be specified.

    CMake requires that projects specify the version of CMake to which they have been written. This policy has been put in place so users trying to build the project may be told when they need to update their CMake. Specifying a version also helps the project build with CMake versions newer than that specified. Use the cmake_minimum_required command at the top of your main CMakeLists.txt file:

      cmake_minimum_required(VERSION <major>.<minor>)

    where "<major>.<minor>" is the version of CMake you want to support (such as "2.6"). The command will ensure that at least the given version of CMake is running and help newer versions be compatible with the project. See documentation of cmake_minimum_required for details.

    Note that the command invocation must appear in the CMakeLists.txt file itself; a call in an included file is not sufficient. However, the cmake_policy command may be called to set policy CMP0000 to OLD or NEW behavior explicitly. The OLD behavior is to silently ignore the missing invocation. The NEW behavior is to issue an error instead of a warning. An included file may set CMP0000 explicitly to affect how this policy is enforced for the main CMakeLists.txt file.

    This policy was introduced in CMake version 2.6.0.

  • CMP0001: CMAKE_BACKWARDS_COMPATIBILITY should no longer be used.

    The OLD behavior is to check CMAKE_BACKWARDS_COMPATIBILITY and present it to the user. The NEW behavior is to ignore CMAKE_BACKWARDS_COMPATIBILITY completely.

    In CMake 2.4 and below the variable CMAKE_BACKWARDS_COMPATIBILITY was used to request compatibility with earlier versions of CMake. In CMake 2.6 and above all compatibility issues are handled by policies and the cmake_policy command. However, CMake must still check CMAKE_BACKWARDS_COMPATIBILITY for projects written for CMake 2.4 and below.

    This policy was introduced in CMake version 2.6.0. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0002: Logical target names must be globally unique.

    Targets names created with add_executable, add_library, or add_custom_target are logical build target names. Logical target names must be globally unique because:

      - Unique names may be referenced unambiguously both in CMake
        code and on make tool command lines.
      - Logical names are used by Xcode and VS IDE generators
        to produce meaningful project names for the targets.

    The logical name of executable and library targets does not have to correspond to the physical file names built. Consider using the OUTPUT_NAME target property to create two targets with the same physical name while keeping logical names distinct. Custom targets must simply have globally unique names (unless one uses the global property ALLOW_DUPLICATE_CUSTOM_TARGETS with a Makefiles generator).

    This policy was introduced in CMake version 2.6.0. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0003: Libraries linked via full path no longer produce linker search paths.

    This policy affects how libraries whose full paths are NOT known are found at link time, but was created due to a change in how CMake deals with libraries whose full paths are known. Consider the code

      target_link_libraries(myexe /path/to/libA.so)

    CMake 2.4 and below implemented linking to libraries whose full paths are known by splitting them on the link line into separate components consisting of the linker search path and the library name. The example code might have produced something like

      ... -L/path/to -lA ...

    in order to link to library A. An analysis was performed to order multiple link directories such that the linker would find library A in the desired location, but there are cases in which this does not work. CMake versions 2.6 and above use the more reliable approach of passing the full path to libraries directly to the linker in most cases. The example code now produces something like

      ... /path/to/libA.so ....

    Unfortunately this change can break code like

      target_link_libraries(myexe /path/to/libA.so B)

    where "B" is meant to find "/path/to/libB.so". This code is wrong because the user is asking the linker to find library B but has not provided a linker search path (which may be added with the link_directories command). However, with the old linking implementation the code would work accidentally because the linker search path added for library A allowed library B to be found.

    In order to support projects depending on linker search paths added by linking to libraries with known full paths, the OLD behavior for this policy will add the linker search paths even though they are not needed for their own libraries. When this policy is set to OLD, CMake will produce a link line such as

      ... -L/path/to /path/to/libA.so -lB ...

    which will allow library B to be found as it was previously. When this policy is set to NEW, CMake will produce a link line such as

      ... /path/to/libA.so -lB ...

    which more accurately matches what the project specified.

    The setting for this policy used when generating the link line is that in effect when the target is created by an add_executable or add_library command. For the example described above, the code

      cmake_policy(SET CMP0003 OLD) # or cmake_policy(VERSION 2.4)
      add_executable(myexe myexe.c)
      target_link_libraries(myexe /path/to/libA.so B)

    will work and suppress the warning for this policy. It may also be updated to work with the corrected linking approach:

      cmake_policy(SET CMP0003 NEW) # or cmake_policy(VERSION 2.6)
      link_directories(/path/to) # needed to find library B
      add_executable(myexe myexe.c)
      target_link_libraries(myexe /path/to/libA.so B)

    Even better, library B may be specified with a full path:

      add_executable(myexe myexe.c)
      target_link_libraries(myexe /path/to/libA.so /path/to/libB.so)

    When all items on the link line have known paths CMake does not check this policy so it has no effect.

    Note that the warning for this policy will be issued for at most one target. This avoids flooding users with messages for every target when setting the policy once will probably fix all targets.

    This policy was introduced in CMake version 2.6.0. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0004: Libraries linked may not have leading or trailing whitespace.

    CMake versions 2.4 and below silently removed leading and trailing whitespace from libraries linked with code like

      target_link_libraries(myexe " A ")

    This could lead to subtle errors in user projects.

    The OLD behavior for this policy is to silently remove leading and trailing whitespace. The NEW behavior for this policy is to diagnose the existence of such whitespace as an error. The setting for this policy used when checking the library names is that in effect when the target is created by an add_executable or add_library command.

    This policy was introduced in CMake version 2.6.0. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0005: Preprocessor definition values are now escaped automatically.

    This policy determines whether or not CMake should generate escaped preprocessor definition values added via add_definitions. CMake versions 2.4 and below assumed that only trivial values would be given for macros in add_definitions calls. It did not attempt to escape non-trivial values such as string literals in generated build rules. CMake versions 2.6 and above support escaping of most values, but cannot assume the user has not added escapes already in an attempt to work around limitations in earlier versions.

    The OLD behavior for this policy is to place definition values given to add_definitions directly in the generated build rules without attempting to escape anything. The NEW behavior for this policy is to generate correct escapes for all native build tools automatically. See documentation of the COMPILE_DEFINITIONS target property for limitations of the escaping implementation.

    This policy was introduced in CMake version 2.6.0. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0006: Installing MACOSX_BUNDLE targets requires a BUNDLE DESTINATION.

    This policy determines whether the install(TARGETS) command must be given a BUNDLE DESTINATION when asked to install a target with the MACOSX_BUNDLE property set. CMake 2.4 and below did not distinguish application bundles from normal executables when installing targets. CMake 2.6 provides a BUNDLE option to the install(TARGETS) command that specifies rules specific to application bundles on the Mac. Projects should use this option when installing a target with the MACOSX_BUNDLE property set.

    The OLD behavior for this policy is to fall back to the RUNTIME DESTINATION if a BUNDLE DESTINATION is not given. The NEW behavior for this policy is to produce an error if a bundle target is installed without a BUNDLE DESTINATION.

    This policy was introduced in CMake version 2.6.0. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0007: list command no longer ignores empty elements.

    This policy determines whether the list command will ignore empty elements in the list. CMake 2.4 and below list commands ignored all empty elements in the list. For example, a;b;;c would have length 3 and not 4. The OLD behavior for this policy is to ignore empty list elements. The NEW behavior for this policy is to correctly count empty elements in a list.

    This policy was introduced in CMake version 2.6.0. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0008: Libraries linked by full-path must have a valid library file name.

    In CMake 2.4 and below it is possible to write code like

      target_link_libraries(myexe /full/path/to/somelib)

    where "somelib" is supposed to be a valid library file name such as "libsomelib.a" or "somelib.lib". For Makefile generators this produces an error at build time because the dependency on the full path cannot be found. For VS IDE and Xcode generators this used to work by accident because CMake would always split off the library directory and ask the linker to search for the library by name (-lsomelib or somelib.lib). Despite the failure with Makefiles, some projects have code like this and build only with VS and/or Xcode. This version of CMake prefers to pass the full path directly to the native build tool, which will fail in this case because it does not name a valid library file.

    This policy determines what to do with full paths that do not appear to name a valid library file. The OLD behavior for this policy is to split the library name from the path and ask the linker to search for it. The NEW behavior for this policy is to trust the given path and pass it directly to the native build tool unchanged.

    This policy was introduced in CMake version 2.6.1. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0009: FILE GLOB_RECURSE calls should not follow symlinks by default.

    In CMake 2.6.1 and below, FILE GLOB_RECURSE calls would follow through symlinks, sometimes coming up with unexpectedly large result sets because of symlinks to top level directories that contain hundreds of thousands of files.

    This policy determines whether or not to follow symlinks encountered during a FILE GLOB_RECURSE call. The OLD behavior for this policy is to follow the symlinks. The NEW behavior for this policy is not to follow the symlinks by default, but only if FOLLOW_SYMLINKS is given as an additional argument to the FILE command.

    This policy was introduced in CMake version 2.6.2. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0010: Bad variable reference syntax is an error.

    In CMake 2.6.2 and below, incorrect variable reference syntax such as a missing close-brace ("${FOO") was reported but did not stop processing of CMake code. This policy determines whether a bad variable reference is an error. The OLD behavior for this policy is to warn about the error, leave the string untouched, and continue. The NEW behavior for this policy is to report an error.

    This policy was introduced in CMake version 2.6.3. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0011: Included scripts do automatic cmake_policy PUSH and POP.

    In CMake 2.6.2 and below, CMake Policy settings in scripts loaded by the include() and find_package() commands would affect the includer. Explicit invocations of cmake_policy(PUSH) and cmake_policy(POP) were required to isolate policy changes and protect the includer. While some scripts intend to affect the policies of their includer, most do not. In CMake 2.6.3 and above, include() and find_package() by default PUSH and POP an entry on the policy stack around an included script, but provide a NO_POLICY_SCOPE option to disable it. This policy determines whether or not to imply NO_POLICY_SCOPE for compatibility. The OLD behavior for this policy is to imply NO_POLICY_SCOPE for include() and find_package() commands. The NEW behavior for this policy is to allow the commands to do their default cmake_policy PUSH and POP.

    This policy was introduced in CMake version 2.6.3. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0012: if() recognizes numbers and boolean constants.

    In CMake versions 2.6.4 and lower the if() command implicitly dereferenced arguments corresponding to variables, even those named like numbers or boolean constants, except for 0 and 1. Numbers and boolean constants such as true, false, yes, no, on, off, y, n, notfound, ignore (all case insensitive) were recognized in some cases but not all. For example, the code "if(TRUE)" might have evaluated as false. Numbers such as 2 were recognized only in boolean expressions like "if(NOT 2)" (leading to false) but not as a single-argument like "if(2)" (also leading to false). Later versions of CMake prefer to treat numbers and boolean constants literally, so they should not be used as variable names.

    The OLD behavior for this policy is to implicitly dereference variables named like numbers and boolean constants. The NEW behavior for this policy is to recognize numbers and boolean constants without dereferencing variables with such names.

    This policy was introduced in CMake version 2.8.0. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0013: Duplicate binary directories are not allowed.

    CMake 2.6.3 and below silently permitted add_subdirectory() calls to create the same binary directory multiple times. During build system generation files would be written and then overwritten in the build tree and could lead to strange behavior. CMake 2.6.4 and above explicitly detect duplicate binary directories. CMake 2.6.4 always considers this case an error. In CMake 2.8.0 and above this policy determines whether or not the case is an error. The OLD behavior for this policy is to allow duplicate binary directories. The NEW behavior for this policy is to disallow duplicate binary directories with an error.

    This policy was introduced in CMake version 2.8.0. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

  • CMP0014: Input directories must have CMakeLists.txt.

    CMake versions before 2.8 silently ignored missing CMakeLists.txt files in directories referenced by add_subdirectory() or subdirs(), treating them as if present but empty. In CMake 2.8.0 and above this policy determines whether or not the case is an error. The OLD behavior for this policy is to silently ignore the problem. The NEW behavior for this policy is to report an error.

    This policy was introduced in CMake version 2.8.0. CMake version 2.8.0 warns when the policy is not set and uses OLD behavior. Use the cmake_policy command to set it to OLD or NEW explicitly.

Variables

Variables That Change Behavior

  • BUILD_SHARED_LIBS: Global flag to cause add_library to create shared libraries if on.

    If present and true, this will cause all libraries to be built shared unless the library was explicitly added as a static library. This variable is often added to projects as an OPTION so that each user of a project can decide if they want to build the project using shared or static libraries.

  • CMAKE_BACKWARDS_COMPATIBILITY: Version of cmake required to build project

    From the point of view of backwards compatibility, this specifies what version of CMake should be supported. By default this value is the version number of CMake that you are running. You can set this to an older version of CMake to support deprecated commands of CMake in projects that were written to use older versions of CMake. This can be set by the user or set at the beginning of a CMakeLists file.

  • CMAKE_BUILD_TYPE: Specifies the build type for make based generators.

    This specifies what build type will be built in this tree. Possible values are empty, Debug, Release, RelWithDebInfo and MinSizeRel. This variable is only supported for make based generators. If this variable is supported, then CMake will also provide initial values for the variables with the name CMAKE_C_FLAGS_[Debug|Release|RelWithDebInfo|MinSizeRel]. For example, if CMAKE_BUILD_TYPE is Debug, then CMAKE_C_FLAGS_DEBUG will be added to the CMAKE_C_FLAGS.

  • CMAKE_COLOR_MAKEFILE: Enables color output when using the Makefile generator.

    When enabled, the generated Makefiles will produce colored output. Default is ON.

  • CMAKE_CONFIGURATION_TYPES: Specifies the available build types.

    This specifies what build types will be available such as Debug, Release, RelWithDebInfo etc. This has reasonable defaults on most platforms. But can be extended to provide other build types. See also CMAKE_BUILD_TYPE.

  • CMAKE_FIND_LIBRARY_PREFIXES: Prefixes to prepend when looking for libraries.

    This specifies what prefixes to add to library names when the find_library command looks for libraries. On UNIX systems this is typically lib, meaning that when trying to find the foo library it will look for libfoo.

  • CMAKE_FIND_LIBRARY_SUFFIXES: Suffixes to append when looking for libraries.

    This specifies what suffixes to add to library names when the find_library command looks for libraries. On Windows systems this is typically .lib and .dll, meaning that when trying to find the foo library it will look for foo.dll etc.

  • CMAKE_INCLUDE_PATH: Path used for searching by FIND_FILE() and FIND_PATH().

    Specifies a path which will be used both by FIND_FILE() and FIND_PATH(). Both commands will check each of the contained directories for the existence of the file which is currently searched. By default it is empty, it is intended to be set by the project. See also CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_PREFIX_PATH.

  • CMAKE_INSTALL_PREFIX: Install directory used by install.

    If "make install" is invoked or INSTALL is built, this directory is pre-pended onto all install directories. This variable defaults to /usr/local on UNIX and c:/Program Files on Windows.

  • CMAKE_LIBRARY_PATH: Path used for searching by FIND_LIBRARY().

    Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() will check each of the contained directories for the existence of the library which is currently searched. By default it is empty, it is intended to be set by the project. See also CMAKE_SYSTEM_LIBRARY_PATH, CMAKE_PREFIX_PATH.

  • CMAKE_MFC_FLAG: Tell cmake to use MFC for an executable or dll.

    This can be set in a CMakeLists.txt file and will enable MFC in the application. It should be set to 1 for static the static MFC library, and 2 for the shared MFC library. This is used in visual studio 6 and 7 project files. The CMakeSetup dialog used MFC and the CMakeLists.txt looks like this:

    add_definitions(-D_AFXDLL)

    set(CMAKE_MFC_FLAG 2)

    add_executable(CMakeSetup WIN32 ${SRCS})

  • CMAKE_MODULE_PATH: Path to look for cmake modules to load.

    Specifies a path to override the default search path for CMake modules. For example include commands will look in this path first for modules to include.

  • CMAKE_NOT_USING_CONFIG_FLAGS: Skip _BUILD_TYPE flags if true.

    This is an internal flag used by the generators in CMake to tell CMake to skip the _BUILD_TYPE flags.

  • CMAKE_PREFIX_PATH: Path used for searching by FIND_XXX(), with appropriate suffixes added.

    Specifies a path which will be used by the FIND_XXX() commands. It contains the "base" directories, the FIND_XXX() commands append appropriate subdirectories to the base directories. So FIND_PROGRAM() adds /bin to each of the directories in the path, FIND_LIBRARY() appends /lib to each of the directories, and FIND_PATH() and FIND_FILE() append /include . By default it is empty, it is intended to be set by the project. See also CMAKE_SYSTEM_PREFIX_PATH, CMAKE_INCLUDE_PATH, CMAKE_LIBRARY_PATH, CMAKE_PROGRAM_PATH.

  • CMAKE_PROGRAM_PATH: Path used for searching by FIND_PROGRAM().

    Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() will check each of the contained directories for the existence of the program which is currently searched. By default it is empty, it is intended to be set by the project. See also CMAKE_SYSTEM_PROGRAM_PATH, CMAKE_PREFIX_PATH.

  • CMAKE_SKIP_INSTALL_ALL_DEPENDENCY: Don't make the install target depend on the all target.

    By default, the "install" target depends on the "all" target. This has the effect, that when "make install" is invoked or INSTALL is built, first the "all" target is built, then the installation starts. If CMAKE_SKIP_INSTALL_ALL_DEPENDENCY is set to TRUE, this dependency is not created, so the installation process will start immediately, independent from whether the project has been completely built or not.

  • CMAKE_SYSTEM_INCLUDE_PATH: Path used for searching by FIND_FILE() and FIND_PATH().

    Specifies a path which will be used both by FIND_FILE() and FIND_PATH(). Both commands will check each of the contained directories for the existence of the file which is currently searched. By default it contains the standard directories for the current system. It is NOT intended to be modified by the project, use CMAKE_INCLUDE_PATH for this. See also CMAKE_SYSTEM_PREFIX_PATH.

  • CMAKE_SYSTEM_LIBRARY_PATH: Path used for searching by FIND_LIBRARY().

    Specifies a path which will be used by FIND_LIBRARY(). FIND_LIBRARY() will check each of the contained directories for the existence of the library which is currently searched. By default it contains the standard directories for the current system. It is NOT intended to be modified by the project, use CMAKE_SYSTEM_LIBRARY_PATH for this. See also CMAKE_SYSTEM_PREFIX_PATH.

  • CMAKE_SYSTEM_PREFIX_PATH: Path used for searching by FIND_XXX(), with appropriate suffixes added.

    Specifies a path which will be used by the FIND_XXX() commands. It contains the "base" directories, the FIND_XXX() commands append appropriate subdirectories to the base directories. So FIND_PROGRAM() adds /bin to each of the directories in the path, FIND_LIBRARY() appends /lib to each of the directories, and FIND_PATH() and FIND_FILE() append /include . By default this contains the standard directories for the current system. It is NOT intended to be modified by the project, use CMAKE_PREFIX_PATH for this. See also CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_SYSTEM_LIBRARY_PATH, CMAKE_SYSTEM_PROGRAM_PATH.

  • CMAKE_SYSTEM_PROGRAM_PATH: Path used for searching by FIND_PROGRAM().

    Specifies a path which will be used by FIND_PROGRAM(). FIND_PROGRAM() will check each of the contained directories for the existence of the program which is currently searched. By default it contains the standard directories for the current system. It is NOT intended to be modified by the project, use CMAKE_PROGRAM_PATH for this. See also CMAKE_SYSTEM_PREFIX_PATH.

  • CMAKE_USER_MAKE_RULES_OVERRIDE: Specify a file that can change the build rule variables.

    If this variable is set, it should to point to a CMakeLists.txt file that will be read in by CMake after all the system settings have been set, but before they have been used. This would allow you to override any variables that need to be changed for some special project.

Variables That Describe the System

  • APPLE: True if running on Mac OSX.

    Set to true on Mac OSX.

  • BORLAND: True of the borland compiler is being used.

    This is set to true if the Borland compiler is being used.

  • CMAKE_CL_64: Using the 64 bit compiler from Microsoft

    Set to true when using the 64 bit cl compiler from Microsoft.

  • CMAKE_COMPILER_2005: Using the Visual Studio 2005 compiler from Microsoft

    Set to true when using the Visual Studio 2005 compiler from Microsoft.

  • CMAKE_HOST_APPLE: True for Apple OSXoperating systems.

    Set to true when the host system is Apple OSX.

  • CMAKE_HOST_SYSTEM: Name of system cmake is being run on.

    The same as CMAKE_SYSTEM but for the host system instead of the target system when cross compiling.

  • CMAKE_HOST_SYSTEM_NAME: Name of the OS CMake is running on.

    The same as CMAKE_SYSTEM_NAME but for the host system instead of the target system when cross compiling.

  • CMAKE_HOST_SYSTEM_PROCESSOR: The name of the CPU CMake is running on.

    The same as CMAKE_SYSTEM_PROCESSOR but for the host system instead of the target system when cross compiling.

  • CMAKE_HOST_SYSTEM_VERSION: OS version CMake is running on.

    The same as CMAKE_SYSTEM_VERSION but for the host system instead of the target system when cross compiling.

  • CMAKE_HOST_UNIX: True for UNIX and UNIX like operating systems.

    Set to true when the host system is UNIX or UNIX like (i.e. APPLE and CYGWIN).

  • CMAKE_HOST_WIN32: True on windows systems, including win64.

    Set to true when the host system is Windows and on cygwin.

  • CMAKE_OBJECT_PATH_MAX: Maximum object file full-path length allowed by native build tools.

    CMake computes for every source file an object file name that is unique to the source file and deterministic with respect to the full path to the source file. This allows multiple source files in a target to share the same name if they lie in different directories without rebuilding when one is added or removed. However, it can produce long full paths in a few cases, so CMake shortens the path using a hashing scheme when the full path to an object file exceeds a limit. CMake has a built-in limit for each platform that is sufficient for common tools, but some native tools may have a lower limit. This variable may be set to specify the limit explicitly. The value must be an integer no less than 128.

  • CMAKE_SYSTEM: Name of system cmake is compiling for.

    This variable is the composite of CMAKE_SYSTEM_NAME and CMAKE_SYSTEM_VERSION, like this ${CMAKE_SYSTEM_NAME}-${CMAKE_SYSTEM_VERSION}. If CMAKE_SYSTEM_VERSION is not set, then CMAKE_SYSTEM is the same as CMAKE_SYSTEM_NAME.

  • CMAKE_SYSTEM_NAME: Name of the OS CMake is building for.

    This is the name of the operating system on which CMake is targeting. On systems that have the uname command, this variable is set to the output of uname -s. Linux, Windows, and Darwin for Mac OSX are the values found on the big three operating systems.

  • CMAKE_SYSTEM_PROCESSOR: The name of the CPU CMake is building for.

    On systems that support uname, this variable is set to the output of uname -p, on windows it is set to the value of the environment variable PROCESSOR_ARCHITECTURE

  • CMAKE_SYSTEM_VERSION: OS version CMake is building for.

    A numeric version string for the system, on systems that support uname, this variable is set to the output of uname -r. On other systems this is set to major-minor version numbers.

  • CYGWIN: True for cygwin.

    Set to true when using CYGWIN.

  • MSVC: True when using Microsoft Visual C

    Set to true when the compiler is some version of Microsoft Visual C.

  • MSVC80: True when using Microsoft Visual C 8.0

    Set to true when the compiler is version 8.0 of Microsoft Visual C.

  • MSVC_IDE: True when using the Microsoft Visual C IDE

    Set to true when the target platform is the Microsoft Visual C IDE, as opposed to the command line compiler.

  • MSVC_VERSION: The version of Microsoft Visual C/C++ being used if any.

    The version of Microsoft Visual C/C++ being used if any. For example 1300 is MSVC 6.0.

  • UNIX: True for UNIX and UNIX like operating systems.

    Set to true when the target system is UNIX or UNIX like (i.e. APPLE and CYGWIN).

  • WIN32: True on windows systems, including win64.

    Set to true when the target system is Windows and on cygwin.

  • XCODE_VERSION: Version of Xcode (Xcode generator only).

    Under the Xcode generator, this is the version of Xcode as specified in "Xcode.app/Contents/version.plist" (such as "3.1.2").

Variables for Languages

  • CMAKE_<LANG>_ARCHIVE_APPEND: Rule variable to append to a static archive.

    This is a rule variable that tells CMake how to append to a static archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on some platforms in order to support large object counts. See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_FINISH.

  • CMAKE_<LANG>_ARCHIVE_CREATE: Rule variable to create a new static archive.

    This is a rule variable that tells CMake how to create a static archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on some platforms in order to support large object counts. See also CMAKE_<LANG>_ARCHIVE_APPEND and CMAKE_<LANG>_ARCHIVE_FINISH.

  • CMAKE_<LANG>_ARCHIVE_FINISH: Rule variable to finish an existing static archive.

    This is a rule variable that tells CMake how to finish a static archive. It is used in place of CMAKE_<LANG>_CREATE_STATIC_LIBRARY on some platforms in order to support large object counts. See also CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_ARCHIVE_APPEND.

  • CMAKE_<LANG>_COMPILER: The full path to the compiler for LANG.

    This is the command that will be used as the <LANG> compiler. Once set, you can not change this variable.

  • CMAKE_<LANG>_COMPILER_ABI: An internal variable subject to change.

    This is used in determining the compiler ABI and is subject to change.

  • CMAKE_<LANG>_COMPILER_ID: An internal variable subject to change.

    This is used in determining the compiler and is subject to change.

  • CMAKE_<LANG>_COMPILER_LOADED: Defined to true if the language is enabled.

    When language <LANG> is enabled by project() or enable_language() this variable is defined to 1.

  • CMAKE_<LANG>_COMPILE_OBJECT: Rule variable to compile a single object file.

    This is a rule variable that tells CMake how to compile a single object file for for the language <LANG>.

  • CMAKE_<LANG>_CREATE_SHARED_LIBRARY: Rule variable to create a shared library.

    This is a rule variable that tells CMake how to create a shared library for the language <LANG>.

  • CMAKE_<LANG>_CREATE_SHARED_MODULE: Rule variable to create a shared module.

    This is a rule variable that tells CMake how to create a shared library for the language <LANG>.

  • CMAKE_<LANG>_CREATE_STATIC_LIBRARY: Rule variable to create a static library.

    This is a rule variable that tells CMake how to create a static library for the language <LANG>.

  • CMAKE_<LANG>_FLAGS_DEBUG: Flags for Debug build type or configuration.

    <LANG> flags used when CMAKE_BUILD_TYPE is Debug.

  • CMAKE_<LANG>_FLAGS_MINSIZEREL: Flags for MinSizeRel build type or configuration.

    <LANG> flags used when CMAKE_BUILD_TYPE is MinSizeRel.Short for minimum size release.

  • CMAKE_<LANG>_FLAGS_RELEASE: Flags for Release build type or configuration.

    <LANG> flags used when CMAKE_BUILD_TYPE is Release

  • CMAKE_<LANG>_FLAGS_RELWITHDEBINFO: Flags for RelWithDebInfo type or configuration.

    <LANG> flags used when CMAKE_BUILD_TYPE is RelWithDebInfo. Short for Release With Debug Information.

  • CMAKE_<LANG>_IGNORE_EXTENSIONS: File extensions that should be ignored by the build.

    This is a list of file extensions that may be part of a project for a given language but are not compiled.

  • CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES: Directories implicitly searched by the compiler for header files.

    CMake does not explicitly specify these directories on compiler command lines for language <LANG>. This prevents system include directories from being treated as user include directories on some compilers.

  • CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES: Implicit linker search path detected for language <LANG>.

    Compilers typically pass directories containing language runtime libraries and default library search paths when they invoke a linker. These paths are implicit linker search directories for the compiler's language. CMake automatically detects these directories for each language and reports the results in this variable.

  • CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES: Implicit link libraries and flags detected for language <LANG>.

    Compilers typically pass language runtime library names and other flags when they invoke a linker. These flags are implicit link options for the compiler's language. CMake automatically detects these libraries and flags for each language and reports the results in this variable.

  • CMAKE_<LANG>_LINKER_PREFERENCE: Preference value for linker language selection.

    The "linker language" for executable, shared library, and module targets is the language whose compiler will invoke the linker. The LINKER_LANGUAGE target property sets the language explicitly. Otherwise, the linker language is that whose linker preference value is highest among languages compiled and linked into the target. See also the CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES variable.

  • CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES: True if CMAKE_<LANG>_LINKER_PREFERENCE propagates across targets.

    This is used when CMake selects a linker language for a target. Languages compiled directly into the target are always considered. A language compiled into static libraries linked by the target is considered if this variable is true.

  • CMAKE_<LANG>_LINK_EXECUTABLE : Rule variable to link and executable.

    Rule variable to link and executable for the given language.

  • CMAKE_<LANG>_OUTPUT_EXTENSION: Extension for the output of a compile for a single file.

    This is the extension for an object file for the given <LANG>. For example .obj for C on Windows.

  • CMAKE_<LANG>_PLATFORM_ID: An internal variable subject to change.

    This is used in determining the platform and is subject to change.

  • CMAKE_<LANG>_SIZEOF_DATA_PTR: Size of pointer-to-data types for language <LANG>.

    This holds the size (in bytes) of pointer-to-data types in the target platform ABI. It is defined for languages C and CXX (C++).

  • CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS: Extensions of source files for the given language.

    This is the list of extensions for a given languages source files.

  • CMAKE_COMPILER_IS_GNU<LANG>: True if the compiler is GNU.

    If the selected <LANG> compiler is the GNU compiler then this is TRUE, if not it is FALSE.

  • CMAKE_INTERNAL_PLATFORM_ABI: An internal variable subject to change.

    This is used in determining the compiler ABI and is subject to change.

  • CMAKE_USER_MAKE_RULES_OVERRIDE_<LANG>: Specify a file that can change the build rule variables.

    If this variable is set, it should to point to a CMakeLists.txt file that will be read in by CMake after all the system settings have been set, but before they have been used. This would allow you to override any variables that need to be changed for some language.

Variables that Control the Build

  • CMAKE_<CONFIG>_POSTFIX: Default filename postfix for libraries under configuration <CONFIG>.

    When a non-executable target is created its <CONFIG>_POSTFIX target property is initialized with the value of this variable if it is set.

  • CMAKE_ARCHIVE_OUTPUT_DIRECTORY: Where to put all the ARCHIVE targets when built.

    This variable is used to initialize the ARCHIVE_OUTPUT_DIRECTORY property on all the targets. See that target property for additional information.

  • CMAKE_BUILD_WITH_INSTALL_RPATH: Use the install path for the RPATH

    Normally CMake uses the build tree for the RPATH when building executables etc on systems that use RPATH. When the software is installed the executables etc are relinked by CMake to have the install RPATH. If this variable is set to true then the software is always built with the install path for the RPATH and does not need to be relinked when installed.

  • CMAKE_DEBUG_POSTFIX: See variable CMAKE_<CONFIG>_POSTFIX.

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

  • CMAKE_EXE_LINKER_FLAGS: Linker flags used to create executables.

    Flags used by the linker when creating an executable.

  • CMAKE_EXE_LINKER_FLAGS_[CMAKE_BUILD_TYPE]: Flag used when linking an executable.

    Same as CMAKE_C_FLAGS_* but used by the linker when creating executables.

  • CMAKE_Fortran_MODULE_DIRECTORY: Fortran module output directory.

    This variable is used to initialize the Fortran_MODULE_DIRECTORY property on all the targets. See that target property for additional information.

  • CMAKE_INCLUDE_CURRENT_DIR: Automatically add the current source- and build directories to the include path.

    If this variable is enabled, CMake automatically adds in each directory ${CMAKE_CURRENT_SOURCE_DIR} and ${CMAKE_CURRENT_BINARY_DIR} to the include path for this directory. These additional include directories do not propagate down to subdirectories. This is useful mainly for out-of-source builds, where files generated into the build tree are included by files located in the source tree.

    By default CMAKE_INCLUDE_CURRENT_DIR is OFF.

  • CMAKE_INSTALL_NAME_DIR: Mac OSX directory name for installed targets.

    CMAKE_INSTALL_NAME_DIR is used to initialize the INSTALL_NAME_DIR property on all targets. See that target property for more information.

  • CMAKE_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 is used to initialize the target property INSTALL_RPATH for all targets.

  • CMAKE_INSTALL_RPATH_USE_LINK_PATH: Add paths to linker search and installed rpath.

    CMAKE_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 is used to initialize the target property INSTALL_RPATH_USE_LINK_PATH for all targets.

  • CMAKE_LIBRARY_OUTPUT_DIRECTORY: Where to put all the LIBRARY targets when built.

    This variable is used to initialize the LIBRARY_OUTPUT_DIRECTORY property on all the targets. See that target property for additional information.

  • CMAKE_LIBRARY_PATH_FLAG: The flag used to add a library search path to a compiler.

    The flag used to specify a library directory to the compiler. On most compilers this is "-L".

  • CMAKE_LINK_DEF_FILE_FLAG : Linker flag used to specify a .def file for dll creation.

    The flag used to add a .def file when creating a dll on Windows, this is only defined on Windows.

  • CMAKE_LINK_LIBRARY_FILE_FLAG: Flag used to link a library specified by a path to its file.

    The flag used before a library file path is given to the linker. This is needed only on very few platforms.

  • CMAKE_LINK_LIBRARY_FLAG: Flag used to link a library into an executable.

    The flag used to specify a library to link to an executable. On most compilers this is "-l".

  • CMAKE_NO_BUILTIN_CHRPATH: Do not use the builtin ELF editor to fix RPATHs on installation.

    When an ELF binary needs to have a different RPATH after installation than it does in the build tree, CMake uses a builtin editor to change the RPATH in the installed copy. If this variable is set to true then CMake will relink the binary before installation instead of using its builtin editor.

  • CMAKE_RUNTIME_OUTPUT_DIRECTORY: Where to put all the RUNTIME targets when built.

    This variable is used to initialize the RUNTIME_OUTPUT_DIRECTORY property on all the targets. See that target property for additional information.

  • CMAKE_SKIP_BUILD_RPATH: Do not include RPATHs in the build tree.

    Normally CMake uses the build tree for the RPATH when building executables etc on systems that use RPATH. When the software is installed the executables etc are relinked by CMake to have the install RPATH. If this variable is set to true then the software is always built with no RPATH.

  • CMAKE_USE_RELATIVE_PATHS: Use relative paths (May not work!).

    If this is set to TRUE, then the CMake will use relative paths between the source and binary tree. This option does not work for more complicated projects, and relative paths are used when possible. In general, it is not possible to move CMake generated makefiles to a different location regardless of the value of this variable.

  • EXECUTABLE_OUTPUT_PATH: Old executable location variable.

    The target property RUNTIME_OUTPUT_DIRECTORY supercedes this variable for a target if it is set. Executable targets are otherwise placed in this directory.

  • LIBRARY_OUTPUT_PATH: Old library location variable.

    The target properties ARCHIVE_OUTPUT_DIRECTORY, LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY supercede this variable for a target if they are set. Library targets are otherwise placed in this directory.

Variables that Provide Information

variables defined by cmake, that give information about the project, and cmake

  • CMAKE_AR: Name of archiving tool for static libraries.

    This specifies name of the program that creates archive or static libraries.

  • CMAKE_BINARY_DIR: The path to the top level of the build tree.

    This is the full path to the top level of the current CMake build tree. For an in-source build, this would be the same as CMAKE_SOURCE_DIR.

  • CMAKE_BUILD_TOOL: Tool used for the actual build process.

    This variable is set to the program that will be needed to build the output of CMake. If the generator selected was Visual Studio 6, the CMAKE_MAKE_PROGRAM will be set to msdev, for Unix makefiles it will be set to make or gmake, and for Visual Studio 7 it set to devenv. For Nmake Makefiles the value is nmake. This can be useful for adding special flags and commands based on the final build environment.

  • CMAKE_CACHEFILE_DIR: The directory with the CMakeCache.txt file.

    This is the full path to the directory that has the CMakeCache.txt file in it. This is the same as CMAKE_BINARY_DIR.

  • CMAKE_CACHE_MAJOR_VERSION: Major version of CMake used to create the CMakeCache.txt file

    This is stores the major version of CMake used to write a CMake cache file. It is only different when a different version of CMake is run on a previously created cache file.

  • CMAKE_CACHE_MINOR_VERSION: Minor version of CMake used to create the CMakeCache.txt file

    This is stores the minor version of CMake used to write a CMake cache file. It is only different when a different version of CMake is run on a previously created cache file.

  • CMAKE_CACHE_PATCH_VERSION: Patch version of CMake used to create the CMakeCache.txt file

    This is stores the patch version of CMake used to write a CMake cache file. It is only different when a different version of CMake is run on a previously created cache file.

  • CMAKE_CFG_INTDIR: Build-time reference to per-configuration output subdirectory.

    For native build systems supporting multiple configurations in the build tree (such as Visual Studio and Xcode), the value is a reference to a build-time variable specifying the name of the per-configuration output subdirectory. On Makefile generators this evaluates to "." because there is only one configuration in a build tree. Example values:

      $(IntDir)        = Visual Studio 6
      $(OutDir)        = Visual Studio 7, 8, 9
      $(Configuration) = Visual Studio 10
      $(CONFIGURATION) = Xcode
      .                = Make-based tools

    Since these values are evaluated by the native build system, this variable is suitable only for use in command lines that will be evaluated at build time. Example of intended usage:

      add_executable(mytool mytool.c)
      add_custom_command(
        OUTPUT out.txt
        COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool
                ${CMAKE_CURRENT_SOURCE_DIR}/in.txt out.txt
        DEPENDS mytool in.txt
        )
      add_custom_target(drive ALL DEPENDS out.txt)

    Note that CMAKE_CFG_INTDIR is no longer necessary for this purpose but has been left for compatibility with existing projects. Instead add_custom_command() recognizes executable target names in its COMMAND option, so "${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool" can be replaced by just "mytool".

    This variable is read-only. Setting it is undefined behavior. In multi-configuration build systems the value of this variable is passed as the value of preprocessor symbol "CMAKE_INTDIR" to the compilation of all source files.

  • CMAKE_COMMAND: The full path to the cmake executable.

    This is the full path to the CMake executable cmake which is useful from custom commands that want to use the cmake -E option for portable system commands. (e.g. /usr/local/bin/cmake

  • CMAKE_CROSSCOMPILING: Is CMake currently cross compiling.

    This variable will be set to true by CMake if CMake is cross compiling. Specifically if the build platform is different from the target platform.

  • CMAKE_CTEST_COMMAND: Full path to ctest command installed with cmake.

    This is the full path to the CTest executable ctest which is useful from custom commands that want to use the cmake -E option for portable system commands.

  • CMAKE_CURRENT_BINARY_DIR: The path to the binary directory currently being processed.

    This the full path to the build directory that is currently being processed by cmake. Each directory added by add_subdirectory will create a binary directory in the build tree, and as it is being processed this variable will be set. For in-source builds this is the current source directory being processed.

  • CMAKE_CURRENT_LIST_FILE: Full path to the listfile currently being processed.

    As CMake processes the listfiles in your project this variable will always be set to the one currently being processed. The value has dynamic scope. When CMake starts processing commands in a source file it sets this variable to the location of the file. When CMake finishes processing commands from the file it restores the previous value. Therefore the value of the variable inside a macro or function is the file invoking the bottom-most entry on the call stack, not the file containing the macro or function definition.

    See also CMAKE_PARENT_LIST_FILE.

  • CMAKE_CURRENT_LIST_LINE: The line number of the current file being processed.

    This is the line number of the file currently being processed by cmake.

  • CMAKE_CURRENT_SOURCE_DIR: The path to the source directory currently being processed.

    This the full path to the source directory that is currently being processed by cmake.

  • CMAKE_DL_LIBS: Name of library containing dlopen and dlcose.

    The name of the library that has dlopen and dlclose in it, usually -ldl on most UNIX machines.

  • CMAKE_EDIT_COMMAND: Full path to cmake-gui or ccmake.

    This is the full path to the CMake executable that can graphically edit the cache. For example, cmake-gui, ccmake, or cmake -i.

  • CMAKE_EXECUTABLE_SUFFIX: The suffix for executables on this platform.

    The suffix to use for the end of an executable if any, .exe on Windows.

    CMAKE_EXECUTABLE_SUFFIX_<LANG> overrides this for language <LANG>.

  • CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES: Additional suffixes for shared libraries.

    Extensions for shared libraries other than that specified by CMAKE_SHARED_LIBRARY_SUFFIX, if any. CMake uses this to recognize external shared library files during analysis of libraries linked by a target.

  • CMAKE_GENERATOR: The generator used to build the project.

    The name of the generator that is being used to generate the build files. (e.g. "Unix Makefiles", "Visual Studio 6", etc.)

  • CMAKE_HOME_DIRECTORY: Path to top of source tree.

    This is the path to the top level of the source tree.

  • CMAKE_IMPORT_LIBRARY_PREFIX: The prefix for import libraries that you link to.

    The prefix to use for the name of an import library if used on this platform.

    CMAKE_IMPORT_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>.

  • CMAKE_IMPORT_LIBRARY_SUFFIX: The suffix for import libraries that you link to.

    The suffix to use for the end of an import library if used on this platform.

    CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>.

  • CMAKE_LINK_LIBRARY_SUFFIX: The suffix for libraries that you link to.

    The suffix to use for the end of a library, .lib on Windows.

  • CMAKE_MAJOR_VERSION: The Major version of cmake (i.e. the 2 in 2.X.X)

    This specifies the major version of the CMake executable being run.

  • CMAKE_MAKE_PROGRAM: See CMAKE_BUILD_TOOL.

    This variable is around for backwards compatibility, see CMAKE_BUILD_TOOL.

  • CMAKE_MINOR_VERSION: The Minor version of cmake (i.e. the 4 in X.4.X).

    This specifies the minor version of the CMake executable being run.

  • CMAKE_PARENT_LIST_FILE: Full path to the parent listfile of the one currently being processed.

    As CMake processes the listfiles in your project this variable will always be set to the listfile that included or somehow invoked the one currently being processed. See also CMAKE_CURRENT_LIST_FILE.

  • CMAKE_PATCH_VERSION: The patch version of cmake (i.e. the 3 in X.X.3).

    This specifies the patch version of the CMake executable being run.

  • CMAKE_PROJECT_NAME: The name of the current project.

    This specifies name of the current project from the closest inherited PROJECT command.

  • CMAKE_RANLIB: Name of randomizing tool for static libraries.

    This specifies name of the program that randomizes libraries on UNIX, not used on Windows, but may be present.

  • CMAKE_ROOT: Install directory for running cmake.

    This is the install root for the running CMake and the Modules directory can be found here. This is commonly used in this format: ${CMAKE_ROOT}/Modules

  • CMAKE_SHARED_LIBRARY_PREFIX: The prefix for shared libraries that you link to.

    The prefix to use for the name of a shared library, lib on UNIX.

    CMAKE_SHARED_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>.

  • CMAKE_SHARED_LIBRARY_SUFFIX: The suffix for shared libraries that you link to.

    The suffix to use for the end of a shared library, .dll on Windows.

    CMAKE_SHARED_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>.

  • CMAKE_SHARED_MODULE_PREFIX: The prefix for loadable modules that you link to.

    The prefix to use for the name of a loadable module on this platform.

    CMAKE_SHARED_MODULE_PREFIX_<LANG> overrides this for language <LANG>.

  • CMAKE_SHARED_MODULE_SUFFIX: The suffix for shared libraries that you link to.

    The suffix to use for the end of a loadable module on this platform

    CMAKE_SHARED_MODULE_SUFFIX_<LANG> overrides this for language <LANG>.

  • CMAKE_SIZEOF_VOID_P: Size of a void pointer.

    This is set to the size of a pointer on the machine, and is determined by a try compile. If a 64 bit size is found, then the library search path is modified to look for 64 bit libraries first.

  • CMAKE_SKIP_RPATH: If true, do not add run time path information.

    If this is set to TRUE, then the rpath information is not added to compiled executables. The default is to add rpath information if the platform supports it.This allows for easy running from the build tree.

  • CMAKE_SOURCE_DIR: The path to the top level of the source tree.

    This is the full path to the top level of the current CMake source tree. For an in-source build, this would be the same as CMAKE_BINARY_DIR.

  • CMAKE_STANDARD_LIBRARIES: Libraries linked into every executable and shared library.

    This is the list of libraries that are linked into all executables and libraries.

  • CMAKE_STATIC_LIBRARY_PREFIX: The prefix for static libraries that you link to.

    The prefix to use for the name of a static library, lib on UNIX.

    CMAKE_STATIC_LIBRARY_PREFIX_<LANG> overrides this for language <LANG>.

  • CMAKE_STATIC_LIBRARY_SUFFIX: The suffix for static libraries that you link to.

    The suffix to use for the end of a static library, .lib on Windows.

    CMAKE_STATIC_LIBRARY_SUFFIX_<LANG> overrides this for language <LANG>.

  • CMAKE_USING_VC_FREE_TOOLS: True if free visual studio tools being used.

    This is set to true if the compiler is Visual Studio free tools.

  • CMAKE_VERBOSE_MAKEFILE: Create verbose makefiles if on.

    This variable defaults to false. You can set this variable to true to make CMake produce verbose makefiles that show each command line as it is used.

  • CMAKE_VERSION: The full version of cmake in major.minor.patch format.

    This specifies the full version of the CMake executable being run. This variable is defined by versions 2.6.3 and higher. See variables CMAKE_MAJOR_VERSION, CMAKE_MINOR_VERSION, and CMAKE_PATCH_VERSION for individual version components.

  • PROJECT_BINARY_DIR: Full path to build directory for project.

    This is the binary directory of the most recent PROJECT command.

  • PROJECT_NAME: Name of the project given to the project command.

    This is the name given to the most recent PROJECT command.

  • PROJECT_SOURCE_DIR: Top level source directory for the current project.

    This is the source directory of the most recent PROJECT command.

  • [Project name]_BINARY_DIR: Top level binary directory for the named project.

    A variable is created with the name used in the PROJECT command, and is the binary directory for the project. This can be useful when SUBDIR is used to connect several projects.

  • [Project name]_SOURCE_DIR: Top level source directory for the named project.

    A variable is created with the name used in the PROJECT command, and is the source directory for the project. This can be useful when add_subdirectory is used to connect several projects.

Copyright

Copyright 2000-2009 Kitware, Inc., Insight Software Consortium. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

Neither the names of Kitware, Inc., the Insight Software Consortium, nor the names of their contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

See Also

The following resources are available to get help using CMake:

Summary of helpful links:

  Home: http://www.cmake.org
  Docs: http://www.cmake.org/HTML/Documentation.html
  Mail: http://www.cmake.org/HTML/MailingLists.html
  FAQ:  http://www.cmake.org/Wiki/CMake_FAQ