--- name: "cmakemodules" section: "1" platform: "linux" package: "cmake-data" version: "2.8.9-1" release: "Debian 7 (Wheezy)" platforms: ["linux"] url: "https://new.carta.tech/cmakemodules" --- # cmakemodules(1) Reference of available CMake modules. ## NAME cmakemodules - Reference of available CMake modules. ## 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. ## 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** Functions to help assemble a standalone bundle application. 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 module: ``` fixup_bundle copy_and_fixup_bundle verify_app 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 copy_resolved_framework_into_bundle fixup_bundle_item verify_bundle_prerequisites verify_bundle_symlinks ``` Requires CMake 2.6 or greater because it uses function, break and PARENT\_SCOPE. Also depends on GetPrerequisites.cmake. ``` FIXUP_BUNDLE( ) ``` Fix up a bundle in-place and make it standalone, such that it can be drag-n-drop copied to another machine and run on that machine as long as all of the system libraries are compatible. If you pass plugins to fixup\_bundle as the libs parameter, you should install them or copy them into the bundle before calling fixup\_bundle. The "libs" parameter is a list of libraries that must be fixed up, but that cannot be determined by otool output analysis. (i.e., plugins) Gather all the keys for all the executables and libraries in a bundle, and then, for each key, copy each prerequisite into the bundle. Then fix each one up according to its own list of prerequisites. Then clear all the keys and call verify\_app on the final bundle to ensure that it is truly standalone. ``` COPY_AND_FIXUP_BUNDLE( ) ``` Makes a copy of the bundle \ at location \ and then fixes up the new copied bundle in-place at \... ``` VERIFY_APP() ``` Verifies that an application \ appears valid based on running analysis tools on it. Calls "message(FATAL\_ERROR" if the application is not verified. ``` GET_BUNDLE_MAIN_EXECUTABLE( ) ``` The result will be the full path name of the bundle's main executable file or an "error:" prefixed string if it could not be determined. ``` GET_DOTAPP_DIR( ) ``` Returns the nearest parent dir whose name ends with ".app" given the full path to an executable. If there is no such parent dir, then simply return the dir containing the executable. The returned directory may or may not exist. ``` GET_BUNDLE_AND_EXECUTABLE( ) ``` Takes either a ".app" directory name or the name of an executable nested inside a ".app" directory and returns the path to the ".app" directory in \ and the path to its main executable in \ ``` GET_BUNDLE_ALL_EXECUTABLES( ) ``` Scans the given bundle recursively for all executable files and accumulates them into a variable. ``` GET_ITEM_KEY( ) ``` Given a file (item) name, generate a key that should be unique considering the set of libraries that need copying or fixing up to make a bundle standalone. This is essentially the file name including extension with "." replaced by "\_" This key is used as a prefix for CMake variables so that we can associate a set of variables with a given item based on its key. ``` CLEAR_BUNDLE_KEYS() ``` Loop over the list of keys, clearing all the variables associated with each key. After the loop, clear the list of keys itself. Caller of get\_bundle\_keys should call clear\_bundle\_keys when done with list of keys. ``` SET_BUNDLE_KEY_VALUES( ) ``` Add a key to the list (if necessary) for the given item. If added, also set all the variables associated with that key. ``` GET_BUNDLE_KEYS( ) ``` Loop over all the executable and library files within the bundle (and given as extra \) and accumulate a list of keys representing them. Set values associated with each key such that we can loop over all of them and copy prerequisite libs into the bundle and then do appropriate install\_name\_tool fixups. ``` COPY_RESOLVED_ITEM_INTO_BUNDLE( ) ``` Copy a resolved item into the bundle if necessary. Copy is not necessary if the resolved\_item is "the same as" the resolved\_embedded\_item. ``` COPY_RESOLVED_FRAMEWORK_INTO_BUNDLE( ) ``` Copy a resolved framework into the bundle if necessary. Copy is not necessary if the resolved\_item is "the same as" the resolved\_embedded\_item. By default, BU\_COPY\_FULL\_FRAMEWORK\_CONTENTS is not set. If you want full frameworks embedded in your bundles, set BU\_COPY\_FULL\_FRAMEWORK\_CONTENTS to ON before calling fixup\_bundle. By default, COPY\_RESOLVED\_FRAMEWORK\_INTO\_BUNDLE copies the framework dylib itself plus the framework Resources directory. ``` FIXUP_BUNDLE_ITEM( ) ``` Get the direct/non-system prerequisites of the resolved embedded item. For each prerequisite, change the way it is referenced to the value of the \_EMBEDDED\_ITEM keyed variable for that prerequisite. (Most likely changing to an "@executable\_path" style reference.) This function requires that the resolved\_embedded\_item be "inside" the bundle already. In other words, if you pass plugins to fixup\_bundle as the libs parameter, you should install them or copy them into the bundle before calling fixup\_bundle. The "libs" parameter is a list of libraries that must be fixed up, but that cannot be determined by otool output analysis. (i.e., plugins) Also, change the id of the item being fixed up to its own \_EMBEDDED\_ITEM value. Accumulate changes in a local variable and make \*one\* call to install\_name\_tool at the end of the function with all the changes at once. If the BU\_CHMOD\_BUNDLE\_ITEMS variable is set then bundle items will be marked writable before install\_name\_tool tries to change them. ``` VERIFY_BUNDLE_PREREQUISITES( ) ``` Verifies that the sum of all prerequisites of all files inside the bundle are contained within the bundle or are "system" libraries, presumed to exist everywhere. ``` VERIFY_BUNDLE_SYMLINKS( ) ``` Verifies that any symlinks found in the bundle point to other files that are already also in the bundle... Anything that points to an external file causes this function to fail the verification. - **CMakeAddFortranSubdirectory** Use MinGW gfortran from VS if a fortran compiler is not found. The 'add\_fortran\_subdirectory' function adds a subdirectory to a project that contains a fortran only sub-project. The module will check the current compiler and see if it can support fortran. If no fortran compiler is found and the compiler is MSVC, then this module will find the MinGW gfortran. It will then use an external project to build with the MinGW tools. It will also create imported targets for the libraries created. This will only work if the fortran code is built into a dll, so BUILD\_SHARED\_LIBS is turned on in the project. In addition the CMAKE\_GNUtoMS option is set to on, so that the MS .lib files are created. Usage is as follows: ``` cmake_add_fortran_subdirectory( # name of subdirectory PROJECT # project name in subdir top CMakeLists.txt ARCHIVE_DIR # dir where project places .lib files RUNTIME_DIR # dir where project places .dll files LIBRARIES ... # names of library targets to import LINK_LIBRARIES # link interface libraries for LIBRARIES [LINK_LIBS ...]... CMAKE_COMMAND_LINE ... # extra command line flags to pass to cmake NO_EXTERNAL_INSTALL # skip installation of external project ) ``` Relative paths in ARCHIVE\_DIR and RUNTIME\_DIR are interpreted with respect to the build directory corresponding to the source directory in which the function is invoked. Limitations: NO\_EXTERNAL\_INSTALL is required for forward compatibility with a future version that supports installation of the external project binaries during "make install". - **CMakeBackwardCompatibilityCXX** define a bunch of backwards compatibility variables ``` CMAKE_ANSI_CXXFLAGS - flag for ansi c++ CMAKE_HAS_ANSI_STRING_STREAM - has 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 vc100 vc100sp1 ``` Usage: =========================== ``` if(MSVC) include(CMakeDetermineVSServicePack) DetermineVSServicePack( my_service_pack ) ``` ``` if( my_service_pack ) message(STATUS "Detected: ${my_service_pack}") endif() endif() ``` \=========================== - **CMakeExpandImportedTargets** ``` ``` CMAKE\_EXPAND\_IMPORTED\_TARGETS(\ LIBRARIES lib1 lib2...libN ``` [CONFIGURATION ] ) ``` CMAKE\_EXPAND\_IMPORTED\_TARGETS() takes a list of libraries and replaces all imported targets contained in this list with their actual file paths of the referenced libraries on disk, including the libraries from their link interfaces. If a CONFIGURATION is given, it uses the respective configuration of the imported targets if it exists. If no CONFIGURATION is given, it uses the first configuration from ${CMAKE\_CONFIGURATION\_TYPES} if set, otherwise ${CMAKE\_BUILD\_TYPE}. This macro is used by all Check\*.cmake files which use TRY\_COMPILE() or TRY\_RUN() and support CMAKE\_REQUIRED\_LIBRARIES , so that these checks support imported targets in CMAKE\_REQUIRED\_LIBRARIES: ``` cmake_expand_imported_targets(expandedLibs LIBRARIES ${CMAKE_REQUIRED_LIBRARIES} CONFIGURATION "${CMAKE_TRY_COMPILE_CONFIGURATION}" ) ``` - **CMakeFindFrameworks** helper module to find OSX frameworks - **CMakeFindPackageMode** ``` ``` This file is executed by cmake when invoked with --find-package. It expects that the following variables are set using -D: ``` NAME = name of the package COMPILER_ID = the CMake compiler ID for which the result is, i.e. GNU/Intel/Clang/MSVC, etc. LANGUAGE = language for which the result will be used, i.e. C/CXX/Fortan/ASM MODE = EXIST : only check for existance of the given package COMPILE : print the flags needed for compiling an object file which uses the given package LINK : print the flags needed for linking when using the given package QUIET = if TRUE, don't print anything ``` - **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( ) ``` 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( ) ``` 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. Macro CMAKE\_FORCE\_Fortran\_COMPILER has the following signature: ``` CMAKE_FORCE_Fortran_COMPILER( ) ``` It sets CMAKE\_Fortran\_COMPILER to the given compiler and the cmake internal variable CMAKE\_Fortran\_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) ``` - **CMakePackageConfigHelpers** CONFIGURE\_PACKAGE\_CONFIG\_FILE(), WRITE\_BASIC\_PACKAGE\_VERSION\_FILE() ``` CONFIGURE_PACKAGE_CONFIG_FILE( INSTALL_DESTINATION [PATH_VARS ... ] [NO_SET_AND_CHECK_MACRO] [NO_CHECK_REQUIRED_COMPONENTS_MACRO]) ``` CONFIGURE\_PACKAGE\_CONFIG\_FILE() should be used instead of the plain CONFIGURE\_FILE() command when creating the \Config.cmake or \-config.cmake file for installing a project or library. It helps making the resulting package relocatable by avoiding hardcoded paths in the installed Config.cmake file. In a FooConfig.cmake file there may be code like this to make the install destinations know to the using project: ``` set(FOO_INCLUDE_DIR "@CMAKE_INSTALL_FULL_INCLUDEDIR@" ) set(FOO_DATA_DIR "@CMAKE_INSTALL_PREFIX@/@RELATIVE_DATA_INSTALL_DIR@" ) set(FOO_ICONS_DIR "@CMAKE_INSTALL_PREFIX@/share/icons" ) ...logic to determine installedPrefix from the own location... set(FOO_CONFIG_DIR "${installedPrefix}/@CONFIG_INSTALL_DIR@" ) ``` All 4 options shown above are not sufficient, since the first 3 hardcode the absolute directory locations, and the 4th case works only if the logic to determine the installedPrefix is correct, and if CONFIG\_INSTALL\_DIR contains a relative path, which in general cannot be guaranteed. This has the effect that the resulting FooConfig.cmake file would work poorly under Windows and OSX, where users are used to choose the install location of a binary package at install time, independent from how CMAKE\_INSTALL\_PREFIX was set at build/cmake time. Using CONFIGURE\_PACKAGE\_CONFIG\_FILE() helps. If used correctly, it makes the resulting FooConfig.cmake file relocatable. Usage: ``` 1. write a FooConfig.cmake.in file as you are used to 2. insert a line containing only the string "@PACKAGE_INIT@" 3. instead of SET(FOO_DIR "@SOME_INSTALL_DIR@"), use SET(FOO_DIR "@PACKAGE_SOME_INSTALL_DIR@") (this must be after the @PACKAGE_INIT@ line) 4. instead of using the normal CONFIGURE_FILE(), use CONFIGURE_PACKAGE_CONFIG_FILE() ``` The \ and \ arguments are the input and output file, the same way as in CONFIGURE\_FILE(). The \ given to INSTALL\_DESTINATION must be the destination where the FooConfig.cmake file will be installed to. This can either be a relative or absolute path, both work. The variables \ to \ given as PATH\_VARS are the variables which contain install destinations. For each of them the macro will create a helper variable PACKAGE\_\. These helper variables must be used in the FooConfig.cmake.in file for setting the installed location. They are calculated by CONFIGURE\_PACKAGE\_CONFIG\_FILE() so that they are always relative to the installed location of the package. This works both for relative and also for absolute locations. For absolute locations it works only if the absolute location is a subdirectory of CMAKE\_INSTALL\_PREFIX. By default configure\_package\_config\_file() also generates two helper macros, set\_and\_check() and check\_required\_components() into the FooConfig.cmake file. set\_and\_check() should be used instead of the normal set() command for setting directories and file locations. Additionally to setting the variable it also checks that the referenced file or directory actually exists and fails with a FATAL\_ERROR otherwise. This makes sure that the created FooConfig.cmake file does not contain wrong references. When using the NO\_SET\_AND\_CHECK\_MACRO, this macro is not generated into the FooConfig.cmake file. check\_required\_components(\) should be called at the end of the FooConfig.cmake file if the package supports components. This macro checks whether all requested, non-optional components have been found, and if this is not the case, sets the Foo\_FOUND variable to FALSE, so that the package is considered to be not found. It does that by testing the Foo\_\\_FOUND variables for all requested required components. When using the NO\_CHECK\_REQUIRED\_COMPONENTS option, this macro is not generated into the FooConfig.cmake file. For an example see below the documentation for WRITE\_BASIC\_PACKAGE\_VERSION\_FILE(). ``` WRITE_BASIC_PACKAGE_VERSION_FILE( filename VERSION major.minor.patch COMPATIBILITY (AnyNewerVersion|SameMajorVersion|ExactVersion) ) ``` Writes a file for use as \ConfigVersion.cmake file to \. See the documentation of FIND\_PACKAGE() for details on this. ``` filename is the output filename, it should be in the build tree. major.minor.patch is the version number of the project to be installed ``` The COMPATIBILITY mode AnyNewerVersion means that the installed package version will be considered compatible if it is newer or exactly the same as the requested version. This mode should be used for packages which are fully backward compatible, also across major versions. If SameMajorVersion is used instead, then the behaviour differs from AnyNewerVersion in that the major version number must be the same as requested, e.g. version 2.0 will not be considered compatible if 1.0 is requested. This mode should be used for packages which guarantee backward compatibility within the same major version. If ExactVersion is used, then the package is only considered compatible if the requested version matches exactly its own version number (not considering the tweak version). For example, version 1.2.3 of a package is only considered compatible to requested version 1.2.3. This mode is for packages without compatibility guarantees. If your project has more elaborated version matching rules, you will need to write your own custom ConfigVersion.cmake file instead of using this macro. Internally, this macro executes configure\_file() to create the resulting version file. Depending on the COMPATIBLITY, either the file BasicConfigVersion-SameMajorVersion.cmake.in or BasicConfigVersion-AnyNewerVersion.cmake.in is used. Please note that these two files are internal to CMake and you should not call configure\_file() on them yourself, but they can be used as starting point to create more sophisticted custom ConfigVersion.cmake files. Example using both configure\_package\_config\_file() and write\_basic\_package\_version\_file(): CMakeLists.txt: ``` set(INCLUDE_INSTALL_DIR include/ ... CACHE ) set(LIB_INSTALL_DIR lib/ ... CACHE ) set(SYSCONFIG_INSTALL_DIR etc/foo/ ... CACHE ) ... include(CMakePackageConfigHelpers) configure_package_config_file(FooConfig.cmake.in ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake INSTALL_DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake PATH_VARS INCLUDE_INSTALL_DIR SYSCONFIG_INSTALL_DIR) write_basic_package_version_file(${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake VERSION 1.2.3 COMPATIBILITY SameMajorVersion ) install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake DESTINATION ${LIB_INSTALL_DIR}/Foo/cmake ) ``` With a FooConfig.cmake.in: ``` set(FOO_VERSION x.y.z) ... @PACKAGE_INIT@ ... set_and_check(FOO_INCLUDE_DIR "@PACKAGE_INCLUDE_INSTALL_DIR@") set_and_check(FOO_SYSCONFIG_DIR "@PACKAGE_SYSCONFIG_INSTALL_DIR@") ``` ``` check_required_components(Foo) ``` - **CMakeParseArguments** ``` ``` CMAKE\_PARSE\_ARGUMENTS(\ \ \ \ args...) CMAKE\_PARSE\_ARGUMENTS() is intended to be used in macros or functions for parsing the arguments given to that macro or function. It processes the arguments and defines a set of variables which hold the values of the respective options. The \ argument contains all options for the respective macro, i.e. keywords which can be used when calling the macro without any value following, like e.g. the OPTIONAL keyword of the install() command. The \ argument contains all keywords for this macro which are followed by one value, like e.g. DESTINATION keyword of the install() command. The \ argument contains all keywords for this macro which can be followed by more than one value, like e.g. the TARGETS or FILES keywords of the install() command. When done, CMAKE\_PARSE\_ARGUMENTS() will have defined for each of the keywords listed in \, \ and \ a variable composed of the given \ followed by "\_" and the name of the respective keyword. These variables will then hold the respective value from the argument list. For the \ keywords this will be TRUE or FALSE. All remaining arguments are collected in a variable \\_UNPARSED\_ARGUMENTS, this can be checked afterwards to see whether your macro was called with unrecognized parameters. As an example here a my\_install() macro, which takes similar arguments as the real install() command: ``` function(MY_INSTALL) set(options OPTIONAL FAST) set(oneValueArgs DESTINATION RENAME) set(multiValueArgs TARGETS CONFIGURATIONS) cmake_parse_arguments(MY_INSTALL "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} ) ... ``` Assume my\_install() has been called like this: ``` my_install(TARGETS foo bar DESTINATION bin OPTIONAL blub) ``` After the cmake\_parse\_arguments() call the macro will have set the following variables: ``` MY_INSTALL_OPTIONAL = TRUE MY_INSTALL_FAST = FALSE (this option was not used when calling my_install() MY_INSTALL_DESTINATION = "bin" MY_INSTALL_RENAME = "" (was not used) MY_INSTALL_TARGETS = "foo;bar" MY_INSTALL_CONFIGURATIONS = "" (was not used) MY_INSTALL_UNPARSED_ARGUMENTS = "blub" (no value expected after "OPTIONAL" ``` You can the continue and process these variables. Keywords terminate lists of values, e.g. if directly after a one\_value\_keyword another recognized keyword follows, this is interpreted as the beginning of the new option. E.g. my\_install(TARGETS foo DESTINATION OPTIONAL) would result in MY\_INSTALL\_DESTINATION set to "OPTIONAL", but MY\_INSTALL\_DESTINATION would be empty and MY\_INSTALL\_OPTIONAL would be set to TRUE therefor. - **CMakePrintSystemInformation** print system information This file can be used for diagnostic purposes just include it in a project to see various internal CMake variables. - **CMakePushCheckState** ``` ``` This module defines two macros: CMAKE\_PUSH\_CHECK\_STATE() and CMAKE\_POP\_CHECK\_STATE() These two macros can be used to save and restore the state of the variables CMAKE\_REQUIRED\_FLAGS, CMAKE\_REQUIRED\_DEFINITIONS, CMAKE\_REQUIRED\_LIBRARIES and CMAKE\_REQUIRED\_INCLUDES used by the various Check-files coming with CMake, like e.g. check\_function\_exists() etc. The variable contents are pushed on a stack, pushing multiple times is supported. This is useful e.g. when executing such tests in a Find-module, where they have to be set, but after the Find-module has been executed they should have the same value as they had before. Usage: ``` cmake_push_check_state() set(CMAKE_REQUIRED_DEFINITIONS ${CMAKE_REQUIRED_DEFINITIONS} -DSOME_MORE_DEF) check_function_exists(...) cmake_pop_check_state() ``` - **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. See CPackComponent module for that. The CPACK\_GENERATOR variable has different meanings in different contexts. In your CMakeLists.txt file, CPACK\_GENERATOR is a \*list of generators\*: when run with no other arguments, CPack will iterate over that list and produce one package for each generator. In a CPACK\_PROJECT\_CONFIG\_FILE, though, CPACK\_GENERATOR is a \*string naming a single generator\*. If you need per-cpack- generator logic to control \*other\* cpack settings, then you need a CPACK\_PROJECT\_CONFIG\_FILE. The CMake source tree itself contains a CPACK\_PROJECT\_CONFIG\_FILE. See the top level file CMakeCPackOptions.cmake.in for an example. If set, the CPACK\_PROJECT\_CONFIG\_FILE is included automatically on a per-generator basis. It only need contain overrides. Here's how it works: ``` - cpack runs - it includes CPackConfig.cmake - it iterates over the generators listed in that file's CPACK_GENERATOR list variable (unless told to use just a specific one via -G on the command line...) ``` ``` - foreach generator, it then - sets CPACK_GENERATOR to the one currently being iterated - includes the CPACK_PROJECT_CONFIG_FILE - produces the package for that generator ``` This is the key: For each generator listed in CPACK\_GENERATOR in CPackConfig.cmake, cpack will \*reset\* CPACK\_GENERATOR internally to \*the one currently being used\* and then include the CPACK\_PROJECT\_CONFIG\_FILE. Before including this CPack module in your CMakeLists.txt file, 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_DIRECTORY - The directory in which CPack is doing its packaging. If it is not set then this will default (internally) to the build dir. This variable may be defined in CPack config file or from the cpack command line option "-B". If set the command line option override the value found in the config file. ``` ``` 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. The default value is ``` ``` ${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-${CPACK_SYSTEM_NAME}. ``` ``` CPACK_PACKAGE_INSTALL_DIRECTORY - Installation directory on the target system. This may be used by some CPack generators like NSIS to create an installation directory e.g., "CMake 2.5" below the installation prefix. All installed element will be put inside this directory. ``` ``` CPACK_PACKAGE_ICON - A branding image that will be displayed inside the installer (used by GUI installers). ``` ``` CPACK_PROJECT_CONFIG_FILE - CPack-time project CPack configuration file. This file included at cpack time, once per generator after CPack has set CPACK_GENERATOR to the actual generator being used. It allows per-generator setting of CPACK_* variables at cpack time. ``` ``` CPACK_RESOURCE_FILE_LICENSE - License to be embedded in the installer. It will typically be displayed to the user by the produced installer (often with an explicit "Accept" button, for graphical installers) prior to installation. This license file is NOT added to installed file but is used by some CPack generators like NSIS. If you want to install a license file (may be the same as this one) along with your project you must add an appropriate CMake INSTALL command in your CMakeLists.txt. ``` ``` CPACK_RESOURCE_FILE_README - ReadMe file to be embedded in the installer. It typically describes in some detail the purpose of the project during the installation. Not all CPack generators uses this file. ``` ``` CPACK_RESOURCE_FILE_WELCOME - Welcome file to be embedded in the installer. It 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. When set the component specification is ignored and all installed items are put in a single "MONOLITHIC" package. Some CPack generators do monolithic packaging by default and may be asked to do component packaging by setting CPACK__COMPONENT_INSTALL to 1/TRUE. ``` ``` CPACK_GENERATOR - List of CPack generators to use. If not specified, CPack will create a set of options CPACK_BINARY_ (e.g., CPACK_BINARY_NSIS) allowing the user to enable/disable individual generators. This variable may be used on the command line as well as in: ``` ``` cpack -D CPACK_GENERATOR="ZIP;TGZ" /path/to/build/tree ``` ``` CPACK_OUTPUT_CONFIG_FILE - The name of the CPack binary configuration file. This file is the CPack configuration generated by the CPack module for binary installers. Defaults to CPackConfig.cmake. ``` ``` CPACK_PACKAGE_EXECUTABLES - Lists each of the executables and associated text label to be used to create Start Menu shortcuts. For example, setting this to the list ccmake;CMake will create a shortcut named "CMake" that will execute the installed executable ccmake. Not all CPack generators use it (at least NSIS and OSXX11 do). ``` ``` 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. For example 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 source configuration file. This file is the CPack configuration generated by the CPack module for source installers. 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 regular expression patterns (that must be properly escaped), e.g., /CVS/;/\\.svn/;\\.swp$;\\.#;/#;.*~;cscope.* ``` 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_INSTALLED_DIRECTORIES - Extra directories to install. ``` ``` CPACK_PACKAGE_INSTALL_REGISTRY_KEY - Registry key used when installing this project. This is only used by installer for Windows. CPACK_CREATE_DESKTOP_LINKS - List of desktop links to create. ``` - **CPackBundle** CPack Bundle generator (Mac OS X) specific options Installers built on Mac OS X using the Bundle generator use the aforementioned DragNDrop (CPACK\_DMG\_xxx) variables, plus the following Bundle-specific parameters (CPACK\_BUNDLE\_xxx). ``` CPACK_BUNDLE_NAME - The name of the generated bundle. This appears in the OSX finder as the bundle name. Required. ``` ``` CPACK_BUNDLE_PLIST - Path to an OSX plist file that will be used for the generated bundle. This assumes that the caller has generated or specified their own Info.plist file. Required. ``` ``` CPACK_BUNDLE_ICON - Path to an OSX icon file that will be used as the icon for the generated bundle. This is the icon that appears in the OSX finder for the bundle, and in the OSX dock when the bundle is opened. Required. ``` ``` CPACK_BUNDLE_STARTUP_COMMAND - Path to a startup script. This is a path to an executable or script that will be run whenever an end-user double-clicks the generated bundle in the OSX Finder. Optional. ``` - **CPackComponent** Build binary and source package installers The CPackComponent module is the module which handles the component part of CPack. See CPack module for general information about CPack. 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. 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_COMPONENTS_ALL - The list of component to install. ``` ``` The default value of this variable is computed by CPack and contains all components defined by the project. The user may set it to only include the specified components. ``` ``` CPACK__COMPONENT_INSTALL - Enable/Disable component install for CPack generator . ``` ``` Each CPack Generator (RPM, DEB, ARCHIVE, NSIS, DMG, etc...) has a legacy default behavior. e.g. RPM builds monolithic whereas NSIS builds component. One can change the default behavior by setting this variable to 0/1 or OFF/ON. CPACK_COMPONENTS_GROUPING - Specify how components are grouped for multi-package component-aware CPack generators. ``` ``` Some generators like RPM or ARCHIVE family (TGZ, ZIP, ...) generates several packages files when asked for component packaging. They group the component differently depending on the value of this variable: - ONE_PER_GROUP (default): creates one package file per component group - ALL_COMPONENTS_IN_ONE : creates a single package with all (requested) component - IGNORE : creates one package per component, i.e. IGNORE component group One can specify different grouping for different CPack generator by using a CPACK_PROJECT_CONFIG_FILE. CPACK_COMPONENT__DISPLAY_NAME - The name to be displayed for a component. CPACK_COMPONENT__DESCRIPTION - The description of a component. CPACK_COMPONENT__GROUP - The group of a component. CPACK_COMPONENT__DEPENDS - The dependencies (list of components) on which this component depends. CPACK_COMPONENT__REQUIRED - True is this component is required. 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. ``` - **CPackCygwin** Cygwin CPack generator (Cygwin). The following variable is specific to installers build on and/or for Cygwin: ``` CPACK_CYGWIN_PATCH_NUMBER - The Cygwin patch number. FIXME: This documentation is incomplete. CPACK_CYGWIN_PATCH_FILE - The Cygwin patch file. FIXME: This documentation is incomplete. CPACK_CYGWIN_BUILD_SCRIPT - The Cygwin build script. FIXME: This documentation is incomplete. ``` - **CPackDMG** DragNDrop CPack generator (Mac OS X). The following variables are specific to the DragNDrop installers built on Mac OS X: ``` CPACK_DMG_VOLUME_NAME - The volume name of the generated disk image. Defaults to CPACK_PACKAGE_FILE_NAME. ``` ``` CPACK_DMG_FORMAT - The disk image format. Common values are UDRO (UDIF read-only), UDZO (UDIF zlib-compressed) or UDBZ (UDIF bzip2-compressed). Refer to hdiutil(1) for more information on other available formats. ``` ``` CPACK_DMG_DS_STORE - Path to a custom DS_Store file. This .DS_Store file e.g. can be used to specify the Finder window position/geometry and layout (such as hidden toolbars, placement of the icons etc.). This file has to be generated by the Finder (either manually or through OSA-script) using a normal folder from which the .DS_Store file can then be extracted. ``` ``` CPACK_DMG_BACKGROUND_IMAGE - Path to a background image file. This file will be used as the background for the Finder Window when the disk image is opened. By default no background image is set. The background image is applied after applying the custom .DS_Store file. ``` ``` CPACK_COMMAND_HDIUTIL - Path to the hdiutil(1) command used to operate on disk image files on Mac OS X. This variable can be used to override the automatically detected command (or specify its location if the auto-detection fails to find it.) ``` ``` CPACK_COMMAND_SETFILE - Path to the SetFile(1) command used to set extended attributes on files and directories on Mac OS X. This variable can be used to override the automatically detected command (or specify its location if the auto-detection fails to find it.) ``` ``` CPACK_COMMAND_REZ - Path to the Rez(1) command used to compile resources on Mac OS X. This variable can be used to override the automatically detected command (or specify its location if the auto-detection fails to find it.) ``` - **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. CPackDeb generator should work on any linux host but it will produce better deb package when Debian specific tools 'dpkg-xxx' are usable on the build system. CPackDeb has specific features which are controlled by the specifics CPACK\_DEBIAN\_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 if dpkg is not found) 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 ``` CPACK\_DEBIAN\_PACKAGE\_HOMEPAGE ``` Mandatory : NO Default : - The URL of the web site for this package, preferably (when applicable) the site from which the original source can be obtained and any additional upstream documentation or information may be found. The content of this field is a simple URL without any surrounding characters such as <>. ``` CPACK\_DEBIAN\_PACKAGE\_SHLIBDEPS ``` Mandatory : NO Default : OFF May be set to ON in order to use dpkg-shlibdeps to generate better package dependency list. You may need set CMAKE_INSTALL_RPATH toi appropriate value if you use this feature, because if you don't dpkg-shlibdeps may fail to find your own shared libs. See http://www.cmake.org/Wiki/CMake_RPATH_handling. ``` CPACK\_DEBIAN\_PACKAGE\_DEBUG ``` Mandatory : NO Default : - May be set when invoking cpack in order to trace debug information during CPackDeb run. ``` CPACK\_DEBIAN\_PACKAGE\_PREDEPENDS ``` Mandatory : NO Default : - see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps This field is like Depends, except that it also forces dpkg to complete installation of the packages named before even starting the installation of the package which declares the pre-dependency. ``` CPACK\_DEBIAN\_PACKAGE\_ENHANCES ``` Mandatory : NO Default : - see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps This field is similar to Suggests but works in the opposite direction. It is used to declare that a package can enhance the functionality of another package. ``` CPACK\_DEBIAN\_PACKAGE\_BREAKS ``` Mandatory : NO Default : - see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps When one binary package declares that it breaks another, dpkg will refuse to allow the package which declares Breaks be installed unless the broken package is deconfigured first, and it will refuse to allow the broken package to be reconfigured. ``` CPACK\_DEBIAN\_PACKAGE\_CONFLICTS ``` Mandatory : NO Default : - see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps When one binary package declares a conflict with another using a Conflicts field, dpkg will refuse to allow them to be installed on the system at the same time. ``` CPACK\_DEBIAN\_PACKAGE\_PROVIDES ``` Mandatory : NO Default : - see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps A virtual package is one which appears in the Provides control field of another package. ``` CPACK\_DEBIAN\_PACKAGE\_REPLACES ``` Mandatory : NO Default : - see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps Packages can declare in their control file that they should overwrite files in certain other packages, or completely replace other packages. ``` CPACK\_DEBIAN\_PACKAGE\_RECOMMENDS ``` Mandatory : NO Default : - see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps Allows packages to declare a strong, but not absolute, dependency on other packages. ``` CPACK\_DEBIAN\_PACKAGE\_SUGGESTS ``` Mandatory : NO Default : - see http://www.debian.org/doc/debian-policy/ch-relationships.html#s-binarydeps Allows packages to declare a suggested package install grouping. ``` CPACK\_DEBIAN\_PACKAGE\_CONTROL\_EXTRA ``` Mandatory : NO Default : - This variable allow advanced user to add custom script to the control.tar.gz Typical usage is for conffiles, postinst, postrm, prerm. Usage: SET(CPACK_DEBIAN_PACKAGE_CONTROL_EXTRA "${CMAKE_CURRENT_SOURCE_DIR/prerm;${CMAKE_CURRENT_SOURCE_DIR}/postrm") ``` - **CPackNSIS** CPack NSIS generator specific options The following variables are specific to the graphical installers built on Windows using the Nullsoft Installation System. ``` CPACK_NSIS_INSTALL_ROOT - The default installation directory presented to the end user by the NSIS installer is under this root dir. The full directory presented to the end user is: ${CPACK_NSIS_INSTALL_ROOT}/${CPACK_PACKAGE_INSTALL_DIRECTORY} ``` ``` CPACK_NSIS_MUI_ICON - An icon filename. The name of a *.ico file used as the main icon for the generated install program. ``` ``` CPACK_NSIS_MUI_UNIICON - An icon filename. The name of a *.ico file used as the main icon for the generated uninstall program. ``` ``` CPACK_NSIS_INSTALLER_MUI_ICON_CODE - undocumented. ``` ``` CPACK_NSIS_EXTRA_PREINSTALL_COMMANDS - Extra NSIS commands that will be added to the beginning of the install Section, before your install tree is available on the target system. ``` ``` CPACK_NSIS_EXTRA_INSTALL_COMMANDS - Extra NSIS commands that will be added to the end of the install Section, after your install tree is available on the target system. ``` ``` CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS - Extra NSIS commands that will be added to the uninstall Section, before your install tree is removed from the target system. ``` ``` CPACK_NSIS_COMPRESSOR - The arguments that will be passed to the NSIS SetCompressor command. ``` ``` CPACK_NSIS_ENABLE_UNINSTALL_BEFORE_INSTALL - Ask about uninstalling previous versions first. If this is set to "ON", then an installer will look for previous installed versions and if one is found, ask the user whether to uninstall it before proceeding with the install. ``` ``` CPACK_NSIS_MODIFY_PATH - Modify PATH toggle. 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. ``` ``` CPACK_NSIS_EXECUTABLES_DIRECTORY - Creating NSIS start menu links assumes that they are in 'bin' unless this variable is set. For example, you would set this to 'exec' if your executables are in an exec directory. ``` ``` CPACK_NSIS_MUI_FINISHPAGE_RUN - Specify an executable to add an option to run on the finish page of the NSIS installer. CPACK_NSIS_MENU_LINKS - Specify links in [application] menu. This should contain a list of pair "link" "link name". The link may be an URL or a path relative to installation prefix. Like: set(CPACK_NSIS_MENU_LINKS "doc/cmake-@CMake_VERSION_MAJOR@.@CMake_VERSION_MINOR@/cmake.html" "CMake Help" "http://www.cmake.org" "CMake Web Site") ``` - **CPackPackageMaker** PackageMaker CPack generator (Mac OS X). 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. ``` - **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. CPackRPM is a component aware generator so when CPACK\_RPM\_COMPONENT\_INSTALL is ON some more CPACK\_RPM\_\\_XXXX variables may be used in order to have component specific values. Note however that \ refers to the \*\*grouping name\*\*. This may be either a component name or a component GROUP name. Usually those vars correspond to RPM spec file entities, one may find information about spec files here http://www.rpm.org/wiki/Docs. You'll find a detailed usage of CPackRPM 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 - The RPM package summary. Mandatory : YES Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY CPACK_RPM_PACKAGE_NAME - The RPM package name. Mandatory : YES Default : CPACK_PACKAGE_NAME CPACK_RPM_PACKAGE_VERSION - The RPM package version. Mandatory : YES Default : CPACK_PACKAGE_VERSION CPACK_RPM_PACKAGE_ARCHITECTURE - The RPM package architecture. Mandatory : NO Default : - This may be set to "noarch" if you know you are building a noarch package. CPACK_RPM_PACKAGE_RELEASE - The RPM package release. Mandatory : YES Default : 1 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 - The RPM package license policy. Mandatory : YES Default : "unknown" CPACK_RPM_PACKAGE_GROUP - The RPM package group. Mandatory : YES Default : "unknown" CPACK_RPM_PACKAGE_VENDOR - The RPM package vendor. Mandatory : YES Default : CPACK_PACKAGE_VENDOR if set or "unknown" CPACK_RPM_PACKAGE_URL - The projects URL. Mandatory : NO Default : - CPACK_RPM_PACKAGE_DESCRIPTION - RPM package description. Mandatory : YES Default : CPACK_PACKAGE_DESCRIPTION_FILE if set or "no package description available" CPACK_RPM_COMPRESSION_TYPE - RPM compression type. Mandatory : NO Default : - May be used to override RPM compression type to be used to build the RPM. For example some Linux distribution now default to lzma or xz compression whereas older cannot use such RPM. Using this one can enforce compression type to be used. Possible value are: lzma, xz, bzip2 and gzip. CPACK_RPM_PACKAGE_REQUIRES - RPM spec requires field. Mandatory : NO Default : - May be used to set RPM dependencies (requires). Note that you must enclose the complete requires string between quotes, for example: set(CPACK_RPM_PACKAGE_REQUIRES "python >= 2.5.0, cmake >= 2.8") The required package list of an RPM file could be printed with rpm -qp --requires file.rpm CPACK_RPM_PACKAGE_SUGGESTS - RPM spec suggest field. Mandatory : NO Default : - May be used to set weak RPM dependencies (suggests). Note that you must enclose the complete requires string between quotes. CPACK_RPM_PACKAGE_PROVIDES - RPM spec provides field. Mandatory : NO Default : - May be used to set RPM dependencies (provides). The provided package list of an RPM file could be printed with rpm -qp --provides file.rpm CPACK_RPM_PACKAGE_OBSOLETES - RPM spec obsoletes field. Mandatory : NO Default : - May be used to set RPM packages that are obsoleted by this one. CPACK_RPM_PACKAGE_RELOCATABLE - build a relocatable RPM. Mandatory : NO Default : CPACK_PACKAGE_RELOCATABLE If this variable is set to TRUE or ON CPackRPM will try to build a relocatable RPM package. A relocatable RPM may be installed using rpm --prefix or --relocate in order to install it at an alternate place see rpm(8). Note that currently this may fail if CPACK_SET_DESTDIR is set to ON. If CPACK_SET_DESTDIR is set then you will get a warning message but if there is file installed with absolute path you'll get unexpected behavior. CPACK_RPM_SPEC_INSTALL_POST - [deprecated]. Mandatory : NO Default : - This way of specifying post-install script is deprecated use CPACK_RPM_POST_INSTALL_SCRIPT_FILE 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 - RPM extended spec definitions lines. Mandatory : NO Default : - May be used to add any %define lines to the generated spec file. CPACK_RPM_PACKAGE_DEBUG - Toggle CPackRPM debug output. Mandatory : NO Default : - May be set when invoking cpack in order to trace debug information during CPack RPM run. For example you may launch CPack like this cpack -D CPACK_RPM_PACKAGE_DEBUG=1 -G RPM CPACK_RPM_USER_BINARY_SPECFILE - A user provided spec file. Mandatory : NO Default : - May be set by the user in order to specify a USER binary spec file to be used by CPackRPM instead of generating the file. The specified file will be processed by CONFIGURE_FILE( @ONLY). CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE - Spec file template. Mandatory : NO Default : - If set CPack will generate a template for USER specified binary spec file and stop with an error. For example launch CPack like this cpack -D CPACK_RPM_GENERATE_USER_BINARY_SPECFILE_TEMPLATE=1 -G RPM The user may then use this file in order to hand-craft is own binary spec file which may be used with CPACK_RPM_USER_BINARY_SPECFILE. CPACK_RPM_PRE_INSTALL_SCRIPT_FILE CPACK_RPM_PRE_UNINSTALL_SCRIPT_FILE Mandatory : NO Default : - May be used to embed a pre (un)installation script in the spec file. The refered script file(s) will be read and directly put after the %pre or %preun section If CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script for each component can be overridden with CPACK_RPM__PRE_INSTALL_SCRIPT_FILE and CPACK_RPM__PRE_UNINSTALL_SCRIPT_FILE One may verify which scriptlet has been included with rpm -qp --scripts package.rpm CPACK_RPM_POST_INSTALL_SCRIPT_FILE CPACK_RPM_POST_UNINSTALL_SCRIPT_FILE Mandatory : NO Default : - May be used to embed a post (un)installation script in the spec file. The refered script file(s) will be read and directly put after the %post or %postun section If CPACK_RPM_COMPONENT_INSTALL is set to ON the (un)install script for each component can be overridden with CPACK_RPM__POST_INSTALL_SCRIPT_FILE and CPACK_RPM__POST_UNINSTALL_SCRIPT_FILE One may verify which scriptlet has been included with rpm -qp --scripts package.rpm CPACK_RPM_USER_FILELIST CPACK_RPM__USER_FILELIST Mandatory : NO Default : - May be used to explicitly specify %() file line in the spec file. Like %config(noreplace) or any other directive that be found in the %files section. Since CPackRPM is generating the list of files (and directories) the user specified files of the CPACK_RPM__USER_FILELIST list will be removed from the generated list. CPACK_RPM_CHANGELOG_FILE - RPM changelog file. Mandatory : NO Default : - May be used to embed a changelog in the spec file. The refered file will be read and directly put after the %changelog section. ``` - **CTest** Configure a project for testing with CTest/CDash Include this module in the top CMakeLists.txt file of a project to enable testing with CTest and dashboard submissions to CDash: ``` project(MyProject) ... include(CTest) ``` The module automatically creates a BUILD\_TESTING option that selects whether to enable testing support (ON by default). After including the module, use code like ``` if(BUILD_TESTING) # ... CMake code to create tests ... endif() ``` to creating tests when testing is enabled. To enable submissions to a CDash server, create a CTestConfig.cmake file at the top of the project with content such as ``` set(CTEST_PROJECT_NAME "MyProject") set(CTEST_NIGHTLY_START_TIME "01:00:00 UTC") set(CTEST_DROP_METHOD "http") set(CTEST_DROP_SITE "my.cdash.org") set(CTEST_DROP_LOCATION "/submit.php?project=MyProject") set(CTEST_DROP_SITE_CDASH TRUE) ``` (the CDash server can provide the file to a project administrator who configures 'MyProject'). Settings in the config file are shared by both this CTest module and the CTest command-line tool's dashboard script mode (ctest -S). While building a project for submission to CDash, CTest scans the build output for errors and warnings and reports them with surrounding context from the build log. This generic approach works for all build tools, but does not give details about the command invocation that produced a given problem. One may get more detailed reports by adding ``` set(CTEST_USE_LAUNCHERS 1) ``` to the CTestConfig.cmake file. When this option is enabled, the CTest module tells CMake's Makefile generators to invoke every command in the generated build system through a CTest launcher program. (Currently the CTEST\_USE\_LAUNCHERS option is ignored on non-Makefile generators.) During a manual build each launcher transparently runs the command it wraps. During a CTest-driven build for submission to CDash each launcher reports detailed information when its command fails or warns. (Setting CTEST\_USE\_LAUNCHERS in CTestConfig.cmake is convenient, but also adds the launcher overhead even for manual builds. One may instead set it in a CTest dashboard script and add it to the CMake cache for the build tree.) - **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(\ \) ``` - the compiler flag - 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 given C source compiles and links into an executable CHECK\_C\_SOURCE\_COMPILES(\ \ \[FAIL\_REGEX \\]) ``` - source code to try to compile, must define 'main' - variable to store whether the source code compiled - 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(\ \) ``` - source code to try to compile - 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(\ \) ``` - the compiler flag - 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 given C++ source compiles and links into an executable CHECK\_CXX\_SOURCE\_COMPILES(\ \ \[FAIL\_REGEX \\]) ``` - source code to try to compile, must define 'main' - variable to store whether the source code compiled - 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(\ \) ``` - source code to try to compile - 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 ``` - **CheckCXXSymbolExists** Check if a symbol exists as a function, variable, or macro in C++ CHECK\_CXX\_SYMBOL\_EXISTS(\ \ \) Check that the \ is available after including given header \ and store the result in a \. Specify the list of files in one argument as a semicolon-separated list. CHECK\_CXX\_SYMBOL\_EXISTS() can be used to check in C++ files, as opposed to CHECK\_SYMBOL\_EXISTS(), which works only for C. If the header files define the symbol as a macro it is considered available and assumed to work. If the header files declare the symbol as a function or variable then the symbol must also be available for linking. If the symbol is a type or enum value it will not be recognized (consider using CheckTypeSize or CheckCSourceCompiles). 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** Check if a C function can be linked CHECK\_FUNCTION\_EXISTS(\ \) Check that the \ is provided by libraries on the system and store the result in a \. This does not verify that any system header file declares the function, only that it can be found at link time (considure using CheckSymbolExists). 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 ``` - **CheckLanguage** Check if a language can be enabled Usage: ``` check_language() ``` where \ is a language that may be passed to enable\_language() such as "Fortran". If CMAKE\_\\_COMPILER is already defined the check does nothing. Otherwise it tries enabling the language in a test project. The result is cached in CMAKE\_\\_COMPILER as the compiler that was found, or NOTFOUND if the language cannot be enabled. Example: ``` check_language(Fortran) if(CMAKE_Fortran_COMPILER) enable_language(Fortran) else() message(STATUS "No Fortran support") endif() ``` - **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 ``` - **CheckPrototypeDefinition** Check if the protoype we expect is correct. check\_prototype\_definition(FUNCTION PROTOTYPE RETURN HEADER VARIABLE) ``` FUNCTION - The name of the function (used to check if prototype exists) PROTOTYPE- The prototype to check. RETURN - The return value of the function. HEADER - The header files required. VARIABLE - The variable to store the result. ``` Example: ``` check_prototype_definition(getpwent_r "struct passwd *getpwent_r(struct passwd *src, char *buf, int buflen)" "NULL" "unistd.h;pwd.h" SOLARIS_GETPWENT_R) ``` 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 ``` - **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 a symbol exists as a function, variable, or macro CHECK\_SYMBOL\_EXISTS(\ \ \) Check that the \ is available after including given header \ and store the result in a \. Specify the list of files in one argument as a semicolon-separated list. If the header files define the symbol as a macro it is considered available and assumed to work. If the header files declare the symbol as a function or variable then the symbol must also be available for linking. If the symbol is a type or enum value it will not be recognized (consider using CheckTypeSize or CheckCSourceCompiles). If the check needs to be done in C++, consider using CHECK\_CXX\_SYMBOL\_EXISTS(), which does the same as CHECK\_SYMBOL\_EXISTS(), but in C++. 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 its size. On return, "HAVE\_${VARIABLE}" holds the existence of the type, and "${VARIABLE}" holds one of the following: ``` = type has non-zero size "0" = type has arch-dependent size (see below) "" = type does not exist ``` Furthermore, the variable "${VARIABLE}\_CODE" holds C preprocessor code to define the macro "${VARIABLE}" to the size of the type, or leave the macro undefined if the type does not exist. The variable "${VARIABLE}" may be "0" when CMAKE\_OSX\_ARCHITECTURES has multiple architectures for building OS X universal binaries. This indicates that the type size varies across architectures. In this case "${VARIABLE}\_CODE" contains C preprocessor tests mapping from each architecture macro to the corresponding type size. The list of architecture macros is stored in "${VARIABLE}\_KEYS", and the value for each key is stored in "${VARIABLE}-${KEY}". If the BUILTIN\_TYPES\_ONLY option is not given, the macro checks for headers \, \, and \, and saves results in HAVE\_SYS\_TYPES\_H, HAVE\_STDINT\_H, and HAVE\_STDDEF\_H. The type size check automatically includes the available headers, thus supporting checks of types defined in the headers. 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 CMAKE_EXTRA_INCLUDE_FILES = list of extra headers to include ``` - **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. - **DeployQt4** Functions to help assemble a standalone Qt4 executable. A collection of CMake utility functions useful for deploying Qt4 executables. The following functions are provided by this module: ``` write_qt4_conf resolve_qt4_paths fixup_qt4_executable install_qt4_plugin_path install_qt4_plugin install_qt4_executable ``` Requires CMake 2.6 or greater because it uses function and PARENT\_SCOPE. Also depends on BundleUtilities.cmake. ``` WRITE_QT4_CONF( ) ``` Writes a qt.conf file with the \ into \. ``` RESOLVE_QT4_PATHS( []) ``` Loop through \ list and if any don't exist resolve them relative to the \ (if supplied) or the CMAKE\_INSTALL\_PREFIX. ``` FIXUP_QT4_EXECUTABLE( [ ]) ``` Copies Qt plugins, writes a Qt configuration file (if needed) and fixes up a Qt4 executable using BundleUtilities so it is standalone and can be drag-and-drop copied to another machine as long as all of the system libraries are compatible. \ should point to the executable to be fixed-up. \ should contain a list of the names or paths of any Qt plugins to be installed. \ will be passed to BundleUtilities and should be a list of any already installed plugins, libraries or executables to also be fixed-up. \ will be passed to BundleUtilities and should contain and directories to be searched to find library dependencies. \ allows an custom plugins directory to be used. \ will force a qt.conf file to be written even if not needed. ``` INSTALL_QT4_PLUGIN_PATH(plugin executable copy installed_plugin_path_var ) ``` Install (or copy) a resolved \ to the default plugins directory (or \) relative to \ and store the result in \. If \ is set to TRUE then the plugins will be copied rather than installed. This is to allow this module to be used at CMake time rather than install time. If \ is set then anything installed will use this COMPONENT. ``` INSTALL_QT4_PLUGIN(plugin executable copy installed_plugin_path_var ) ``` Install (or copy) an unresolved \ to the default plugins directory (or \) relative to \ and store the result in \. See documentation of INSTALL\_QT4\_PLUGIN\_PATH. ``` INSTALL_QT4_EXECUTABLE( [ ]) ``` Installs Qt plugins, writes a Qt configuration file (if needed) and fixes up a Qt4 executable using BundleUtilities so it is standalone and can be drag-and-drop copied to another machine as long as all of the system libraries are compatible. The executable will be fixed-up at install time. \ is the COMPONENT used for bundle fixup and plugin installation. See documentation of FIXUP\_QT4\_BUNDLE. - **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 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 [SVN_USERNAME john ] # Username for Subversion checkout and update [SVN_PASSWORD doe ] # Password for Subversion checkout and update [SVN_TRUST_CERT 1 ] # Trust the Subversion server site certificate [GIT_REPOSITORY url] # URL of git repo [GIT_TAG tag] # Git branch name, commit id or tag [URL /.../src.tgz] # Full path or URL of source [URL_MD5 md5] # MD5 checksum of file at URL [TIMEOUT seconds] # Time allowed for file download operations #--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 [CMAKE_CACHE_ARGS args...] # Initial cache arguments, of the form -Dvar:string=on #--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 #--Output logging------------- [LOG_DOWNLOAD 1] # Wrap download in script to log output [LOG_UPDATE 1] # Wrap update in script to log output [LOG_CONFIGURE 1] # Wrap configure in script to log output [LOG_BUILD 1] # Wrap build in script to log output [LOG_TEST 1] # Wrap test in script to log output [LOG_INSTALL 1] # Wrap install in script to log output #--Custom targets------------- [STEP_TARGETS st1 st2 ...] # Generate custom targets for these steps ) ``` 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 = /tmp STAMP_DIR = /src/-stamp DOWNLOAD_DIR = /src SOURCE_DIR = /src/ BINARY_DIR = /src/-build INSTALL_DIR = ``` Otherwise, if the EP\_BASE directory property is set then components of an external project are stored under the specified base: ``` TMP_DIR = /tmp/ STAMP_DIR = /Stamp/ DOWNLOAD_DIR = /Download/ SOURCE_DIR = /Source/ BINARY_DIR = /Build/ INSTALL_DIR = /Install/ ``` If no PREFIX, EP\_PREFIX, or EP\_BASE is specified then the default is to set PREFIX to "\-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( # 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 [LOG 1] # Wrap step in script to log output ) ``` The command line, comment, and working directory of every standard and custom step is processed to replace tokens \, \, \, and \ with corresponding property values. The 'ExternalProject\_Get\_Property' function retrieves external project target properties: ``` ExternalProject_Get_Property( [prop1 [prop2 [...]]]) ``` It stores property values in variables of the same name. Property names correspond to the keyword argument names of 'ExternalProject\_Add'. The 'ExternalProject\_Add\_StepTargets' function generates custom targets for the steps listed: ``` ExternalProject_Add_StepTargets( [step1 [step2 [...]]]) ``` If STEP\_TARGETS is set then ExternalProject\_Add\_StepTargets is automatically called at the end of matching calls to ExternalProject\_Add\_Step. Pass STEP\_TARGETS explicitly to individual ExternalProject\_Add calls, or implicitly to all ExternalProject\_Add calls by setting the directory property EP\_STEP\_TARGETS. If STEP\_TARGETS is not set, clients may still manually call ExternalProject\_Add\_StepTargets after calling ExternalProject\_Add or ExternalProject\_Add\_Step. This functionality is provided to make it easy to drive the steps independently of each other by specifying targets on build command lines. For example, you may be submitting to a sub-project based dashboard, where you want to drive the configure portion of the build, then submit to the dashboard, followed by the build portion, followed by tests. If you invoke a custom target that depends on a step halfway through the step dependency chain, then all the previous steps will also run to ensure everything is up to date. For example, to drive configure, build and test steps independently for each ExternalProject\_Add call in your project, write the following line prior to any ExternalProject\_Add calls in your CMakeLists file: ``` set_property(DIRECTORY PROPERTY EP_STEP_TARGETS configure build test) ``` - **FeatureSummary** Macros for generating a summary of enabled/disabled features This module provides the macros feature\_summary(), set\_package\_properties() and add\_feature\_info(). For compatibility it also still provides set\_package\_info(), set\_feature\_info(), print\_enabled\_features() and print\_disabled\_features(). These macros can be used to generate a summary of enabled and disabled packages and/or feature for a build tree: ``` -- The following OPTIONAL packages have been found: LibXml2 (required version >= 2.4) , XML processing library. , * Enables HTML-import in MyWordProcessor * Enables odt-export in MyWordProcessor PNG , A PNG image library. , * Enables saving screenshots -- The following OPTIONAL packages have not been found: Lua51 , The Lua scripting language. , * Enables macros in MyWordProcessor Foo , Foo provides cool stuff. ``` ``` FEATURE_SUMMARY( [FILENAME ] [APPEND] [VAR ] [INCLUDE_QUIET_PACKAGES] [FATAL_ON_MISSING_REQUIRED_PACKAGES] [DESCRIPTION "Found packages:"] WHAT (ALL | PACKAGES_FOUND | PACKAGES_NOT_FOUND | ENABLED_FEATURES | DISABLED_FEATURES] ) ``` The FEATURE\_SUMMARY() macro can be used to print information about enabled or disabled packages or features of a project. By default, only the names of the features/packages will be printed and their required version when one was specified. Use SET\_PACKAGE\_PROPERTIES() to add more useful information, like e.g. a download URL for the respective package or their purpose in the project. The WHAT option is the only mandatory option. Here you specify what information will be printed: ``` ALL: print everything ENABLED_FEATURES: the list of all features which are enabled DISABLED_FEATURES: the list of all features which are disabled PACKAGES_FOUND: the list of all packages which have been found PACKAGES_NOT_FOUND: the list of all packages which have not been found OPTIONAL_PACKAGES_FOUND: only those packages which have been found which have the type OPTIONAL OPTIONAL_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type OPTIONAL RECOMMENDED_PACKAGES_FOUND: only those packages which have been found which have the type RECOMMENDED RECOMMENDED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RECOMMENDED REQUIRED_PACKAGES_FOUND: only those packages which have been found which have the type REQUIRED REQUIRED_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type REQUIRED RUNTIME_PACKAGES_FOUND: only those packages which have been found which have the type RUNTIME RUNTIME_PACKAGES_NOT_FOUND: only those packages which have not been found which have the type RUNTIME ``` If a FILENAME is given, the information is printed into this file. If APPEND is used, it is appended to this file, otherwise the file is overwritten if it already existed. If the VAR option is used, the information is "printed" into the specified variable. If FILENAME is not used, the information is printed to the terminal. Using the DESCRIPTION option a description or headline can be set which will be printed above the actual content. If INCLUDE\_QUIET\_PACKAGES is given, packages which have been searched with find\_package(... QUIET) will also be listed. By default they are skipped. If FATAL\_ON\_MISSING\_REQUIRED\_PACKAGES is given, CMake will abort if a package which is marked as REQUIRED has not been found. Example 1, append everything to a file: ``` feature_summary(WHAT ALL FILENAME ${CMAKE_BINARY_DIR}/all.log APPEND) ``` Example 2, print the enabled features into the variable enabledFeaturesText, including QUIET packages: ``` feature_summary(WHAT ENABLED_FEATURES INCLUDE_QUIET_PACKAGES DESCRIPTION "Enabled Features:" VAR enabledFeaturesText) message(STATUS "${enabledFeaturesText}") ``` ``` SET_PACKAGE_PROPERTIES( PROPERTIES [ URL ] [ DESCRIPTION ] [ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ] [ PURPOSE ] ) ``` Use this macro to set up information about the named package, which can then be displayed via FEATURE\_SUMMARY(). This can be done either directly in the Find-module or in the project which uses the module after the FIND\_PACKAGE() call. The features for which information can be set are added automatically by the find\_package() command. URL: this should be the homepage of the package, or something similar. Ideally this is set already directly in the Find-module. DESCRIPTION: A short description what that package is, at most one sentence. Ideally this is set already directly in the Find-module. TYPE: What type of dependency has the using project on that package. Default is OPTIONAL. In this case it is a package which can be used by the project when available at buildtime, but it also work without. RECOMMENDED is similar to OPTIONAL, i.e. the project will build if the package is not present, but the functionality of the resulting binaries will be severly limited. If a REQUIRED package is not available at buildtime, the project may not even build. This can be combined with the FATAL\_ON\_MISSING\_REQUIRED\_PACKAGES argument for feature\_summary(). Last, a RUNTIME package is a package which is actually not used at all during the build, but which is required for actually running the resulting binaries. So if such a package is missing, the project can still be built, but it may not work later on. If set\_package\_properties() is called multiple times for the same package with different TYPEs, the TYPE is only changed to higher TYPEs ( RUNTIME \< OPTIONAL \< RECOMMENDED \< REQUIRED ), lower TYPEs are ignored. The TYPE property is project-specific, so it cannot be set by the Find-module, but must be set in the project. PURPOSE: This describes which features this package enables in the project, i.e. it tells the user what functionality he gets in the resulting binaries. If set\_package\_properties() is called multiple times for a package, all PURPOSE properties are appended to a list of purposes of the package in the project. As the TYPE property, also the PURPOSE property is project-specific, so it cannot be set by the Find-module, but must be set in the project. Example for setting the info for a package: ``` find_package(LibXml2) set_package_properties(LibXml2 PROPERTIES DESCRIPTION "A XML processing library." URL "http://xmlsoft.org/") ``` ``` set_package_properties(LibXml2 PROPERTIES TYPE RECOMMENDED PURPOSE "Enables HTML-import in MyWordProcessor") ... set_package_properties(LibXml2 PROPERTIES TYPE OPTIONAL PURPOSE "Enables odt-export in MyWordProcessor") ``` ``` find_package(DBUS) set_package_properties(DBUS PROPERTIES TYPE RUNTIME PURPOSE "Necessary to disable the screensaver during a presentation" ) ``` ``` ADD_FEATURE_INFO( ) ``` Use this macro to add information about a feature with the given \. \ contains whether this feature is enabled or not, \ is a text describing the feature. The information can be displayed using feature\_summary() for ENABLED\_FEATURES and DISABLED\_FEATURES respectively. Example for setting the info for a feature: ``` option(WITH_FOO "Help for foo" ON) add_feature_info(Foo WITH_FOO "The Foo feature provides very cool stuff.") ``` The following macros are provided for compatibility with previous CMake versions: ``` SET_PACKAGE_INFO( [ [] ] ) ``` Use this macro to set up information about the named package, which can then be displayed via FEATURE\_SUMMARY(). This can be done either directly in the Find-module or in the project which uses the module after the FIND\_PACKAGE() call. The features for which information can be set are added automatically by the find\_package() command. ``` PRINT_ENABLED_FEATURES() ``` Does the same as FEATURE\_SUMMARY(WHAT ENABLED\_FEATURES DESCRIPTION "Enabled features:") ``` PRINT_DISABLED_FEATURES() ``` Does the same as FEATURE\_SUMMARY(WHAT DISABLED\_FEATURES DESCRIPTION "Disabled features:") ``` SET_FEATURE_INFO( [] ) ``` Does the same as SET\_PACKAGE\_INFO(\ \ \ ) - **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 ALSA_VERSION_STRING - the version of alsa found (since CMake 2.8.8) ``` - **FindASPELL** Try to find ASPELL Once done this will define ``` ASPELL_FOUND - system has ASPELL ASPELL_EXECUTABLE - the ASPELL executable 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 ``` - **FindArmadillo** Find Armadillo Find the Armadillo C++ library Using Armadillo: ``` find_package(Armadillo REQUIRED) include_directories(${ARMADILLO_INCLUDE_DIRS}) add_executable(foo foo.cc) target_link_libraries(foo ${ARMADILLO_LIBRARIES}) ``` This module sets the following variables: ``` ARMADILLO_FOUND - set to true if the library is found ARMADILLO_INCLUDE_DIRS - list of required include directories ARMADILLO_LIBRARIES - list of libraries to be linked ARMADILLO_VERSION_MAJOR - major version number ARMADILLO_VERSION_MINOR - minor version number ARMADILLO_VERSION_PATCH - patch version number ARMADILLO_VERSION_STRING - version number as a string (ex: "1.0.4") ARMADILLO_VERSION_NAME - name of the version (ex: "Antipodean Antileech") ``` - **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 ``` The minimum required version of bison can be specified using the standard CMake syntax, e.g. find\_package(BISON 2.1.3) If bison is found, the module defines the macros: ``` BISON_TARGET( [VERBOSE ] [COMPILE_FLAGS ]) ``` which will create a custom rule to generate a parser. \ is the path to a yacc file. \ 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, \ 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 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 ``` 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_NEED_PREFIX - this is set if the functions are prefixed with BZ2_ BZIP2_VERSION_STRING - the version of BZip2 found (since CMake 2.8.8) ``` - **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) set(Boost_USE_STATIC_RUNTIME OFF) 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, 1.41, 1.41.0, 1.42, 1.42.0, 1.43, 1.43.0, 1.44, 1.44.0, 1.45, 1.45.0, 1.46, 1.46.0, 1.46.1, 1.47, 1.47.0, 1.48, 1.48.0, 1.49, 1.49.0, 1.50, 1.50.0, 1.51, 1.51.0, 1.52, 1.52.0, 1.53, 1.53.0, 1.54, 1.54.0, 1.55, 1.55.0, 1.56, 1.56.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. ``` ``` Boost_NO_SYSTEM_PATHS Set to TRUE to suppress searching in system paths (or other locations outside of BOOST_ROOT or BOOST_INCLUDEDIR). Useful when specifying BOOST_ROOT. Defaults to OFF. [Since CMake 2.8.3] ``` ``` Boost_NO_BOOST_CMAKE Do not do a find_package call in config mode before searching for a regular boost install. This will avoid finding boost-cmake installs. Defaults to OFF. [Since CMake 2.8.6] ``` ``` Boost_USE_STATIC_RUNTIME If enabled, searches for boost libraries linked against a static C++ standard library ('s' ABI tag). This option should be set to ON or OFF because the default behavior if not specified is platform dependent for backwards compatibility. [Since CMake 2.8.3] ``` ``` Boost_USE_DEBUG_PYTHON If enabled, searches for boost libraries compiled against a special debug build of Python ('y' ABI tag). Defaults to OFF. [Since CMake 2.8.3] ``` ``` Boost_USE_STLPORT If enabled, searches for boost libraries compiled against the STLPort standard library ('p' ABI tag). Defaults to OFF. [Since CMake 2.8.3] ``` ``` Boost_USE_STLPORT_DEPRECATED_NATIVE_IOSTREAMS If enabled, searches for boost libraries compiled against the deprecated STLPort "native iostreams" feature ('n' ABI tag). Defaults to OFF. [Since CMake 2.8.3] ``` 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 ``` ``` Boost_THREADAPI When building boost.thread, sometimes the name of the library contains an additional "pthread" or "win32" string known as the threadapi. This can happen when compiling against pthreads on Windows or win32 threads on Cygwin. You may specify this variable and if set when FindBoost searches for the Boost threading library it will first try to match the threadapi you specify. For Example: libboost_thread_win32-mgw45-mt-1_43.a might be found if you specified "win32" here before falling back on libboost_thread-mgw45-mt-1_43.a. [Since CMake 2.8.3] ``` ``` Boost_REALPATH Resolves symbolic links for discovered boost libraries to assist with packaging. For example, instead of Boost_SYSTEM_LIBRARY_RELEASE being resolved to "/usr/lib/libboost_system.so" it would be "/usr/lib/libboost_system.so.1.42.0" instead. This does not affect linking and should not be enabled unless the user needs this information. [Since CMake 2.8.3] ``` - **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 \, 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_ -- 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(). Some standard CMake target calls can be used on the target after calling this macro (e.g. set_target_properties and target_link_libraries), but setting properties that adjust compilation flags will not affect code compiled by nvcc. Such flags should be modified before calling CUDA_ADD_EXECUTABLE, CUDA_ADD_LIBRARY or CUDA_WRAP_SRCS. ``` ``` 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 several 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, _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). CUDA_curand_LIBRARY -- CUDA Random Number Generation library. Only available for CUDA version 3.2+. CUDA_cusparse_LIBRARY -- CUDA Sparse Matrix library. Only available for CUDA version 3.2+. CUDA_npp_LIBRARY -- NVIDIA Performance Primitives library. Only available for CUDA version 4.0+. CUDA_nvcuvenc_LIBRARY -- CUDA Video Encoder library. Only available for CUDA version 3.2+. Windows only. CUDA_nvcuvid_LIBRARY -- CUDA Video Decoder library. Only available for CUDA version 3.2+. Windows only. ``` ``` 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. CURL_VERSION_STRING - the version of curl found (since CMake 2.8.8) ``` - **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 CUPS_VERSION_STRING - version of Cups found (since CMake 2.8.8) 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 [deprecated since 1.3] Only used in the case both Python & Perl are detected on the system to control which CxxTest code generator is used. Valid only for CxxTest version 3. ``` ``` NOTE: In older versions of this Find Module, this variable controlled if the Python test generator was used instead of the Perl one, regardless of which scripting language the user had installed. ``` ``` CXXTEST_TESTGEN_ARGS (since CMake 2.8.3) Specify a list of options to pass to the CxxTest code generator. If not defined, --error-printer is passed. ``` OUTPUT Variables ``` CXXTEST_FOUND True if the CxxTest framework was found CXXTEST_INCLUDE_DIRS 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 CXXTEST_TESTGEN_EXECUTABLE (since CMake 2.8.3) The test generator that is actually used (chosen using user preferences and interpreters found in the system) CXXTEST_TESTGEN_INTERPRETER (since CMake 2.8.3) The full path to the Perl or Python executable on the system ``` MACROS for optional use by CMake users: ``` CXXTEST_ADD_TEST( ) 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 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 and applications - **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_VERSION = The version reported by doxygen --version ``` ``` 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 FLEX_INCLUDE_DIRS - The path to the flex headers ``` The minimum required version of flex can be specified using the standard syntax, e.g. FIND\_PACKAGE(FLEX 2.5.13) If flex is found on the system, the module provides the macro: ``` FLEX_TARGET(Name FlexInput FlexOutput [COMPILE_FLAGS ]) ``` which creates a custom command to generate the \ file from the \ 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 \ and \ 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_BINARY_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. FREETYPE_VERSION_STRING, the version of freetype found (since CMake 2.8.8) 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. This module will define the following variables: ``` GCCXML - 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 searches giflib and 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\_VERSION, reports either version 4 or 3 (for everything before version 4) The minimum required version of giflib can be specified using the standard syntax, e.g. FIND\_PACKAGE(GIF 4) $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 GTK2_ADDITIONAL_SUFFIXES - Allows defining additional directories to search for include files ``` \================= 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 a CMake or environment variable) The root directory of the gtest install prefix ``` ``` GTEST_MSVC_SEARCH - If compiling with MSVC, this variable can be set to "MD" or "MT" to enable searching a GTest build tree (defaults: "MD") ``` Example Usage: ``` enable_testing() 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 by running an executable for each test and test fixture. You will also have to rerun CMake after adding or removing tests or test fixtures. 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. GETTEXT_VERSION_STRING: the version of gettext found (since CMake 2.8.8) ``` 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. ``` GETTEXT\_PROCESS\_POT( \ \[ALL\] \[INSTALL\_DESTINATION \\] LANGUAGES \ \ ... ) ``` Process the given pot file to mo files. If INSTALL_DESTINATION is given then automatically install rules will be created, the language subdirectory will be taken into account (by default use share/locale/). If ALL is specified, the pot file is processed when building the all traget. It creates a custom target "potfile". ``` GETTEXT\_PROCESS\_PO\_FILES( \ \[ALL\] \[INSTALL\_DESTINATION \\] PO\_FILES \ \ ... ) ``` Process the given po files to mo files for the given language. If INSTALL_DESTINATION is given then automatically install rules will be created, the language subdirectory will be taken into account (by default use share/locale/). If ALL is specified, the po files are processed when building the all traget. It creates a custom target "pofiles". ``` - **FindGit** ``` ``` The module defines the following variables: ``` GIT_EXECUTABLE - path to git command line client GIT_FOUND - true if the command line client was found GIT_VERSION_STRING - the version of git found (since CMake 2.8.8) ``` Example usage: ``` find_package(Git) if(GIT_FOUND) message("git found: ${GIT_EXECUTABLE}") endif() ``` - **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 GNUPLOT_VERSION_STRING - the version of Gnuplot found (since CMake 2.8.8) ``` GNUPLOT\_VERSION\_STRING will not work for old versions like 3.7.1. - **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. The only valid components are C, CXX, Fortran, HL, and Fortran\_HL. 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_DIRS - Location of the hdf5 includes HDF5_INCLUDE_DIR - Location of the hdf5 includes (deprecated) 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_Fortran_LIBRARIES - Required libraries for the HDF5 Fortran bindings HDF5_HL_LIBRARIES - Required libraries for the HDF5 high level API HDF5_Fortran_HL_LIBRARIES - Required libraries for the high level Fortran 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_Fortran_COMPILER_EXECUTABLE - the path to the HDF5 Fortran 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 ``` ``` HSPELL_VERSION_STRING - The version of Hspell found (x.y) HSPELL_MAJOR_VERSION - the major version of Hspell HSPELL_MINOR_VERSION - The minor version of 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__FOUND - TRUE if is found. ImageMagick__EXECUTABLE - Full path to executable. ImageMagick_VERSION_STRING - the version of ImageMagick found (since CMake 2.8.8) ``` ImageMagick\_VERSION\_STRING will not work for old versions like 5.2.3. 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__FOUND - TRUE if is found. ImageMagick__INCLUDE_DIRS - Full path to include dirs. ImageMagick__LIBRARIES - Full path to 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 JNI_FOUND = TRUE if JNI headers and libraries were found. 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 JASPER_VERSION_STRING - the version of Jasper found (since CMake 2.8.8) ``` - **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_JAVA_EXECUTABLE = the full path to the Java runtime Java_JAVAC_EXECUTABLE = the full path to the Java compiler Java_JAVAH_EXECUTABLE = the full path to the Java header generator Java_JAVADOC_EXECUTABLE = the full path to the Java documention generator Java_JAR_EXECUTABLE = the full path to the Java archiver Java_VERSION_STRING = Version of the package found (java version), eg. 1.6.0_12 Java_VERSION_MAJOR = The major version of the package found. Java_VERSION_MINOR = The minor version of the package found. Java_VERSION_PATCH = The patch version of the package found. Java_VERSION_TWEAK = The tweak version of the package found (after '_') Java_VERSION = This is set to: $major.$minor.$patch(.$tweak) ``` The minimum required version of Java can be specified using the standard CMake syntax, e.g. FIND\_PACKAGE(Java 1.5) NOTE: ${Java\_VERSION} and ${Java\_VERSION\_STRING} are not guaranteed to be identical. For example some java version may return: Java\_VERSION\_STRING = 1.5.0\_17 and Java\_VERSION = 1.5.0.17 another example is the Java OEM, with: Java\_VERSION\_STRING = 1.6.0-oem and Java\_VERSION = 1.6.0 For these components the following variables are set: ``` Java_FOUND - TRUE if all components are found. Java_INCLUDE_DIRS - Full paths to all include dirs. Java_LIBRARIES - Full paths to all libraries. Java__FOUND - TRUE if is found. ``` Example Usages: ``` FIND_PACKAGE(Java) FIND_PACKAGE(Java COMPONENTS Runtime) FIND_PACKAGE(Java COMPONENTS Development) ``` - **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_ 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 \ - **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 \ - **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 ``` - **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 ``` - **FindLibArchive** Find libarchive library and headers The module defines the following variables: ``` LibArchive_FOUND - true if libarchive was found LibArchive_INCLUDE_DIRS - include search path LibArchive_LIBRARIES - libraries to link LibArchive_VERSION - libarchive 3-component version number ``` - **FindLibLZMA** Find LibLZMA Find LibLZMA headers and library ``` LIBLZMA_FOUND - True if liblzma is found. LIBLZMA_INCLUDE_DIRS - Directory where liblzma headers are located. LIBLZMA_LIBRARIES - Lzma libraries to link against. LIBLZMA_HAS_AUTO_DECODER - True if lzma_auto_decoder() is found (required). LIBLZMA_HAS_EASY_ENCODER - True if lzma_easy_encoder() is found (required). LIBLZMA_HAS_LZMA_PRESET - True if lzma_lzma_preset() is found (required). LIBLZMA_VERSION_MAJOR - The major version of lzma LIBLZMA_VERSION_MINOR - The minor version of lzma LIBLZMA_VERSION_PATCH - The patch version of lzma LIBLZMA_VERSION_STRING - version number as a string (ex: "5.0.3") ``` - **FindLibXml2** Try to find the LibXml2 xml processing library 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 LIBXML2_VERSION_STRING - the version of LibXml2 found (since CMake 2.8.8) ``` - **FindLibXslt** Try to find the LibXslt library 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 LIBXSLT_VERSION_STRING - version of LibXslt found (since CMake 2.8.8) ``` Additionally, the following two variables are set (but not required for using xslt): ``` LIBXSLT_EXSLT_LIBRARIES - Link to these if you need to link against the exslt library LIBXSLT_XSLTPROC_EXECUTABLE - Contains the full path to the xsltproc executable if found ``` - **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 ``` 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 LUA_VERSION_STRING, the version of Lua found (since CMake 2.8.8) ``` Note that the expected include convention is ``` #include "lua.h" ``` and not ``` #include ``` 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** Find a Message Passing Interface (MPI) implementation The Message Passing Interface (MPI) is a library used to write high-performance distributed-memory parallel applications, 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 them have somewhat different include paths, libraries to link against, etc., and this module tries to smooth out those differences. \=== Variables === This module will set the following variables per language in your project, where \ is one of C, CXX, or Fortran: ``` MPI__FOUND TRUE if FindMPI found MPI flags for MPI__COMPILER MPI Compiler wrapper for 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__LIBRARIES All libraries to link MPI programs against ``` Additionally, FindMPI sets the following variables for running MPI programs from the command line: ``` 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 other flags ``` \=== Usage === To use this module, simply call FindMPI from a CMakeLists.txt file, or run find\_package(MPI), then run CMake. If you are happy with the auto- detected configuration for your language, then you're done. If not, you have two options: ``` 1. Set MPI__COMPILER to the MPI wrapper (mpicc, etc.) of your choice and reconfigure. FindMPI will attempt to determine all the necessary variables using THAT compiler's compile and link flags. 2. If this fails, or if your MPI implementation does not come with a compiler wrapper, then set both MPI__LIBRARIES and MPI__INCLUDE_PATH. You may also set any other variables listed above, but these two are required. This will circumvent autodetection entirely. ``` When configuration is successful, MPI\_\\_COMPILER will be set to the compiler wrapper for \, if it was found. MPI\_\\_FOUND and other variables above will be set if any MPI implementation was found for \, regardless of whether a compiler was found. 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. \=== Backward Compatibility === For backward compatibility with older versions of FindMPI, these variables are set, but deprecated: ``` MPI_FOUND MPI_COMPILER MPI_LIBRARY MPI_COMPILE_FLAGS MPI_INCLUDE_PATH MPI_EXTRA_LIBRARY MPI_LINK_FLAGS MPI_LIBRARIES ``` In new projects, please use the MPI\_\\_XXX equivalents. - **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_ROOT_DIR - Set this variable to the root installation of OpenSSL ``` Read-Only variables: ``` OPENSSL_FOUND - system has the OpenSSL library OPENSSL_INCLUDE_DIR - the OpenSSL include directory OPENSSL_LIBRARIES - The libraries needed to use OpenSSL OPENSSL_VERSION - This is set to $major.$minor.$revision$path (eg. 0.9.8s) ``` - **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\.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). ``` _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 searches libpng, the library for working with PNG images. It defines the following variables ``` PNG_INCLUDE_DIRS, 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. PNG_VERSION_STRING - the version of the PNG library found (since CMake 2.8.8) ``` Also defined, but not for general use are ``` PNG_LIBRARY, where to find the PNG library. ``` For backward compatiblity the variable PNG\_INCLUDE\_DIR is also set. It has the same value as PNG\_INCLUDE\_DIRS. Since PNG depends on the ZLib compression library, none of the above will be defined unless ZLib can be found. - **FindPackageHandleStandardArgs** ``` ``` FIND\_PACKAGE\_HANDLE\_STANDARD\_ARGS(\ ... ) This function is intended to be used in FindXXX.cmake modules files. It handles the REQUIRED, QUIET and version-related arguments to FIND\_PACKAGE(). It also sets the \\_FOUND variable. The package is considered found if all variables \... listed contain valid results, e.g. valid filepaths. There are two modes of this function. The first argument in both modes is the name of the Find-module where it is called (in original casing). The first simple mode looks like this: ``` FIND_PACKAGE_HANDLE_STANDARD_ARGS( (DEFAULT_MSG|"Custom failure message") ... ) ``` If the variables \ to \ are all valid, then \\_FOUND will be set to TRUE. If DEFAULT\_MSG is given as second argument, then the function will generate itself useful success and error messages. You can also supply a custom error message for the failure case. This is not recommended. The second mode is more powerful and also supports version checking: ``` FIND_PACKAGE_HANDLE_STANDARD_ARGS(NAME [REQUIRED_VARS ...] [VERSION_VAR ] [HANDLE_COMPONENTS] [CONFIG_MODE] [FAIL_MESSAGE "Custom failure message"] ) ``` As above, if \ through \ are all valid, \\_FOUND will be set to TRUE. After REQUIRED\_VARS the variables which are required for this package are listed. Following VERSION\_VAR the name of the variable can be specified which holds the version of the package which has been found. If this is done, this version will be checked against the (potentially) specified required version used in the find\_package() call. The EXACT keyword is also handled. The default messages include information about the required version and the version which has been actually found, both if the version is ok or not. If the package supports components, use the HANDLE\_COMPONENTS option to enable handling them. In this case, find\_package\_handle\_standard\_args() will report which components have been found and which are missing, and the \\_FOUND variable will be set to FALSE if any of the required components (i.e. not the ones listed after OPTIONAL\_COMPONENTS) are missing. Use the option CONFIG\_MODE if your FindXXX.cmake module is a wrapper for a find\_package(... NO\_MODULE) call. In this case VERSION\_VAR will be set to \\_VERSION and the macro will automatically check whether the Config module was found. Via FAIL\_MESSAGE a custom failure message can be specified, if this is not used, the default message will be displayed. Example for mode 1: ``` FIND_PACKAGE_HANDLE_STANDARD_ARGS(LibXml2 DEFAULT_MSG LIBXML2_LIBRARY LIBXML2_INCLUDE_DIR) ``` LibXml2 is considered to be found, if both LIBXML2\_LIBRARY 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, success will be reported, including the content of \. On repeated Cmake runs, the same message won't be printed again. Example for mode 2: ``` FIND_PACKAGE_HANDLE_STANDARD_ARGS(BISON REQUIRED_VARS BISON_EXECUTABLE VERSION_VAR BISON_VERSION) ``` In this case, BISON is considered to be found if the variable(s) listed after REQUIRED\_VAR are all valid, i.e. BISON\_EXECUTABLE in this case. Also the version of BISON will be checked by using the version contained in BISON\_VERSION. Since no FAIL\_MESSAGE is given, the default messages will be printed. Another example for mode 2: ``` FIND_PACKAGE(Automoc4 QUIET NO_MODULE HINTS /opt/automoc4) FIND_PACKAGE_HANDLE_STANDARD_ARGS(Automoc4 CONFIG_MODE) ``` In this case, FindAutmoc4.cmake wraps a call to FIND\_PACKAGE(Automoc4 NO\_MODULE) and adds an additional search directory for automoc4. The following FIND\_PACKAGE\_HANDLE\_STANDARD\_ARGS() call produces a proper success/error message. - **FindPackageMessage** ``` ``` FIND\_PACKAGE\_MESSAGE(\ "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. PERL_VERSION_STRING - version of perl found (since CMake 2.8.8) ``` - **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 minimum required version of Perl can be specified using the standard syntax, e.g. FIND\_PACKAGE(PerlLibs 6.0) ``` 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( [REQUIRED] [QUIET] []*) checks for all the given modules ``` ``` pkg_search_module( [REQUIRED] [QUIET] []*) 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 When the 'QUIET' argument is set, no status messages will be printed. It sets the following variables: ``` PKG_CONFIG_FOUND ... if pkg-config executable was found PKG_CONFIG_EXECUTABLE ... pathname of the pkg-config program PKG_CONFIG_VERSION_STRING ... the version of the pkg-config program found (since CMake 2.8.8) ``` 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. ``` _FOUND ... set to 1 if module(s) exist _LIBRARIES ... only the libraries (w/o the '-l') _LIBRARY_DIRS ... the paths of the libraries (w/o the '-L') _LDFLAGS ... all required linker flags _LDFLAGS_OTHER ... all other linker flags _INCLUDE_DIRS ... the '-I' preprocessor flags (w/o the '-I') _CFLAGS ... all required cflags _CFLAGS_OTHER ... the other compiler flags ``` ``` = for common case = _STATIC for static linking ``` There are some special variables whose prefix depends on the count of given modules. When there is only one module, \ stays unchanged. When there are multiple modules, the prefix will be changed to \\_\: ``` _VERSION ... version of the module _PREFIX ... prefix-directory of the module _INCLUDEDIR ... include-dir of the module _LIBDIR ... lib-dir of the module ``` ``` = when |MODULES| == 1, else = _ ``` A \ parameter can have the following formats: ``` {MODNAME} ... matches any version {MODNAME}>={VERSION} ... at least version is required {MODNAME}={VERSION} ... exactly version is required {MODNAME}<={VERSION} ... modules must not be newer than ``` 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) ``` - **FindPostgreSQL** Find the PostgreSQL installation. In Windows, we make the assumption that, if the PostgreSQL files are installed, the default directory will be C:\\Program Files\\PostgreSQL. This module defines ``` PostgreSQL_LIBRARIES - the PostgreSQL libraries needed for linking PostgreSQL_INCLUDE_DIRS - the directories of the PostgreSQL headers PostgreSQL_VERSION_STRING - the version of PostgreSQL found (since CMake 2.8.8) ``` - **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. The following variables can be set and are optional: ``` PROTOBUF_SRC_ROOT_FOLDER - When compiling with MSVC, if this cache variable is set the protobuf-default VS project build locations (vsprojects/Debug & vsprojects/Release) will be searched for libraries and binaries. ``` ``` PROTOBUF_IMPORT_DIRS - List of additional directories to be searched for imported .proto files. (New in CMake 2.8.8) ``` Defines the following variables: ``` PROTOBUF_FOUND - Found the Google Protocol Buffers library (libprotobuf & header files) PROTOBUF_INCLUDE_DIRS - Include directories for Google Protocol Buffers PROTOBUF_LIBRARIES - The protobuf libraries ``` \[New in CMake 2.8.5\] ``` PROTOBUF_PROTOC_LIBRARIES - The protoc libraries PROTOBUF_LITE_LIBRARIES - The protobuf-lite libraries ``` The following cache variables are also available to set or use: ``` 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 ``` \[New in CMake 2.8.5\] ``` PROTOBUF_LIBRARY_DEBUG - The protobuf library (debug) PROTOBUF_PROTOC_LIBRARY_DEBUG - The protoc library (debug) PROTOBUF_LITE_LIBRARY - The protobuf lite library PROTOBUF_LITE_LIBRARY_DEBUG - The protobuf lite library (debug) ``` ``` ==================================================================== 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_LIBRARIES}) ``` NOTE: You may need to link against pthreads, depending ``` on the platform. ``` NOTE: The PROTOBUF\_GENERATE\_CPP macro & add\_executable() or add\_library() ``` calls only work properly within the same directory. ``` ``` ==================================================================== ``` 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 ``` ``` PYTHON_VERSION_STRING - Python version found e.g. 2.5.2 PYTHON_VERSION_MAJOR - Python major version found e.g. 2 PYTHON_VERSION_MINOR - Python minor version found e.g. 5 PYTHON_VERSION_PATCH - Python patch version found e.g. 2 ``` The Python\_ADDITIONAL\_VERSIONS variable can be used to specify a list of version numbers that should be taken into account when searching for Python. You need to set this variable before calling find\_package(PythonInterp). - **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 (deprecated) PYTHONLIBS_VERSION_STRING - version of the Python libs found (since CMake 2.8.8) ``` The Python\_ADDITIONAL\_VERSIONS variable can be used to specify a list of version numbers that should be taken into account when searching for Python. You need to set this variable before calling find\_package(PythonLibs). If you'd like to specify the installation of Python to use, you should modify the following cache variables: ``` PYTHON_LIBRARY - path to the python library PYTHON_INCLUDE_DIR - path to where Python.h is found ``` - **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. QT_VERSION_STRING - the version of Qt found ``` 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 REQUIRED QtCore QtGui QtXml) 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_QTMULTIMEDIA 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 QT_USE_QTDECLARATIVE ``` ``` QT_USE_IMPORTED_TARGETS If this variable is set to TRUE, FindQt4.cmake will create imported library targets for the various Qt libraries and set the library variables like QT_QTCORE_LIBRARY to point at these imported targets instead of the library file on disk. This provides much better handling of the release and debug versions of the Qt libraries and is also always backwards compatible, except for the case that dependencies of libraries are exported, these will then also list the names of the imported targets as dependency and not the file location on disk. This is much more flexible, but requires that FindQt4.cmake is executed before such an exported dependency file is processed. ``` 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. ``` ``` You should have a look on the AUTOMOC property for targets to achieve the same results. ``` ``` 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. ``` ``` You can pass additional parameters to the qdbusxml2cpp call by setting properties on the input file: ``` ``` INCLUDE the given file will be included in the generate interface header ``` ``` CLASSNAME the generated class is named accordingly ``` ``` NO_NAMESPACE the generated class is not wrapped in a namespace ``` ``` macro QT4_ADD_DBUS_INTERFACES(outfiles inputfile ... ) Create the interface header and implementation files for all listed interface xml files. The basename will be automatically determined from the name of the xml file. ``` ``` The source file properties described for QT4_ADD_DBUS_INTERFACE also apply here. ``` ``` 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 adaptor.{cpp,h} where basename defaults to the basename of the xml file. If 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_QTASSISTANTCLIENT_FOUND True if QtAssistantClient 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_QTHELP_FOUND True if QtHelp was found. QT_QTMOTIF_FOUND True if QtMotif was found. QT_QTMULTIMEDIA_FOUND True if QtMultimedia was found (since Qt 4.6.0). 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_QTSVG_FOUND True if QtSvg was found. QT_QTSCRIPT_FOUND True if QtScript was found. QT_QTSCRIPTTOOLS_FOUND True if QtScriptTools was found. QT_QTTEST_FOUND True if QtTest was found. QT_QTUITOOLS_FOUND True if QtUiTools was found. QT_QTWEBKIT_FOUND True if QtWebKit was found. QT_QTXML_FOUND True if QtXml was found. QT_QTXMLPATTERNS_FOUND True if QtXmlPatterns was found. QT_PHONON_FOUND True if phonon was found. QT_QTDECLARATIVE_FOUND True if QtDeclarative 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_QTDBUS_INCLUDE_DIR Path to "include/QtDBus" QT_QTDESIGNER_INCLUDE_DIR Path to "include/QtDesigner" QT_QTDESIGNERCOMPONENTS_INCLUDE_DIR Path to "include/QtDesigner" 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_QTMULTIMEDIA_INCLUDE_DIR Path to "include/QtMultimedia" 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_QTDECLARATIVE_INCLUDE_DIR Path to "include/QtDeclarative" ``` ``` 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_IMPORTS_DIR Path to "imports" 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_QTMULTIMEDIA_LIBRARY The QtMultimedia 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 ``` The QtDeclarative library: QT\_QTDECLARATIVE\_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. QT_DESIGNER_EXECUTABLE Where to find the Qt designer tool. QT_LINGUIST_EXECUTABLE Where to find the Qt linguist 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 \ - **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 of Ruby can be specified using the standard syntax, e.g. FIND\_PACKAGE(Ruby 1.8) 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 \. 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 ``` The minimum required version of SWIG can be specified using the standard syntax, e.g. FIND\_PACKAGE(SWIG 1.1) All information is 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_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 SUBVERSION_FOUND - same as Subversion_FOUND, set for compatiblity reasons ``` The minimum required version of Subversion can be specified using the standard syntax, e.g. FIND\_PACKAGE(Subversion 1.4) If the command line client executable is found two macros are defined: ``` Subversion_WC_INFO( ) Subversion_WC_LOG( ) ``` Subversion\_WC\_INFO extracts information of a subversion working copy at a given location. This macro defines the following variables: ``` _WC_URL - url of the repository (at ) _WC_ROOT - root url of the repository _WC_REVISION - current revision _WC_LAST_CHANGED_AUTHOR - author of last commit _WC_LAST_CHANGED_DATE - date of last commit _WC_LAST_CHANGED_REV - revision of last commit _WC_INFO - output of command `svn info ' ``` Subversion\_WC\_LOG retrieves the log message of the base revision of a subversion working copy at a given location. This macro defines the variable: ``` _LAST_CHANGED_LOG - last log of base revision ``` 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 ``` For systems with multiple thread libraries, caller can set ``` CMAKE_THREAD_PREFER_PTHREAD ``` - **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_SM_INCLUDE_PATH, X11_SM_LIB, X11_SM_FOUND X11_X11_INCLUDE_PATH, X11_X11_LIB 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_Xxf86vm_LIB X11_xf86vmode_FOUND X11_Xfixes_INCLUDE_PATH, X11_Xfixes_LIB, X11_Xfixes_FOUND X11_Xft_INCLUDE_PATH, X11_Xft_LIB, X11_Xft_FOUND X11_Xi_INCLUDE_PATH, X11_Xi_LIB, X11_Xi_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_Xkbfile_INCLUDE_PATH, X11_Xkbfile_LIB, X11_Xkbfile_FOUND X11_Xmu_INCLUDE_PATH, X11_Xmu_LIB, X11_Xmu_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 X11_XSync_INCLUDE_PATH, (in X11_Xext_LIB), X11_XSync_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. Once done this will define ``` ZLIB_INCLUDE_DIRS - where to find zlib.h, etc. ZLIB_LIBRARIES - List of libraries when using zlib. ZLIB_FOUND - True if zlib found. ``` ``` ZLIB_VERSION_STRING - The version of zlib found (x.y.z) ZLIB_VERSION_MAJOR - The major version of zlib ZLIB_VERSION_MINOR - The minor version of zlib ZLIB_VERSION_PATCH - The patch version of zlib ZLIB_VERSION_TWEAK - The tweak version of zlib ``` The following variable are provided for backward compatibility ``` ZLIB_MAJOR_VERSION - The major version of zlib ZLIB_MINOR_VERSION - The minor version of zlib ZLIB_PATCH_VERSION - The patch version of zlib ``` An includer may set ZLIB\_ROOT to a zlib installation root to tell this module where to look. - **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. - **FindosgPresentation** ``` ``` 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 osgPresentation This module defines OSGPRESENTATION\_FOUND - Was osgPresentation found? OSGPRESENTATION\_INCLUDE\_DIR - Where to find the headers OSGPRESENTATION\_LIBRARIES - The libraries to link for osgPresentation (use this) OSGPRESENTATION\_LIBRARY - The osgPresentation library OSGPRESENTATION\_LIBRARY\_DEBUG - The osgPresentation debug library $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg. Created by Eric Wing. Modified to work with osgPresentation by Robert Osfield, January 2012. - **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. - **FindosgQt** ``` ``` 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 osgQt This module defines OSGQT\_FOUND - Was osgQt found? OSGQT\_INCLUDE\_DIR - Where to find the headers OSGQT\_LIBRARIES - The libraries to link for osgQt (use this) OSGQT\_LIBRARY - The osgQt library OSGQT\_LIBRARY\_DEBUG - The osgQt debug library $OSGDIR is an environment variable that would correspond to the ./configure --prefix=$OSGDIR used in building osg. Created by Eric Wing. Modified to work with osgQt by Robert Osfield, January 2012. - **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 core base ...) 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.) wxWidgets_EXCLUDE_COMMON_LIBRARIES - Set to TRUE to exclude linking of commonly required libs (e.g., png tiff jpeg zlib regex expat). ``` 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 ``` There is also a wxWidgets\_CONFIG\_OPTIONS variable for all other options that need to be passed to the wx-config utility. For example, to use the base toolkit found in the /usr/local path, set the variable (before calling the FIND\_PACKAGE command) as such: ``` SET(wxWidgets_CONFIG_OPTIONS --toolkit=base --prefix=/usr) ``` 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: ``` # Note that for MinGW users the order of libs is important! FIND_PACKAGE(wxWidgets COMPONENTS net gl core base) IF(wxWidgets_FOUND) INCLUDE(${wxWidgets_USE_FILE}) # and for each of your dependent executable/library targets: TARGET_LINK_LIBRARIES( ${wxWidgets_LIBRARIES}) ENDIF(wxWidgets_FOUND) ``` If wxWidgets is required (i.e., not an optional part): ``` FIND_PACKAGE(wxWidgets REQUIRED net gl core base) INCLUDE(${wxWidgets_USE_FILE}) # and for each of your dependent executable/library targets: TARGET_LINK_LIBRARIES( ${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 \ (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( [MACRO_NAMESPACE ] [SYMBOL_NAMESPACE ] [SYMBOLS [:] ...]) ``` It generates in \ 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 "\". The SYMBOLS option lists symbols to mangle automatically with C preprocessor definitions: ``` ==> #define ... : ==> #define _ ... ``` 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 "\". 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 "FCMangle.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.) - **GNUInstallDirs** Define GNU standard installation directories Provides install directory variables as defined for GNU software: ``` http://www.gnu.org/prep/standards/html_node/Directory-Variables.html ``` Inclusion of this module defines the following variables: ``` CMAKE_INSTALL_ - destination for files of a given type CMAKE_INSTALL_FULL_ - corresponding absolute path ``` where \ is one of: ``` BINDIR - user executables (bin) SBINDIR - system admin executables (sbin) LIBEXECDIR - program executables (libexec) SYSCONFDIR - read-only single-machine data (etc) SHAREDSTATEDIR - modifiable architecture-independent data (com) LOCALSTATEDIR - modifiable single-machine data (var) LIBDIR - object code libraries (lib or lib64 or lib/ on Debian) INCLUDEDIR - C header files (include) OLDINCLUDEDIR - C header files for non-gcc (/usr/include) DATAROOTDIR - read-only architecture-independent data root (share) DATADIR - read-only architecture-independent data (DATAROOTDIR) INFODIR - info documentation (DATAROOTDIR/info) LOCALEDIR - locale-dependent data (DATAROOTDIR/locale) MANDIR - man documentation (DATAROOTDIR/man) DOCDIR - documentation root (DATAROOTDIR/doc/PROJECT_NAME) ``` Each CMAKE\_INSTALL\_\ value may be passed to the DESTINATION options of install() commands for the corresponding file type. If the includer does not define a value the above-shown default will be used and the value will appear in the cache for editing by the user. Each CMAKE\_INSTALL\_FULL\_\ value contains an absolute path constructed from the corresponding destination by prepending (if necessary) the value of CMAKE\_INSTALL\_PREFIX. - **GenerateExportHeader** Function for generation of export macros for libraries This module provides the function GENERATE\_EXPORT\_HEADER() and the accompanying ADD\_COMPILER\_EXPORT\_FLAGS() function. The GENERATE\_EXPORT\_HEADER function can be used to generate a file suitable for preprocessor inclusion which contains EXPORT macros to be used in library classes. GENERATE\_EXPORT\_HEADER( LIBRARY\_TARGET ``` [BASE_NAME ] [EXPORT_MACRO_NAME ] [EXPORT_FILE_NAME ] [DEPRECATED_MACRO_NAME ] [NO_EXPORT_MACRO_NAME ] [STATIC_DEFINE ] [NO_DEPRECATED_MACRO_NAME ] [DEFINE_NO_DEPRECATED] [PREFIX_NAME ] ``` ) ADD\_COMPILER\_EXPORT\_FLAGS( \[\\] ) By default GENERATE\_EXPORT\_HEADER() generates macro names in a file name determined by the name of the library. The ADD\_COMPILER\_EXPORT\_FLAGS function adds -fvisibility=hidden to CMAKE\_CXX\_FLAGS if supported, and is a no-op on Windows which does not need extra compiler flags for exporting support. You may optionally pass a single argument to ADD\_COMPILER\_EXPORT\_FLAGS that will be populated with the required CXX\_FLAGS required to enable visibility support for the compiler/architecture in use. This means that in the simplest case, users of these functions will be equivalent to: ``` add_compiler_export_flags() add_library(somelib someclass.cpp) generate_export_header(somelib) install(TARGETS somelib DESTINATION ${LIBRARY_INSTALL_DIR}) install(FILES someclass.h ${PROJECT_BINARY_DIR}/somelib_export.h DESTINATION ${INCLUDE_INSTALL_DIR} ) ``` And in the ABI header files: ``` #include "somelib_export.h" class SOMELIB_EXPORT SomeClass { ... }; ``` The CMake fragment will generate a file in the ${CMAKE\_CURRENT\_BUILD\_DIR} called somelib\_export.h containing the macros SOMELIB\_EXPORT, SOMELIB\_NO\_EXPORT, SOMELIB\_DEPRECATED, SOMELIB\_DEPRECATED\_EXPORT and SOMELIB\_DEPRECATED\_NO\_EXPORT. The resulting file should be installed with other headers in the library. The BASE\_NAME argument can be used to override the file name and the names used for the macros ``` add_library(somelib someclass.cpp) generate_export_header(somelib BASE_NAME other_name ) ``` Generates a file called other\_name\_export.h containing the macros OTHER\_NAME\_EXPORT, OTHER\_NAME\_NO\_EXPORT and OTHER\_NAME\_DEPRECATED etc. The BASE\_NAME may be overridden by specifiying other options in the function. For example: ``` add_library(somelib someclass.cpp) generate_export_header(somelib EXPORT_MACRO_NAME OTHER_NAME_EXPORT ) ``` creates the macro OTHER\_NAME\_EXPORT instead of SOMELIB\_EXPORT, but other macros and the generated file name is as default. ``` add_library(somelib someclass.cpp) generate_export_header(somelib DEPRECATED_MACRO_NAME KDE_DEPRECATED ) ``` creates the macro KDE\_DEPRECATED instead of SOMELIB\_DEPRECATED. If LIBRARY\_TARGET is a static library, macros are defined without values. If the same sources are used to create both a shared and a static library, the uppercased symbol ${BASE\_NAME}\_STATIC\_DEFINE should be used when building the static library ``` add_library(shared_variant SHARED ${lib_SRCS}) add_library(static_variant ${lib_SRCS}) generate_export_header(shared_variant BASE_NAME libshared_and_static) set_target_properties(static_variant PROPERTIES COMPILE_FLAGS -DLIBSHARED_AND_STATIC_STATIC_DEFINE) ``` This will cause the export macros to expand to nothing when building the static library. If DEFINE\_NO\_DEPRECATED is specified, then a macro ${BASE\_NAME}\_NO\_DEPRECATED will be defined This macro can be used to remove deprecated code from preprocessor output. ``` option(EXCLUDE_DEPRECATED "Exclude deprecated parts of the library" FALSE) if (EXCLUDE_DEPRECATED) set(NO_BUILD_DEPRECATED DEFINE_NO_DEPRECATED) endif() generate_export_header(somelib ${NO_BUILD_DEPRECATED}) ``` And then in somelib: ``` class SOMELIB_EXPORT SomeClass { public: #ifndef SOMELIB_NO_DEPRECATED SOMELIB_DEPRECATED void oldMethod(); #endif }; ``` ``` #ifndef SOMELIB_NO_DEPRECATED void SomeClass::oldMethod() { } #endif ``` If PREFIX\_NAME is specified, the argument will be used as a prefix to all generated macros. For example: ``` generate_export_header(somelib PREFIX_NAME VTK_) ``` Generates the macros VTK\_SOMELIB\_EXPORT etc. - **GetPrerequisites** Functions to analyze and list executable file prerequisites. This module 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 module: ``` get_prerequisites list_prerequisites list_prerequisites_by_glob 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 (projects can override with gp_resolved_file_type_override) gp_file_type ``` Requires CMake 2.6 or greater because it uses function, break, return and PARENT\_SCOPE. ``` GET_PREREQUISITES( ) ``` Get the list of shared library files required by \. The list in the variable named \ should be empty on first entry to this function. On exit, \ will contain the list of required shared library files. \ is the full path to an executable file. \ is the name of a CMake variable to contain the results. \ must be 0 or 1 indicating whether to include or exclude "system" prerequisites. If \ is set to 1 all prerequisites will be found recursively, if set to 0 only direct prerequisites are listed. \ is the path to the top level executable used for @executable\_path replacment on the Mac. \ is a list of paths where libraries might be found: these paths are searched first when a target without any path info is given. Then standard system locations are also searched: PATH, Framework locations, /usr/lib... ``` LIST_PREREQUISITES( [ [ []]]) ``` Print a message listing the prerequisites of \. \ is the name of a shared library or executable target or the full path to a shared library or executable file. If \ is set to 1 all prerequisites will be found recursively, if set to 0 only direct prerequisites are listed. \ must be 0 or 1 indicating whether to include or exclude "system" prerequisites. With \ set to 0 only the full path names of the prerequisites are printed, set to 1 extra informatin will be displayed. ``` LIST_PREREQUISITES_BY_GLOB( ) ``` Print the prerequisites of shared library and executable files matching a globbing pattern. \ is GLOB or GLOB\_RECURSE and \ is a globbing expression used with "file(GLOB" or "file(GLOB\_RECURSE" to retrieve a list of matching files. If a matching file is executable, its prerequisites are listed. Any additional (optional) arguments provided are passed along as the optional arguments to the list\_prerequisites calls. ``` GP_APPEND_UNIQUE( ) ``` Append \ to the list variable \ only if the value is not already in the list. ``` IS_FILE_EXECUTABLE( ) ``` Return 1 in \ if \ is a binary executable, 0 otherwise. ``` GP_ITEM_DEFAULT_EMBEDDED_PATH( ) ``` Return the path that others should refer to the item by when the item is embedded inside a bundle. Override on a per-project basis by providing a project-specific gp\_item\_default\_embedded\_path\_override function. ``` GP_RESOLVE_ITEM( ) ``` Resolve an item into an existing full path file. Override on a per-project basis by providing a project-specific gp\_resolve\_item\_override function. ``` GP_RESOLVED_FILE_TYPE( ) ``` Return the type of \ with respect to \. String describing type of prerequisite is returned in variable named \. Use \ and \ if necessary to resolve non-absolute \ values -- but only for non-embedded items. Possible types are: ``` system local embedded other ``` Override on a per-project basis by providing a project-specific gp\_resolved\_file\_type\_override function. ``` GP_FILE_TYPE( ) ``` Return the type of \ with respect to \. String describing type of prerequisite is returned in variable named \. Possible types are: ``` system local embedded other ``` - **InstallRequiredSystemLibraries** ``` ``` By including this file, all library files listed in the variable CMAKE\_INSTALL\_SYSTEM\_RUNTIME\_LIBS will be installed with INSTALL(PROGRAMS ...) into bin for WIN32 and lib for non-WIN32. If CMAKE\_INSTALL\_SYSTEM\_RUNTIME\_LIBS\_SKIP is set to TRUE before including this file, then the INSTALL command is not called. The user can use the variable CMAKE\_INSTALL\_SYSTEM\_RUNTIME\_LIBS to use a custom install command and install them however they want. If it is the MSVC compiler, then the microsoft run time libraries will be found and automatically added to the CMAKE\_INSTALL\_SYSTEM\_RUNTIME\_LIBS, 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\_DEBUG\_LIBRARIES\_ONLY is set then only the debug libraries are installed when both debug and release are available. If CMAKE\_INSTALL\_MFC\_LIBRARIES is set then the MFC run time libraries are installed as well as the CRT run time libraries. If CMAKE\_INSTALL\_SYSTEM\_RUNTIME\_DESTINATION is set then the libraries are installed to that directory rather than the default. If CMAKE\_INSTALL\_SYSTEM\_RUNTIME\_LIBS\_NO\_WARNINGS is NOT set, then this file warns about required files that do not exist. You can set this variable to ON before including this file to avoid the warning. For example, the Visual Studio Express editions do not include the redistributable files, so if you include this file on a machine with only VS Express installed, you'll get the warning. - **MacroAddFileDependencies** MACRO\_ADD\_FILE\_DEPENDENCIES(\<\_file\> depend\_files...) Using the macro MACRO\_ADD\_FILE\_DEPENDENCIES() is discouraged. There are usually better ways to specify 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 \ APPEND PROPERTY OBJECT\_DEPENDS depend\_files) instead. - **ProcessorCount** ProcessorCount(var) Determine the number of processors/cores and save value in ${var} Sets the variable named ${var} to the number of physical cores available on the machine if the information can be determined. Otherwise it is set to 0. Currently this functionality is implemented for AIX, cygwin, FreeBSD, HPUX, IRIX, Linux, Mac OS X, QNX, Sun and Windows. This function is guaranteed to return a positive integer (\>=1) if it succeeds. It returns 0 if there's a problem determining the processor count. Example use, in a ctest -S dashboard script: ``` include(ProcessorCount) ProcessorCount(N) if(NOT N EQUAL 0) set(CTEST_BUILD_FLAGS -j${N}) set(ctest_test_args ${ctest_test_args} PARALLEL_LEVEL ${N}) endif() ``` This function is intended to offer an approximation of the value of the number of compute cores available on the current machine, such that you may use that value for parallel building and parallel testing. It is meant to help utilize as much of the machine as seems reasonable. Of course, knowledge of what else might be running on the machine simultaneously should be used when deciding whether to request a machine's full capacity all for yourself. - **Qt4ConfigDependentSettings** ``` ``` This file is included by FindQt4.cmake, don't include it directly. - **Qt4Macros** ``` ``` This file is included by FindQt4.cmake, don't include it directly. - **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 ``` - **UseJava** Use Module for Java This file provides functions for Java. It is assumed that FindJava.cmake has already been loaded. See FindJava.cmake for information on how to load Java into your CMake project. add\_jar(TARGET\_NAME SRC1 SRC2 .. SRCN RCS1 RCS2 .. RCSN) This command creates a \.jar. It compiles the given source files (SRC) and adds the given resource files (RCS) to the jar file. If only resource files are given then just a jar file is created. Additional instructions: ``` To add compile flags to the target you can set these flags with the following variable: ``` ``` set(CMAKE_JAVA_COMPILE_FLAGS -nowarn) ``` ``` To add a path or a jar file to the class path you can do this with the CMAKE_JAVA_INCLUDE_PATH variable. ``` ``` set(CMAKE_JAVA_INCLUDE_PATH /usr/share/java/shibboleet.jar) ``` ``` To use a different output name for the target you can set it with: ``` ``` set(CMAKE_JAVA_TARGET_OUTPUT_NAME shibboleet.jar) add_jar(foobar foobar.java) ``` ``` To use a different output directory than CMAKE_CURRENT_BINARY_DIR you can set it with: ``` ``` set(CMAKE_JAVA_TARGET_OUTPUT_DIR ${PROJECT_BINARY_DIR}/bin) ``` ``` To define an entry point in your jar you can set it with: ``` ``` set(CMAKE_JAVA_JAR_ENTRY_POINT com/examples/MyProject/Main) ``` ``` To add a VERSION to the target output name you can set it using CMAKE_JAVA_TARGET_VERSION. This will create a jar file with the name shibboleet-1.0.0.jar and will create a symlink shibboleet.jar pointing to the jar with the version information. ``` ``` set(CMAKE_JAVA_TARGET_VERSION 1.2.0) add_jar(shibboleet shibbotleet.java) ``` ``` If the target is a JNI library, utilize the following commands to create a JNI symbolic link: ``` ``` set(CMAKE_JNI_TARGET TRUE) set(CMAKE_JAVA_TARGET_VERSION 1.2.0) add_jar(shibboleet shibbotleet.java) install_jar(shibboleet ${LIB_INSTALL_DIR}/shibboleet) install_jni_symlink(shibboleet ${JAVA_LIB_INSTALL_DIR}) ``` ``` If a single target needs to produce more than one jar from its java source code, to prevent the accumulation of duplicate class files in subsequent jars, set/reset CMAKE_JAR_CLASSES_PREFIX prior to calling the add_jar() function: ``` ``` set(CMAKE_JAR_CLASSES_PREFIX com/redhat/foo) add_jar(foo foo.java) ``` ``` set(CMAKE_JAR_CLASSES_PREFIX com/redhat/bar) add_jar(bar bar.java) ``` Target Properties: ``` The add_jar() functions sets some target properties. You can get these properties with the get_property(TARGET PROPERTY ) command. ``` ``` INSTALL_FILES The files which should be installed. This is used by install_jar(). JNI_SYMLINK The JNI symlink which should be installed. This is used by install_jni_symlink(). JAR_FILE The location of the jar file so that you can include it. CLASS_DIR The directory where the class files can be found. For example to use them with javah. ``` find\_jar(\ ``` name | NAMES name1 [name2 ...] [PATHS path1 [path2 ... ENV var]] [VERSIONS version1 [version2]] [DOC "cache documentation string"] ) ``` This command is used to find a full path to the named jar. A cache entry named by \ is created to stor the result of this command. If the full path to a jar is found the result is stored in the variable and the search will not repeated unless the variable is cleared. If nothing is found, the result will be \-NOTFOUND, and the search will be attempted again next time find\_jar 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 NAMES argument. Additional search locations can be specified after the PATHS argument. If you require special a version of a jar file you can specify it with the VERSIONS argument. The argument after DOC will be used for the documentation string in the cache. install\_jar(TARGET\_NAME DESTINATION) This command installs the TARGET\_NAME files to the given DESTINATION. It should be called in the same scope as add\_jar() or it will fail. install\_jni\_symlink(TARGET\_NAME DESTINATION) This command installs the TARGET\_NAME JNI symlinks to the given DESTINATION. It should be called in the same scope as add\_jar() or it will fail. create\_javadoc(\ ``` PACKAGES pkg1 [pkg2 ...] [SOURCEPATH ] [CLASSPATH ] [INSTALLPATH ] [DOCTITLE "the documentation title"] [WINDOWTITLE "the title of the document"] [AUTHOR TRUE|FALSE] [USE TRUE|FALSE] [VERSION TRUE|FALSE] ) ``` Create java documentation based on files or packages. For more details please read the javadoc manpage. There are two main signatures for create\_javadoc. The first signature works with package names on a path with source files: ``` Example: create_javadoc(my_example_doc PACKAGES com.exmaple.foo com.example.bar SOURCEPATH "${CMAKE_CURRENT_SOURCE_DIR}" CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH} WINDOWTITLE "My example" DOCTITLE "

My example

" AUTHOR TRUE USE TRUE VERSION TRUE ) ``` The second signature for create\_javadoc works on a given list of files. ``` create_javadoc( FILES file1 [file2 ...] [CLASSPATH ] [INSTALLPATH ] [DOCTITLE "the documentation title"] [WINDOWTITLE "the title of the document"] [AUTHOR TRUE|FALSE] [USE TRUE|FALSE] [VERSION TRUE|FALSE] ) ``` Example: ``` create_javadoc(my_example_doc FILES ${example_SRCS} CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH} WINDOWTITLE "My example" DOCTITLE "

My example

" AUTHOR TRUE USE TRUE VERSION TRUE ) ``` Both signatures share most of the options. These options are the same as what you can find in the javadoc manpage. Please look at the manpage for CLASSPATH, DOCTITLE, WINDOWTITLE, AUTHOR, USE and VERSION. The documentation will be by default installed to ``` ${CMAKE_INSTALL_PREFIX}/share/javadoc/ ``` if you don't set the INSTALLPATH. - **UseJavaClassFilelist** ``` ``` This script create a list of compiled Java class files to be added to a jar file. This avoids including cmake files which get created in the binary directory. - **UseJavaSymlinks** ``` ``` Helper script for UseJava.cmake - **UsePkgConfig** Obsolete pkg-config module for CMake, use FindPkgConfig instead. This module defines the following macro: 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\_\\_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 \ (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. Determines if wxWidgets was FOUND and sets the appropriate libs, incdirs, flags, etc. INCLUDE\_DIRECTORIES and LINK\_DIRECTORIES are called. USAGE ``` # Note that for MinGW users the order of libs is important! FIND_PACKAGE(wxWidgets REQUIRED net gl core base) INCLUDE(${wxWidgets_USE_FILE}) # and for each of your dependent executable/library targets: TARGET_LINK_LIBRARIES( ${wxWidgets_LIBRARIES}) ``` DEPRECATED ``` LINK_LIBRARIES is not called in favor of adding dependencies per target. ``` AUTHOR ``` Jan Woetzel ``` - **WriteBasicConfigVersionFile** ``` ``` ``` WRITE_BASIC_CONFIG_VERSION_FILE( filename VERSION major.minor.patch COMPATIBILITY (AnyNewerVersion|SameMajorVersion) ) ``` Deprecated, see WRITE\_BASIC\_PACKAGE\_VERSION\_FILE(), it is identical. ## 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 **[ccmake(1)](/ccmake/1.md), [cpack(1)](/cpack/1.md), [ctest(1)](/ctest/1.md), [cmakecommands(1)](/cmakecommands/1.md), [cmakecompat(1)](/cmakecompat/1.md), [cmakemodules(1)](/cmakemodules/1.md), [cmakeprops(1)](/cmakeprops/1.md), [cmakevars(1)](/cmakevars/1.md)** The following resources are available to get help using CMake: - **Home Page** http://www.cmake.org The primary starting point for learning about CMake. - **Frequently Asked Questions** http://www.cmake.org/Wiki/CMake\_FAQ A Wiki is provided containing answers to frequently asked questions. - **Online Documentation** http://www.cmake.org/HTML/Documentation.html Links to available documentation may be found on this web page. - **Mailing List** http://www.cmake.org/HTML/MailingLists.html For help and discussion about using cmake, a mailing list is provided at cmake@cmake.org. The list is member-post-only but one may sign up on the CMake web page. Please first read the full documentation at http://www.cmake.org before posting questions to the list. 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 ```