cmake
(1)
Name
cmake - Platform Makefile Generator.
Synopsis
Please see following description for synopsis
Description
User Commands cmake(1)
NAME
cmake - Cross-Platform Makefile Generator.
USAGE
cmake [options] <path-to-source>
cmake [options] <path-to-existing-build>
DESCRIPTION
The "cmake" executable is the CMake command-line interface.
It may be used to configure projects in scripts. Project
configuration settings may be specified on the command line
with the -D option. The -i option will cause cmake to
interactively prompt for such settings.
CMake is a cross-platform build system generator. Projects
specify their build process with platform-independent CMake
listfiles included in each directory of a source tree with
the name CMakeLists.txt. Users build a project by using
CMake to generate a build system for a native tool on their
platform.
OPTIONS
-C <initial-cache>
Pre-load a script to populate the cache.
When cmake is first run in an empty build tree, it cre-
ates a CMakeCache.txt file and populates it with cus-
tomizable settings for the project. This option may be
used to specify a file from which to load cache entries
before the first pass through the project's cmake list-
files. The loaded entries take priority over the
project's default values. The given file should be a
CMake script containing SET commands that use the CACHE
option, not a cache-format file.
-D <var>:<type>=<value>
Create a cmake cache entry.
When cmake is first run in an empty build tree, it cre-
ates a CMakeCache.txt file and populates it with cus-
tomizable settings for the project. This option may be
used to specify a setting that takes priority over the
project's default value. The option may be repeated
for as many cache entries as desired.
-U <globbing_expr>
cmake 2.8.6 Last change: June 17, 2014 1
User Commands cmake(1)
Remove matching entries from CMake cache.
This option may be used to remove one or more variables
from the CMakeCache.txt file, globbing expressions
using * and ? are supported. The option may be repeated
for as many cache entries as desired.
Use with care, you can make your CMakeCache.txt
non-working.
-G <generator-name>
Specify a makefile generator.
CMake may support multiple native build systems on cer-
tain platforms. A makefile generator is responsible
for generating a particular build system. Possible
generator names are specified in the Generators sec-
tion.
-Wno-dev
Suppress developer warnings.
Suppress warnings that are meant for the author of the
CMakeLists.txt files.
-Wdev
Enable developer warnings.
Enable warnings that are meant for the author of the
CMakeLists.txt files.
-E CMake command mode.
For true platform independence, CMake provides a list
of commands that can be used on all systems. Run with
-E help for the usage information. Commands available
are: chdir, compare_files, copy, copy_directory,
copy_if_different, echo, echo_append, environment,
make_directory, md5sum, remove, remove_directory,
rename, tar, time, touch, touch_nocreate. In addition,
some platform specific commands are available. On Win-
dows: comspec, delete_regv, write_regv. On UNIX: cre-
ate_symlink.
-i Run in wizard mode.
cmake 2.8.6 Last change: June 17, 2014 2
User Commands cmake(1)
Wizard mode runs cmake interactively without a GUI.
The user is prompted to answer questions about the
project configuration. The answers are used to set
cmake cache values.
-L[A][H]
List non-advanced cached variables.
List cache variables will run CMake and list all the
variables from the CMake cache that are not marked as
INTERNAL or ADVANCED. This will effectively display
current CMake settings, which can be then changed with
-D option. Changing some of the variable may result in
more variables being created. If A is specified, then
it will display also advanced variables. If H is speci-
fied, it will also display help for each variable.
--build <dir>
Build a CMake-generated project binary tree.
This abstracts a native build tool's command-line
interface with the following options:
<dir> = Project binary directory to be built.
--target <tgt> = Build <tgt> instead of default targets.
--config <cfg> = For multi-configuration tools, choose <cfg>.
--clean-first = Build target 'clean' first, then build.
(To clean only, use --target 'clean'.)
--use-stderr = Don't merge stdout/stderr.
-- = Pass remaining options to the native tool.
Run cmake --build with no options for quick help.
-N View mode only.
Only load the cache. Do not actually run configure and
generate steps.
-P <file>
Process script mode.
Process the given cmake file as a script written in the
CMake language. No configure or generate step is per-
formed and the cache is not modified. If variables are
defined using -D, this must be done before the -P argu-
ment.
cmake 2.8.6 Last change: June 17, 2014 3
User Commands cmake(1)
--find-package
Run in pkg-config like mode.
Search a package using find_package() and print the
resulting flags to stdout. This can be used to use
cmake instead of pkg-config to find installed libraries
in plain Makefile-based projects or in autoconf-based
projects (via share/aclocal/cmake.m4).
--graphviz=[file]
Generate graphviz of dependencies.
Generate a graphviz input file that will contain all
the library and executable dependencies in the project.
--system-information [file]
Dump information about this system.
Dump a wide range of information about the current sys-
tem. If run from the top of a binary tree for a CMake
project it will dump additional information such as the
cache, log files etc.
--debug-trycompile
Do not delete the try_compile build tree. Only useful
on one try_compile at a time.
Do not delete the files and directories created for
try_compile calls. This is useful in debugging failed
try_compiles. It may however change the results of the
try-compiles as old junk from a previous try-compile
may cause a different test to either pass or fail
incorrectly. This option is best used for one try-com-
pile at a time, and only when debugging.
--debug-output
Put cmake in a debug mode.
Print extra stuff during the cmake run like stack
traces with message(send_error ) calls.
--trace
Put cmake in trace mode.
Print a trace of all calls made and from where with
message(send_error ) calls.
cmake 2.8.6 Last change: June 17, 2014 4
User Commands cmake(1)
--warn-uninitialized
Warn about uninitialized values.
Print a warning when an uninitialized variable is used.
--warn-unused-vars
Warn about unused variables.
Find variables that are declared or set, but not used.
--no-warn-unused-cli
Don't warn about command line options.
Don't find variables that are declared on the command
line, but not used.
--check-system-vars
Find problems with variable usage in system files.
Normally, unused and uninitialized variables are
searched for only in CMAKE_SOURCE_DIR and
CMAKE_BINARY_DIR. This flag tells CMake to warn about
other files as well.
--help-command cmd [file]
Print help for a single command and exit.
Full documentation specific to the given command is
displayed. If a file is specified, the documentation is
written into and the output format is determined
depending on the filename suffix. Supported are man
page, HTML, DocBook and plain text.
--help-command-list [file]
List available listfile commands and exit.
The list contains all commands for which help may be
obtained by using the --help-command argument followed
by a command name. If a file is specified, the documen-
tation is written into and the output format is deter-
mined depending on the filename suffix. Supported are
man page, HTML, DocBook and plain text.
--help-commands [file]
Print help for all commands and exit.
cmake 2.8.6 Last change: June 17, 2014 5
User Commands cmake(1)
Full documentation specific for all current command is
displayed.If a file is specified, the documentation is
written into and the output format is determined
depending on the filename suffix. Supported are man
page, HTML, DocBook and plain text.
--help-compatcommands [file]
Print help for compatibility commands.
Full documentation specific for all compatibility com-
mands is displayed.If a file is specified, the documen-
tation is written into and the output format is deter-
mined depending on the filename suffix. Supported are
man page, HTML, DocBook and plain text.
--help-module module [file]
Print help for a single module and exit.
Full documentation specific to the given module is dis-
played.If a file is specified, the documentation is
written into and the output format is determined
depending on the filename suffix. Supported are man
page, HTML, DocBook and plain text.
--help-module-list [file]
List available modules and exit.
The list contains all modules for which help may be
obtained by using the --help-module argument followed
by a module name. If a file is specified, the documen-
tation is written into and the output format is deter-
mined depending on the filename suffix. Supported are
man page, HTML, DocBook and plain text.
--help-modules [file]
Print help for all modules and exit.
Full documentation for all modules is displayed. If a
file is specified, the documentation is written into
and the output format is determined depending on the
filename suffix. Supported are man page, HTML, DocBook
and plain text.
--help-custom-modules [file]
Print help for all custom modules and exit.
Full documentation for all custom modules is displayed.
cmake 2.8.6 Last change: June 17, 2014 6
User Commands cmake(1)
If a file is specified, the documentation is written
into and the output format is determined depending on
the filename suffix. Supported are man page, HTML, Doc-
Book and plain text.
--help-policy cmp [file]
Print help for a single policy and exit.
Full documentation specific to the given policy is dis-
played.If a file is specified, the documentation is
written into and the output format is determined
depending on the filename suffix. Supported are man
page, HTML, DocBook and plain text.
--help-policies [file]
Print help for all policies and exit.
Full documentation for all policies is displayed.If a
file is specified, the documentation is written into
and the output format is determined depending on the
filename suffix. Supported are man page, HTML, DocBook
and plain text.
--help-property prop [file]
Print help for a single property and exit.
Full documentation specific to the given property is
displayed.If a file is specified, the documentation is
written into and the output format is determined
depending on the filename suffix. Supported are man
page, HTML, DocBook and plain text.
--help-property-list [file]
List available properties and exit.
The list contains all properties for which help may be
obtained by using the --help-property argument followed
by a property name. If a file is specified, the help
is written into it.If a file is specified, the documen-
tation is written into and the output format is deter-
mined depending on the filename suffix. Supported are
man page, HTML, DocBook and plain text.
--help-properties [file]
Print help for all properties and exit.
Full documentation for all properties is displayed.If a
cmake 2.8.6 Last change: June 17, 2014 7
User Commands cmake(1)
file is specified, the documentation is written into
and the output format is determined depending on the
filename suffix. Supported are man page, HTML, DocBook
and plain text.
--help-variable var [file]
Print help for a single variable and exit.
Full documentation specific to the given variable is
displayed.If a file is specified, the documentation is
written into and the output format is determined
depending on the filename suffix. Supported are man
page, HTML, DocBook and plain text.
--help-variable-list [file]
List documented variables and exit.
The list contains all variables for which help may be
obtained by using the --help-variable argument followed
by a variable name. If a file is specified, the help
is written into it.If a file is specified, the documen-
tation is written into and the output format is deter-
mined depending on the filename suffix. Supported are
man page, HTML, DocBook and plain text.
--help-variables [file]
Print help for all variables and exit.
Full documentation for all variables is displayed.If a
file is specified, the documentation is written into
and the output format is determined depending on the
filename suffix. Supported are man page, HTML, DocBook
and plain text.
--copyright [file]
Print the CMake copyright and exit.
If a file is specified, the copyright is written into
it.
--help
Print usage information and exit.
Usage describes the basic command line interface and
its options.
cmake 2.8.6 Last change: June 17, 2014 8
User Commands cmake(1)
--help-full [file]
Print full help and exit.
Full help displays most of the documentation provided
by the UNIX man page. It is provided for use on
non-UNIX platforms, but is also convenient if the man
page is not installed. If a file is specified, the
help is written into it.
--help-html [file]
Print full help in HTML format.
This option is used by CMake authors to help produce
web pages. If a file is specified, the help is written
into it.
--help-man [file]
Print full help as a UNIX man page and exit.
This option is used by the cmake build to generate the
UNIX man page. If a file is specified, the help is
written into it.
--version [file]
Show program name/version banner and exit.
If a file is specified, the version is written into it.
GENERATORS
The following generators are available on this platform:
Unix Makefiles
Generates standard UNIX makefiles.
A hierarchy of UNIX makefiles is generated into the
build tree. Any standard UNIX-style make program can
build the project through the default make target. A
"make install" target is also provided.
CodeBlocks - Unix Makefiles
Generates CodeBlocks project files.
Project files for CodeBlocks will be created in the top
directory and in every subdirectory which features a
CMakeLists.txt file containing a PROJECT() call. Addi-
tionally a hierarchy of makefiles is generated into the
cmake 2.8.6 Last change: June 17, 2014 9
User Commands cmake(1)
build tree. The appropriate make program can build the
project through the default make target. A "make
install" target is also provided.
Eclipse CDT4 - Unix Makefiles
Generates Eclipse CDT 4.0 project files.
Project files for Eclipse will be created in the top
directory. In out of source builds, a linked resource
to the top level source directory will be created.Addi-
tionally a hierarchy of makefiles is generated into the
build tree. The appropriate make program can build the
project through the default make target. A "make
install" target is also provided.
KDevelop3
Generates KDevelop 3 project files.
Project files for KDevelop 3 will be created in the top
directory and in every subdirectory which features a
CMakeLists.txt file containing a PROJECT() call. If you
change the settings using KDevelop cmake will try its
best to keep your changes when regenerating the project
files. Additionally a hierarchy of UNIX makefiles is
generated into the build tree. Any standard UNIX-style
make program can build the project through the default
make target. A "make install" target is also provided.
KDevelop3 - Unix Makefiles
Generates KDevelop 3 project files.
Project files for KDevelop 3 will be created in the top
directory and in every subdirectory which features a
CMakeLists.txt file containing a PROJECT() call. If you
change the settings using KDevelop cmake will try its
best to keep your changes when regenerating the project
files. Additionally a hierarchy of UNIX makefiles is
generated into the build tree. Any standard UNIX-style
make program can build the project through the default
make target. A "make install" target is also provided.
COMMANDS
add_custom_command
Add a custom build rule to the generated build system.
There are two main signatures for add_custom_command
The first signature is for adding a custom command to
produce an output.
cmake 2.8.6 Last change: June 17, 2014 10
User Commands cmake(1)
add_custom_command(OUTPUT output1 [output2 ...]
COMMAND command1 [ARGS] [args1...]
[COMMAND command2 [ARGS] [args2...] ...]
[MAIN_DEPENDENCY depend]
[DEPENDS [depends...]]
[IMPLICIT_DEPENDS <lang1> depend1 ...]
[WORKING_DIRECTORY dir]
[COMMENT comment] [VERBATIM] [APPEND])
This defines a command to generate specified OUTPUT
file(s). A target created in the same directory
(CMakeLists.txt file) that specifies any output of the
custom command as a source file is given a rule to gen-
erate the file using the command at build time. Do not
list the output in more than one independent target
that may build in parallel or the two instances of the
rule may conflict (instead use add_custom_target to
drive the command and make the other targets depend on
that one). If an output name is a relative path it
will be interpreted relative to the build tree direc-
tory corresponding to the current source directory.
Note that MAIN_DEPENDENCY is completely optional and is
used as a suggestion to visual studio about where to
hang the custom command. In makefile terms this creates
a new target in the following form:
OUTPUT: MAIN_DEPENDENCY DEPENDS
COMMAND
If more than one command is specified they will be exe-
cuted in order. The optional ARGS argument is for back-
ward compatibility and will be ignored.
The second signature adds a custom command to a target
such as a library or executable. This is useful for
performing an operation before or after building the
target. The command becomes part of the target and will
only execute when the target itself is built. If the
target is already built, the command will not execute.
add_custom_command(TARGET target
PRE_BUILD | PRE_LINK | POST_BUILD
COMMAND command1 [ARGS] [args1...]
[COMMAND command2 [ARGS] [args2...] ...]
[WORKING_DIRECTORY dir]
[COMMENT comment] [VERBATIM])
This defines a new command that will be associated with
building the specified target. When the command will
cmake 2.8.6 Last change: June 17, 2014 11
User Commands cmake(1)
happen is determined by which of the following is spec-
ified:
PRE_BUILD - run before all other dependencies
PRE_LINK - run after other dependencies
POST_BUILD - run after the target has been built
Note that the PRE_BUILD option is only supported on
Visual Studio 7 or later. For all other generators
PRE_BUILD will be treated as PRE_LINK.
If WORKING_DIRECTORY is specified the command will be
executed in the directory given. If it is a relative
path it will be interpreted relative to the build tree
directory corresponding to the current source direc-
tory. If COMMENT is set, the value will be displayed as
a message before the commands are executed at build
time. If APPEND is specified the COMMAND and DEPENDS
option values are appended to the custom command for
the first output specified. There must have already
been a previous call to this command with the same out-
put. The COMMENT, WORKING_DIRECTORY, and MAIN_DEPEN-
DENCY options are currently ignored when APPEND is
given, but may be used in the future.
If VERBATIM is given then all arguments to the commands
will be escaped properly for the build tool so that the
invoked command receives each argument unchanged. Note
that one level of escapes is still used by the CMake
language processor before add_custom_command even sees
the arguments. Use of VERBATIM is recommended as it
enables correct behavior. When VERBATIM is not given
the behavior is platform specific because there is no
protection of tool-specific special characters.
If the output of the custom command is not actually
created as a file on disk it should be marked as SYM-
BOLIC with SET_SOURCE_FILES_PROPERTIES.
The IMPLICIT_DEPENDS option requests scanning of
implicit dependencies of an input file. The language
given specifies the programming language whose corre-
sponding dependency scanner should be used. Currently
only C and CXX language scanners are supported. Depen-
dencies discovered from the scanning are added to those
of the custom command at build time. Note that the
IMPLICIT_DEPENDS option is currently supported only for
cmake 2.8.6 Last change: June 17, 2014 12
User Commands cmake(1)
Makefile generators and will be ignored by other gener-
ators.
If COMMAND specifies an executable target (created by
ADD_EXECUTABLE) it will automatically be replaced by
the location of the executable created at build time.
Additionally a target-level dependency will be added so
that the executable target will be built before any
target using this custom command. However this does
NOT add a file-level dependency that would cause the
custom command to re-run whenever the executable is
recompiled.
Arguments to COMMAND may use "generator expressions"
with the syntax "$<...>". Generator expressions are
evaluted during build system generation to produce
information specific to each build configuration.
Valid expressions are:
$<CONFIGURATION> = configuration name
$<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a)
$<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so)
$<TARGET_SONAME_FILE:tgt> = file with soname (.so.3)
where "tgt" is the name of a target. Target file
expressions produce a full path, but _DIR and _NAME
versions can produce the directory and file name compo-
nents:
$<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt>
$<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt>
$<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt>
References to target names in generator expressions
imply target-level dependencies, but NOT file-level
dependencies. List target names with the DEPENDS
option to add file dependencies.
The DEPENDS option specifies files on which the command
depends. If any dependency is an OUTPUT of another
custom command in the same directory (CMakeLists.txt
file) CMake automatically brings the other custom com-
mand into the target in which this command is built.
If DEPENDS is not specified the command will run when-
ever the OUTPUT is missing; if the command does not
actually create the OUTPUT then the rule will always
run. If DEPENDS specifies any target (created by an
cmake 2.8.6 Last change: June 17, 2014 13
User Commands cmake(1)
ADD_* command) a target-level dependency is created to
make sure the target is built before any target using
this custom command. Additionally, if the target is an
executable or library a file-level dependency is cre-
ated to cause the custom command to re-run whenever the
target is recompiled.
add_custom_target
Add a target with no output so it will always be built.
add_custom_target(Name [ALL] [command1 [args1...]]
[COMMAND command2 [args2...] ...]
[DEPENDS depend depend depend ... ]
[WORKING_DIRECTORY dir]
[COMMENT comment] [VERBATIM]
[SOURCES src1 [src2...]])
Adds a target with the given name that executes the
given commands. The target has no output file and is
ALWAYS CONSIDERED OUT OF DATE even if the commands try
to create a file with the name of the target. Use
ADD_CUSTOM_COMMAND to generate a file with dependen-
cies. By default nothing depends on the custom target.
Use ADD_DEPENDENCIES to add dependencies to or from
other targets. If the ALL option is specified it indi-
cates that this target should be added to the default
build target so that it will be run every time (the
command cannot be called ALL). The command and argu-
ments are optional and if not specified an empty target
will be created. If WORKING_DIRECTORY is set, then the
command will be run in that directory. If it is a rela-
tive path it will be interpreted relative to the build
tree directory corresponding to the current source
directory. If COMMENT is set, the value will be dis-
played as a message before the commands are executed at
build time. Dependencies listed with the DEPENDS argu-
ment may reference files and outputs of custom commands
created with add_custom_command() in the same directory
(CMakeLists.txt file).
If VERBATIM is given then all arguments to the commands
will be escaped properly for the build tool so that the
invoked command receives each argument unchanged. Note
that one level of escapes is still used by the CMake
language processor before add_custom_target even sees
the arguments. Use of VERBATIM is recommended as it
enables correct behavior. When VERBATIM is not given
the behavior is platform specific because there is no
protection of tool-specific special characters.
cmake 2.8.6 Last change: June 17, 2014 14
User Commands cmake(1)
The SOURCES option specifies additional source files to
be included in the custom target. Specified source
files will be added to IDE project files for conve-
nience in editing even if they have not build rules.
add_definitions
Adds -D define flags to the compilation of source
files.
add_definitions(-DFOO -DBAR ...)
Adds flags to the compiler command line for sources in
the current directory and below. This command can be
used to add any flags, but it was originally intended
to add preprocessor definitions. Flags beginning in -D
or /D that look like preprocessor definitions are auto-
matically added to the COMPILE_DEFINITIONS property for
the current directory. Definitions with non-trival
values may be left in the set of flags instead of being
converted for reasons of backwards compatibility. See
documentation of the directory, target, and source file
COMPILE_DEFINITIONS properties for details on adding
preprocessor definitions to specific scopes and config-
urations.
add_dependencies
Add a dependency between top-level targets.
add_dependencies(target-name depend-target1
depend-target2 ...)
Make a top-level target depend on other top-level tar-
gets. A top-level target is one created by ADD_EXE-
CUTABLE, ADD_LIBRARY, or ADD_CUSTOM_TARGET. Adding
dependencies with this command can be used to make sure
one target is built before another target. Dependen-
cies added to an IMPORTED target are followed transi-
tively in its place since the target itself does not
build. See the DEPENDS option of ADD_CUSTOM_TARGET and
ADD_CUSTOM_COMMAND for adding file-level dependencies
in custom rules. See the OBJECT_DEPENDS option in
SET_SOURCE_FILES_PROPERTIES to add file-level dependen-
cies to object files.
add_executable
Add an executable to the project using the specified
source files.
add_executable(<name> [WIN32] [MACOSX_BUNDLE]
cmake 2.8.6 Last change: June 17, 2014 15
User Commands cmake(1)
[EXCLUDE_FROM_ALL]
source1 source2 ... sourceN)
Adds an executable target called <name> to be built
from the source files listed in the command invocation.
The <name> corresponds to the logical target name and
must be globally unique within a project. The actual
file name of the executable built is constructed based
on conventions of the native platform (such as
<name>.exe or just <name>).
By default the executable file will be created in the
build tree directory corresponding to the source tree
directory in which the command was invoked. See docu-
mentation of the RUNTIME_OUTPUT_DIRECTORY target prop-
erty to change this location. See documentation of the
OUTPUT_NAME target property to change the <name> part
of the final file name.
If WIN32 is given the property WIN32_EXECUTABLE will be
set on the target created. See documentation of that
target property for details.
If MACOSX_BUNDLE is given the corresponding property
will be set on the created target. See documentation
of the MACOSX_BUNDLE target property for details.
If EXCLUDE_FROM_ALL is given the corresponding property
will be set on the created target. See documentation
of the EXCLUDE_FROM_ALL target property for details.
The add_executable command can also create IMPORTED
executable targets using this signature:
add_executable(<name> IMPORTED)
An IMPORTED executable target references an executable
file located outside the project. No rules are gener-
ated to build it. The target name has scope in the
directory in which it is created and below. It may be
referenced like any target built within the project.
IMPORTED executables are useful for convenient refer-
ence from commands like add_custom_command. Details
about the imported executable are specified by setting
properties whose names begin in "IMPORTED_". The most
important such property is IMPORTED_LOCATION (and its
cmake 2.8.6 Last change: June 17, 2014 16
User Commands cmake(1)
per-configuration version IMPORTED_LOCATION_<CONFIG>)
which specifies the location of the main executable
file on disk. See documentation of the IMPORTED_*
properties for more information.
add_library
Add a library to the project using the specified source
files.
add_library(<name> [STATIC | SHARED | MODULE]
[EXCLUDE_FROM_ALL]
source1 source2 ... sourceN)
Adds a library target called <name> to be built from
the source files listed in the command invocation. The
<name> corresponds to the logical target name and must
be globally unique within a project. The actual file
name of the library built is constructed based on con-
ventions of the native platform (such as lib<name>.a or
<name>.lib).
STATIC, SHARED, or MODULE may be given to specify the
type of library to be created. STATIC libraries are
archives of object files for use when linking other
targets. SHARED libraries are linked dynamically and
loaded at runtime. MODULE libraries are plugins that
are not linked into other targets but may be loaded
dynamically at runtime using dlopen-like functionality.
If no type is given explicitly the type is STATIC or
SHARED based on whether the current value of the vari-
able BUILD_SHARED_LIBS is true.
By default the library file will be created in the
build tree directory corresponding to the source tree
directory in which the command was invoked. See docu-
mentation of the ARCHIVE_OUTPUT_DIRECTORY, LIBRARY_OUT-
PUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY target
properties to change this location. See documentation
of the OUTPUT_NAME target property to change the <name>
part of the final file name.
If EXCLUDE_FROM_ALL is given the corresponding property
will be set on the created target. See documentation
of the EXCLUDE_FROM_ALL target property for details.
The add_library command can also create IMPORTED
library targets using this signature:
cmake 2.8.6 Last change: June 17, 2014 17
User Commands cmake(1)
add_library(<name> <SHARED|STATIC|MODULE|UNKNOWN> IMPORTED)
An IMPORTED library target references a library file
located outside the project. No rules are generated to
build it. The target name has scope in the directory
in which it is created and below. It may be referenced
like any target built within the project. IMPORTED
libraries are useful for convenient reference from com-
mands like target_link_libraries. Details about the
imported library are specified by setting properties
whose names begin in "IMPORTED_". The most important
such property is IMPORTED_LOCATION (and its per-config-
uration version IMPORTED_LOCATION_<CONFIG>) which spec-
ifies the location of the main library file on disk.
See documentation of the IMPORTED_* properties for more
information.
add_subdirectory
Add a subdirectory to the build.
add_subdirectory(source_dir [binary_dir]
[EXCLUDE_FROM_ALL])
Add a subdirectory to the build. The source_dir speci-
fies the directory in which the source CmakeLists.txt
and code files are located. If it is a relative path it
will be evaluated with respect to the current directory
(the typical usage), but it may also be an absolute
path. The binary_dir specifies the directory in which
to place the output files. If it is a relative path it
will be evaluated with respect to the current output
directory, but it may also be an absolute path. If
binary_dir is not specified, the value of source_dir,
before expanding any relative path, will be used (the
typical usage). The CMakeLists.txt file in the speci-
fied source directory will be processed immediately by
CMake before processing in the current input file con-
tinues beyond this command.
If the EXCLUDE_FROM_ALL argument is provided then tar-
gets in the subdirectory will not be included in the
ALL target of the parent directory by default, and will
be excluded from IDE project files. Users must explic-
itly build targets in the subdirectory. This is meant
for use when the subdirectory contains a separate part
of the project that is useful but not necessary, such
as a set of examples. Typically the subdirectory
should contain its own project() command invocation so
that a full build system will be generated in the sub-
directory (such as a VS IDE solution file). Note that
cmake 2.8.6 Last change: June 17, 2014 18
User Commands cmake(1)
inter-target dependencies supercede this exclusion. If
a target built by the parent project depends on a tar-
get in the subdirectory, the dependee target will be
included in the parent project build system to satisfy
the dependency.
add_test
Add a test to the project with the specified arguments.
add_test(testname Exename arg1 arg2 ... )
If the ENABLE_TESTING command has been run, this com-
mand adds a test target to the current directory. If
ENABLE_TESTING has not been run, this command does
nothing. The tests are run by the testing subsystem by
executing Exename with the specified arguments. Exe-
name can be either an executable built by this project
or an arbitrary executable on the system (like tclsh).
The test will be run with the current working directory
set to the CMakeList.txt files corresponding directory
in the binary tree.
add_test(NAME <name> [CONFIGURATIONS [Debug|Release|...]]
[WORKING_DIRECTORY dir]
COMMAND <command> [arg1 [arg2 ...]])
If COMMAND specifies an executable target (created by
add_executable) it will automatically be replaced by
the location of the executable created at build time.
If a CONFIGURATIONS option is given then the test will
be executed only when testing under one of the named
configurations. If a WORKING_DIRECTORY option is given
then the test will be executed in the given directory.
Arguments after COMMAND may use "generator expressions"
with the syntax "$<...>". Generator expressions are
evaluted during build system generation to produce
information specific to each build configuration.
Valid expressions are:
$<CONFIGURATION> = configuration name
$<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a)
$<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so)
$<TARGET_SONAME_FILE:tgt> = file with soname (.so.3)
cmake 2.8.6 Last change: June 17, 2014 19
User Commands cmake(1)
where "tgt" is the name of a target. Target file
expressions produce a full path, but _DIR and _NAME
versions can produce the directory and file name compo-
nents:
$<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt>
$<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt>
$<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt>
Example usage:
add_test(NAME mytest
COMMAND testDriver --config $<CONFIGURATION>
--exe $<TARGET_FILE:myexe>)
This creates a test "mytest" whose command runs a test-
Driver tool passing the configuration name and the full
path to the executable file produced by target "myexe".
aux_source_directory
Find all source files in a directory.
aux_source_directory(<dir> <variable>)
Collects the names of all the source files in the spec-
ified directory and stores the list in the <variable>
provided. This command is intended to be used by
projects that use explicit template instantiation.
Template instantiation files can be stored in a "Tem-
plates" subdirectory and collected automatically using
this command to avoid manually listing all instantia-
tions.
It is tempting to use this command to avoid writing the
list of source files for a library or executable tar-
get. While this seems to work, there is no way for
CMake to generate a build system that knows when a new
source file has been added. Normally the generated
build system knows when it needs to rerun CMake because
the CMakeLists.txt file is modified to add a new
source. When the source is just added to the directory
without modifying this file, one would have to manually
rerun CMake to generate a build system incorporating
the new file.
break
Break from an enclosing foreach or while loop.
cmake 2.8.6 Last change: June 17, 2014 20
User Commands cmake(1)
break()
Breaks from an enclosing foreach loop or while loop
build_command
Get the command line to build this project.
build_command(<variable>
[CONFIGURATION <config>]
[PROJECT_NAME <projname>]
[TARGET <target>])
Sets the given <variable> to a string containing the
command line for building one configuration of a target
in a project using the build tool appropriate for the
current CMAKE_GENERATOR.
If CONFIGURATION is omitted, CMake chooses a reasonable
default value for multi-configuration generators.
CONFIGURATION is ignored for single-configuration gen-
erators.
If PROJECT_NAME is omitted, the resulting command line
will build the top level PROJECT in the current build
tree.
If TARGET is omitted, the resulting command line will
build everything, effectively using build target 'all'
or 'ALL_BUILD'.
build_command(<cachevariable> <makecommand>)
This second signature is deprecated, but still avail-
able for backwards compatibility. Use the first signa-
ture instead.
Sets the given <cachevariable> to a string containing
the command to build this project from the root of the
build tree using the build tool given by <makecommand>.
<makecommand> should be the full path to msdev, devenv,
nmake, make or one of the end user build tools.
cmake_minimum_required
Set the minimum required version of cmake for a
project.
cmake 2.8.6 Last change: June 17, 2014 21
User Commands cmake(1)
cmake_minimum_required(VERSION major[.minor[.patch[.tweak]]]
[FATAL_ERROR])
If the current version of CMake is lower than that
required it will stop processing the project and report
an error. When a version higher than 2.4 is specified
the command implicitly invokes
cmake_policy(VERSION major[.minor[.patch[.tweak]]])
which sets the cmake policy version level to the ver-
sion specified. When version 2.4 or lower is given the
command implicitly invokes
cmake_policy(VERSION 2.4)
which enables compatibility features for CMake 2.4 and
lower.
The FATAL_ERROR option is accepted but ignored by CMake
2.6 and higher. It should be specified so CMake ver-
sions 2.4 and lower fail with an error instead of just
a warning.
cmake_policy
Manage CMake Policy settings.
As CMake evolves it is sometimes necessary to change
existing behavior in order to fix bugs or improve
implementations of existing features. The CMake Policy
mechanism is designed to help keep existing projects
building as new versions of CMake introduce changes in
behavior. Each new policy (behavioral change) is given
an identifier of the form "CMP<NNNN>" where "<NNNN>" is
an integer index. Documentation associated with each
policy describes the OLD and NEW behavior and the rea-
son the policy was introduced. Projects may set each
policy to select the desired behavior. When CMake
needs to know which behavior to use it checks for a
setting specified by the project. If no setting is
available the OLD behavior is assumed and a warning is
produced requesting that the policy be set.
The cmake_policy command is used to set policies to OLD
or NEW behavior. While setting policies individually
is supported, we encourage projects to set policies
based on CMake versions.
cmake 2.8.6 Last change: June 17, 2014 22
User Commands cmake(1)
cmake_policy(VERSION major.minor[.patch[.tweak]])
Specify that the current CMake list file is written for
the given version of CMake. All policies introduced in
the specified version or earlier will be set to use NEW
behavior. All policies introduced after the specified
version will be unset (unless variable CMAKE_POL-
ICY_DEFAULT_CMP<NNNN> sets a default). This effec-
tively requests behavior preferred as of a given CMake
version and tells newer CMake versions to warn about
their new policies. The policy version specified must
be at least 2.4 or the command will report an error.
In order to get compatibility features supporting ver-
sions earlier than 2.4 see documentation of policy
CMP0001.
cmake_policy(SET CMP<NNNN> NEW)
cmake_policy(SET CMP<NNNN> OLD)
Tell CMake to use the OLD or NEW behavior for a given
policy. Projects depending on the old behavior of a
given policy may silence a policy warning by setting
the policy state to OLD. Alternatively one may fix the
project to work with the new behavior and set the pol-
icy state to NEW.
cmake_policy(GET CMP<NNNN> <variable>)
Check whether a given policy is set to OLD or NEW
behavior. The output variable value will be "OLD" or
"NEW" if the policy is set, and empty otherwise.
CMake keeps policy settings on a stack, so changes made
by the cmake_policy command affect only the top of the
stack. A new entry on the policy stack is managed
automatically for each subdirectory to protect its par-
ents and siblings. CMake also manages a new entry for
scripts loaded by include() and find_package() commands
except when invoked with the NO_POLICY_SCOPE option
(see also policy CMP0011). The cmake_policy command
provides an interface to manage custom entries on the
policy stack:
cmake_policy(PUSH)
cmake_policy(POP)
Each PUSH must have a matching POP to erase any
changes. This is useful to make temporary changes to
cmake 2.8.6 Last change: June 17, 2014 23
User Commands cmake(1)
policy settings.
Functions and macros record policy settings when they
are created and use the pre-record policies when they
are invoked. If the function or macro implementation
sets policies, the changes automatically propagate up
through callers until they reach the closest nested
policy stack entry.
configure_file
Copy a file to another location and modify its con-
tents.
configure_file(<input> <output>
[COPYONLY] [ESCAPE_QUOTES] [@ONLY])
Copies a file <input> to file <output> and substitutes
variable values referenced in the file content. If
<input> is a relative path it is evaluated with respect
to the current source directory. The <input> must be a
file, not a directory. If <output> is a relative path
it is evaluated with respect to the current binary
directory. If <output> names an existing directory the
input file is placed in that directory with its origi-
nal name.
This command replaces any variables in the input file
referenced as ${VAR} or @VAR@ with their values as
determined by CMake. If a variable is not defined, it
will be replaced with nothing. If COPYONLY is speci-
fied, then no variable expansion will take place. If
ESCAPE_QUOTES is specified then any substituted quotes
will be C-style escaped. The file will be configured
with the current values of CMake variables. If @ONLY is
specified, only variables of the form @VAR@ will be
replaces and ${VAR} will be ignored. This is useful
for configuring scripts that use ${VAR}. Any occur-
rences of #cmakedefine VAR will be replaced with either
#define VAR or /* #undef VAR */ depending on the set-
ting of VAR in CMake. Any occurrences of #cmakedefine01
VAR will be replaced with either #define VAR 1 or
#define VAR 0 depending on whether VAR evaluates to
TRUE or FALSE in CMake
create_test_sourcelist
Create a test driver and source list for building test
programs.
cmake 2.8.6 Last change: June 17, 2014 24
User Commands cmake(1)
create_test_sourcelist(sourceListName driverName
test1 test2 test3
EXTRA_INCLUDE include.h
FUNCTION function)
A test driver is a program that links together many
small tests into a single executable. This is useful
when building static executables with large libraries
to shrink the total required size. The list of source
files needed to build the test driver will be in
sourceListName. DriverName is the name of the test
driver program. The rest of the arguments consist of a
list of test source files, can be semicolon separated.
Each test source file should have a function in it that
is the same name as the file with no extension (foo.cxx
should have int foo(int, char*[]);) DriverName will be
able to call each of the tests by name on the command
line. If EXTRA_INCLUDE is specified, then the next
argument is included into the generated file. If FUNC-
TION is specified, then the next argument is taken as a
function name that is passed a pointer to ac and av.
This can be used to add extra command line processing
to each test. The cmake variable CMAKE_TEST-
DRIVER_BEFORE_TESTMAIN can be set to have code that
will be placed directly before calling the test main
function. CMAKE_TESTDRIVER_AFTER_TESTMAIN can be set
to have code that will be placed directly after the
call to the test main function.
define_property
Define and document custom properties.
define_property(<GLOBAL | DIRECTORY | TARGET | SOURCE |
TEST | VARIABLE | CACHED_VARIABLE>
PROPERTY <name> [INHERITED]
BRIEF_DOCS <brief-doc> [docs...]
FULL_DOCS <full-doc> [docs...])
Define one property in a scope for use with the
set_property and get_property commands. This is pri-
marily useful to associate documentation with property
names that may be retrieved with the get_property com-
mand. The first argument determines the kind of scope
in which the property should be used. It must be one
of the following:
GLOBAL = associated with the global namespace
DIRECTORY = associated with one directory
TARGET = associated with one target
SOURCE = associated with one source file
cmake 2.8.6 Last change: June 17, 2014 25
User Commands cmake(1)
TEST = associated with a test named with add_test
VARIABLE = documents a CMake language variable
CACHED_VARIABLE = documents a CMake cache variable
Note that unlike set_property and get_property no
actual scope needs to be given; only the kind of scope
is important.
The required PROPERTY option is immediately followed by
the name of the property being defined.
If the INHERITED option then the get_property command
will chain up to the next higher scope when the
requested property is not set in the scope given to the
command. DIRECTORY scope chains to GLOBAL. TARGET,
SOURCE, and TEST chain to DIRECTORY.
The BRIEF_DOCS and FULL_DOCS options are followed by
strings to be associated with the property as its brief
and full documentation. Corresponding options to the
get_property command will retrieve the documentation.
else Starts the else portion of an if block.
else(expression)
See the if command.
elseif
Starts the elseif portion of an if block.
elseif(expression)
See the if command.
enable_language
Enable a language (CXX/C/Fortran/etc)
enable_language(languageName [OPTIONAL] )
This command enables support for the named language in
CMake. This is the same as the project command but does
not create any of the extra variables that are created
by the project command. Example languages are CXX, C,
Fortran. If OPTIONAL is used, use the CMAKE_<language-
Name>_COMPILER_WORKS variable to check whether the
cmake 2.8.6 Last change: June 17, 2014 26
User Commands cmake(1)
language has been enabled successfully.
enable_testing
Enable testing for current directory and below.
enable_testing()
Enables testing for this directory and below. See also
the add_test command. Note that ctest expects to find
a test file in the build directory root. Therefore,
this command should be in the source directory root.
endforeach
Ends a list of commands in a FOREACH block.
endforeach(expression)
See the FOREACH command.
endfunction
Ends a list of commands in a function block.
endfunction(expression)
See the function command.
endif
Ends a list of commands in an if block.
endif(expression)
See the if command.
endmacro
Ends a list of commands in a macro block.
endmacro(expression)
See the macro command.
endwhile
Ends a list of commands in a while block.
endwhile(expression)
See the while command.
cmake 2.8.6 Last change: June 17, 2014 27
User Commands cmake(1)
execute_process
Execute one or more child processes.
execute_process(COMMAND <cmd1> [args1...]]
[COMMAND <cmd2> [args2...] [...]]
[WORKING_DIRECTORY <directory>]
[TIMEOUT <seconds>]
[RESULT_VARIABLE <variable>]
[OUTPUT_VARIABLE <variable>]
[ERROR_VARIABLE <variable>]
[INPUT_FILE <file>]
[OUTPUT_FILE <file>]
[ERROR_FILE <file>]
[OUTPUT_QUIET]
[ERROR_QUIET]
[OUTPUT_STRIP_TRAILING_WHITESPACE]
[ERROR_STRIP_TRAILING_WHITESPACE])
Runs the given sequence of one or more commands with
the standard output of each process piped to the stan-
dard input of the next. A single standard error pipe
is used for all processes. If WORKING_DIRECTORY is
given the named directory will be set as the current
working directory of the child processes. If TIMEOUT
is given the child processes will be terminated if they
do not finish in the specified number of seconds (frac-
tions are allowed). If RESULT_VARIABLE is given the
variable will be set to contain the result of running
the processes. This will be an integer return code
from the last child or a string describing an error
condition. If OUTPUT_VARIABLE or ERROR_VARIABLE are
given the variable named will be set with the contents
of the standard output and standard error pipes respec-
tively. If the same variable is named for both pipes
their output will be merged in the order produced. If
INPUT_FILE, OUTPUT_FILE, or ERROR_FILE is given the
file named will be attached to the standard input of
the first process, standard output of the last process,
or standard error of all processes respectively. If
OUTPUT_QUIET or ERROR_QUIET is given then the standard
output or standard error results will be quietly
ignored. If more than one OUTPUT_* or ERROR_* option
is given for the same pipe the precedence is not speci-
fied. If no OUTPUT_* or ERROR_* options are given the
output will be shared with the corresponding pipes of
the CMake process itself.
The execute_process command is a newer more powerful
version of exec_program, but the old command has been
kept for compatibility.
cmake 2.8.6 Last change: June 17, 2014 28
User Commands cmake(1)
export
Export targets from the build tree for use by outside
projects.
export(TARGETS [target1 [target2 [...]]] [NAMESPACE <namespace>]
[APPEND] FILE <filename>)
Create a file <filename> that may be included by out-
side projects to import targets from the current
project's build tree. This is useful during cross-com-
piling to build utility executables that can run on the
host platform in one project and then import them into
another project being compiled for the target platform.
If the NAMESPACE option is given the <namespace> string
will be prepended to all target names written to the
file. If the APPEND option is given the generated code
will be appended to the file instead of overwriting it.
If a library target is included in the export but a
target to which it links is not included the behavior
is unspecified.
The file created by this command is specific to the
build tree and should never be installed. See the
install(EXPORT) command to export targets from an
installation tree.
export(PACKAGE <name>)
Store the current build directory in the CMake user
package registry for package <name>. The find_package
command may consider the directory while searching for
package <name>. This helps dependent projects find and
use a package from the current project's build tree
without help from the user. Note that the entry in the
package registry that this command creates works only
in conjunction with a package configuration file
(<name>Config.cmake) that works with the build tree.
file File manipulation command.
file(WRITE filename "message to write"... )
file(APPEND filename "message to write"... )
file(READ filename variable [LIMIT numBytes] [OFFSET offset] [HEX])
file(STRINGS filename variable [LIMIT_COUNT num]
[LIMIT_INPUT numBytes] [LIMIT_OUTPUT numBytes]
[LENGTH_MINIMUM numBytes] [LENGTH_MAXIMUM numBytes]
[NEWLINE_CONSUME] [REGEX regex]
[NO_HEX_CONVERSION])
file(GLOB variable [RELATIVE path] [globbing expressions]...)
cmake 2.8.6 Last change: June 17, 2014 29
User Commands cmake(1)
file(GLOB_RECURSE variable [RELATIVE path]
[FOLLOW_SYMLINKS] [globbing expressions]...)
file(RENAME <oldname> <newname>)
file(REMOVE [file1 ...])
file(REMOVE_RECURSE [file1 ...])
file(MAKE_DIRECTORY [directory1 directory2 ...])
file(RELATIVE_PATH variable directory file)
file(TO_CMAKE_PATH path result)
file(TO_NATIVE_PATH path result)
file(DOWNLOAD url file [INACTIVITY_TIMEOUT timeout]
[TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS]
[EXPECTED_MD5 sum])
file(UPLOAD filename url [INACTIVITY_TIMEOUT timeout]
[TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS])
WRITE will write a message into a file called 'file-
name'. It overwrites the file if it already exists, and
creates the file if it does not exist.
APPEND will write a message into a file same as WRITE,
except it will append it to the end of the file
READ will read the content of a file and store it into
the variable. It will start at the given offset and
read up to numBytes. If the argument HEX is given, the
binary data will be converted to hexadecimal represen-
tation and this will be stored in the variable.
STRINGS will parse a list of ASCII strings from a file
and store it in a variable. Binary data in the file are
ignored. Carriage return (CR) characters are ignored.
It works also for Intel Hex and Motorola S-record
files, which are automatically converted to binary for-
mat when reading them. Disable this using NO_HEX_CON-
VERSION.
LIMIT_COUNT sets the maximum number of strings to
return. LIMIT_INPUT sets the maximum number of bytes to
read from the input file. LIMIT_OUTPUT sets the maximum
number of bytes to store in the output variable.
LENGTH_MINIMUM sets the minimum length of a string to
return. Shorter strings are ignored. LENGTH_MAXIMUM
sets the maximum length of a string to return. Longer
strings are split into strings no longer than the maxi-
mum length. NEWLINE_CONSUME allows newlines to be
included in strings instead of terminating them.
cmake 2.8.6 Last change: June 17, 2014 30
User Commands cmake(1)
REGEX specifies a regular expression that a string must
match to be returned. Typical usage
file(STRINGS myfile.txt myfile)
stores a list in the variable "myfile" in which each
item is a line from the input file.
GLOB will generate a list of all files that match the
globbing expressions and store it into the variable.
Globbing expressions are similar to regular expres-
sions, but much simpler. If RELATIVE flag is specified
for an expression, the results will be returned as a
relative path to the given path. (We do not recommend
using GLOB to collect a list of source files from your
source tree. If no CMakeLists.txt file changes when a
source is added or removed then the generated build
system cannot know when to ask CMake to regenerate.)
Examples of globbing expressions include:
*.cxx - match all files with extension cxx
*.vt? - match all files with extension vta,...,vtz
f[3-5].txt - match files f3.txt, f4.txt, f5.txt
GLOB_RECURSE will generate a list similar to the regu-
lar GLOB, except it will traverse all the subdirecto-
ries of the matched directory and match the files. Sub-
directories that are symlinks are only traversed if
FOLLOW_SYMLINKS is given or cmake policy CMP0009 is not
set to NEW. See cmake --help-policy CMP0009 for more
information.
Examples of recursive globbing include:
/dir/*.py - match all python files in /dir and subdirectories
MAKE_DIRECTORY will create the given directories, also
if their parent directories don't exist yet
RENAME moves a file or directory within a filesystem,
replacing the destination atomically.
REMOVE will remove the given files, also in
cmake 2.8.6 Last change: June 17, 2014 31
User Commands cmake(1)
subdirectories
REMOVE_RECURSE will remove the given files and directo-
ries, also non-empty directories
RELATIVE_PATH will determine relative path from direc-
tory to the given file.
TO_CMAKE_PATH will convert path into a cmake style path
with unix /. The input can be a single path or a sys-
tem path like "$ENV{PATH}". Note the double quotes
around the ENV call TO_CMAKE_PATH only takes one argu-
ment.
TO_NATIVE_PATH works just like TO_CMAKE_PATH, but will
convert from a cmake style path into the native path
style \ for windows and / for UNIX.
DOWNLOAD will download the given URL to the given file.
If LOG var is specified a log of the download will be
put in var. If STATUS var is specified the status of
the operation will be put in var. The status is
returned in a list of length 2. The first element is
the numeric return value for the operation, and the
second element is a string value for the error. A 0
numeric error means no error in the operation. If TIME-
OUT time is specified, the operation will timeout after
time seconds, time should be specified as an integer.
The INACTIVITY_TIMEOUT specifies an integer number of
seconds of inactivity after which the operation should
terminate. If EXPECTED_MD5 sum is specified, the opera-
tion will verify that the downloaded file's actual md5
sum matches the expected value. If it does not match,
the operation fails with an error. If SHOW_PROGRESS is
specified, progress information will be printed as sta-
tus messages until the operation is complete.
UPLOAD will upload the given file to the given URL. If
LOG var is specified a log of the upload will be put in
var. If STATUS var is specified the status of the oper-
ation will be put in var. The status is returned in a
list of length 2. The first element is the numeric
return value for the operation, and the second element
is a string value for the error. A 0 numeric error
means no error in the operation. If TIMEOUT time is
specified, the operation will timeout after time
cmake 2.8.6 Last change: June 17, 2014 32
User Commands cmake(1)
seconds, time should be specified as an integer. The
INACTIVITY_TIMEOUT specifies an integer number of sec-
onds of inactivity after which the operation should
terminate. If SHOW_PROGRESS is specified, progress
information will be printed as status messages until
the operation is complete.
The file() command also provides COPY and INSTALL sig-
natures:
file(<COPY|INSTALL> files... DESTINATION <dir>
[FILE_PERMISSIONS permissions...]
[DIRECTORY_PERMISSIONS permissions...]
[NO_SOURCE_PERMISSIONS] [USE_SOURCE_PERMISSIONS]
[FILES_MATCHING]
[[PATTERN <pattern> | REGEX <regex>]
[EXCLUDE] [PERMISSIONS permissions...]] [...])
The COPY signature copies files, directories, and sym-
links to a destination folder. Relative input paths
are evaluated with respect to the current source direc-
tory, and a relative destination is evaluated with
respect to the current build directory. Copying pre-
serves input file timestamps, and optimizes out a file
if it exists at the destination with the same time-
stamp. Copying preserves input permissions unless
explicit permissions or NO_SOURCE_PERMISSIONS are given
(default is USE_SOURCE_PERMISSIONS). See the
install(DIRECTORY) command for documentation of permis-
sions, PATTERN, REGEX, and EXCLUDE options.
The INSTALL signature differs slightly from COPY: it
prints status messages, and NO_SOURCE_PERMISSIONS is
default. Installation scripts generated by the
install() command use this signature (with some undocu-
mented options for internal use).
find_file
Find the full path to a file.
find_file(<VAR> name1 [path1 path2 ...])
This is the short-hand signature for the command that
is sufficient in many cases. It is the same as
find_file(<VAR> name1 [PATHS path1 path2 ...])
find_file(
cmake 2.8.6 Last change: June 17, 2014 33
User Commands cmake(1)
<VAR>
name | NAMES name1 [name2 ...]
[HINTS path1 [path2 ... ENV var]]
[PATHS path1 [path2 ... ENV var]]
[PATH_SUFFIXES suffix1 [suffix2 ...]]
[DOC "cache documentation string"]
[NO_DEFAULT_PATH]
[NO_CMAKE_ENVIRONMENT_PATH]
[NO_CMAKE_PATH]
[NO_SYSTEM_ENVIRONMENT_PATH]
[NO_CMAKE_SYSTEM_PATH]
[CMAKE_FIND_ROOT_PATH_BOTH |
ONLY_CMAKE_FIND_ROOT_PATH |
NO_CMAKE_FIND_ROOT_PATH]
)
This command is used to find a full path to named file.
A cache entry named by <VAR> is created to store the
result of this command. If the full path to a file is
found the result is stored in the variable and the
search will not be repeated unless the variable is
cleared. If nothing is found, the result will be
<VAR>-NOTFOUND, and the search will be attempted again
the next time find_file is invoked with the same vari-
able. The name of the full path to a file that is
searched for is specified by the names listed after the
NAMES argument. Additional search locations can be
specified after the PATHS argument. If ENV var is
found in the HINTS or PATHS section the environment
variable var will be read and converted from a system
environment variable to a cmake style list of paths.
For example ENV PATH would be a way to list the system
path variable. The argument after DOC will be used for
the documentation string in the cache. PATH_SUFFIXES
specifies additional subdirectories to check below each
search path.
If NO_DEFAULT_PATH is specified, then no additional
paths are added to the search. If NO_DEFAULT_PATH is
not specified, the search process is as follows:
1. Search paths specified in cmake-specific cache vari-
ables. These are intended to be used on the command
line with a -DVAR=value. This can be skipped if
NO_CMAKE_PATH is passed.
<prefix>/include for each <prefix> in CMAKE_PREFIX_PATH
CMAKE_INCLUDE_PATH
CMAKE_FRAMEWORK_PATH
cmake 2.8.6 Last change: June 17, 2014 34
User Commands cmake(1)
2. Search paths specified in cmake-specific environment
variables. These are intended to be set in the user's
shell configuration. This can be skipped if
NO_CMAKE_ENVIRONMENT_PATH is passed.
<prefix>/include for each <prefix> in CMAKE_PREFIX_PATH
CMAKE_INCLUDE_PATH
CMAKE_FRAMEWORK_PATH
3. Search the paths specified by the HINTS option.
These should be paths computed by system introspection,
such as a hint provided by the location of another item
already found. Hard-coded guesses should be specified
with the PATHS option.
4. Search the standard system environment variables.
This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an
argument.
PATH
INCLUDE
5. Search cmake variables defined in the Platform files
for the current system. This can be skipped if
NO_CMAKE_SYSTEM_PATH is passed.
<prefix>/include for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH
CMAKE_SYSTEM_INCLUDE_PATH
CMAKE_SYSTEM_FRAMEWORK_PATH
6. Search the paths specified by the PATHS option or in
the short-hand version of the command. These are typi-
cally hard-coded guesses.
On Darwin or systems supporting OS X Frameworks, the
cmake variable CMAKE_FIND_FRAMEWORK can be set to
empty or one of the following:
"FIRST" - Try to find frameworks before standard
libraries or headers. This is the default on Darwin.
"LAST" - Try to find frameworks after standard
libraries or headers.
"ONLY" - Only try to find frameworks.
"NEVER" - Never try to find frameworks.
On Darwin or systems supporting OS X Application
cmake 2.8.6 Last change: June 17, 2014 35
User Commands cmake(1)
Bundles, the cmake variable CMAKE_FIND_APPBUNDLE can be
set to empty or one of the following:
"FIRST" - Try to find application bundles before standard
programs. This is the default on Darwin.
"LAST" - Try to find application bundles after standard
programs.
"ONLY" - Only try to find application bundles.
"NEVER" - Never try to find application bundles.
The CMake variable CMAKE_FIND_ROOT_PATH specifies one
or more directories to be prepended to all other search
directories. This effectively "re-roots" the entire
search under given locations. By default it is empty.
It is especially useful when cross-compiling to point
to the root directory of the target environment and
CMake will search there too. By default at first the
directories listed in CMAKE_FIND_ROOT_PATH and then the
non-rooted directories will be searched. The default
behavior can be adjusted by setting
CMAKE_FIND_ROOT_PATH_MODE_INCLUDE. This behavior can
be manually overridden on a per-call basis. By using
CMAKE_FIND_ROOT_PATH_BOTH the search order will be as
described above. If NO_CMAKE_FIND_ROOT_PATH is used
then CMAKE_FIND_ROOT_PATH will not be used. If
ONLY_CMAKE_FIND_ROOT_PATH is used then only the
re-rooted directories will be searched.
The default search order is designed to be most-spe-
cific to least-specific for common use cases. Projects
may override the order by simply calling the command
multiple times and using the NO_* options:
find_file(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
find_file(<VAR> NAMES name)
Once one of the calls succeeds the result variable will
be set and stored in the cache so that no call will
search again.
find_library
Find a library.
find_library(<VAR> name1 [path1 path2 ...])
This is the short-hand signature for the command that
is sufficient in many cases. It is the same as
find_library(<VAR> name1 [PATHS path1 path2 ...])
cmake 2.8.6 Last change: June 17, 2014 36
User Commands cmake(1)
find_library(
<VAR>
name | NAMES name1 [name2 ...]
[HINTS path1 [path2 ... ENV var]]
[PATHS path1 [path2 ... ENV var]]
[PATH_SUFFIXES suffix1 [suffix2 ...]]
[DOC "cache documentation string"]
[NO_DEFAULT_PATH]
[NO_CMAKE_ENVIRONMENT_PATH]
[NO_CMAKE_PATH]
[NO_SYSTEM_ENVIRONMENT_PATH]
[NO_CMAKE_SYSTEM_PATH]
[CMAKE_FIND_ROOT_PATH_BOTH |
ONLY_CMAKE_FIND_ROOT_PATH |
NO_CMAKE_FIND_ROOT_PATH]
)
This command is used to find a library. A cache entry
named by <VAR> is created to store the result of this
command. If the library is found the result is stored
in the variable and the search will not be repeated
unless the variable is cleared. If nothing is found,
the result will be <VAR>-NOTFOUND, and the search will
be attempted again the next time find_library is
invoked with the same variable. The name of the
library that is searched for is specified by the names
listed after the NAMES argument. Additional search
locations can be specified after the PATHS argument.
If ENV var is found in the HINTS or PATHS section the
environment variable var will be read and converted
from a system environment variable to a cmake style
list of paths. For example ENV PATH would be a way to
list the system path variable. The argument after DOC
will be used for the documentation string in the cache.
PATH_SUFFIXES specifies additional subdirectories to
check below each search path.
If NO_DEFAULT_PATH is specified, then no additional
paths are added to the search. If NO_DEFAULT_PATH is
not specified, the search process is as follows:
1. Search paths specified in cmake-specific cache vari-
ables. These are intended to be used on the command
line with a -DVAR=value. This can be skipped if
NO_CMAKE_PATH is passed.
<prefix>/lib/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and
<prefix>/lib for each <prefix> in CMAKE_PREFIX_PATH
CMAKE_LIBRARY_PATH
cmake 2.8.6 Last change: June 17, 2014 37
User Commands cmake(1)
CMAKE_FRAMEWORK_PATH
2. Search paths specified in cmake-specific environment
variables. These are intended to be set in the user's
shell configuration. This can be skipped if
NO_CMAKE_ENVIRONMENT_PATH is passed.
<prefix>/lib/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and
<prefix>/lib for each <prefix> in CMAKE_PREFIX_PATH
CMAKE_LIBRARY_PATH
CMAKE_FRAMEWORK_PATH
3. Search the paths specified by the HINTS option.
These should be paths computed by system introspection,
such as a hint provided by the location of another item
already found. Hard-coded guesses should be specified
with the PATHS option.
4. Search the standard system environment variables.
This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an
argument.
PATH
LIB
5. Search cmake variables defined in the Platform files
for the current system. This can be skipped if
NO_CMAKE_SYSTEM_PATH is passed.
<prefix>/lib/<arch> if CMAKE_LIBRARY_ARCHITECTURE is set, and
<prefix>/lib for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH
CMAKE_SYSTEM_LIBRARY_PATH
CMAKE_SYSTEM_FRAMEWORK_PATH
6. Search the paths specified by the PATHS option or in
the short-hand version of the command. These are typi-
cally hard-coded guesses.
On Darwin or systems supporting OS X Frameworks, the
cmake variable CMAKE_FIND_FRAMEWORK can be set to
empty or one of the following:
"FIRST" - Try to find frameworks before standard
libraries or headers. This is the default on Darwin.
"LAST" - Try to find frameworks after standard
libraries or headers.
cmake 2.8.6 Last change: June 17, 2014 38
User Commands cmake(1)
"ONLY" - Only try to find frameworks.
"NEVER" - Never try to find frameworks.
On Darwin or systems supporting OS X Application Bun-
dles, the cmake variable CMAKE_FIND_APPBUNDLE can be
set to empty or one of the following:
"FIRST" - Try to find application bundles before standard
programs. This is the default on Darwin.
"LAST" - Try to find application bundles after standard
programs.
"ONLY" - Only try to find application bundles.
"NEVER" - Never try to find application bundles.
The CMake variable CMAKE_FIND_ROOT_PATH specifies one
or more directories to be prepended to all other search
directories. This effectively "re-roots" the entire
search under given locations. By default it is empty.
It is especially useful when cross-compiling to point
to the root directory of the target environment and
CMake will search there too. By default at first the
directories listed in CMAKE_FIND_ROOT_PATH and then the
non-rooted directories will be searched. The default
behavior can be adjusted by setting
CMAKE_FIND_ROOT_PATH_MODE_LIBRARY. This behavior can
be manually overridden on a per-call basis. By using
CMAKE_FIND_ROOT_PATH_BOTH the search order will be as
described above. If NO_CMAKE_FIND_ROOT_PATH is used
then CMAKE_FIND_ROOT_PATH will not be used. If
ONLY_CMAKE_FIND_ROOT_PATH is used then only the
re-rooted directories will be searched.
The default search order is designed to be most-spe-
cific to least-specific for common use cases. Projects
may override the order by simply calling the command
multiple times and using the NO_* options:
find_library(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
find_library(<VAR> NAMES name)
Once one of the calls succeeds the result variable will
be set and stored in the cache so that no call will
search again.
If the library found is a framework, then VAR will be
set to the full path to the framework <full-
Path>/A.framework. When a full path to a framework is
used as a library, CMake will use a -framework A, and a
cmake 2.8.6 Last change: June 17, 2014 39
User Commands cmake(1)
-F<fullPath> to link the framework to the target.
find_package
Load settings for an external project.
find_package(<package> [version] [EXACT] [QUIET]
[[REQUIRED|COMPONENTS] [components...]]
[NO_POLICY_SCOPE])
Finds and loads settings from an external project.
<package>_FOUND will be set to indicate whether the
package was found. When the package is found pack-
age-specific information is provided through variables
documented by the package itself. The QUIET option
disables messages if the package cannot be found. The
REQUIRED option stops processing with an error message
if the package cannot be found. A package-specific
list of components may be listed after the REQUIRED
option or after the COMPONENTS option if no REQUIRED
option is given. The [version] argument requests a
version with which the package found should be compati-
ble (format is major[.minor[.patch[.tweak]]]). The
EXACT option requests that the version be matched
exactly. If no [version] and/or component list is
given to a recursive invocation inside a find-module,
the corresponding arguments are forwarded automatically
from the outer call (including the EXACT flag for [ver-
sion]). Version support is currently provided only on
a package-by-package basis (details below).
User code should generally look for packages using the
above simple signature. The remainder of this command
documentation specifies the full command signature and
details of the search process. Project maintainers
wishing to provide a package to be found by this com-
mand are encouraged to read on.
The command has two modes by which it searches for
packages: "Module" mode and "Config" mode. Module mode
is available when the command is invoked with the above
reduced signature. CMake searches for a file called
"Find<package>.cmake" in the CMAKE_MODULE_PATH followed
by the CMake installation. If the file is found, it is
read and processed by CMake. It is responsible for
finding the package, checking the version, and produc-
ing any needed messages. Many find-modules provide
limited or no support for versioning; check the module
documentation. If no module is found the command pro-
ceeds to Config mode.
cmake 2.8.6 Last change: June 17, 2014 40
User Commands cmake(1)
The complete Config mode command signature is:
find_package(<package> [version] [EXACT] [QUIET]
[[REQUIRED|COMPONENTS] [components...]] [NO_MODULE]
[NO_POLICY_SCOPE]
[NAMES name1 [name2 ...]]
[CONFIGS config1 [config2 ...]]
[HINTS path1 [path2 ... ]]
[PATHS path1 [path2 ... ]]
[PATH_SUFFIXES suffix1 [suffix2 ...]]
[NO_DEFAULT_PATH]
[NO_CMAKE_ENVIRONMENT_PATH]
[NO_CMAKE_PATH]
[NO_SYSTEM_ENVIRONMENT_PATH]
[NO_CMAKE_PACKAGE_REGISTRY]
[NO_CMAKE_BUILDS_PATH]
[NO_CMAKE_SYSTEM_PATH]
[NO_CMAKE_SYSTEM_PACKAGE_REGISTRY]
[CMAKE_FIND_ROOT_PATH_BOTH |
ONLY_CMAKE_FIND_ROOT_PATH |
NO_CMAKE_FIND_ROOT_PATH])
The NO_MODULE option may be used to skip Module mode
explicitly. It is also implied by use of options not
specified in the reduced signature.
Config mode attempts to locate a configuration file
provided by the package to be found. A cache entry
called <package>_DIR is created to hold the directory
containing the file. By default the command searches
for a package with the name <package>. If the NAMES
option is given the names following it are used instead
of <package>. The command searches for a file called
"<name>Config.cmake" or "<lower-case-name>-con-
fig.cmake" for each name specified. A replacement set
of possible configuration file names may be given using
the CONFIGS option. The search procedure is specified
below. Once found, the configuration file is read and
processed by CMake. Since the file is provided by the
package it already knows the location of package con-
tents. The full path to the configuration file is
stored in the cmake variable <package>_CONFIG.
All configuration files which have been considered by
CMake while searching for an installation of the pack-
age with an appropriate version are stored in the cmake
variable <package>_CONSIDERED_CONFIGS, the associated
versions in <package>_CONSIDERED_VERSIONS.
cmake 2.8.6 Last change: June 17, 2014 41
User Commands cmake(1)
If the package configuration file cannot be found CMake
will generate an error describing the problem unless
the QUIET argument is specified. If REQUIRED is speci-
fied and the package is not found a fatal error is gen-
erated and the configure step stops executing. If
<package>_DIR has been set to a directory not contain-
ing a configuration file CMake will ignore it and
search from scratch.
When the [version] argument is given Config mode will
only find a version of the package that claims compati-
bility with the requested version (format is
major[.minor[.patch[.tweak]]]). If the EXACT option is
given only a version of the package claiming an exact
match of the requested version may be found. CMake
does not establish any convention for the meaning of
version numbers. Package version numbers are checked
by "version" files provided by the packages themselves.
For a candidate package configuration file "<con-
fig-file>.cmake" the corresponding version file is
located next to it and named either "<config-file>-ver-
sion.cmake" or "<config-file>Version.cmake". If no
such version file is available then the configuration
file is assumed to not be compatible with any requested
version. A basic version file containing generic ver-
sion matching code can be created using the macro
write_basic_config_version_file(), see its documenta-
tion for more details. When a version file is found it
is loaded to check the requested version number. The
version file is loaded in a nested scope in which the
following variables have been defined:
PACKAGE_FIND_NAME = the <package> name
PACKAGE_FIND_VERSION = full requested version string
PACKAGE_FIND_VERSION_MAJOR = major version if requested, else 0
PACKAGE_FIND_VERSION_MINOR = minor version if requested, else 0
PACKAGE_FIND_VERSION_PATCH = patch version if requested, else 0
PACKAGE_FIND_VERSION_TWEAK = tweak version if requested, else 0
PACKAGE_FIND_VERSION_COUNT = number of version components, 0 to 4
The version file checks whether it satisfies the
requested version and sets these variables:
PACKAGE_VERSION = full provided version string
PACKAGE_VERSION_EXACT = true if version is exact match
PACKAGE_VERSION_COMPATIBLE = true if version is compatible
PACKAGE_VERSION_UNSUITABLE = true if unsuitable as any version
These variables are checked by the find_package command
cmake 2.8.6 Last change: June 17, 2014 42
User Commands cmake(1)
to determine whether the configuration file provides an
acceptable version. They are not available after the
find_package call returns. If the version is accept-
able the following variables are set:
<package>_VERSION = full provided version string
<package>_VERSION_MAJOR = major version if provided, else 0
<package>_VERSION_MINOR = minor version if provided, else 0
<package>_VERSION_PATCH = patch version if provided, else 0
<package>_VERSION_TWEAK = tweak version if provided, else 0
<package>_VERSION_COUNT = number of version components, 0 to 4
and the corresponding package configuration file is
loaded. When multiple package configuration files are
available whose version files claim compatibility with
the version requested it is unspecified which one is
chosen. No attempt is made to choose a highest or
closest version number.
Config mode provides an elaborate interface and search
procedure. Much of the interface is provided for com-
pleteness and for use internally by find-modules loaded
by Module mode. Most user code should simply call
find_package(<package> [major[.minor]] [EXACT] [REQUIRED|QUIET])
in order to find a package. Package maintainers pro-
viding CMake package configuration files are encouraged
to name and install them such that the procedure out-
lined below will find them without requiring use of
additional options.
CMake constructs a set of possible installation pre-
fixes for the package. Under each prefix several
directories are searched for a configuration file. The
tables below show the directories searched. Each entry
is meant for installation trees following Windows (W),
UNIX (U), or Apple (A) conventions.
<prefix>/ (W)
<prefix>/(cmake|CMake)/ (W)
<prefix>/<name>*/ (W)
<prefix>/<name>*/(cmake|CMake)/ (W)
<prefix>/(lib/<arch>|lib|share)/cmake/<name>*/ (U)
<prefix>/(lib/<arch>|lib|share)/<name>*/ (U)
<prefix>/(lib/<arch>|lib|share)/<name>*/(cmake|CMake)/ (U)
cmake 2.8.6 Last change: June 17, 2014 43
User Commands cmake(1)
On systems supporting OS X Frameworks and Application
Bundles the following directories are searched for
frameworks or bundles containing a configuration file:
<prefix>/<name>.framework/Resources/ (A)
<prefix>/<name>.framework/Resources/CMake/ (A)
<prefix>/<name>.framework/Versions/*/Resources/ (A)
<prefix>/<name>.framework/Versions/*/Resources/CMake/ (A)
<prefix>/<name>.app/Contents/Resources/ (A)
<prefix>/<name>.app/Contents/Resources/CMake/ (A)
In all cases the <name> is treated as case-insensitive
and corresponds to any of the names specified (<pack-
age> or names given by NAMES). Paths with lib/<arch>
are enabled if CMAKE_LIBRARY_ARCHITECTURE is set. If
PATH_SUFFIXES is specified the suffixes are appended to
each (W) or (U) directory entry one-by-one.
This set of directories is intended to work in coopera-
tion with projects that provide configuration files in
their installation trees. Directories above marked
with (W) are intended for installations on Windows
where the prefix may point at the top of an applica-
tion's installation directory. Those marked with (U)
are intended for installations on UNIX platforms where
the prefix is shared by multiple packages. This is
merely a convention, so all (W) and (U) directories are
still searched on all platforms. Directories marked
with (A) are intended for installations on Apple plat-
forms. The cmake variables CMAKE_FIND_FRAMEWORK and
CMAKE_FIND_APPBUNDLE determine the order of preference
as specified below.
The set of installation prefixes is constructed using
the following steps. If NO_DEFAULT_PATH is specified
all NO_* options are enabled.
1. Search paths specified in cmake-specific cache vari-
ables. These are intended to be used on the command
line with a -DVAR=value. This can be skipped if
NO_CMAKE_PATH is passed.
CMAKE_PREFIX_PATH
CMAKE_FRAMEWORK_PATH
CMAKE_APPBUNDLE_PATH
2. Search paths specified in cmake-specific environment
cmake 2.8.6 Last change: June 17, 2014 44
User Commands cmake(1)
variables. These are intended to be set in the user's
shell configuration. This can be skipped if
NO_CMAKE_ENVIRONMENT_PATH is passed.
<package>_DIR
CMAKE_PREFIX_PATH
CMAKE_FRAMEWORK_PATH
CMAKE_APPBUNDLE_PATH
3. Search paths specified by the HINTS option. These
should be paths computed by system introspection, such
as a hint provided by the location of another item
already found. Hard-coded guesses should be specified
with the PATHS option.
4. Search the standard system environment variables.
This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is
passed. Path entries ending in "/bin" or "/sbin" are
automatically converted to their parent directories.
PATH
5. Search project build trees recently configured in a
CMake GUI. This can be skipped if NO_CMAKE_BUILDS_PATH
is passed. It is intended for the case when a user is
building multiple dependent projects one after another.
6. Search paths stored in the CMake user package reg-
istry. This can be skipped if NO_CMAKE_PACKAGE_REG-
ISTRY is passed. On Windows a <package> may appear
under registry key
HKEY_CURRENT_USER\Software\Kitware\CMake\Packages\<package>
as a REG_SZ value, with arbitrary name, that specifies
the directory containing the package configuration
file. On UNIX platforms a <package> may appear under
the directory
~/.cmake/packages/<package>
as a file, with arbitrary name, whose content specifies
the directory containing the package configuration
file. See the export(PACKAGE) command to create user
package registry entries for project build trees.
cmake 2.8.6 Last change: June 17, 2014 45
User Commands cmake(1)
7. Search cmake variables defined in the Platform files
for the current system. This can be skipped if
NO_CMAKE_SYSTEM_PATH is passed.
CMAKE_SYSTEM_PREFIX_PATH
CMAKE_SYSTEM_FRAMEWORK_PATH
CMAKE_SYSTEM_APPBUNDLE_PATH
8. Search paths stored in the CMake system package reg-
istry. This can be skipped if NO_CMAKE_SYSTEM_PACK-
AGE_REGISTRY is passed. On Windows a <package> may
appear under registry key
HKEY_LOCAL_MACHINE\Software\Kitware\CMake\Packages\<package>
as a REG_SZ value, with arbitrary name, that specifies
the directory containing the package configuration
file. There is no system package registry on non-Win-
dows platforms.
9. Search paths specified by the PATHS option. These
are typically hard-coded guesses.
On Darwin or systems supporting OS X Frameworks, the
cmake variable CMAKE_FIND_FRAMEWORK can be set to
empty or one of the following:
"FIRST" - Try to find frameworks before standard
libraries or headers. This is the default on Darwin.
"LAST" - Try to find frameworks after standard
libraries or headers.
"ONLY" - Only try to find frameworks.
"NEVER" - Never try to find frameworks.
On Darwin or systems supporting OS X Application Bun-
dles, the cmake variable CMAKE_FIND_APPBUNDLE can be
set to empty or one of the following:
"FIRST" - Try to find application bundles before standard
programs. This is the default on Darwin.
"LAST" - Try to find application bundles after standard
programs.
"ONLY" - Only try to find application bundles.
"NEVER" - Never try to find application bundles.
The CMake variable CMAKE_FIND_ROOT_PATH specifies one
cmake 2.8.6 Last change: June 17, 2014 46
User Commands cmake(1)
or more directories to be prepended to all other search
directories. This effectively "re-roots" the entire
search under given locations. By default it is empty.
It is especially useful when cross-compiling to point
to the root directory of the target environment and
CMake will search there too. By default at first the
directories listed in CMAKE_FIND_ROOT_PATH and then the
non-rooted directories will be searched. The default
behavior can be adjusted by setting
CMAKE_FIND_ROOT_PATH_MODE_PACKAGE. This behavior can
be manually overridden on a per-call basis. By using
CMAKE_FIND_ROOT_PATH_BOTH the search order will be as
described above. If NO_CMAKE_FIND_ROOT_PATH is used
then CMAKE_FIND_ROOT_PATH will not be used. If
ONLY_CMAKE_FIND_ROOT_PATH is used then only the
re-rooted directories will be searched.
The default search order is designed to be most-spe-
cific to least-specific for common use cases. Projects
may override the order by simply calling the command
multiple times and using the NO_* options:
find_package(<package> PATHS paths... NO_DEFAULT_PATH)
find_package(<package>)
Once one of the calls succeeds the result variable will
be set and stored in the cache so that no call will
search again.
Every non-REQUIRED find_package() call can be disabled
by setting the variable CMAKE_DISABLE_FIND_PACK-
AGE_<package> to TRUE. See the documentation for the
CMAKE_DISABLE_FIND_PACKAGE_<package> variable for more
information.
See the cmake_policy() command documentation for dis-
cussion of the NO_POLICY_SCOPE option.
find_path
Find the directory containing a file.
find_path(<VAR> name1 [path1 path2 ...])
This is the short-hand signature for the command that
is sufficient in many cases. It is the same as
find_path(<VAR> name1 [PATHS path1 path2 ...])
cmake 2.8.6 Last change: June 17, 2014 47
User Commands cmake(1)
find_path(
<VAR>
name | NAMES name1 [name2 ...]
[HINTS path1 [path2 ... ENV var]]
[PATHS path1 [path2 ... ENV var]]
[PATH_SUFFIXES suffix1 [suffix2 ...]]
[DOC "cache documentation string"]
[NO_DEFAULT_PATH]
[NO_CMAKE_ENVIRONMENT_PATH]
[NO_CMAKE_PATH]
[NO_SYSTEM_ENVIRONMENT_PATH]
[NO_CMAKE_SYSTEM_PATH]
[CMAKE_FIND_ROOT_PATH_BOTH |
ONLY_CMAKE_FIND_ROOT_PATH |
NO_CMAKE_FIND_ROOT_PATH]
)
This command is used to find a directory containing the
named file. A cache entry named by <VAR> is created to
store the result of this command. If the file in a
directory is found the result is stored in the variable
and the search will not be repeated unless the variable
is cleared. If nothing is found, the result will be
<VAR>-NOTFOUND, and the search will be attempted again
the next time find_path is invoked with the same vari-
able. The name of the file in a directory that is
searched for is specified by the names listed after the
NAMES argument. Additional search locations can be
specified after the PATHS argument. If ENV var is
found in the HINTS or PATHS section the environment
variable var will be read and converted from a system
environment variable to a cmake style list of paths.
For example ENV PATH would be a way to list the system
path variable. The argument after DOC will be used for
the documentation string in the cache. PATH_SUFFIXES
specifies additional subdirectories to check below each
search path.
If NO_DEFAULT_PATH is specified, then no additional
paths are added to the search. If NO_DEFAULT_PATH is
not specified, the search process is as follows:
1. Search paths specified in cmake-specific cache vari-
ables. These are intended to be used on the command
line with a -DVAR=value. This can be skipped if
NO_CMAKE_PATH is passed.
<prefix>/include for each <prefix> in CMAKE_PREFIX_PATH
CMAKE_INCLUDE_PATH
cmake 2.8.6 Last change: June 17, 2014 48
User Commands cmake(1)
CMAKE_FRAMEWORK_PATH
2. Search paths specified in cmake-specific environment
variables. These are intended to be set in the user's
shell configuration. This can be skipped if
NO_CMAKE_ENVIRONMENT_PATH is passed.
<prefix>/include for each <prefix> in CMAKE_PREFIX_PATH
CMAKE_INCLUDE_PATH
CMAKE_FRAMEWORK_PATH
3. Search the paths specified by the HINTS option.
These should be paths computed by system introspection,
such as a hint provided by the location of another item
already found. Hard-coded guesses should be specified
with the PATHS option.
4. Search the standard system environment variables.
This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an
argument.
PATH
INCLUDE
5. Search cmake variables defined in the Platform files
for the current system. This can be skipped if
NO_CMAKE_SYSTEM_PATH is passed.
<prefix>/include for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH
CMAKE_SYSTEM_INCLUDE_PATH
CMAKE_SYSTEM_FRAMEWORK_PATH
6. Search the paths specified by the PATHS option or in
the short-hand version of the command. These are typi-
cally hard-coded guesses.
On Darwin or systems supporting OS X Frameworks, the
cmake variable CMAKE_FIND_FRAMEWORK can be set to
empty or one of the following:
"FIRST" - Try to find frameworks before standard
libraries or headers. This is the default on Darwin.
"LAST" - Try to find frameworks after standard
libraries or headers.
"ONLY" - Only try to find frameworks.
"NEVER" - Never try to find frameworks.
cmake 2.8.6 Last change: June 17, 2014 49
User Commands cmake(1)
On Darwin or systems supporting OS X Application Bun-
dles, the cmake variable CMAKE_FIND_APPBUNDLE can be
set to empty or one of the following:
"FIRST" - Try to find application bundles before standard
programs. This is the default on Darwin.
"LAST" - Try to find application bundles after standard
programs.
"ONLY" - Only try to find application bundles.
"NEVER" - Never try to find application bundles.
The CMake variable CMAKE_FIND_ROOT_PATH specifies one
or more directories to be prepended to all other search
directories. This effectively "re-roots" the entire
search under given locations. By default it is empty.
It is especially useful when cross-compiling to point
to the root directory of the target environment and
CMake will search there too. By default at first the
directories listed in CMAKE_FIND_ROOT_PATH and then the
non-rooted directories will be searched. The default
behavior can be adjusted by setting
CMAKE_FIND_ROOT_PATH_MODE_INCLUDE. This behavior can
be manually overridden on a per-call basis. By using
CMAKE_FIND_ROOT_PATH_BOTH the search order will be as
described above. If NO_CMAKE_FIND_ROOT_PATH is used
then CMAKE_FIND_ROOT_PATH will not be used. If
ONLY_CMAKE_FIND_ROOT_PATH is used then only the
re-rooted directories will be searched.
The default search order is designed to be most-spe-
cific to least-specific for common use cases. Projects
may override the order by simply calling the command
multiple times and using the NO_* options:
find_path(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
find_path(<VAR> NAMES name)
Once one of the calls succeeds the result variable will
be set and stored in the cache so that no call will
search again.
When searching for frameworks, if the file is specified
as A/b.h, then the framework search will look for
A.framework/Headers/b.h. If that is found the path will
be set to the path to the framework. CMake will convert
this to the correct -F option to include the file.
cmake 2.8.6 Last change: June 17, 2014 50
User Commands cmake(1)
find_program
Find an executable program.
find_program(<VAR> name1 [path1 path2 ...])
This is the short-hand signature for the command that
is sufficient in many cases. It is the same as
find_program(<VAR> name1 [PATHS path1 path2 ...])
find_program(
<VAR>
name | NAMES name1 [name2 ...]
[HINTS path1 [path2 ... ENV var]]
[PATHS path1 [path2 ... ENV var]]
[PATH_SUFFIXES suffix1 [suffix2 ...]]
[DOC "cache documentation string"]
[NO_DEFAULT_PATH]
[NO_CMAKE_ENVIRONMENT_PATH]
[NO_CMAKE_PATH]
[NO_SYSTEM_ENVIRONMENT_PATH]
[NO_CMAKE_SYSTEM_PATH]
[CMAKE_FIND_ROOT_PATH_BOTH |
ONLY_CMAKE_FIND_ROOT_PATH |
NO_CMAKE_FIND_ROOT_PATH]
)
This command is used to find a program. A cache entry
named by <VAR> is created to store the result of this
command. If the program is found the result is stored
in the variable and the search will not be repeated
unless the variable is cleared. If nothing is found,
the result will be <VAR>-NOTFOUND, and the search will
be attempted again the next time find_program is
invoked with the same variable. The name of the pro-
gram that is searched for is specified by the names
listed after the NAMES argument. Additional search
locations can be specified after the PATHS argument.
If ENV var is found in the HINTS or PATHS section the
environment variable var will be read and converted
from a system environment variable to a cmake style
list of paths. For example ENV PATH would be a way to
list the system path variable. The argument after DOC
will be used for the documentation string in the cache.
PATH_SUFFIXES specifies additional subdirectories to
check below each search path.
If NO_DEFAULT_PATH is specified, then no additional
paths are added to the search. If NO_DEFAULT_PATH is
not specified, the search process is as follows:
cmake 2.8.6 Last change: June 17, 2014 51
User Commands cmake(1)
1. Search paths specified in cmake-specific cache vari-
ables. These are intended to be used on the command
line with a -DVAR=value. This can be skipped if
NO_CMAKE_PATH is passed.
<prefix>/[s]bin for each <prefix> in CMAKE_PREFIX_PATH
CMAKE_PROGRAM_PATH
CMAKE_APPBUNDLE_PATH
2. Search paths specified in cmake-specific environment
variables. These are intended to be set in the user's
shell configuration. This can be skipped if
NO_CMAKE_ENVIRONMENT_PATH is passed.
<prefix>/[s]bin for each <prefix> in CMAKE_PREFIX_PATH
CMAKE_PROGRAM_PATH
CMAKE_APPBUNDLE_PATH
3. Search the paths specified by the HINTS option.
These should be paths computed by system introspection,
such as a hint provided by the location of another item
already found. Hard-coded guesses should be specified
with the PATHS option.
4. Search the standard system environment variables.
This can be skipped if NO_SYSTEM_ENVIRONMENT_PATH is an
argument.
PATH
5. Search cmake variables defined in the Platform files
for the current system. This can be skipped if
NO_CMAKE_SYSTEM_PATH is passed.
<prefix>/[s]bin for each <prefix> in CMAKE_SYSTEM_PREFIX_PATH
CMAKE_SYSTEM_PROGRAM_PATH
CMAKE_SYSTEM_APPBUNDLE_PATH
6. Search the paths specified by the PATHS option or in
the short-hand version of the command. These are typi-
cally hard-coded guesses.
On Darwin or systems supporting OS X Frameworks, the
cmake variable CMAKE_FIND_FRAMEWORK can be set to
empty or one of the following:
cmake 2.8.6 Last change: June 17, 2014 52
User Commands cmake(1)
"FIRST" - Try to find frameworks before standard
libraries or headers. This is the default on Darwin.
"LAST" - Try to find frameworks after standard
libraries or headers.
"ONLY" - Only try to find frameworks.
"NEVER" - Never try to find frameworks.
On Darwin or systems supporting OS X Application Bun-
dles, the cmake variable CMAKE_FIND_APPBUNDLE can be
set to empty or one of the following:
"FIRST" - Try to find application bundles before standard
programs. This is the default on Darwin.
"LAST" - Try to find application bundles after standard
programs.
"ONLY" - Only try to find application bundles.
"NEVER" - Never try to find application bundles.
The CMake variable CMAKE_FIND_ROOT_PATH specifies one
or more directories to be prepended to all other search
directories. This effectively "re-roots" the entire
search under given locations. By default it is empty.
It is especially useful when cross-compiling to point
to the root directory of the target environment and
CMake will search there too. By default at first the
directories listed in CMAKE_FIND_ROOT_PATH and then the
non-rooted directories will be searched. The default
behavior can be adjusted by setting
CMAKE_FIND_ROOT_PATH_MODE_PROGRAM. This behavior can
be manually overridden on a per-call basis. By using
CMAKE_FIND_ROOT_PATH_BOTH the search order will be as
described above. If NO_CMAKE_FIND_ROOT_PATH is used
then CMAKE_FIND_ROOT_PATH will not be used. If
ONLY_CMAKE_FIND_ROOT_PATH is used then only the
re-rooted directories will be searched.
The default search order is designed to be most-spe-
cific to least-specific for common use cases. Projects
may override the order by simply calling the command
multiple times and using the NO_* options:
find_program(<VAR> NAMES name PATHS paths... NO_DEFAULT_PATH)
find_program(<VAR> NAMES name)
Once one of the calls succeeds the result variable will
be set and stored in the cache so that no call will
search again.
cmake 2.8.6 Last change: June 17, 2014 53
User Commands cmake(1)
fltk_wrap_ui
Create FLTK user interfaces Wrappers.
fltk_wrap_ui(resultingLibraryName source1
source2 ... sourceN )
Produce .h and .cxx files for all the .fl and .fld
files listed. The resulting .h and .cxx files will be
added to a variable named resultingLibrary-
Name_FLTK_UI_SRCS which should be added to your
library.
foreach
Evaluate a group of commands for each value in a list.
foreach(loop_var arg1 arg2 ...)
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
endforeach(loop_var)
All commands between foreach and the matching endfore-
ach are recorded without being invoked. Once the end-
foreach is evaluated, the recorded list of commands is
invoked once for each argument listed in the original
foreach command. Before each iteration of the loop
"${loop_var}" will be set as a variable with the cur-
rent value in the list.
foreach(loop_var RANGE total)
foreach(loop_var RANGE start stop [step])
Foreach can also iterate over a generated range of num-
bers. There are three types of this iteration:
* When specifying single number, the range will have
elements 0 to "total".
* When specifying two numbers, the range will have ele-
ments from the first number to the second number.
* The third optional number is the increment used to
iterate from the first number to the second number.
foreach(loop_var IN [LISTS [list1 [...]]]
[ITEMS [item1 [...]]])
cmake 2.8.6 Last change: June 17, 2014 54
User Commands cmake(1)
Iterates over a precise list of items. The LISTS
option names list-valued variables to be traversed,
including empty elements (an empty string is a
zero-length list). The ITEMS option ends argument
parsing and includes all arguments following it in the
iteration.
function
Start recording a function for later invocation as a
command.
function(<name> [arg1 [arg2 [arg3 ...]]])
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
endfunction(<name>)
Define a function named <name> that takes arguments
named arg1 arg2 arg3 (...). Commands listed after
function, but before the matching endfunction, are not
invoked until the function is invoked. When it is
invoked, the commands recorded in the function are
first modified by replacing formal parameters (${arg1})
with the arguments passed, and then invoked as normal
commands. In addition to referencing the formal parame-
ters you can reference the variable ARGC which will be
set to the number of arguments passed into the function
as well as ARGV0 ARGV1 ARGV2 ... which will have the
actual values of the arguments passed in. This facili-
tates creating functions with optional arguments. Addi-
tionally ARGV holds the list of all arguments given to
the function and ARGN holds the list of argument past
the last expected argument.
See the cmake_policy() command documentation for the
behavior of policies inside functions.
get_cmake_property
Get a property of the CMake instance.
get_cmake_property(VAR property)
Get a property from the CMake instance. The value of
the property is stored in the variable VAR. If the
property is not found, VAR will be set to "NOTFOUND".
Some supported properties include: VARIABLES,
CACHE_VARIABLES, COMMANDS, MACROS, and COMPONENTS.
cmake 2.8.6 Last change: June 17, 2014 55
User Commands cmake(1)
See also the more general get_property() command.
get_directory_property
Get a property of DIRECTORY scope.
get_directory_property(<variable> [DIRECTORY <dir>] <prop-name>)
Store a property of directory scope in the named vari-
able. If the property is not defined the empty-string
is returned. The DIRECTORY argument specifies another
directory from which to retrieve the property value.
The specified directory must have already been tra-
versed by CMake.
get_directory_property(<variable> [DIRECTORY <dir>]
DEFINITION <var-name>)
Get a variable definition from a directory. This form
is useful to get a variable definition from another
directory.
See also the more general get_property() command.
get_filename_component
Get a specific component of a full filename.
get_filename_component(<VAR> FileName
PATH|ABSOLUTE|NAME|EXT|NAME_WE|REALPATH
[CACHE])
Set <VAR> to be the path (PATH), file name (NAME), file
extension (EXT), file name without extension (NAME_WE)
of FileName, the full path (ABSOLUTE), or the full path
with all symlinks resolved (REALPATH). Note that the
path is converted to Unix slashes format and has no
trailing slashes. The longest file extension is always
considered. If the optional CACHE argument is speci-
fied, the result variable is added to the cache.
get_filename_component(<VAR> FileName
PROGRAM [PROGRAM_ARGS <ARG_VAR>]
[CACHE])
The program in FileName will be found in the system
search path or left as a full path. If PROGRAM_ARGS is
present with PROGRAM, then any command-line arguments
present in the FileName string are split from the
cmake 2.8.6 Last change: June 17, 2014 56
User Commands cmake(1)
program name and stored in <ARG_VAR>. This is used to
separate a program name from its arguments in a command
line string.
get_property
Get a property.
get_property(<variable>
<GLOBAL |
DIRECTORY [dir] |
TARGET <target> |
SOURCE <source> |
TEST <test> |
CACHE <entry> |
VARIABLE>
PROPERTY <name>
[SET | DEFINED | BRIEF_DOCS | FULL_DOCS])
Get one property from one object in a scope. The first
argument specifies the variable in which to store the
result. The second argument determines the scope from
which to get the property. It must be one of the fol-
lowing:
GLOBAL scope is unique and does not accept a name.
DIRECTORY scope defaults to the current directory but
another directory (already processed by CMake) may be
named by full or relative path.
TARGET scope must name one existing target.
SOURCE scope must name one source file.
TEST scope must name one existing test.
CACHE scope must name one cache entry.
VARIABLE scope is unique and does not accept a name.
The required PROPERTY option is immediately followed by
the name of the property to get. If the property is
not set an empty value is returned. If the SET option
cmake 2.8.6 Last change: June 17, 2014 57
User Commands cmake(1)
is given the variable is set to a boolean value indi-
cating whether the property has been set. If the
DEFINED option is given the variable is set to a
boolean value indicating whether the property has been
defined such as with define_property. If BRIEF_DOCS or
FULL_DOCS is given then the variable is set to a string
containing documentation for the requested property.
If documentation is requested for a property that has
not been defined NOTFOUND is returned.
get_source_file_property
Get a property for a source file.
get_source_file_property(VAR file property)
Get a property from a source file. The value of the
property is stored in the variable VAR. If the prop-
erty is not found, VAR will be set to "NOTFOUND". Use
set_source_files_properties to set property values.
Source file properties usually control how the file is
built. One property that is always there is LOCATION
See also the more general get_property() command.
get_target_property
Get a property from a target.
get_target_property(VAR target property)
Get a property from a target. The value of the prop-
erty is stored in the variable VAR. If the property is
not found, VAR will be set to "NOTFOUND". Use set_tar-
get_properties to set property values. Properties are
usually used to control how a target is built, but some
query the target instead. This command can get proper-
ties for any target so far created. The targets do not
need to be in the current CMakeLists.txt file.
See also the more general get_property() command.
get_test_property
Get a property of the test.
get_test_property(test property VAR)
Get a property from the Test. The value of the prop-
erty is stored in the variable VAR. If the property is
cmake 2.8.6 Last change: June 17, 2014 58
User Commands cmake(1)
not found, VAR will be set to "NOTFOUND". For a list of
standard properties you can type cmake --help-prop-
erty-list
See also the more general get_property() command.
if Conditionally execute a group of commands.
if(expression)
# then section.
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
elseif(expression2)
# elseif section.
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
else(expression)
# else section.
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
endif(expression)
Evaluates the given expression. If the result is true,
the commands in the THEN section are invoked. Other-
wise, the commands in the else section are invoked.
The elseif and else sections are optional. You may have
multiple elseif clauses. Note that the expression in
the else and endif clause is optional. Long expressions
can be used and there is a traditional order of prece-
dence. Parenthetical expressions are evaluated first
followed by unary operators such as EXISTS, COMMAND,
and DEFINED. Then any EQUAL, LESS, GREATER, STRLESS,
STRGREATER, STREQUAL, MATCHES will be evaluated. Then
NOT operators and finally AND, OR operators will be
evaluated. Possible expressions are:
if(<constant>)
True if the constant is 1, ON, YES, TRUE, Y, or a
non-zero number. False if the constant is 0, OFF, NO,
FALSE, N, IGNORE, "", or ends in the suffix '-NOT-
FOUND'. Named boolean constants are case-insensitive.
If the argument is not one of these constants, it is
treated as a variable:
cmake 2.8.6 Last change: June 17, 2014 59
User Commands cmake(1)
if(<variable>)
True if the variable is defined to a value that is not
a false constant. False otherwise.
if(NOT <expression>)
True if the expression is not true.
if(<expr1> AND <expr2>)
True if both expressions would be considered true indi-
vidually.
if(<expr1> OR <expr2>)
True if either expression would be considered true
individually.
if(COMMAND command-name)
True if the given name is a command, macro or function
that can be invoked.
if(POLICY policy-id)
True if the given name is an existing policy (of the
form CMP<NNNN>).
if(TARGET target-name)
True if the given name is an existing target, built or
imported.
if(EXISTS file-name)
if(EXISTS directory-name)
True if the named file or directory exists. Behavior
is well-defined only for full paths.
if(file1 IS_NEWER_THAN file2)
True if file1 is newer than file2 or if one of the two
files doesn't exist. Behavior is well-defined only for
cmake 2.8.6 Last change: June 17, 2014 60
User Commands cmake(1)
full paths.
if(IS_DIRECTORY directory-name)
True if the given name is a directory. Behavior is
well-defined only for full paths.
if(IS_SYMLINK file-name)
True if the given name is a symbolic link. Behavior is
well-defined only for full paths.
if(IS_ABSOLUTE path)
True if the given path is an absolute path.
if(<variable|string> MATCHES regex)
True if the given string or variable's value matches
the given regular expression.
if(<variable|string> LESS <variable|string>)
if(<variable|string> GREATER <variable|string>)
if(<variable|string> EQUAL <variable|string>)
True if the given string or variable's value is a valid
number and the inequality or equality is true.
if(<variable|string> STRLESS <variable|string>)
if(<variable|string> STRGREATER <variable|string>)
if(<variable|string> STREQUAL <variable|string>)
True if the given string or variable's value is lexico-
graphically less (or greater, or equal) than the string
or variable on the right.
if(<variable|string> VERSION_LESS <variable|string>)
if(<variable|string> VERSION_EQUAL <variable|string>)
if(<variable|string> VERSION_GREATER <variable|string>)
Component-wise integer version number comparison (ver-
sion format is major[.minor[.patch[.tweak]]]).
if(DEFINED <variable>)
cmake 2.8.6 Last change: June 17, 2014 61
User Commands cmake(1)
True if the given variable is defined. It does not mat-
ter if the variable is true or false just if it has
been set.
if((expression) AND (expression OR (expression)))
The expressions inside the parenthesis are evaluated
first and then the remaining expression is evaluated as
in the previous examples. Where there are nested paren-
thesis the innermost are evaluated as part of evaluat-
ing the expression that contains them.
The if command was written very early in CMake's his-
tory, predating the ${} variable evaluation syntax, and
for convenience evaluates variables named by its argu-
ments as shown in the above signatures. Note that nor-
mal variable evaluation with ${} applies before the if
command even receives the arguments. Therefore code
like
set(var1 OFF)
set(var2 "var1")
if(${var2})
appears to the if command as
if(var1)
and is evaluated according to the if(<variable>) case
documented above. The result is OFF which is false.
However, if we remove the ${} from the example then the
command sees
if(var2)
which is true because var2 is defined to "var1" which
is not a false constant.
Automatic evaluation applies in the other cases when-
ever the above-documented signature accepts <vari-
able|string>:
1) The left hand argument to MATCHES is first checked
to see if it is a defined variable, if so the vari-
able's value is used, otherwise the original value is
cmake 2.8.6 Last change: June 17, 2014 62
User Commands cmake(1)
used.
2) If the left hand argument to MATCHES is missing it
returns false without error
3) Both left and right hand arguments to LESS GREATER
EQUAL are independently tested to see if they are
defined variables, if so their defined values are used
otherwise the original value is used.
4) Both left and right hand arguments to STRLESS STRE-
QUAL STRGREATER are independently tested to see if they
are defined variables, if so their defined values are
used otherwise the original value is used.
5) Both left and right hand argumemnts to VERSION_LESS
VERSION_EQUAL VERSION_GREATER are independently tested
to see if they are defined variables, if so their
defined values are used otherwise the original value is
used.
6) The right hand argument to NOT is tested to see if
it is a boolean constant, if so the value is used, oth-
erwise it is assumed to be a variable and it is deref-
erenced.
7) The left and right hand arguments to AND OR are
independently tested to see if they are boolean con-
stants, if so they are used as such, otherwise they are
assumed to be variables and are dereferenced.
include
Read CMake listfile code from the given file.
include(<file|module> [OPTIONAL] [RESULT_VARIABLE <VAR>]
[NO_POLICY_SCOPE])
Reads CMake listfile code from the given file. Com-
mands in the file are processed immediately as if they
were written in place of the include command. If
OPTIONAL is present, then no error is raised if the
file does not exist. If RESULT_VARIABLE is given the
variable will be set to the full filename which has
been included or NOTFOUND if it failed.
cmake 2.8.6 Last change: June 17, 2014 63
User Commands cmake(1)
If a module is specified instead of a file, the file
with name <modulename>.cmake is searched first in
CMAKE_MODULE_PATH, then in the CMake module directory.
There is one exception to this: if the file which calls
include() is located itself in the CMake module direc-
tory, then first the CMake module directory is searched
and CMAKE_MODULE_PATH afterwards. See also policy
CMP0017.
See the cmake_policy() command documentation for dis-
cussion of the NO_POLICY_SCOPE option.
include_directories
Add include directories to the build.
include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)
Add the given directories to those searched by the com-
piler for include files. By default the directories are
appended onto the current list of directories. This
default behavior can be changed by setting
CMAKE_INCLUDE_DIRECTORIES_BEFORE to ON. By using BEFORE
or AFTER you can select between appending and prepend-
ing, independent from the default. If the SYSTEM option
is given the compiler will be told that the directories
are meant as system include directories on some plat-
forms.
include_external_msproject
Include an external Microsoft project file in a
workspace.
include_external_msproject(projectname location
dep1 dep2 ...)
Includes an external Microsoft project in the generated
workspace file. Currently does nothing on UNIX. This
will create a target named [projectname]. This can be
used in the add_dependencies command to make things
depend on the external project.
include_regular_expression
Set the regular expression used for dependency check-
ing.
include_regular_expression(regex_match [regex_complain])
Set the regular expressions used in dependency
cmake 2.8.6 Last change: June 17, 2014 64
User Commands cmake(1)
checking. Only files matching regex_match will be
traced as dependencies. Only files matching regex_com-
plain will generate warnings if they cannot be found
(standard header paths are not searched). The defaults
are:
regex_match = "^.*$" (match everything)
regex_complain = "^$" (match empty string only)
install
Specify rules to run at install time.
This command generates installation rules for a
project. Rules specified by calls to this command
within a source directory are executed in order during
installation. The order across directories is not
defined.
There are multiple signatures for this command. Some
of them define installation properties for files and
targets. Properties common to multiple signatures are
covered here but they are valid only for signatures
that specify them.
DESTINATION arguments specify the directory on disk to
which a file will be installed. If a full path (with a
leading slash or drive letter) is given it is used
directly. If a relative path is given it is inter-
preted relative to the value of CMAKE_INSTALL_PREFIX.
PERMISSIONS arguments specify permissions for installed
files. Valid permissions are OWNER_READ, OWNER_WRITE,
OWNER_EXECUTE, GROUP_READ, GROUP_WRITE, GROUP_EXECUTE,
WORLD_READ, WORLD_WRITE, WORLD_EXECUTE, SETUID, and
SETGID. Permissions that do not make sense on certain
platforms are ignored on those platforms.
The CONFIGURATIONS argument specifies a list of build
configurations for which the install rule applies
(Debug, Release, etc.).
The COMPONENT argument specifies an installation compo-
nent name with which the install rule is associated,
such as "runtime" or "development". During compo-
nent-specific installation only install rules
cmake 2.8.6 Last change: June 17, 2014 65
User Commands cmake(1)
associated with the given component name will be exe-
cuted. During a full installation all components are
installed.
The RENAME argument specifies a name for an installed
file that may be different from the original file.
Renaming is allowed only when a single file is
installed by the command.
The OPTIONAL argument specifies that it is not an error
if the file to be installed does not exist.
The TARGETS signature:
install(TARGETS targets... [EXPORT <export-name>]
[[ARCHIVE|LIBRARY|RUNTIME|FRAMEWORK|BUNDLE|
PRIVATE_HEADER|PUBLIC_HEADER|RESOURCE]
[DESTINATION <dir>]
[PERMISSIONS permissions...]
[CONFIGURATIONS [Debug|Release|...]]
[COMPONENT <component>]
[OPTIONAL] [NAMELINK_ONLY|NAMELINK_SKIP]
] [...])
The TARGETS form specifies rules for installing targets
from a project. There are five kinds of target files
that may be installed: ARCHIVE, LIBRARY, RUNTIME,
FRAMEWORK, and BUNDLE. Executables are treated as RUN-
TIME targets, except that those marked with the
MACOSX_BUNDLE property are treated as BUNDLE targets on
OS X. Static libraries are always treated as ARCHIVE
targets. Module libraries are always treated as LIBRARY
targets. For non-DLL platforms shared libraries are
treated as LIBRARY targets, except that those marked
with the FRAMEWORK property are treated as FRAMEWORK
targets on OS X. For DLL platforms the DLL part of a
shared library is treated as a RUNTIME target and the
corresponding import library is treated as an ARCHIVE
target. All Windows-based systems including Cygwin are
DLL platforms. The ARCHIVE, LIBRARY, RUNTIME, and
FRAMEWORK arguments change the type of target to which
the subsequent properties apply. If none is given the
installation properties apply to all target types. If
only one is given then only targets of that type will
be installed (which can be used to install just a DLL
or just an import library).
cmake 2.8.6 Last change: June 17, 2014 66
User Commands cmake(1)
The PRIVATE_HEADER, PUBLIC_HEADER, and RESOURCE argu-
ments cause subsequent properties to be applied to
installing a FRAMEWORK shared library target's associ-
ated files on non-Apple platforms. Rules defined by
these arguments are ignored on Apple platforms because
the associated files are installed into the appropriate
locations inside the framework folder. See documenta-
tion of the PRIVATE_HEADER, PUBLIC_HEADER, and RESOURCE
target properties for details.
Either NAMELINK_ONLY or NAMELINK_SKIP may be specified
as a LIBRARY option. On some platforms a versioned
shared library has a symbolic link such as
lib<name>.so -> lib<name>.so.1
where "lib<name>.so.1" is the soname of the library and
"lib<name>.so" is a "namelink" allowing linkers to find
the library when given "-l<name>". The NAMELINK_ONLY
option causes installation of only the namelink when a
library target is installed. The NAMELINK_SKIP option
causes installation of library files other than the
namelink when a library target is installed. When nei-
ther option is given both portions are installed. On
platforms where versioned shared libraries do not have
namelinks or when a library is not versioned the
NAMELINK_SKIP option installs the library and the
NAMELINK_ONLY option installs nothing. See the VERSION
and SOVERSION target properties for details on creating
versioned shared libraries.
One or more groups of properties may be specified in a
single call to the TARGETS form of this command. A
target may be installed more than once to different
locations. Consider hypothetical targets "myExe",
"mySharedLib", and "myStaticLib". The code
install(TARGETS myExe mySharedLib myStaticLib
RUNTIME DESTINATION bin
LIBRARY DESTINATION lib
ARCHIVE DESTINATION lib/static)
install(TARGETS mySharedLib DESTINATION /some/full/path)
will install myExe to <prefix>/bin and myStaticLib to
<prefix>/lib/static. On non-DLL platforms mySharedLib
will be installed to <prefix>/lib and /some/full/path.
On DLL platforms the mySharedLib DLL will be installed
to <prefix>/bin and /some/full/path and its import
cmake 2.8.6 Last change: June 17, 2014 67
User Commands cmake(1)
library will be installed to <prefix>/lib/static and
/some/full/path. On non-DLL platforms mySharedLib will
be installed to <prefix>/lib and /some/full/path.
The EXPORT option associates the installed target files
with an export called <export-name>. It must appear
before any RUNTIME, LIBRARY, or ARCHIVE options. To
actually install the export file itself, call
install(EXPORT). See documentation of the
install(EXPORT ...) signature below for details.
Installing a target with EXCLUDE_FROM_ALL set to true
has undefined behavior.
The FILES signature:
install(FILES files... DESTINATION <dir>
[PERMISSIONS permissions...]
[CONFIGURATIONS [Debug|Release|...]]
[COMPONENT <component>]
[RENAME <name>] [OPTIONAL])
The FILES form specifies rules for installing files for
a project. File names given as relative paths are
interpreted with respect to the current source direc-
tory. Files installed by this form are by default
given permissions OWNER_WRITE, OWNER_READ, GROUP_READ,
and WORLD_READ if no PERMISSIONS argument is given.
The PROGRAMS signature:
install(PROGRAMS files... DESTINATION <dir>
[PERMISSIONS permissions...]
[CONFIGURATIONS [Debug|Release|...]]
[COMPONENT <component>]
[RENAME <name>] [OPTIONAL])
The PROGRAMS form is identical to the FILES form except
that the default permissions for the installed file
also include OWNER_EXECUTE, GROUP_EXECUTE, and
WORLD_EXECUTE. This form is intended to install pro-
grams that are not targets, such as shell scripts. Use
the TARGETS form to install targets built within the
project.
cmake 2.8.6 Last change: June 17, 2014 68
User Commands cmake(1)
The DIRECTORY signature:
install(DIRECTORY dirs... DESTINATION <dir>
[FILE_PERMISSIONS permissions...]
[DIRECTORY_PERMISSIONS permissions...]
[USE_SOURCE_PERMISSIONS] [OPTIONAL]
[CONFIGURATIONS [Debug|Release|...]]
[COMPONENT <component>] [FILES_MATCHING]
[[PATTERN <pattern> | REGEX <regex>]
[EXCLUDE] [PERMISSIONS permissions...]] [...])
The DIRECTORY form installs contents of one or more
directories to a given destination. The directory
structure is copied verbatim to the destination. The
last component of each directory name is appended to
the destination directory but a trailing slash may be
used to avoid this because it leaves the last component
empty. Directory names given as relative paths are
interpreted with respect to the current source direc-
tory. If no input directory names are given the desti-
nation directory will be created but nothing will be
installed into it. The FILE_PERMISSIONS and DIREC-
TORY_PERMISSIONS options specify permissions given to
files and directories in the destination. If
USE_SOURCE_PERMISSIONS is specified and FILE_PERMIS-
SIONS is not, file permissions will be copied from the
source directory structure. If no permissions are
specified files will be given the default permissions
specified in the FILES form of the command, and the
directories will be given the default permissions spec-
ified in the PROGRAMS form of the command.
Installation of directories may be controlled with fine
granularity using the PATTERN or REGEX options. These
"match" options specify a globbing pattern or regular
expression to match directories or files encountered
within input directories. They may be used to apply
certain options (see below) to a subset of the files
and directories encountered. The full path to each
input file or directory (with forward slashes) is
matched against the expression. A PATTERN will match
only complete file names: the portion of the full path
matching the pattern must occur at the end of the file
name and be preceded by a slash. A REGEX will match
any portion of the full path but it may use '/' and '$'
to simulate the PATTERN behavior. By default all files
and directories are installed whether or not they are
matched. The FILES_MATCHING option may be given before
the first match option to disable installation of files
(but not directories) not matched by any expression.
cmake 2.8.6 Last change: June 17, 2014 69
User Commands cmake(1)
For example, the code
install(DIRECTORY src/ DESTINATION include/myproj
FILES_MATCHING PATTERN "*.h")
will extract and install header files from a source
tree.
Some options may follow a PATTERN or REGEX expression
and are applied only to files or directories matching
them. The EXCLUDE option will skip the matched file or
directory. The PERMISSIONS option overrides the per-
missions setting for the matched file or directory.
For example the code
install(DIRECTORY icons scripts/ DESTINATION share/myproj
PATTERN "CVS" EXCLUDE
PATTERN "scripts/*"
PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ
GROUP_EXECUTE GROUP_READ)
will install the icons directory to share/myproj/icons
and the scripts directory to share/myproj. The icons
will get default file permissions, the scripts will be
given specific permissions, and any CVS directories
will be excluded.
The SCRIPT and CODE signature:
install([[SCRIPT <file>] [CODE <code>]] [...])
The SCRIPT form will invoke the given CMake script
files during installation. If the script file name is
a relative path it will be interpreted with respect to
the current source directory. The CODE form will
invoke the given CMake code during installation. Code
is specified as a single argument inside a dou-
ble-quoted string. For example, the code
install(CODE "MESSAGE(\"Sample install message.\")")
will print a message during installation.
The EXPORT signature:
cmake 2.8.6 Last change: June 17, 2014 70
User Commands cmake(1)
install(EXPORT <export-name> DESTINATION <dir>
[NAMESPACE <namespace>] [FILE <name>.cmake]
[PERMISSIONS permissions...]
[CONFIGURATIONS [Debug|Release|...]]
[COMPONENT <component>])
The EXPORT form generates and installs a CMake file
containing code to import targets from the installation
tree into another project. Target installations are
associated with the export <export-name> using the
EXPORT option of the install(TARGETS ...) signature
documented above. The NAMESPACE option will prepend
<namespace> to the target names as they are written to
the import file. By default the generated file will be
called <export-name>.cmake but the FILE option may be
used to specify a different name. The value given to
the FILE option must be a file name with the ".cmake"
extension. If a CONFIGURATIONS option is given then
the file will only be installed when one of the named
configurations is installed. Additionally, the gener-
ated import file will reference only the matching tar-
get configurations. If a COMPONENT option is specified
that does not match that given to the targets associ-
ated with <export-name> the behavior is undefined. If
a library target is included in the export but a target
to which it links is not included the behavior is
unspecified.
The EXPORT form is useful to help outside projects use
targets built and installed by the current project.
For example, the code
install(TARGETS myexe EXPORT myproj DESTINATION bin)
install(EXPORT myproj NAMESPACE mp_ DESTINATION lib/myproj)
will install the executable myexe to <prefix>/bin and
code to import it in the file "<pre-
fix>/lib/myproj/myproj.cmake". An outside project may
load this file with the include command and reference
the myexe executable from the installation tree using
the imported target name mp_myexe as if the target were
built in its own tree.
NOTE: This command supercedes the INSTALL_TARGETS com-
mand and the target properties PRE_INSTALL_SCRIPT and
POST_INSTALL_SCRIPT. It also replaces the FILES forms
of the INSTALL_FILES and INSTALL_PROGRAMS commands.
The processing order of these install rules relative to
those generated by INSTALL_TARGETS, INSTALL_FILES, and
cmake 2.8.6 Last change: June 17, 2014 71
User Commands cmake(1)
INSTALL_PROGRAMS commands is not defined.
link_directories
Specify directories in which the linker will look for
libraries.
link_directories(directory1 directory2 ...)
Specify the paths in which the linker should search for
libraries. The command will apply only to targets cre-
ated after it is called. For historical reasons, rela-
tive paths given to this command are passed to the
linker unchanged (unlike many CMake commands which
interpret them relative to the current source direc-
tory).
list List operations.
list(LENGTH <list> <output variable>)
list(GET <list> <element index> [<element index> ...]
<output variable>)
list(APPEND <list> <element> [<element> ...])
list(FIND <list> <value> <output variable>)
list(INSERT <list> <element_index> <element> [<element> ...])
list(REMOVE_ITEM <list> <value> [<value> ...])
list(REMOVE_AT <list> <index> [<index> ...])
list(REMOVE_DUPLICATES <list>)
list(REVERSE <list>)
list(SORT <list>)
LENGTH will return a given list's length.
GET will return list of elements specified by indices
from the list.
APPEND will append elements to the list.
FIND will return the index of the element specified in
the list or -1 if it wasn't found.
INSERT will insert elements to the list to the speci-
fied location.
REMOVE_AT and REMOVE_ITEM will remove items from the
cmake 2.8.6 Last change: June 17, 2014 72
User Commands cmake(1)
list. The difference is that REMOVE_ITEM will remove
the given items, while REMOVE_AT will remove the items
at the given indices.
REMOVE_DUPLICATES will remove duplicated items in the
list.
REVERSE reverses the contents of the list in-place.
SORT sorts the list in-place alphabetically.
The list subcommands APPEND, INSERT, REMOVE_AT,
REMOVE_ITEM, REMOVE_DUPLICATES, REVERSE and SORT may
create new values for the list within the current CMake
variable scope. Similar to the SET command, the LIST
command creates new variable values in the current
scope, even if the list itself is actually defined in a
parent scope. To propagate the results of these opera-
tions upwards, use SET with PARENT_SCOPE, SET with
CACHE INTERNAL, or some other means of value propaga-
tion.
NOTES: A list in cmake is a ; separated group of
strings. To create a list the set command can be used.
For example, set(var a b c d e) creates a list with
a;b;c;d;e, and set(var "a b c d e") creates a string or
a list with one item in it.
When specifying index values, if <element index> is 0
or greater, it is indexed from the beginning of the
list, with 0 representing the first list element. If
<element index> is -1 or lesser, it is indexed from the
end of the list, with -1 representing the last list
element. Be careful when counting with negative
indices: they do not start from 0. -0 is equivalent to
0, the first list element.
load_cache
Load in the values from another project's CMake cache.
load_cache(pathToCacheFile READ_WITH_PREFIX
prefix entry1...)
Read the cache and store the requested entries in
cmake 2.8.6 Last change: June 17, 2014 73
User Commands cmake(1)
variables with their name prefixed with the given pre-
fix. This only reads the values, and does not create
entries in the local project's cache.
load_cache(pathToCacheFile [EXCLUDE entry1...]
[INCLUDE_INTERNALS entry1...])
Load in the values from another cache and store them in
the local project's cache as internal entries. This is
useful for a project that depends on another project
built in a different tree. EXCLUDE option can be used
to provide a list of entries to be excluded.
INCLUDE_INTERNALS can be used to provide a list of
internal entries to be included. Normally, no internal
entries are brought in. Use of this form of the com-
mand is strongly discouraged, but it is provided for
backward compatibility.
load_command
Load a command into a running CMake.
load_command(COMMAND_NAME <loc1> [loc2 ...])
The given locations are searched for a library whose
name is cmCOMMAND_NAME. If found, it is loaded as a
module and the command is added to the set of available
CMake commands. Usually, TRY_COMPILE is used before
this command to compile the module. If the command is
successfully loaded a variable named
CMAKE_LOADED_COMMAND_<COMMAND_NAME>
will be set to the full path of the module that was
loaded. Otherwise the variable will not be set.
macro
Start recording a macro for later invocation as a com-
mand.
macro(<name> [arg1 [arg2 [arg3 ...]]])
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
endmacro(<name>)
Define a macro named <name> that takes arguments named
arg1 arg2 arg3 (...). Commands listed after macro, but
before the matching endmacro, are not invoked until the
cmake 2.8.6 Last change: June 17, 2014 74
User Commands cmake(1)
macro is invoked. When it is invoked, the commands
recorded in the macro are first modified by replacing
formal parameters (${arg1}) with the arguments passed,
and then invoked as normal commands. In addition to
referencing the formal parameters you can reference the
values ${ARGC} which will be set to the number of argu-
ments passed into the function as well as ${ARGV0}
${ARGV1} ${ARGV2} ... which will have the actual values
of the arguments passed in. This facilitates creating
macros with optional arguments. Additionally ${ARGV}
holds the list of all arguments given to the macro and
${ARGN} holds the list of argument past the last
expected argument. Note that the parameters to a macro
and values such as ARGN are not variables in the usual
CMake sense. They are string replacements much like the
c preprocessor would do with a macro. If you want true
CMake variables you should look at the function com-
mand.
See the cmake_policy() command documentation for the
behavior of policies inside macros.
mark_as_advanced
Mark cmake cached variables as advanced.
mark_as_advanced([CLEAR|FORCE] VAR VAR2 VAR...)
Mark the named cached variables as advanced. An
advanced variable will not be displayed in any of the
cmake GUIs unless the show advanced option is on. If
CLEAR is the first argument advanced variables are
changed back to unadvanced. If FORCE is the first
argument, then the variable is made advanced. If nei-
ther FORCE nor CLEAR is specified, new values will be
marked as advanced, but if the variable already has an
advanced/non-advanced state, it will not be changed.
It does nothing in script mode.
math Mathematical expressions.
math(EXPR <output variable> <math expression>)
EXPR evaluates mathematical expression and return
result in the output variable. Example mathematical
expression is '5 * ( 10 + 13 )'. Supported operators
are + - * / % | & ^ ~ << >> * / %. They have the same
meaning as they do in c code.
cmake 2.8.6 Last change: June 17, 2014 75
User Commands cmake(1)
message
Display a message to the user.
message([STATUS|WARNING|AUTHOR_WARNING|FATAL_ERROR|SEND_ERROR]
"message to display" ...)
The optional keyword determines the type of message:
(none) = Important information
STATUS = Incidental information
WARNING = CMake Warning, continue processing
AUTHOR_WARNING = CMake Warning (dev), continue processing
SEND_ERROR = CMake Error, continue but skip generation
FATAL_ERROR = CMake Error, stop all processing
The CMake command-line tool displays STATUS messages on
stdout and all other message types on stderr. The
CMake GUI displays all messages in its log area. The
interactive dialogs (ccmake and CMakeSetup) show STATUS
messages one at a time on a status line and other mes-
sages in interactive pop-up boxes.
CMake Warning and Error message text displays using a
simple markup language. Non-indented text is formatted
in line-wrapped paragraphs delimited by newlines.
Indented text is considered pre-formatted.
option
Provides an option that the user can optionally select.
option(<option_variable> "help string describing option"
[initial value])
Provide an option for the user to select as ON or OFF.
If no initial value is provided, OFF is used.
If you have options that depend on the values of other
options, see the module help for CMakeDependentOption.
project
Set a name for the entire project.
project(<projectname> [languageName1 languageName2 ... ] )
Sets the name of the project. Additionally this sets
the variables <projectName>_BINARY_DIR and <project-
Name>_SOURCE_DIR to the respective values.
cmake 2.8.6 Last change: June 17, 2014 76
User Commands cmake(1)
Optionally you can specify which languages your project
supports. Example languages are CXX (i.e. C++), C,
Fortran, etc. By default C and CXX are enabled. E.g.
if you do not have a C++ compiler, you can disable the
check for it by explicitly listing the languages you
want to support, e.g. C. By using the special language
"NONE" all checks for any language can be disabled.
qt_wrap_cpp
Create Qt Wrappers.
qt_wrap_cpp(resultingLibraryName DestName
SourceLists ...)
Produce moc files for all the .h files listed in the
SourceLists. The moc files will be added to the
library using the DestName source list.
qt_wrap_ui
Create Qt user interfaces Wrappers.
qt_wrap_ui(resultingLibraryName HeadersDestName
SourcesDestName SourceLists ...)
Produce .h and .cxx files for all the .ui files listed
in the SourceLists. The .h files will be added to the
library using the HeadersDestNamesource list. The .cxx
files will be added to the library using the Sources-
DestNamesource list.
remove_definitions
Removes -D define flags added by add_definitions.
remove_definitions(-DFOO -DBAR ...)
Removes flags (added by add_definitions) from the com-
piler command line for sources in the current directory
and below.
return
Return from a file, directory or function.
return()
Returns from a file, directory or function. When this
command is encountered in an included file (via
include() or find_package()), it causes processing of
the current file to stop and control is returned to the
cmake 2.8.6 Last change: June 17, 2014 77
User Commands cmake(1)
including file. If it is encountered in a file which is
not included by another file, e.g. a CMakeLists.txt,
control is returned to the parent directory if there is
one. If return is called in a function, control is
returned to the caller of the function. Note that a
macro is not a function and does not handle return like
a function does.
separate_arguments
Parse space-separated arguments into a semicolon-sepa-
rated list.
separate_arguments(<var> <UNIX|WINDOWS>_COMMAND "<args>")
Parses a unix- or windows-style command-line string
"<args>" and stores a semicolon-separated list of the
arguments in <var>. The entire command line must be
given in one "<args>" argument.
The UNIX_COMMAND mode separates arguments by unquoted
whitespace. It recognizes both single-quote and dou-
ble-quote pairs. A backslash escapes the next literal
character (\" is "); there are no special escapes (\n
is just n).
The WINDOWS_COMMAND mode parses a windows command-line
using the same syntax the runtime library uses to con-
struct argv at startup. It separates arguments by
whitespace that is not double-quoted. Backslashes are
literal unless they precede double-quotes. See the
MSDN article "Parsing C Command-Line Arguments" for
details.
separate_arguments(VARIABLE)
Convert the value of VARIABLE to a semi-colon separated
list. All spaces are replaced with ';'. This helps
with generating command lines.
set Set a CMAKE variable to a given value.
set(<variable> <value>
[[CACHE <type> <docstring> [FORCE]] | PARENT_SCOPE])
Within CMake sets <variable> to the value <value>.
<value> is expanded before <variable> is set to it.
If CACHE is present, then the <variable> is put in the
cmake 2.8.6 Last change: June 17, 2014 78
User Commands cmake(1)
cache. <type> and <docstring> are then required. <type>
is used by the CMake GUI to choose a widget with which
the user sets a value. The value for <type> may be one
of
FILEPATH = File chooser dialog.
PATH = Directory chooser dialog.
STRING = Arbitrary string.
BOOL = Boolean ON/OFF checkbox.
INTERNAL = No GUI entry (used for persistent variables).
If <type> is INTERNAL, then the <value> is always writ-
ten into the cache, replacing any values existing in
the cache. If it is not a cache variable, then this
always writes into the current makefile. The FORCE
option will overwrite the cache value removing any
changes by the user.
If PARENT_SCOPE is present, the variable will be set in
the scope above the current scope. Each new directory
or function creates a new scope. This command will set
the value of a variable into the parent directory or
calling function (whichever is applicable to the case
at hand).
If <value> is not specified then the variable is
removed instead of set. See also: the unset() command.
set(<variable> <value1> ... <valueN>)
In this case <variable> is set to a semicolon separated
list of values.
<variable> can be an environment variable such as:
set( ENV{PATH} /home/martink )
in which case the environment variable will be set.
set_directory_properties
Set a property of the directory.
set_directory_properties(PROPERTIES prop1 value1 prop2 value2)
Set a property for the current directory and
cmake 2.8.6 Last change: June 17, 2014 79
User Commands cmake(1)
subdirectories. If the property is not found, CMake
will report an error. The properties include:
INCLUDE_DIRECTORIES, LINK_DIRECTORIES, INCLUDE_REGU-
LAR_EXPRESSION, and ADDITIONAL_MAKE_CLEAN_FILES. ADDI-
TIONAL_MAKE_CLEAN_FILES is a list of files that will be
cleaned as a part of "make clean" stage.
set_property
Set a named property in a given scope.
set_property(<GLOBAL |
DIRECTORY [dir] |
TARGET [target1 [target2 ...]] |
SOURCE [src1 [src2 ...]] |
TEST [test1 [test2 ...]] |
CACHE [entry1 [entry2 ...]]>
[APPEND] [APPEND_STRING]
PROPERTY <name> [value1 [value2 ...]])
Set one property on zero or more objects of a scope.
The first argument determines the scope in which the
property is set. It must be one of the following:
GLOBAL scope is unique and does not accept a name.
DIRECTORY scope defaults to the current directory but
another directory (already processed by CMake) may be
named by full or relative path.
TARGET scope may name zero or more existing targets.
SOURCE scope may name zero or more source files. Note
that source file properties are visible only to targets
added in the same directory (CMakeLists.txt).
TEST scope may name zero or more existing tests.
CACHE scope must name zero or more cache existing
entries.
The required PROPERTY option is immediately followed by
the name of the property to set. Remaining arguments
are used to compose the property value in the form of a
semicolon-separated list. If the APPEND option is
cmake 2.8.6 Last change: June 17, 2014 80
User Commands cmake(1)
given the list is appended to any existing property
value.If the APPEND_STRING option is given the string
is append to any existing property value as string,
i.e. it results in a longer string and not a list of
strings.
set_source_files_properties
Source files can have properties that affect how they
are built.
set_source_files_properties([file1 [file2 [...]]]
PROPERTIES prop1 value1
[prop2 value2 [...]])
Set properties associated with source files using a
key/value paired list. See properties documentation
for those known to CMake. Unrecognized properties are
ignored. Source file properties are visible only to
targets added in the same directory (CMakeLists.txt).
set_target_properties
Targets can have properties that affect how they are
built.
set_target_properties(target1 target2 ...
PROPERTIES prop1 value1
prop2 value2 ...)
Set properties on a target. The syntax for the command
is to list all the files you want to change, and then
provide the values you want to set next. You can use
any prop value pair you want and extract it later with
the GET_TARGET_PROPERTY command.
Properties that affect the name of a target's output
file are as follows. The PREFIX and SUFFIX properties
override the default target name prefix (such as "lib")
and suffix (such as ".so"). IMPORT_PREFIX and
IMPORT_SUFFIX are the equivalent properties for the
import library corresponding to a DLL (for SHARED
library targets). OUTPUT_NAME sets the real name of a
target when it is built and can be used to help create
two targets of the same name even though CMake requires
unique logical target names. There is also a <CON-
FIG>_OUTPUT_NAME that can set the output name on a
per-configuration basis. <CONFIG>_POSTFIX sets a post-
fix for the real name of the target when it is built
under the configuration named by <CONFIG> (in
upper-case, such as "DEBUG_POSTFIX"). The value of
cmake 2.8.6 Last change: June 17, 2014 81
User Commands cmake(1)
this property is initialized when the target is created
to the value of the variable CMAKE_<CONFIG>_POSTFIX
(except for executable targets because earlier CMake
versions which did not use this variable for executa-
bles).
The LINK_FLAGS property can be used to add extra flags
to the link step of a target. LINK_FLAGS_<CONFIG> will
add to the configuration <CONFIG>, for example, DEBUG,
RELEASE, MINSIZEREL, RELWITHDEBINFO. DEFINE_SYMBOL sets
the name of the preprocessor symbol defined when com-
piling sources in a shared library. If not set here
then it is set to target_EXPORTS by default (with some
substitutions if the target is not a valid C identi-
fier). This is useful for headers to know whether they
are being included from inside their library or outside
to properly setup dllexport/dllimport decorations. The
COMPILE_FLAGS property sets additional compiler flags
used to build sources within the target. It may also
be used to pass additional preprocessor definitions.
The LINKER_LANGUAGE property is used to change the tool
used to link an executable or shared library. The
default is set the language to match the files in the
library. CXX and C are common values for this property.
For shared libraries VERSION and SOVERSION can be used
to specify the build version and api version respec-
tively. When building or installing appropriate sym-
links are created if the platform supports symlinks and
the linker supports so-names. If only one of both is
specified the missing is assumed to have the same ver-
sion number. For executables VERSION can be used to
specify the build version. When building or installing
appropriate symlinks are created if the platform sup-
ports symlinks. For shared libraries and executables on
Windows the VERSION attribute is parsed to extract a
"major.minor" version number. These numbers are used as
the image version of the binary.
There are a few properties used to specify RPATH rules.
INSTALL_RPATH is a semicolon-separated list specifying
the rpath to use in installed targets (for platforms
that support it). INSTALL_RPATH_USE_LINK_PATH is a
boolean that if set to true will append directories in
the linker search path and outside the project to the
INSTALL_RPATH. SKIP_BUILD_RPATH is a boolean specifying
whether to skip automatic generation of an rpath
cmake 2.8.6 Last change: June 17, 2014 82
User Commands cmake(1)
allowing the target to run from the build tree.
BUILD_WITH_INSTALL_RPATH is a boolean specifying
whether to link the target in the build tree with the
INSTALL_RPATH. This takes precedence over
SKIP_BUILD_RPATH and avoids the need for relinking
before installation. INSTALL_NAME_DIR is a string
specifying the directory portion of the "install_name"
field of shared libraries on Mac OSX to use in the
installed targets. When the target is created the val-
ues of the variables CMAKE_INSTALL_RPATH,
CMAKE_INSTALL_RPATH_USE_LINK_PATH,
CMAKE_SKIP_BUILD_RPATH, CMAKE_BUILD_WITH_INSTALL_RPATH,
and CMAKE_INSTALL_NAME_DIR are used to initialize these
properties.
PROJECT_LABEL can be used to change the name of the
target in an IDE like visual studio. VS_KEYWORD can be
set to change the visual studio keyword, for example QT
integration works better if this is set to Qt4VSv1.0.
VS_SCC_PROJECTNAME, VS_SCC_LOCALPATH, VS_SCC_PROVIDER
can be set to add support for source control bindings
in a Visual Studio project file.
VS_GLOBAL_<variable> can be set to add a Visual Studio
project-specific global variable. Qt integration works
better if VS_GLOBAL_QtVersion is set to the Qt version
FindQt4.cmake found. For example, "4.7.3"
The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT proper-
ties are the old way to specify CMake scripts to run
before and after installing a target. They are used
only when the old INSTALL_TARGETS command is used to
install the target. Use the INSTALL command instead.
The EXCLUDE_FROM_DEFAULT_BUILD property is used by the
visual studio generators. If it is set to 1 the target
will not be part of the default build when you select
"Build Solution".
set_tests_properties
Set a property of the tests.
set_tests_properties(test1 [test2...] PROPERTIES prop1 value1 prop2 value2)
Set a property for the tests. If the property is not
cmake 2.8.6 Last change: June 17, 2014 83
User Commands cmake(1)
found, CMake will report an error. The properties
include:
WILL_FAIL: If set to true, this will invert the
pass/fail flag of the test.
PASS_REGULAR_EXPRESSION: If set, the test output will
be checked against the specified regular expressions
and at least one of the regular expressions has to
match, otherwise the test will fail.
Example: PASS_REGULAR_EXPRESSION "TestPassed;All ok"
FAIL_REGULAR_EXPRESSION: If set, if the output will
match to one of specified regular expressions, the test
will fail.
Example: PASS_REGULAR_EXPRESSION "[^a-z]Error;ERROR;Failed"
Both PASS_REGULAR_EXPRESSION and FAIL_REGULAR_EXPRES-
SION expect a list of regular expressions.
TIMEOUT: Setting this will limit the test runtime to
the number of seconds specified.
site_name
Set the given variable to the name of the computer.
site_name(variable)
source_group
Define a grouping for sources in the makefile.
source_group(name [REGULAR_EXPRESSION regex] [FILES src1 src2 ...])
Defines a group into which sources will be placed in
project files. This is mainly used to setup file tabs
in Visual Studio. Any file whose name is listed or
matches the regular expression will be placed in this
group. If a file matches multiple groups, the LAST
group that explicitly lists the file will be favored,
if any. If no group explicitly lists the file, the
LAST group whose regular expression matches the file
will be favored.
cmake 2.8.6 Last change: June 17, 2014 84
User Commands cmake(1)
The name of the group may contain backslashes to spec-
ify subgroups:
source_group(outer\\inner ...)
For backwards compatibility, this command is also sup-
ports the format:
source_group(name regex)
string
String operations.
string(REGEX MATCH <regular_expression>
<output variable> <input> [<input>...])
string(REGEX MATCHALL <regular_expression>
<output variable> <input> [<input>...])
string(REGEX REPLACE <regular_expression>
<replace_expression> <output variable>
<input> [<input>...])
string(REPLACE <match_string>
<replace_string> <output variable>
<input> [<input>...])
string(COMPARE EQUAL <string1> <string2> <output variable>)
string(COMPARE NOTEQUAL <string1> <string2> <output variable>)
string(COMPARE LESS <string1> <string2> <output variable>)
string(COMPARE GREATER <string1> <string2> <output variable>)
string(ASCII <number> [<number> ...] <output variable>)
string(CONFIGURE <string1> <output variable>
[@ONLY] [ESCAPE_QUOTES])
string(TOUPPER <string1> <output variable>)
string(TOLOWER <string1> <output variable>)
string(LENGTH <string> <output variable>)
string(SUBSTRING <string> <begin> <length> <output variable>)
string(STRIP <string> <output variable>)
string(RANDOM [LENGTH <length>] [ALPHABET <alphabet>]
[RANDOM_SEED <seed>] <output variable>)
string(FIND <string> <substring> <output variable> [REVERSE])
REGEX MATCH will match the regular expression once and
store the match in the output variable.
REGEX MATCHALL will match the regular expression as
many times as possible and store the matches in the
output variable as a list.
REGEX REPLACE will match the regular expression as many
cmake 2.8.6 Last change: June 17, 2014 85
User Commands cmake(1)
times as possible and substitute the replacement
expression for the match in the output. The replace
expression may refer to paren-delimited subexpressions
of the match using \1, \2, ..., \9. Note that two
backslashes (\\1) are required in CMake code to get a
backslash through argument parsing.
REPLACE will replace all occurrences of match_string in
the input with replace_string and store the result in
the output.
COMPARE EQUAL/NOTEQUAL/LESS/GREATER will compare the
strings and store true or false in the output variable.
ASCII will convert all numbers into corresponding ASCII
characters.
CONFIGURE will transform a string like CONFIGURE_FILE
transforms a file.
TOUPPER/TOLOWER will convert string to upper/lower
characters.
LENGTH will return a given string's length.
SUBSTRING will return a substring of a given string. If
length is -1 the remainder of the string starting at
begin will be returned.
STRIP will return a substring of a given string with
leading and trailing spaces removed.
RANDOM will return a random string of given length con-
sisting of characters from the given alphabet. Default
length is 5 characters and default alphabet is all num-
bers and upper and lower case letters. If an integer
RANDOM_SEED is given, its value will be used to seed
the random number generator.
FIND will return the position where the given substring
was found in the supplied string. If the REVERSE flag
was used, the command will search for the position of
cmake 2.8.6 Last change: June 17, 2014 86
User Commands cmake(1)
the last occurrence of the specified substring.
The following characters have special meaning in regu-
lar expressions:
^ Matches at beginning of a line
$ Matches at end of a line
. Matches any single character
[ ] Matches any character(s) inside the brackets
[^ ] Matches any character(s) not inside the brackets
- Matches any character in range on either side of a dash
* Matches preceding pattern zero or more times
+ Matches preceding pattern one or more times
? Matches preceding pattern zero or once only
| Matches a pattern on either side of the |
() Saves a matched subexpression, which can be referenced
in the REGEX REPLACE operation. Additionally it is saved
by all regular expression-related commands, including
e.g. if( MATCHES ), in the variables CMAKE_MATCH_(0..9).
target_link_libraries
Link a target to given libraries.
target_link_libraries(<target> [item1 [item2 [...]]]
[[debug|optimized|general] <item>] ...)
Specify libraries or flags to use when linking a given
target. The named <target> must have been created in
the current directory by a command such as add_exe-
cutable or add_library. The remaining arguments spec-
ify library names or flags.
If a library name matches that of another target in the
project a dependency will automatically be added in the
build system to make sure the library being linked is
up-to-date before the target links. Item names start-
ing with '-', but not '-l' or '-framework', are treated
as linker flags.
A "debug", "optimized", or "general" keyword indicates
that the library immediately following it is to be used
only for the corresponding build configuration. The
"debug" keyword corresponds to the Debug configuration
(or to configurations named in the DEBUG_CONFIGURATIONS
global property if it is set). The "optimized" keyword
corresponds to all other configurations. The "general"
keyword corresponds to all configurations, and is
cmake 2.8.6 Last change: June 17, 2014 87
User Commands cmake(1)
purely optional (assumed if omitted). Higher granular-
ity may be achieved for per-configuration rules by cre-
ating and linking to IMPORTED library targets. See the
IMPORTED mode of the add_library command for more
information.
Library dependencies are transitive by default. When
this target is linked into another target then the
libraries linked to this target will appear on the link
line for the other target too. See the LINK_INTER-
FACE_LIBRARIES target property to override the set of
transitive link dependencies for a target.
target_link_libraries(<target> LINK_INTERFACE_LIBRARIES
[[debug|optimized|general] <lib>] ...)
The LINK_INTERFACE_LIBRARIES mode appends the libraries
to the LINK_INTERFACE_LIBRARIES and its per-configura-
tion equivalent target properties instead of using them
for linking. Libraries specified as "debug" are
appended to the the LINK_INTERFACE_LIBRARIES_DEBUG
property (or to the properties corresponding to config-
urations listed in the DEBUG_CONFIGURATIONS global
property if it is set). Libraries specified as "opti-
mized" are appended to the the LINK_INTERFACE_LIBRARIES
property. Libraries specified as "general" (or without
any keyword) are treated as if specified for both
"debug" and "optimized".
The library dependency graph is normally acyclic (a
DAG), but in the case of mutually-dependent STATIC
libraries CMake allows the graph to contain cycles
(strongly connected components). When another target
links to one of the libraries CMake repeats the entire
connected component. For example, the code
add_library(A STATIC a.c)
add_library(B STATIC b.c)
target_link_libraries(A B)
target_link_libraries(B A)
add_executable(main main.c)
target_link_libraries(main A)
links 'main' to 'A B A B'. (While one repetition is
usually sufficient, pathological object file and symbol
arrangements can require more. One may handle such
cases by manually repeating the component in the last
target_link_libraries call. However, if two archives
cmake 2.8.6 Last change: June 17, 2014 88
User Commands cmake(1)
are really so interdependent they should probably be
combined into a single archive.)
try_compile
Try building some code.
try_compile(RESULT_VAR <bindir> <srcdir>
<projectName> [targetName] [CMAKE_FLAGS flags...]
[OUTPUT_VARIABLE <var>])
Try building a project. In this form, srcdir should
contain a complete CMake project with a CMakeLists.txt
file and all sources. The bindir and srcdir will not be
deleted after this command is run. Specify targetName
to build a specific target instead of the 'all' or
'ALL_BUILD' target.
try_compile(RESULT_VAR <bindir> <srcfile>
[CMAKE_FLAGS flags...]
[COMPILE_DEFINITIONS flags...]
[OUTPUT_VARIABLE <var>]
[COPY_FILE <fileName>])
Try building a source file into an executable. In this
form the user need only supply a source file that
defines a 'main'. CMake will create a CMakeLists.txt
file to build the source as an executable. Specify
COPY_FILE to get a copy of the linked executable at the
given fileName.
In this version all files in bindir/CMakeFiles/CMakeTmp
will be cleaned automatically. For debugging,
--debug-trycompile can be passed to cmake to avoid this
clean. However, multiple sequential try_compile opera-
tions reuse this single output directory. If you use
--debug-trycompile, you can only debug one try_compile
call at a time. The recommended procedure is to config-
ure with cmake all the way through once, then delete
the cache entry associated with the try_compile call of
interest, and then re-run cmake again with
--debug-trycompile.
Some extra flags that can be included are,
INCLUDE_DIRECTORIES, LINK_DIRECTORIES, and
LINK_LIBRARIES. COMPILE_DEFINITIONS are -Ddefinition
that will be passed to the compile line. try_compile
creates a CMakeList.txt file on the fly that looks like
this:
cmake 2.8.6 Last change: June 17, 2014 89
User Commands cmake(1)
add_definitions( <expanded COMPILE_DEFINITIONS from calling cmake>)
include_directories(${INCLUDE_DIRECTORIES})
link_directories(${LINK_DIRECTORIES})
add_executable(cmTryCompileExec sources)
target_link_libraries(cmTryCompileExec ${LINK_LIBRARIES})
In both versions of the command, if OUTPUT_VARIABLE is
specified, then the output from the build process is
stored in the given variable. The success or failure of
the try_compile, i.e. TRUE or FALSE respectively, is
returned in RESULT_VAR. CMAKE_FLAGS can be used to pass
-DVAR:TYPE=VALUE flags to the cmake that is run during
the build. Set variable CMAKE_TRY_COMPILE_CONFIGURATION
to choose a build configuration.
try_run
Try compiling and then running some code.
try_run(RUN_RESULT_VAR COMPILE_RESULT_VAR
bindir srcfile [CMAKE_FLAGS <Flags>]
[COMPILE_DEFINITIONS <flags>]
[COMPILE_OUTPUT_VARIABLE comp]
[RUN_OUTPUT_VARIABLE run]
[OUTPUT_VARIABLE var]
[ARGS <arg1> <arg2>...])
Try compiling a srcfile. Return TRUE or FALSE for suc-
cess or failure in COMPILE_RESULT_VAR. Then if the
compile succeeded, run the executable and return its
exit code in RUN_RESULT_VAR. If the executable was
built, but failed to run, then RUN_RESULT_VAR will be
set to FAILED_TO_RUN. COMPILE_OUTPUT_VARIABLE specifies
the variable where the output from the compile step
goes. RUN_OUTPUT_VARIABLE specifies the variable where
the output from the running executable goes.
For compatibility reasons OUTPUT_VARIABLE is still sup-
ported, which gives you the output from the compile and
run step combined.
Cross compiling issues
When cross compiling, the executable compiled in the
first step usually cannot be run on the build host.
try_run() checks the CMAKE_CROSSCOMPILING variable to
detect whether CMake is in crosscompiling mode. If
that's the case, it will still try to compile the exe-
cutable, but it will not try to run the executable.
cmake 2.8.6 Last change: June 17, 2014 90
User Commands cmake(1)
Instead it will create cache variables which must be
filled by the user or by presetting them in some CMake
script file to the values the executable would have
produced if it would have been run on its actual target
platform. These variables are RUN_RESULT_VAR (explana-
tion see above) and if RUN_OUTPUT_VARIABLE (or OUT-
PUT_VARIABLE) was used, an additional cache variable
RUN_RESULT_VAR__COMPILE_RESULT_VAR__TRYRUN_OUTPUT.This
is intended to hold stdout and stderr from the exe-
cutable.
In order to make cross compiling your project easier,
use try_run only if really required. If you use
try_run, use RUN_OUTPUT_VARIABLE (or OUTPUT_VARIABLE)
only if really required. Using them will require that
when crosscompiling, the cache variables will have to
be set manually to the output of the executable. You
can also "guard" the calls to try_run with
if(CMAKE_CROSSCOMPILING) and provide an easy-to-preset
alternative for this case.
Set variable CMAKE_TRY_COMPILE_CONFIGURATION to choose
a build configuration.
unset
Unset a variable, cache variable, or environment vari-
able.
unset(<variable> [CACHE])
Removes the specified variable causing it to become
undefined. If CACHE is present then the variable is
removed from the cache instead of the current scope.
<variable> can be an environment variable such as:
unset(ENV{LD_LIBRARY_PATH})
in which case the variable will be removed from the
current environment.
variable_watch
Watch the CMake variable for change.
variable_watch(<variable name> [<command to execute>])
cmake 2.8.6 Last change: June 17, 2014 91
User Commands cmake(1)
If the specified variable changes, the message will be
printed about the variable being changed. If the com-
mand is specified, the command will be executed. The
command will receive the following arguments: COM-
MAND(<variable> <access> <value> <current list file>
<stack>)
while
Evaluate a group of commands while a condition is true
while(condition)
COMMAND1(ARGS ...)
COMMAND2(ARGS ...)
...
endwhile(condition)
All commands between while and the matching endwhile
are recorded without being invoked. Once the endwhile
is evaluated, the recorded list of commands is invoked
as long as the condition is true. The condition is
evaluated using the same logic as the if command.
PROPERTIES
CMake Properties - Properties supported by CMake, the Cross-Platform Makefile Generator.
This is the documentation for the properties supported by
CMake. Properties can have different scopes. They can either
be assigned to a source file, a directory, a target or glob-
ally to CMake. By modifying the values of properties the be-
haviour of the build system can be customized.
PROPERTIES OF GLOBAL SCOPE
ALLOW_DUPLICATE_CUSTOM_TARGETS
Allow duplicate custom targets to be created.
Normally CMake requires that all targets built in a
project have globally unique logical names (see policy
CMP0002). This is necessary to generate meaningful
project file names in Xcode and VS IDE generators. It
also allows the target names to be referenced unambigu-
ously.
Makefile generators are capable of supporting duplicate
custom target names. For projects that care only about
Makefile generators and do not wish to support Xcode or
VS IDE generators, one may set this property to true to
allow duplicate custom targets. The property allows
cmake 2.8.6 Last change: June 17, 2014 92
User Commands cmake(1)
multiple add_custom_target command calls in different
directories to specify the same target name. However,
setting this property will cause non-Makefile genera-
tors to produce an error and refuse to generate the
project.
DEBUG_CONFIGURATIONS
Specify which configurations are for debugging.
The value must be a semi-colon separated list of con-
figuration names. Currently this property is used only
by the target_link_libraries command (see its documen-
tation for details). Additional uses may be defined in
the future.
This property must be set at the top level of the
project and before the first target_link_libraries com-
mand invocation. If any entry in the list does not
match a valid configuration for the project the behav-
ior is undefined.
DISABLED_FEATURES
List of features which are disabled during the CMake
run.
List of features which are disabled during the CMake
run. Be default it contains the names of all packages
which were not found. This is determined using the
<NAME>_FOUND variables. Packages which are searched
QUIET are not listed. A project can add its own fea-
tures to this list.This property is used by the macros
in FeatureSummary.cmake.
ENABLED_FEATURES
List of features which are enabled during the CMake
run.
List of features which are enabled during the CMake
run. Be default it contains the names of all packages
which were found. This is determined using the
<NAME>_FOUND variables. Packages which are searched
QUIET are not listed. A project can add its own fea-
tures to this list.This property is used by the macros
in FeatureSummary.cmake.
ENABLED_LANGUAGES
Read-only property that contains the list of currently
cmake 2.8.6 Last change: June 17, 2014 93
User Commands cmake(1)
enabled languages
Set to list of currently enabled languages.
FIND_LIBRARY_USE_LIB64_PATHS
Whether FIND_LIBRARY should automatically search lib64
directories.
FIND_LIBRARY_USE_LIB64_PATHS is a boolean specifying
whether the FIND_LIBRARY command should automatically
search the lib64 variant of directories called lib in
the search path when building 64-bit binaries.
FIND_LIBRARY_USE_OPENBSD_VERSIONING
Whether FIND_LIBRARY should find OpenBSD-style shared
libraries.
This property is a boolean specifying whether the
FIND_LIBRARY command should find shared libraries with
OpenBSD-style versioned extension:
".so.<major>.<minor>". The property is set to true on
OpenBSD and false on other platforms.
GLOBAL_DEPENDS_DEBUG_MODE
Enable global target dependency graph debug mode.
CMake automatically analyzes the global inter-target
dependency graph at the beginning of native build sys-
tem generation. This property causes it to display
details of its analysis to stderr.
GLOBAL_DEPENDS_NO_CYCLES
Disallow global target dependency graph cycles.
CMake automatically analyzes the global inter-target
dependency graph at the beginning of native build sys-
tem generation. It reports an error if the dependency
graph contains a cycle that does not consist of all
STATIC library targets. This property tells CMake to
disallow all cycles completely, even among static
libraries.
IN_TRY_COMPILE
Read-only property that is true during a try-compile
configuration.
True when building a project inside a TRY_COMPILE or
cmake 2.8.6 Last change: June 17, 2014 94
User Commands cmake(1)
TRY_RUN command.
PACKAGES_FOUND
List of packages which were found during the CMake run.
List of packages which were found during the CMake run.
Whether a package has been found is determined using
the <NAME>_FOUND variables.
PACKAGES_NOT_FOUND
List of packages which were not found during the CMake
run.
List of packages which were not found during the CMake
run. Whether a package has been found is determined
using the <NAME>_FOUND variables.
PREDEFINED_TARGETS_FOLDER
Name of FOLDER for targets that are added automatically
by CMake.
If not set, CMake uses "CMakePredefinedTargets" as a
default value for this property. Targets such as
INSTALL, PACKAGE and RUN_TESTS will be organized into
this FOLDER. See also the documentation for the FOLDER
target property.
REPORT_UNDEFINED_PROPERTIES
If set, report any undefined properties to this file.
If this property is set to a filename then when CMake
runs it will report any properties or variables that
were accessed but not defined into the filename speci-
fied in this property.
RULE_LAUNCH_COMPILE
Specify a launcher for compile rules.
Makefile generators prefix compiler commands with the
given launcher command line. This is intended to allow
launchers to intercept build problems with high granu-
larity. Non-Makefile generators currently ignore this
property.
RULE_LAUNCH_CUSTOM
Specify a launcher for custom rules.
cmake 2.8.6 Last change: June 17, 2014 95
User Commands cmake(1)
Makefile generators prefix custom commands with the
given launcher command line. This is intended to allow
launchers to intercept build problems with high granu-
larity. Non-Makefile generators currently ignore this
property.
RULE_LAUNCH_LINK
Specify a launcher for link rules.
Makefile generators prefix link and archive commands
with the given launcher command line. This is intended
to allow launchers to intercept build problems with
high granularity. Non-Makefile generators currently
ignore this property.
RULE_MESSAGES
Specify whether to report a message for each make rule.
This property specifies whether Makefile generators
should add a progress message describing what each
build rule does. If the property is not set the
default is ON. Set the property to OFF to disable
granular messages and report only as each target com-
pletes. This is intended to allow scripted builds to
avoid the build time cost of detailed reports. If a
CMAKE_RULE_MESSAGES cache entry exists its value ini-
tializes the value of this property. Non-Makefile gen-
erators currently ignore this property.
TARGET_ARCHIVES_MAY_BE_SHARED_LIBS
Set if shared libraries may be named like archives.
On AIX shared libraries may be named "lib<name>.a".
This property is set to true on such platforms.
TARGET_SUPPORTS_SHARED_LIBS
Does the target platform support shared libraries.
TARGET_SUPPORTS_SHARED_LIBS is a boolean specifying
whether the target platform supports shared libraries.
Basically all current general general purpose OS do so,
the exception are usually embedded systems with no or
special OSs.
USE_FOLDERS
Use the FOLDER target property to organize targets into
folders.
cmake 2.8.6 Last change: June 17, 2014 96
User Commands cmake(1)
If not set, CMake treats this property as OFF by
default. CMake generators that are capable of organiz-
ing into a hierarchy of folders use the values of the
FOLDER target property to name those folders. See also
the documentation for the FOLDER target property.
__CMAKE_DELETE_CACHE_CHANGE_VARS_
Internal property
Used to detect compiler changes, Do not set.
PROPERTIES ON DIRECTORIES
ADDITIONAL_MAKE_CLEAN_FILES
Additional files to clean during the make clean stage.
A list of files that will be cleaned as a part of the
"make clean" stage.
CACHE_VARIABLES
List of cache variables available in the current direc-
tory.
This read-only property specifies the list of CMake
cache variables currently defined. It is intended for
debugging purposes.
CLEAN_NO_CUSTOM
Should the output of custom commands be left.
If this is true then the outputs of custom commands for
this directory will not be removed during the "make
clean" stage.
COMPILE_DEFINITIONS
Preprocessor definitions for compiling a directory's
sources.
The COMPILE_DEFINITIONS property may be set to a semi-
colon-separated list of preprocessor definitions using
the syntax VAR or VAR=value. Function-style defini-
tions are not supported. CMake will automatically
escape the value correctly for the native build system
(note that CMake language syntax may require escapes to
specify some values). This property may be set on a
per-configuration basis using the name COMPILE_DEFINI-
TIONS_<CONFIG> where <CONFIG> is an upper-case name
(ex. "COMPILE_DEFINITIONS_DEBUG"). This property will
cmake 2.8.6 Last change: June 17, 2014 97
User Commands cmake(1)
be initialized in each directory by its value in the
directory's parent.
CMake will automatically drop some definitions that are
not supported by the native build tool. The VS6 IDE
does not support definition values with spaces (but
NMake does).
Disclaimer: Most native build tools have poor support
for escaping certain values. CMake has work-arounds
for many cases but some values may just not be possible
to pass correctly. If a value does not seem to be
escaped correctly, do not attempt to work-around the
problem by adding escape sequences to the value. Your
work-around may break in a future version of CMake that
has improved escape support. Instead consider defining
the macro in a (configured) header file. Then report
the limitation. Known limitations include:
# - broken almost everywhere
; - broken in VS IDE and Borland Makefiles
, - broken in VS IDE
% - broken in some cases in NMake
& | - broken in some cases on MinGW
^ < > \" - broken in most Make tools on Windows
CMake does not reject these values outright because
they do work in some cases. Use with caution.
COMPILE_DEFINITIONS_<CONFIG>
Per-configuration preprocessor definitions in a direc-
tory.
This is the configuration-specific version of COM-
PILE_DEFINITIONS. This property will be initialized in
each directory by its value in the directory's parent.
DEFINITIONS
For CMake 2.4 compatibility only. Use COMPILE_DEFINI-
TIONS instead.
This read-only property specifies the list of flags
given so far to the add_definitions command. It is
intended for debugging purposes. Use the COMPILE_DEFI-
NITIONS instead.
cmake 2.8.6 Last change: June 17, 2014 98
User Commands cmake(1)
EXCLUDE_FROM_ALL
Exclude the directory from the all target of its par-
ent.
A property on a directory that indicates if its targets
are excluded from the default build target. If it is
not, then with a Makefile for example typing make will
cause the targets to be built. The same concept applies
to the default build of other generators.
IMPLICIT_DEPENDS_INCLUDE_TRANSFORM
Specify #include line transforms for dependencies in a
directory.
This property specifies rules to transform macro-like
#include lines during implicit dependency scanning of C
and C++ source files. The list of rules must be semi-
colon-separated with each entry of the form
"A_MACRO(%)=value-with-%" (the % must be literal).
During dependency scanning occurrences of A_MACRO(...)
on #include lines will be replaced by the value given
with the macro argument substituted for '%'. For exam-
ple, the entry
MYDIR(%)=<mydir/%>
will convert lines of the form
#include MYDIR(myheader.h)
to
#include <mydir/myheader.h>
allowing the dependency to be followed.
This property applies to sources in all targets within
a directory. The property value is initialized in each
directory by its value in the directory's parent.
INCLUDE_DIRECTORIES
List of preprocessor include file search directories.
This read-only property specifies the list of directo-
ries given so far to the include_directories command.
It is intended for debugging purposes.
cmake 2.8.6 Last change: June 17, 2014 99
User Commands cmake(1)
INCLUDE_REGULAR_EXPRESSION
Include file scanning regular expression.
This read-only property specifies the regular expres-
sion used during dependency scanning to match include
files that should be followed. See the include_regu-
lar_expression command.
INTERPROCEDURAL_OPTIMIZATION
Enable interprocedural optimization for targets in a
directory.
If set to true, enables interprocedural optimizations
if they are known to be supported by the compiler.
INTERPROCEDURAL_OPTIMIZATION_<CONFIG>
Per-configuration interprocedural optimization for a
directory.
This is a per-configuration version of INTERPROCEDU-
RAL_OPTIMIZATION. If set, this property overrides the
generic property for the named configuration.
LINK_DIRECTORIES
List of linker search directories.
This read-only property specifies the list of directo-
ries given so far to the link_directories command. It
is intended for debugging purposes.
LISTFILE_STACK
The current stack of listfiles being processed.
This property is mainly useful when trying to debug
errors in your CMake scripts. It returns a list of what
list files are currently being processed, in order. So
if one listfile does an INCLUDE command then that is
effectively pushing the included listfile onto the
stack.
MACROS
List of macro commands available in the current direc-
tory.
This read-only property specifies the list of CMake
macros currently defined. It is intended for debugging
purposes. See the macro command.
cmake 2.8.6 Last change: June 17, 2014 100
User Commands cmake(1)
PARENT_DIRECTORY
Source directory that added current subdirectory.
This read-only property specifies the source directory
that added the current source directory as a subdirec-
tory of the build. In the top-level directory the
value is the empty-string.
RULE_LAUNCH_COMPILE
Specify a launcher for compile rules.
See the global property of the same name for details.
This overrides the global property for a directory.
RULE_LAUNCH_CUSTOM
Specify a launcher for custom rules.
See the global property of the same name for details.
This overrides the global property for a directory.
RULE_LAUNCH_LINK
Specify a launcher for link rules.
See the global property of the same name for details.
This overrides the global property for a directory.
TEST_INCLUDE_FILE
A cmake file that will be included when ctest is run.
If you specify TEST_INCLUDE_FILE, that file will be
included and processed when ctest is run on the direc-
tory.
VARIABLES
List of variables defined in the current directory.
This read-only property specifies the list of CMake
variables currently defined. It is intended for debug-
ging purposes.
PROPERTIES ON TARGETS
<CONFIG>_OUTPUT_NAME
Old per-configuration target file base name.
This is a configuration-specific version of OUT-
PUT_NAME. Use OUTPUT_NAME_<CONFIG> instead.
cmake 2.8.6 Last change: June 17, 2014 101
User Commands cmake(1)
<CONFIG>_POSTFIX
Postfix to append to the target file name for configu-
ration <CONFIG>.
When building with configuration <CONFIG> the value of
this property is appended to the target file name built
on disk. For non-executable targets, this property is
initialized by the value of the variable CMAKE_<CON-
FIG>_POSTFIX if it is set when a target is created.
This property is ignored on the Mac for Frameworks and
App Bundles.
ARCHIVE_OUTPUT_DIRECTORY
Output directory in which to build ARCHIVE target
files.
This property specifies the directory into which ar-
chive target files should be built. Multi-configuration
generators (VS, Xcode) append a per-configuration sub-
directory to the specified directory. There are three
kinds of target files that may be built: archive,
library, and runtime. Executables are always treated
as runtime targets. Static libraries are always treated
as archive targets. Module libraries are always treated
as library targets. For non-DLL platforms shared
libraries are treated as library targets. For DLL plat-
forms the DLL part of a shared library is treated as a
runtime target and the corresponding import library is
treated as an archive target. All Windows-based systems
including Cygwin are DLL platforms. This property is
initialized by the value of the variable CMAKE_AR-
CHIVE_OUTPUT_DIRECTORY if it is set when a target is
created.
ARCHIVE_OUTPUT_DIRECTORY_<CONFIG>
Per-configuration output directory for ARCHIVE target
files.
This is a per-configuration version of ARCHIVE_OUT-
PUT_DIRECTORY, but multi-configuration generators (VS,
Xcode) do NOT append a per-configuration subdirectory
to the specified directory. This property is initial-
ized by the value of the variable CMAKE_ARCHIVE_OUT-
PUT_DIRECTORY_<CONFIG> if it is set when a target is
created.
ARCHIVE_OUTPUT_NAME
Output name for ARCHIVE target files.
cmake 2.8.6 Last change: June 17, 2014 102
User Commands cmake(1)
This property specifies the base name for archive tar-
get files. It overrides OUTPUT_NAME and OUT-
PUT_NAME_<CONFIG> properties. There are three kinds of
target files that may be built: archive, library, and
runtime. Executables are always treated as runtime
targets. Static libraries are always treated as archive
targets. Module libraries are always treated as library
targets. For non-DLL platforms shared libraries are
treated as library targets. For DLL platforms the DLL
part of a shared library is treated as a runtime target
and the corresponding import library is treated as an
archive target. All Windows-based systems including
Cygwin are DLL platforms.
ARCHIVE_OUTPUT_NAME_<CONFIG>
Per-configuration output name for ARCHIVE target files.
This is the configuration-specific version of AR-
CHIVE_OUTPUT_NAME.
AUTOMOC
Should the target be processed with automoc (for Qt
projects).
AUTOMOC is a boolean specifying whether CMake will han-
dle the Qt moc preprocessor automatically, i.e. without
having to use the QT4_WRAP_CPP() macro. Currently Qt4
is supported. When this property is set to TRUE, CMake
will scan the source files at build time and invoke moc
accordingly. If an #include statement like #include
"moc_foo.cpp" is found, the Q_OBJECT class declaration
is expected in the header, and moc is run on the header
file. If an #include statement like #include "foo.moc"
is found, then a Q_OBJECT is expected in the current
source file and moc is run on the file itself. Addi-
tionally, all header files are parsed for Q_OBJECT
macros, and if found, moc is also executed on those
files. The resulting moc files, which are not included
as shown above in any of the source files are included
in a generated <targetname>_automoc.cpp file, which is
compiled as part of the target.This property is ini-
tialized by the value of the variable CMAKE_AUTOMOC if
it is set when a target is created.
BUILD_WITH_INSTALL_RPATH
Should build tree targets have install tree rpaths.
BUILD_WITH_INSTALL_RPATH is a boolean specifying
whether to link the target in the build tree with the
cmake 2.8.6 Last change: June 17, 2014 103
User Commands cmake(1)
INSTALL_RPATH. This takes precedence over
SKIP_BUILD_RPATH and avoids the need for relinking
before installation. This property is initialized by
the value of the variable
CMAKE_BUILD_WITH_INSTALL_RPATH if it is set when a tar-
get is created.
BUNDLE
This target is a CFBundle on the Mac.
If a module library target has this property set to
true it will be built as a CFBundle when built on the
mac. It will have the directory structure required for
a CFBundle and will be suitable to be used for creating
Browser Plugins or other application resources.
BUNDLE_EXTENSION
The file extension used to name a BUNDLE target on the
Mac.
The default value is "bundle" - you can also use "plug-
in" or whatever file extension is required by the host
app for your bundle.
COMPILE_DEFINITIONS
Preprocessor definitions for compiling a target's
sources.
The COMPILE_DEFINITIONS property may be set to a semi-
colon-separated list of preprocessor definitions using
the syntax VAR or VAR=value. Function-style defini-
tions are not supported. CMake will automatically
escape the value correctly for the native build system
(note that CMake language syntax may require escapes to
specify some values). This property may be set on a
per-configuration basis using the name COMPILE_DEFINI-
TIONS_<CONFIG> where <CONFIG> is an upper-case name
(ex. "COMPILE_DEFINITIONS_DEBUG").
CMake will automatically drop some definitions that are
not supported by the native build tool. The VS6 IDE
does not support definition values with spaces (but
NMake does).
Disclaimer: Most native build tools have poor support
for escaping certain values. CMake has work-arounds
for many cases but some values may just not be possible
cmake 2.8.6 Last change: June 17, 2014 104
User Commands cmake(1)
to pass correctly. If a value does not seem to be
escaped correctly, do not attempt to work-around the
problem by adding escape sequences to the value. Your
work-around may break in a future version of CMake that
has improved escape support. Instead consider defining
the macro in a (configured) header file. Then report
the limitation. Known limitations include:
# - broken almost everywhere
; - broken in VS IDE and Borland Makefiles
, - broken in VS IDE
% - broken in some cases in NMake
& | - broken in some cases on MinGW
^ < > \" - broken in most Make tools on Windows
CMake does not reject these values outright because
they do work in some cases. Use with caution.
COMPILE_DEFINITIONS_<CONFIG>
Per-configuration preprocessor definitions on a target.
This is the configuration-specific version of COM-
PILE_DEFINITIONS.
COMPILE_FLAGS
Additional flags to use when compiling this target's
sources.
The COMPILE_FLAGS property sets additional compiler
flags used to build sources within the target. Use
COMPILE_DEFINITIONS to pass additional preprocessor
definitions.
DEBUG_POSTFIX
See target property <CONFIG>_POSTFIX.
This property is a special case of the more-general
<CONFIG>_POSTFIX property for the DEBUG configuration.
DEFINE_SYMBOL
Define a symbol when compiling this target's sources.
DEFINE_SYMBOL sets the name of the preprocessor symbol
defined when compiling sources in a shared library. If
not set here then it is set to target_EXPORTS by
default (with some substitutions if the target is not a
valid C identifier). This is useful for headers to know
cmake 2.8.6 Last change: June 17, 2014 105
User Commands cmake(1)
whether they are being included from inside their
library our outside to properly setup dllex-
port/dllimport decorations.
ENABLE_EXPORTS
Specify whether an executable exports symbols for load-
able modules.
Normally an executable does not export any symbols
because it is the final program. It is possible for an
executable to export symbols to be used by loadable
modules. When this property is set to true CMake will
allow other targets to "link" to the executable with
the TARGET_LINK_LIBRARIES command. On all platforms a
target-level dependency on the executable is created
for targets that link to it. For DLL platforms an
import library will be created for the exported symbols
and then used for linking. All Windows-based systems
including Cygwin are DLL platforms. For non-DLL plat-
forms that require all symbols to be resolved at link
time, such as Mac OS X, the module will "link" to the
executable using a flag like "-bundle_loader". For
other non-DLL platforms the link rule is simply ignored
since the dynamic loader will automatically bind sym-
bols when the module is loaded.
EXCLUDE_FROM_ALL
Exclude the target from the all target.
A property on a target that indicates if the target is
excluded from the default build target. If it is not,
then with a Makefile for example typing make will cause
this target to be built. The same concept applies to
the default build of other generators. Installing a
target with EXCLUDE_FROM_ALL set to true has undefined
behavior.
EchoString
A message to be displayed when the target is built.
A message to display on some generators (such as make-
files) when the target is built.
FOLDER
Set the folder name. Use to organize targets in an IDE.
Targets with no FOLDER property will appear as top
level entities in IDEs like Visual Studio. Targets with
cmake 2.8.6 Last change: June 17, 2014 106
User Commands cmake(1)
the same FOLDER property value will appear next to each
other in a folder of that name. To nest folders, use
FOLDER values such as 'GUI/Dialogs' with '/' characters
separating folder levels.
FRAMEWORK
This target is a framework on the Mac.
If a shared library target has this property set to
true it will be built as a framework when built on the
mac. It will have the directory structure required for
a framework and will be suitable to be used with the
-framework option
Fortran_FORMAT
Set to FIXED or FREE to indicate the Fortran source
layout.
This property tells CMake whether the Fortran source
files in a target use fixed-format or free-format.
CMake will pass the corresponding format flag to the
compiler. Use the source-specific Fortran_FORMAT prop-
erty to change the format of a specific source file.
If the variable CMAKE_Fortran_FORMAT is set when a tar-
get is created its value is used to initialize this
property.
Fortran_MODULE_DIRECTORY
Specify output directory for Fortran modules provided
by the target.
If the target contains Fortran source files that pro-
vide modules and the compiler supports a module output
directory this specifies the directory in which the
modules will be placed. When this property is not set
the modules will be placed in the build directory cor-
responding to the target's source directory. If the
variable CMAKE_Fortran_MODULE_DIRECTORY is set when a
target is created its value is used to initialize this
property.
GENERATOR_FILE_NAME
Generator's file for this target.
An internal property used by some generators to record
the name of project or dsp file associated with this
target.
cmake 2.8.6 Last change: June 17, 2014 107
User Commands cmake(1)
HAS_CXX
Link the target using the C++ linker tool (obsolete).
This is equivalent to setting the LINKER_LANGUAGE prop-
erty to CXX. See that property's documentation for
details.
IMPLICIT_DEPENDS_INCLUDE_TRANSFORM
Specify #include line transforms for dependencies in a
target.
This property specifies rules to transform macro-like
#include lines during implicit dependency scanning of C
and C++ source files. The list of rules must be semi-
colon-separated with each entry of the form
"A_MACRO(%)=value-with-%" (the % must be literal).
During dependency scanning occurrences of A_MACRO(...)
on #include lines will be replaced by the value given
with the macro argument substituted for '%'. For exam-
ple, the entry
MYDIR(%)=<mydir/%>
will convert lines of the form
#include MYDIR(myheader.h)
to
#include <mydir/myheader.h>
allowing the dependency to be followed.
This property applies to sources in the target on which
it is set.
IMPORTED
Read-only indication of whether a target is IMPORTED.
The boolean value of this property is true for targets
created with the IMPORTED option to add_executable or
add_library. It is false for targets built within the
project.
IMPORTED_CONFIGURATIONS
cmake 2.8.6 Last change: June 17, 2014 108
User Commands cmake(1)
Configurations provided for an IMPORTED target.
Lists configuration names available for an IMPORTED
target. The names correspond to configurations defined
in the project from which the target is imported. If
the importing project uses a different set of configu-
rations the names may be mapped using the
MAP_IMPORTED_CONFIG_<CONFIG> property. Ignored for
non-imported targets.
IMPORTED_IMPLIB
Full path to the import library for an IMPORTED target.
Specifies the location of the ".lib" part of a windows
DLL. Ignored for non-imported targets.
IMPORTED_IMPLIB_<CONFIG>
Per-configuration version of IMPORTED_IMPLIB property.
This property is used when loading settings for the
<CONFIG> configuration of an imported target. Configu-
ration names correspond to those provided by the
project from which the target is imported.
IMPORTED_LINK_DEPENDENT_LIBRARIES
Dependent shared libraries of an imported shared
library.
Shared libraries may be linked to other shared
libraries as part of their implementation. On some
platforms the linker searches for the dependent
libraries of shared libraries they are including in the
link. This property lists the dependent shared
libraries of an imported library. The list should be
disjoint from the list of interface libraries in the
IMPORTED_LINK_INTERFACE_LIBRARIES property. On plat-
forms requiring dependent shared libraries to be found
at link time CMake uses this list to add appropriate
files or paths to the link command line. Ignored for
non-imported targets.
IMPORTED_LINK_DEPENDENT_LIBRARIES_<CONFIG>
Per-configuration version of IMPORTED_LINK_DEPEN-
DENT_LIBRARIES.
This property is used when loading settings for the
<CONFIG> configuration of an imported target. Configu-
ration names correspond to those provided by the
cmake 2.8.6 Last change: June 17, 2014 109
User Commands cmake(1)
project from which the target is imported. If set,
this property completely overrides the generic property
for the named configuration.
IMPORTED_LINK_INTERFACE_LANGUAGES
Languages compiled into an IMPORTED static library.
Lists languages of soure files compiled to produce a
STATIC IMPORTED library (such as "C" or "CXX"). CMake
accounts for these languages when computing how to link
a target to the imported library. For example, when a
C executable links to an imported C++ static library
CMake chooses the C++ linker to satisfy language run-
time dependencies of the static library.
This property is ignored for targets that are not
STATIC libraries. This property is ignored for
non-imported targets.
IMPORTED_LINK_INTERFACE_LANGUAGES_<CONFIG>
Per-configuration version of IMPORTED_LINK_INTER-
FACE_LANGUAGES.
This property is used when loading settings for the
<CONFIG> configuration of an imported target. Configu-
ration names correspond to those provided by the
project from which the target is imported. If set,
this property completely overrides the generic property
for the named configuration.
IMPORTED_LINK_INTERFACE_LIBRARIES
Transitive link interface of an IMPORTED target.
Lists libraries whose interface is included when an
IMPORTED library target is linked to another target.
The libraries will be included on the link line for the
target. Unlike the LINK_INTERFACE_LIBRARIES property,
this property applies to all imported target types,
including STATIC libraries. This property is ignored
for non-imported targets.
IMPORTED_LINK_INTERFACE_LIBRARIES_<CONFIG>
Per-configuration version of IMPORTED_LINK_INTER-
FACE_LIBRARIES.
This property is used when loading settings for the
<CONFIG> configuration of an imported target.
cmake 2.8.6 Last change: June 17, 2014 110
User Commands cmake(1)
Configuration names correspond to those provided by the
project from which the target is imported. If set,
this property completely overrides the generic property
for the named configuration.
IMPORTED_LINK_INTERFACE_MULTIPLICITY
Repetition count for cycles of IMPORTED static
libraries.
This is LINK_INTERFACE_MULTIPLICITY for IMPORTED tar-
gets.
IMPORTED_LINK_INTERFACE_MULTIPLICITY_<CONFIG>
Per-configuration repetition count for cycles of
IMPORTED archives.
This is the configuration-specific version of
IMPORTED_LINK_INTERFACE_MULTIPLICITY. If set, this
property completely overrides the generic property for
the named configuration.
IMPORTED_LOCATION
Full path to the main file on disk for an IMPORTED tar-
get.
Specifies the location of an IMPORTED target file on
disk. For executables this is the location of the exe-
cutable file. For bundles on OS X this is the location
of the executable file inside Contents/MacOS under the
application bundle folder. For static libraries and
modules this is the location of the library or module.
For shared libraries on non-DLL platforms this is the
location of the shared library. For frameworks on OS X
this is the location of the library file symlink just
inside the framework folder. For DLLs this is the
location of the ".dll" part of the library. For
UNKNOWN libraries this is the location of the file to
be linked. Ignored for non-imported targets.
IMPORTED_LOCATION_<CONFIG>
Per-configuration version of IMPORTED_LOCATION prop-
erty.
This property is used when loading settings for the
<CONFIG> configuration of an imported target. Configu-
ration names correspond to those provided by the
project from which the target is imported.
cmake 2.8.6 Last change: June 17, 2014 111
User Commands cmake(1)
IMPORTED_NO_SONAME
Specifies that an IMPORTED shared library target has no
"soname".
Set this property to true for an imported shared
library file that has no "soname" field. CMake may
adjust generated link commands for some platforms to
prevent the linker from using the path to the library
in place of its missing soname. Ignored for
non-imported targets.
IMPORTED_NO_SONAME_<CONFIG>
Per-configuration version of IMPORTED_NO_SONAME prop-
erty.
This property is used when loading settings for the
<CONFIG> configuration of an imported target. Configu-
ration names correspond to those provided by the
project from which the target is imported.
IMPORTED_SONAME
The "soname" of an IMPORTED target of shared library
type.
Specifies the "soname" embedded in an imported shared
library. This is meaningful only on platforms support-
ing the feature. Ignored for non-imported targets.
IMPORTED_SONAME_<CONFIG>
Per-configuration version of IMPORTED_SONAME property.
This property is used when loading settings for the
<CONFIG> configuration of an imported target. Configu-
ration names correspond to those provided by the
project from which the target is imported.
IMPORT_PREFIX
What comes before the import library name.
Similar to the target property PREFIX, but used for
import libraries (typically corresponding to a DLL)
instead of regular libraries. A target property that
can be set to override the prefix (such as "lib") on an
import library name.
IMPORT_SUFFIX
What comes after the import library name.
cmake 2.8.6 Last change: June 17, 2014 112
User Commands cmake(1)
Similar to the target property SUFFIX, but used for
import libraries (typically corresponding to a DLL)
instead of regular libraries. A target property that
can be set to override the suffix (such as ".lib") on
an import library name.
INSTALL_NAME_DIR
Mac OSX directory name for installed targets.
INSTALL_NAME_DIR is a string specifying the directory
portion of the "install_name" field of shared libraries
on Mac OSX to use in the installed targets.
INSTALL_RPATH
The rpath to use for installed targets.
A semicolon-separated list specifying the rpath to use
in installed targets (for platforms that support it).
This property is initialized by the value of the vari-
able CMAKE_INSTALL_RPATH if it is set when a target is
created.
INSTALL_RPATH_USE_LINK_PATH
Add paths to linker search and installed rpath.
INSTALL_RPATH_USE_LINK_PATH is a boolean that if set to
true will append directories in the linker search path
and outside the project to the INSTALL_RPATH. This
property is initialized by the value of the variable
CMAKE_INSTALL_RPATH_USE_LINK_PATH if it is set when a
target is created.
INTERPROCEDURAL_OPTIMIZATION
Enable interprocedural optimization for a target.
If set to true, enables interprocedural optimizations
if they are known to be supported by the compiler.
INTERPROCEDURAL_OPTIMIZATION_<CONFIG>
Per-configuration interprocedural optimization for a
target.
This is a per-configuration version of INTERPROCEDU-
RAL_OPTIMIZATION. If set, this property overrides the
generic property for the named configuration.
cmake 2.8.6 Last change: June 17, 2014 113
User Commands cmake(1)
LABELS
Specify a list of text labels associated with a target.
Target label semantics are currently unspecified.
LIBRARY_OUTPUT_DIRECTORY
Output directory in which to build LIBRARY target
files.
This property specifies the directory into which
library target files should be built. Multi-configura-
tion generators (VS, Xcode) append a per-configuration
subdirectory to the specified directory. There are
three kinds of target files that may be built: archive,
library, and runtime. Executables are always treated
as runtime targets. Static libraries are always treated
as archive targets. Module libraries are always treated
as library targets. For non-DLL platforms shared
libraries are treated as library targets. For DLL plat-
forms the DLL part of a shared library is treated as a
runtime target and the corresponding import library is
treated as an archive target. All Windows-based systems
including Cygwin are DLL platforms. This property is
initialized by the value of the variable
CMAKE_LIBRARY_OUTPUT_DIRECTORY if it is set when a tar-
get is created.
LIBRARY_OUTPUT_DIRECTORY_<CONFIG>
Per-configuration output directory for LIBRARY target
files.
This is a per-configuration version of LIBRARY_OUT-
PUT_DIRECTORY, but multi-configuration generators (VS,
Xcode) do NOT append a per-configuration subdirectory
to the specified directory. This property is initial-
ized by the value of the variable CMAKE_LIBRARY_OUT-
PUT_DIRECTORY_<CONFIG> if it is set when a target is
created.
LIBRARY_OUTPUT_NAME
Output name for LIBRARY target files.
This property specifies the base name for library tar-
get files. It overrides OUTPUT_NAME and OUT-
PUT_NAME_<CONFIG> properties. There are three kinds of
target files that may be built: archive, library, and
runtime. Executables are always treated as runtime
targets. Static libraries are always treated as archive
targets. Module libraries are always treated as library
cmake 2.8.6 Last change: June 17, 2014 114
User Commands cmake(1)
targets. For non-DLL platforms shared libraries are
treated as library targets. For DLL platforms the DLL
part of a shared library is treated as a runtime target
and the corresponding import library is treated as an
archive target. All Windows-based systems including
Cygwin are DLL platforms.
LIBRARY_OUTPUT_NAME_<CONFIG>
Per-configuration output name for LIBRARY target files.
This is the configuration-specific version of
LIBRARY_OUTPUT_NAME.
LINKER_LANGUAGE
Specifies language whose compiler will invoke the
linker.
For executables, shared libraries, and modules, this
sets the language whose compiler is used to link the
target (such as "C" or "CXX"). A typical value for an
executable is the language of the source file providing
the program entry point (main). If not set, the lan-
guage with the highest linker preference value is the
default. See documentation of
CMAKE_<LANG>_LINKER_PREFERENCE variables.
LINK_DEPENDS
Additional files on which a target binary depends for
linking.
Specifies a semicolon-separated list of full-paths to
files on which the link rule for this target depends.
The target binary will be linked if any of the named
files is newer than it.
This property is ignored by non-Makefile generators.
It is intended to specify dependencies on "linker
scripts" for custom Makefile link rules.
LINK_FLAGS
Additional flags to use when linking this target.
The LINK_FLAGS property can be used to add extra flags
to the link step of a target. LINK_FLAGS_<CONFIG> will
add to the configuration <CONFIG>, for example, DEBUG,
RELEASE, MINSIZEREL, RELWITHDEBINFO.
cmake 2.8.6 Last change: June 17, 2014 115
User Commands cmake(1)
LINK_FLAGS_<CONFIG>
Per-configuration linker flags for a target.
This is the configuration-specific version of
LINK_FLAGS.
LINK_INTERFACE_LIBRARIES
List public interface libraries for a shared library or
executable.
By default linking to a shared library target transi-
tively links to targets with which the library itself
was linked. For an executable with exports (see the
ENABLE_EXPORTS property) no default transitive link
dependencies are used. This property replaces the
default transitive link dependencies with an explicit
list. When the target is linked into another target
the libraries listed (and recursively their link inter-
face libraries) will be provided to the other target
also. If the list is empty then no transitive link
dependencies will be incorporated when this target is
linked into another target even if the default set is
non-empty. This property is ignored for STATIC
libraries.
LINK_INTERFACE_LIBRARIES_<CONFIG>
Per-configuration list of public interface libraries
for a target.
This is the configuration-specific version of
LINK_INTERFACE_LIBRARIES. If set, this property com-
pletely overrides the generic property for the named
configuration.
LINK_INTERFACE_MULTIPLICITY
Repetition count for STATIC libraries with cyclic
dependencies.
When linking to a STATIC library target with cyclic
dependencies the linker may need to scan more than once
through the archives in the strongly connected compo-
nent of the dependency graph. CMake by default con-
structs the link line so that the linker will scan
through the component at least twice. This property
specifies the minimum number of scans if it is larger
than the default. CMake uses the largest value speci-
fied by any target in a component.
cmake 2.8.6 Last change: June 17, 2014 116
User Commands cmake(1)
LINK_INTERFACE_MULTIPLICITY_<CONFIG>
Per-configuration repetition count for cycles of STATIC
libraries.
This is the configuration-specific version of
LINK_INTERFACE_MULTIPLICITY. If set, this property
completely overrides the generic property for the named
configuration.
LINK_SEARCH_END_STATIC
End a link line such that static system libraries are
used.
Some linkers support switches such as -Bstatic and
-Bdynamic to determine whether to use static or shared
libraries for -lXXX options. CMake uses these options
to set the link type for libraries whose full paths are
not known or (in some cases) are in implicit link
directories for the platform. By default CMake adds an
option at the end of the library list (if necessary) to
set the linker search type back to its starting type.
This property switches the final linker search type to
-Bstatic regardless of how it started. See also
LINK_SEARCH_START_STATIC.
LINK_SEARCH_START_STATIC
Assume the linker looks for static libraries by
default.
Some linkers support switches such as -Bstatic and
-Bdynamic to determine whether to use static or shared
libraries for -lXXX options. CMake uses these options
to set the link type for libraries whose full paths are
not known or (in some cases) are in implicit link
directories for the platform. By default the linker
search type is assumed to be -Bdynamic at the beginning
of the library list. This property switches the
assumption to -Bstatic. It is intended for use when
linking an executable statically (e.g. with the GNU
-static option). See also LINK_SEARCH_END_STATIC.
LOCATION
Read-only location of a target on disk.
For an imported target, this read-only property returns
the value of the LOCATION_<CONFIG> property for an
unspecified configuration <CONFIG> provided by the tar-
get.
cmake 2.8.6 Last change: June 17, 2014 117
User Commands cmake(1)
For a non-imported target, this property is provided
for compatibility with CMake 2.4 and below. It was
meant to get the location of an executable target's
output file for use in add_custom_command. The path
may contain a build-system-specific portion that is
replaced at build time with the configuration getting
built (such as "$(ConfigurationName)" in VS). In CMake
2.6 and above add_custom_command automatically recog-
nizes a target name in its COMMAND and DEPENDS options
and computes the target location. In CMake 2.8.4 and
above add_custom_command recognizes generator expres-
sions to refer to target locations anywhere in the com-
mand. Therefore this property is not needed for creat-
ing custom commands.
Do not set properties that affect the location of the
target after reading this property. These include
properties whose names match "(RUNTIME|LIBRARY|AR-
CHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?" or
"(IMPLIB_)?(PREFIX|SUFFIX)". Failure to follow this
rule is not diagnosed and leaves the location of the
target undefined.
LOCATION_<CONFIG>
Read-only property providing a target location on disk.
A read-only property that indicates where a target's
main file is located on disk for the configuration
<CONFIG>. The property is defined only for library and
executable targets. An imported target may provide a
set of configurations different from that of the
importing project. By default CMake looks for an
exact-match but otherwise uses an arbitrary available
configuration. Use the MAP_IMPORTED_CONFIG_<CONFIG>
property to map imported configurations explicitly.
Do not set properties that affect the location of the
target after reading this property. These include
properties whose names match "(RUNTIME|LIBRARY|AR-
CHIVE)_OUTPUT_(NAME|DIRECTORY)(_<CONFIG>)?" or
"(IMPLIB_)?(PREFIX|SUFFIX)". Failure to follow this
rule is not diagnosed and leaves the location of the
target undefined.
MACOSX_BUNDLE
Build an executable as an application bundle on Mac OS
X.
cmake 2.8.6 Last change: June 17, 2014 118
User Commands cmake(1)
When this property is set to true the executable when
built on Mac OS X will be created as an application
bundle. This makes it a GUI executable that can be
launched from the Finder. See the MACOSX_BUN-
DLE_INFO_PLIST target property for information about
creation of the Info.plist file for the application
bundle.
MACOSX_BUNDLE_INFO_PLIST
Specify a custom Info.plist template for a Mac OS X App
Bundle.
An executable target with MACOSX_BUNDLE enabled will be
built as an application bundle on Mac OS X. By default
its Info.plist file is created by configuring a tem-
plate called MacOSXBundleInfo.plist.in located in the
CMAKE_MODULE_PATH. This property specifies an alterna-
tive template file name which may be a full path.
The following target properties may be set to specify
content to be configured into the file:
MACOSX_BUNDLE_INFO_STRING
MACOSX_BUNDLE_ICON_FILE
MACOSX_BUNDLE_GUI_IDENTIFIER
MACOSX_BUNDLE_LONG_VERSION_STRING
MACOSX_BUNDLE_BUNDLE_NAME
MACOSX_BUNDLE_SHORT_VERSION_STRING
MACOSX_BUNDLE_BUNDLE_VERSION
MACOSX_BUNDLE_COPYRIGHT
CMake variables of the same name may be set to affect
all targets in a directory that do not have each spe-
cific property set. If a custom Info.plist is speci-
fied by this property it may of course hard-code all
the settings instead of using the target properties.
MACOSX_FRAMEWORK_INFO_PLIST
Specify a custom Info.plist template for a Mac OS X
Framework.
An library target with FRAMEWORK enabled will be built
as a framework on Mac OS X. By default its Info.plist
file is created by configuring a template called
MacOSXFrameworkInfo.plist.in located in the CMAKE_MOD-
ULE_PATH. This property specifies an alternative tem-
plate file name which may be a full path.
cmake 2.8.6 Last change: June 17, 2014 119
User Commands cmake(1)
The following target properties may be set to specify
content to be configured into the file:
MACOSX_FRAMEWORK_ICON_FILE
MACOSX_FRAMEWORK_IDENTIFIER
MACOSX_FRAMEWORK_SHORT_VERSION_STRING
MACOSX_FRAMEWORK_BUNDLE_VERSION
CMake variables of the same name may be set to affect
all targets in a directory that do not have each spe-
cific property set. If a custom Info.plist is speci-
fied by this property it may of course hard-code all
the settings instead of using the target properties.
MAP_IMPORTED_CONFIG_<CONFIG>
Map from project configuration to IMPORTED target's
configuration.
List configurations of an imported target that may be
used for the current project's <CONFIG> configuration.
Targets imported from another project may not provide
the same set of configuration names available in the
current project. Setting this property tells CMake
what imported configurations are suitable for use when
building the <CONFIG> configuration. The first config-
uration in the list found to be provided by the
imported target is selected. If no matching configura-
tions are available the imported target is considered
to be not found. This property is ignored for
non-imported targets.
OSX_ARCHITECTURES
Target specific architectures for OS X.
The OSX_ARCHITECTURES property sets the target binary
architecture for targets on OS X. This property is
initialized by the value of the variable
CMAKE_OSX_ARCHITECTURES if it is set when a target is
created. Use OSX_ARCHITECTURES_<CONFIG> to set the
binary architectures on a per-configuration basis.
<CONFIG> is an upper-case name (ex: "OSX_ARCHITEC-
TURES_DEBUG").
OSX_ARCHITECTURES_<CONFIG>
Per-configuration OS X binary architectures for a tar-
get.
This property is the configuration-specific version of
cmake 2.8.6 Last change: June 17, 2014 120
User Commands cmake(1)
OSX_ARCHITECTURES.
OUTPUT_NAME
Output name for target files.
This sets the base name for output files created for an
executable or library target. If not set, the logical
target name is used by default.
OUTPUT_NAME_<CONFIG>
Per-configuration target file base name.
This is the configuration-specific version of OUT-
PUT_NAME.
POST_INSTALL_SCRIPT
Deprecated install support.
The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT proper-
ties are the old way to specify CMake scripts to run
before and after installing a target. They are used
only when the old INSTALL_TARGETS command is used to
install the target. Use the INSTALL command instead.
PREFIX
What comes before the library name.
A target property that can be set to override the pre-
fix (such as "lib") on a library name.
PRE_INSTALL_SCRIPT
Deprecated install support.
The PRE_INSTALL_SCRIPT and POST_INSTALL_SCRIPT proper-
ties are the old way to specify CMake scripts to run
before and after installing a target. They are used
only when the old INSTALL_TARGETS command is used to
install the target. Use the INSTALL command instead.
PRIVATE_HEADER
Specify private header files in a FRAMEWORK shared
library target.
Shared library targets marked with the FRAMEWORK prop-
erty generate frameworks on OS X and normal shared
libraries on other platforms. This property may be set
cmake 2.8.6 Last change: June 17, 2014 121
User Commands cmake(1)
to a list of header files to be placed in the Private-
Headers directory inside the framework folder. On
non-Apple platforms these headers may be installed
using the PRIVATE_HEADER option to the install(TARGETS)
command.
PROJECT_LABEL
Change the name of a target in an IDE.
Can be used to change the name of the target in an IDE
like Visual Studio.
PUBLIC_HEADER
Specify public header files in a FRAMEWORK shared
library target.
Shared library targets marked with the FRAMEWORK prop-
erty generate frameworks on OS X and normal shared
libraries on other platforms. This property may be set
to a list of header files to be placed in the Headers
directory inside the framework folder. On non-Apple
platforms these headers may be installed using the PUB-
LIC_HEADER option to the install(TARGETS) command.
RESOURCE
Specify resource files in a FRAMEWORK shared library
target.
Shared library targets marked with the FRAMEWORK prop-
erty generate frameworks on OS X and normal shared
libraries on other platforms. This property may be set
to a list of files to be placed in the Resources direc-
tory inside the framework folder. On non-Apple plat-
forms these files may be installed using the RESOURCE
option to the install(TARGETS) command.
RULE_LAUNCH_COMPILE
Specify a launcher for compile rules.
See the global property of the same name for details.
This overrides the global and directory property for a
target.
RULE_LAUNCH_CUSTOM
Specify a launcher for custom rules.
See the global property of the same name for details.
cmake 2.8.6 Last change: June 17, 2014 122
User Commands cmake(1)
This overrides the global and directory property for a
target.
RULE_LAUNCH_LINK
Specify a launcher for link rules.
See the global property of the same name for details.
This overrides the global and directory property for a
target.
RUNTIME_OUTPUT_DIRECTORY
Output directory in which to build RUNTIME target
files.
This property specifies the directory into which run-
time target files should be built. Multi-configuration
generators (VS, Xcode) append a per-configuration sub-
directory to the specified directory. There are three
kinds of target files that may be built: archive,
library, and runtime. Executables are always treated
as runtime targets. Static libraries are always treated
as archive targets. Module libraries are always treated
as library targets. For non-DLL platforms shared
libraries are treated as library targets. For DLL plat-
forms the DLL part of a shared library is treated as a
runtime target and the corresponding import library is
treated as an archive target. All Windows-based systems
including Cygwin are DLL platforms. This property is
initialized by the value of the variable CMAKE_RUN-
TIME_OUTPUT_DIRECTORY if it is set when a target is
created.
RUNTIME_OUTPUT_DIRECTORY_<CONFIG>
Per-configuration output directory for RUNTIME target
files.
This is a per-configuration version of RUNTIME_OUT-
PUT_DIRECTORY, but multi-configuration generators (VS,
Xcode) do NOT append a per-configuration subdirectory
to the specified directory. This property is initial-
ized by the value of the variable CMAKE_RUNTIME_OUT-
PUT_DIRECTORY_<CONFIG> if it is set when a target is
created.
RUNTIME_OUTPUT_NAME
Output name for RUNTIME target files.
This property specifies the base name for runtime
cmake 2.8.6 Last change: June 17, 2014 123
User Commands cmake(1)
target files. It overrides OUTPUT_NAME and OUT-
PUT_NAME_<CONFIG> properties. There are three kinds of
target files that may be built: archive, library, and
runtime. Executables are always treated as runtime
targets. Static libraries are always treated as archive
targets. Module libraries are always treated as library
targets. For non-DLL platforms shared libraries are
treated as library targets. For DLL platforms the DLL
part of a shared library is treated as a runtime target
and the corresponding import library is treated as an
archive target. All Windows-based systems including
Cygwin are DLL platforms.
RUNTIME_OUTPUT_NAME_<CONFIG>
Per-configuration output name for RUNTIME target files.
This is the configuration-specific version of RUN-
TIME_OUTPUT_NAME.
SKIP_BUILD_RPATH
Should rpaths be used for the build tree.
SKIP_BUILD_RPATH is a boolean specifying whether to
skip automatic generation of an rpath allowing the tar-
get to run from the build tree. This property is ini-
tialized by the value of the variable
CMAKE_SKIP_BUILD_RPATH if it is set when a target is
created.
SOURCES
Source names specified for a target.
Read-only list of sources specified for a target. The
names returned are suitable for passing to the
set_source_files_properties command.
SOVERSION
What version number is this target.
For shared libraries VERSION and SOVERSION can be used
to specify the build version and api version respec-
tively. When building or installing appropriate sym-
links are created if the platform supports symlinks and
the linker supports so-names. If only one of both is
specified the missing is assumed to have the same ver-
sion number. For shared libraries and executables on
Windows the VERSION attribute is parsed to extract a
"major.minor" version number. These numbers are used as
cmake 2.8.6 Last change: June 17, 2014 124
User Commands cmake(1)
the image version of the binary.
STATIC_LIBRARY_FLAGS
Extra flags to use when linking static libraries.
Extra flags to use when linking a static library.
STATIC_LIBRARY_FLAGS_<CONFIG>
Per-configuration flags for creating a static library.
This is the configuration-specific version of
STATIC_LIBRARY_FLAGS.
SUFFIX
What comes after the library name.
A target property that can be set to override the suf-
fix (such as ".so") on a library name.
TYPE The type of the target.
This read-only property can be used to test the type of
the given target. It will be one of STATIC_LIBRARY,
MODULE_LIBRARY, SHARED_LIBRARY, EXECUTABLE or one of
the internal target types.
VERSION
What version number is this target.
For shared libraries VERSION and SOVERSION can be used
to specify the build version and api version respec-
tively. When building or installing appropriate sym-
links are created if the platform supports symlinks and
the linker supports so-names. If only one of both is
specified the missing is assumed to have the same ver-
sion number. For executables VERSION can be used to
specify the build version. When building or installing
appropriate symlinks are created if the platform sup-
ports symlinks. For shared libraries and executables on
Windows the VERSION attribute is parsed to extract a
"major.minor" version number. These numbers are used as
the image version of the binary.
VS_GLOBAL_<variable>
Visual Studio project-specific global variable.
cmake 2.8.6 Last change: June 17, 2014 125
User Commands cmake(1)
Tell the Visual Studio generator to set the global
variable '<variable>' to a given value in the generated
Visual Studio project. Ignored on other generators. Qt
integration works better if VS_GLOBAL_QtVersion is set
to the version FindQt4.cmake found. For example,
"4.7.3"
VS_KEYWORD
Visual Studio project keyword.
Can be set to change the visual studio keyword, for
example QT integration works better if this is set to
Qt4VSv1.0.
VS_SCC_LOCALPATH
Visual Studio Source Code Control Provider.
Can be set to change the visual studio source code con-
trol local path property.
VS_SCC_PROJECTNAME
Visual Studio Source Code Control Project.
Can be set to change the visual studio source code con-
trol project name property.
VS_SCC_PROVIDER
Visual Studio Source Code Control Provider.
Can be set to change the visual studio source code con-
trol provider property.
WIN32_EXECUTABLE
Build an executable with a WinMain entry point on win-
dows.
When this property is set to true the executable when
linked on Windows will be created with a WinMain()
entry point instead of of just main().This makes it a
GUI executable instead of a console application. See
the CMAKE_MFC_FLAG variable documentation to configure
use of MFC for WinMain executables.
XCODE_ATTRIBUTE_<an-attribute>
Set Xcode target attributes directly.
cmake 2.8.6 Last change: June 17, 2014 126
User Commands cmake(1)
Tell the Xcode generator to set '<an-attribute>' to a
given value in the generated Xcode project. Ignored on
other generators.
PROPERTIES ON TESTS
ATTACHED_FILES
Attach a list of files to a dashboard submission.
Set this property to a list of files that will be
encoded and submitted to the dashboard as an addition
to the test result.
ATTACHED_FILES_ON_FAIL
Attach a list of files to a dashboard submission if the
test fails.
Same as ATTACHED_FILES, but these files will only be
included if the test does not pass.
COST Set this to a floating point value. Tests in a test set
will be run in descending order of cost.
This property describes the cost of a test. You can
explicitly set this value; tests with higher COST val-
ues will run first.
DEPENDS
Specifies that this test should only be run after the
specified list of tests.
Set this to a list of tests that must finish before
this test is run.
ENVIRONMENT
Specify environment variables that should be defined
for running a test.
If set to a list of environment variables and values of
the form MYVAR=value those environment variables will
be defined while running the test. The environment is
restored to its previous state after the test is done.
FAIL_REGULAR_EXPRESSION
If the output matches this regular expression the test
will fail.
cmake 2.8.6 Last change: June 17, 2014 127
User Commands cmake(1)
If set, if the output matches one of specified regular
expressions, the test will fail.For example: PASS_REGU-
LAR_EXPRESSION "[^a-z]Error;ERROR;Failed"
LABELS
Specify a list of text labels associated with a test.
The list is reported in dashboard submissions.
MEASUREMENT
Specify a CDASH measurement and value to be reported
for a test.
If set to a name then that name will be reported to
CDASH as a named measurement with a value of 1. You may
also specify a value by setting MEASUREMENT to "mea-
surement=value".
PASS_REGULAR_EXPRESSION
The output must match this regular expression for the
test to pass.
If set, the test output will be checked against the
specified regular expressions and at least one of the
regular expressions has to match, otherwise the test
will fail.
PROCESSORS
How many process slots this test requires
Denotes the number of processors that this test will
require. This is typically used for MPI tests, and
should be used in conjunction with the ctest_test PAR-
ALLEL_LEVEL option.
REQUIRED_FILES
List of files required to run the test.
If set to a list of files, the test will not be run
unless all of the files exist.
RESOURCE_LOCK
Specify a list of resources that are locked by this
test.
If multiple tests specify the same resource lock, they
cmake 2.8.6 Last change: June 17, 2014 128
User Commands cmake(1)
are guaranteed not to run concurrently.
RUN_SERIAL
Do not run this test in parallel with any other test.
Use this option in conjunction with the ctest_test PAR-
ALLEL_LEVEL option to specify that this test should not
be run in parallel with any other tests.
TIMEOUT
How many seconds to allow for this test.
This property if set will limit a test to not take more
than the specified number of seconds to run. If it
exceeds that the test process will be killed and ctest
will move to the next test. This setting takes prece-
dence over CTEST_TESTING_TIMEOUT.
WILL_FAIL
If set to true, this will invert the pass/fail flag of
the test.
This property can be used for tests that are expected
to fail and return a non zero return code.
WORKING_DIRECTORY
The directory from which the test executable will be
called.
If this is not set it is called from the directory the
test executable is located in.
PROPERTIES ON SOURCE FILES
ABSTRACT
Is this source file an abstract class.
A property on a source file that indicates if the
source file represents a class that is abstract. This
only makes sense for languages that have a notion of an
abstract class and it is only used by some tools that
wrap classes into other languages.
COMPILE_DEFINITIONS
Preprocessor definitions for compiling a source file.
The COMPILE_DEFINITIONS property may be set to a
cmake 2.8.6 Last change: June 17, 2014 129
User Commands cmake(1)
semicolon-separated list of preprocessor definitions
using the syntax VAR or VAR=value. Function-style def-
initions are not supported. CMake will automatically
escape the value correctly for the native build system
(note that CMake language syntax may require escapes to
specify some values). This property may be set on a
per-configuration basis using the name COMPILE_DEFINI-
TIONS_<CONFIG> where <CONFIG> is an upper-case name
(ex. "COMPILE_DEFINITIONS_DEBUG").
CMake will automatically drop some definitions that are
not supported by the native build tool. The VS6 IDE
does not support definition values with spaces (but
NMake does). Xcode does not support per-configuration
definitions on source files.
Disclaimer: Most native build tools have poor support
for escaping certain values. CMake has work-arounds
for many cases but some values may just not be possible
to pass correctly. If a value does not seem to be
escaped correctly, do not attempt to work-around the
problem by adding escape sequences to the value. Your
work-around may break in a future version of CMake that
has improved escape support. Instead consider defining
the macro in a (configured) header file. Then report
the limitation. Known limitations include:
# - broken almost everywhere
; - broken in VS IDE and Borland Makefiles
, - broken in VS IDE
% - broken in some cases in NMake
& | - broken in some cases on MinGW
^ < > \" - broken in most Make tools on Windows
CMake does not reject these values outright because
they do work in some cases. Use with caution.
COMPILE_DEFINITIONS_<CONFIG>
Per-configuration preprocessor definitions on a source
file.
This is the configuration-specific version of COM-
PILE_DEFINITIONS. Note that Xcode does not support
per-configuration source file flags so this property
will be ignored by the Xcode generator.
COMPILE_FLAGS
cmake 2.8.6 Last change: June 17, 2014 130
User Commands cmake(1)
Additional flags to be added when compiling this source
file.
These flags will be added to the list of compile flags
when this source file builds. Use COMPILE_DEFINITIONS
to pass additional preprocessor definitions.
EXTERNAL_OBJECT
If set to true then this is an object file.
If this property is set to true then the source file is
really an object file and should not be compiled. It
will still be linked into the target though.
Fortran_FORMAT
Set to FIXED or FREE to indicate the Fortran source
layout.
This property tells CMake whether a given Fortran
source file uses fixed-format or free-format. CMake
will pass the corresponding format flag to the com-
piler. Consider using the target-wide Fortran_FORMAT
property if all source files in a target share the same
format.
GENERATED
Is this source file generated as part of the build
process.
If a source file is generated by the build process
CMake will handle it differently in terms of dependency
checking etc. Otherwise having a non-existent source
file could create problems.
HEADER_FILE_ONLY
Is this source file only a header file.
A property on a source file that indicates if the
source file is a header file with no associated imple-
mentation. This is set automatically based on the file
extension and is used by CMake to determine is certain
dependency information should be computed.
KEEP_EXTENSION
Make the output file have the same extension as the
source file.
cmake 2.8.6 Last change: June 17, 2014 131
User Commands cmake(1)
If this property is set then the file extension of the
output file will be the same as that of the source
file. Normally the output file extension is computed
based on the language of the source file, for example
.cxx will go to a .o extension.
LABELS
Specify a list of text labels associated with a source
file.
This property has meaning only when the source file is
listed in a target whose LABELS property is also set.
No other semantics are currently specified.
LANGUAGE
What programming language is the file.
A property that can be set to indicate what programming
language the source file is. If it is not set the lan-
guage is determined based on the file extension. Typi-
cal values are CXX C etc. Setting this property for a
file means this file will be compiled. Do not set this
for header or files that should not be compiled.
LOCATION
The full path to a source file.
A read only property on a SOURCE FILE that contains the
full path to the source file.
MACOSX_PACKAGE_LOCATION
Place a source file inside a Mac OS X bundle, CFBundle,
or framework.
Executable targets with the MACOSX_BUNDLE property set
are built as Mac OS X application bundles on Apple
platforms. Shared library targets with the FRAMEWORK
property set are built as Mac OS X frameworks on Apple
platforms. Module library targets with the BUNDLE
property set are built as Mac OS X CFBundle bundles on
Apple platforms. Source files listed in the target
with this property set will be copied to a directory
inside the bundle or framework content folder specified
by the property value. For bundles the content folder
is "<name>.app/Contents". For frameworks the content
folder is "<name>.framework/Versions/<version>". For
cfbundles the content folder is "<name>.bundle/Con-
tents" (unless the extension is changed). See the
cmake 2.8.6 Last change: June 17, 2014 132
User Commands cmake(1)
PUBLIC_HEADER, PRIVATE_HEADER, and RESOURCE target
properties for specifying files meant for Headers, Pri-
vateHeaders, or Resources directories.
OBJECT_DEPENDS
Additional files on which a compiled object file
depends.
Specifies a semicolon-separated list of full-paths to
files on which any object files compiled from this
source file depend. An object file will be recompiled
if any of the named files is newer than it.
This property need not be used to specify the depen-
dency of a source file on a generated header file that
it includes. Although the property was originally
introduced for this purpose, it is no longer necessary.
If the generated header file is created by a custom
command in the same target as the source file, the
automatic dependency scanning process will recognize
the dependency. If the generated header file is cre-
ated by another target, an inter-target dependency
should be created with the add_dependencies command (if
one does not already exist due to linking relation-
ships).
OBJECT_OUTPUTS
Additional outputs for a Makefile rule.
Additional outputs created by compilation of this
source file. If any of these outputs is missing the
object will be recompiled. This is supported only on
Makefile generators and will be ignored on other gener-
ators.
SYMBOLIC
Is this just a name for a rule.
If SYMBOLIC (boolean) is set to true the build system
will be informed that the source file is not actually
created on disk but instead used as a symbolic name for
a build rule.
WRAP_EXCLUDE
Exclude this source file from any code wrapping tech-
niques.
cmake 2.8.6 Last change: June 17, 2014 133
User Commands cmake(1)
Some packages can wrap source files into alternate lan-
guages to provide additional functionality. For exam-
ple, C++ code can be wrapped into Java or Python etc
using SWIG etc. If WRAP_EXCLUDE is set to true (1 etc)
that indicates then this source file should not be
wrapped.
PROPERTIES ON CACHE ENTRIES
ADVANCED
True if entry should be hidden by default in GUIs.
This is a boolean value indicating whether the entry is
considered interesting only for advanced configuration.
The mark_as_advanced() command modifies this property.
HELPSTRING
Help associated with entry in GUIs.
This string summarizes the purpose of an entry to help
users set it through a CMake GUI.
MODIFIED
Internal management property. Do not set or get.
This is an internal cache entry property managed by
CMake to track interactive user modification of
entries. Ignore it.
STRINGS
Enumerate possible STRING entry values for GUI selec-
tion.
For cache entries with type STRING, this enumerates a
set of values. CMake GUIs may use this to provide a
selection widget instead of a generic string entry
field. This is for convenience only. CMake does not
enforce that the value matches one of those listed.
TYPE Widget type for entry in GUIs.
Cache entry values are always strings, but CMake GUIs
present widgets to help users set values. The GUIs use
this property as a hint to determine the widget type.
Valid TYPE values are:
BOOL = Boolean ON/OFF value.
cmake 2.8.6 Last change: June 17, 2014 134
User Commands cmake(1)
PATH = Path to a directory.
FILEPATH = Path to a file.
STRING = Generic string value.
INTERNAL = Do not present in GUI at all.
STATIC = Value managed by CMake, do not change.
UNINITIALIZED = Type not yet specified.
Generally the TYPE of a cache entry should be set by
the command which creates it (set, option,
find_library, etc.).
VALUE
Value of a cache entry.
This property maps to the actual value of a cache
entry. Setting this property always sets the value
without checking, so use with care.
COMPATIBILITY COMMANDS
CMake Compatibility Listfile Commands - Obsolete commands supported by CMake for compatibility.
This is the documentation for now obsolete listfile commands
from previous CMake versions, which are still supported for
compatibility reasons. You should instead use the newer,
faster and shinier new commands. ;-)
build_name
Deprecated. Use ${CMAKE_SYSTEM} and ${CMAKE_CXX_COM-
PILER} instead.
build_name(variable)
Sets the specified variable to a string representing
the platform and compiler settings. These values are
now available through the CMAKE_SYSTEM and
CMAKE_CXX_COMPILER variables.
exec_program
Deprecated. Use the execute_process() command instead.
Run an executable program during the processing of the
CMakeList.txt file.
exec_program(Executable [directory in which to run]
[ARGS <arguments to executable>]
[OUTPUT_VARIABLE <var>]
cmake 2.8.6 Last change: June 17, 2014 135
User Commands cmake(1)
[RETURN_VALUE <var>])
The executable is run in the optionally specified
directory. The executable can include arguments if it
is double quoted, but it is better to use the optional
ARGS argument to specify arguments to the program.
This is because cmake will then be able to escape spa-
ces in the executable path. An optional argument OUT-
PUT_VARIABLE specifies a variable in which to store the
output. To capture the return value of the execution,
provide a RETURN_VALUE. If OUTPUT_VARIABLE is speci-
fied, then no output will go to the stdout/stderr of
the console running cmake.
export_library_dependencies
Deprecated. Use INSTALL(EXPORT) or EXPORT command.
This command generates an old-style library dependen-
cies file. Projects requiring CMake 2.6 or later
should not use the command. Use instead the
install(EXPORT) command to help export targets from an
installation tree and the export() command to export
targets from a build tree.
The old-style library dependencies file does not take
into account per-configuration names of libraries or
the LINK_INTERFACE_LIBRARIES target property.
export_library_dependencies(<file> [APPEND])
Create a file named <file> that can be included into a
CMake listfile with the INCLUDE command. The file will
contain a number of SET commands that will set all the
variables needed for library dependency information.
This should be the last command in the top level CMake-
Lists.txt file of the project. If the APPEND option is
specified, the SET commands will be appended to the
given file instead of replacing it.
install_files
Deprecated. Use the install(FILES ) command instead.
This command has been superceded by the install com-
mand. It is provided for compatibility with older
CMake code. The FILES form is directly replaced by the
FILES form of the install command. The regexp form can
be expressed more clearly using the GLOB form of the
cmake 2.8.6 Last change: June 17, 2014 136
User Commands cmake(1)
file command.
install_files(<dir> extension file file ...)
Create rules to install the listed files with the given
extension into the given directory. Only files exist-
ing in the current source tree or its corresponding
location in the binary tree may be listed. If a file
specified already has an extension, that extension will
be removed first. This is useful for providing lists
of source files such as foo.cxx when you want the cor-
responding foo.h to be installed. A typical extension
is '.h'.
install_files(<dir> regexp)
Any files in the current source directory that match
the regular expression will be installed.
install_files(<dir> FILES file file ...)
Any files listed after the FILES keyword will be
installed explicitly from the names given. Full paths
are allowed in this form.
The directory <dir> is relative to the installation
prefix, which is stored in the variable
CMAKE_INSTALL_PREFIX.
install_programs
Deprecated. Use the install(PROGRAMS ) command instead.
This command has been superceded by the install com-
mand. It is provided for compatibility with older
CMake code. The FILES form is directly replaced by the
PROGRAMS form of the INSTALL command. The regexp form
can be expressed more clearly using the GLOB form of
the FILE command.
install_programs(<dir> file1 file2 [file3 ...])
install_programs(<dir> FILES file1 [file2 ...])
Create rules to install the listed programs into the
given directory. Use the FILES argument to guarantee
that the file list version of the command will be used
even when there is only one argument.
cmake 2.8.6 Last change: June 17, 2014 137
User Commands cmake(1)
install_programs(<dir> regexp)
In the second form any program in the current source
directory that matches the regular expression will be
installed.
This command is intended to install programs that are
not built by cmake, such as shell scripts. See the
TARGETS form of the INSTALL command to create installa-
tion rules for targets built by cmake.
The directory <dir> is relative to the installation
prefix, which is stored in the variable
CMAKE_INSTALL_PREFIX.
install_targets
Deprecated. Use the install(TARGETS ) command instead.
This command has been superceded by the install com-
mand. It is provided for compatibility with older
CMake code.
install_targets(<dir> [RUNTIME_DIRECTORY dir] target target)
Create rules to install the listed targets into the
given directory. The directory <dir> is relative to
the installation prefix, which is stored in the vari-
able CMAKE_INSTALL_PREFIX. If RUNTIME_DIRECTORY is
specified, then on systems with special runtime files
(Windows DLL), the files will be copied to that direc-
tory.
link_libraries
Deprecated. Use the target_link_libraries() command
instead.
Link libraries to all targets added later.
link_libraries(library1 <debug | optimized> library2 ...)
Specify a list of libraries to be linked into any fol-
lowing targets (typically added with the add_executable
or add_library calls). This command is passed down to
all subdirectories. The debug and optimized strings
may be used to indicate that the next library listed is
to be used only for that specific type of build.
cmake 2.8.6 Last change: June 17, 2014 138
User Commands cmake(1)
make_directory
Deprecated. Use the file(MAKE_DIRECTORY ) command
instead.
make_directory(directory)
Creates the specified directory. Full paths should be
given. Any parent directories that do not exist will
also be created. Use with care.
output_required_files
Deprecated. Approximate C preprocessor dependency
scanning.
This command exists only because ancient CMake versions
provided it. CMake handles preprocessor dependency
scanning automatically using a more advanced scanner.
output_required_files(srcfile outputfile)
Outputs a list of all the source files that are
required by the specified srcfile. This list is written
into outputfile. This is similar to writing out the
dependencies for srcfile except that it jumps from .h
files into .cxx, .c and .cpp files if possible.
remove
Deprecated. Use the list(REMOVE_ITEM ) command instead.
remove(VAR VALUE VALUE ...)
Removes VALUE from the variable VAR. This is typically
used to remove entries from a vector (e.g. semicolon
separated list). VALUE is expanded.
subdir_depends
Deprecated. Does nothing.
subdir_depends(subdir dep1 dep2 ...)
Does not do anything. This command used to help
projects order parallel builds correctly. This func-
tionality is now automatic.
subdirs
Deprecated. Use the add_subdirectory() command instead.
cmake 2.8.6 Last change: June 17, 2014 139
User Commands cmake(1)
Add a list of subdirectories to the build.
subdirs(dir1 dir2 ...[EXCLUDE_FROM_ALL exclude_dir1 exclude_dir2 ...]
[PREORDER] )
Add a list of subdirectories to the build. The add_sub-
directory command should be used instead of subdirs
although subdirs will still work. This will cause any
CMakeLists.txt files in the sub directories to be pro-
cessed by CMake. Any directories after the PREORDER
flag are traversed first by makefile builds, the PRE-
ORDER flag has no effect on IDE projects. Any directo-
ries after the EXCLUDE_FROM_ALL marker will not be
included in the top level makefile or project file.
This is useful for having CMake create makefiles or
projects for a set of examples in a project. You would
want CMake to generate makefiles or project files for
all the examples at the same time, but you would not
want them to show up in the top level project or be
built each time make is run from the top.
use_mangled_mesa
Copy mesa headers for use in combination with system
GL.
use_mangled_mesa(PATH_TO_MESA OUTPUT_DIRECTORY)
The path to mesa includes, should contain gl_mangle.h.
The mesa headers are copied to the specified output
directory. This allows mangled mesa headers to over-
ride other GL headers by being added to the include
directory path earlier.
utility_source
Specify the source tree of a third-party utility.
utility_source(cache_entry executable_name
path_to_source [file1 file2 ...])
When a third-party utility's source is included in the
distribution, this command specifies its location and
name. The cache entry will not be set unless the
path_to_source and all listed files exist. It is
assumed that the source tree of the utility will have
been built before it is needed.
When cross compiling CMake will print a warning if a
utility_source() command is executed, because in many
cmake 2.8.6 Last change: June 17, 2014 140
User Commands cmake(1)
cases it is used to build an executable which is exe-
cuted later on. This doesn't work when cross compiling,
since the executable can run only on their target plat-
form. So in this case the cache entry has to be
adjusted manually so it points to an executable which
is runnable on the build host.
variable_requires
Deprecated. Use the if() command instead.
Assert satisfaction of an option's required variables.
variable_requires(TEST_VARIABLE RESULT_VARIABLE
REQUIRED_VARIABLE1
REQUIRED_VARIABLE2 ...)
The first argument (TEST_VARIABLE) is the name of the
variable to be tested, if that variable is false noth-
ing else is done. If TEST_VARIABLE is true, then the
next argument (RESULT_VARIABLE) is a variable that is
set to true if all the required variables are set. The
rest of the arguments are variables that must be true
or not set to NOTFOUND to avoid an error. If any are
not true, an error is reported.
write_file
Deprecated. Use the file(WRITE ) command instead.
write_file(filename "message to write"... [APPEND])
The first argument is the file name, the rest of the
arguments are messages to write. If the argument APPEND
is specified, then the message will be appended.
NOTE 1: file(WRITE ... and file(APPEND ... do exactly
the same as this one but add some more functionality.
NOTE 2: When using write_file the produced file cannot
be used as an input to CMake (CONFIGURE_FILE, source
file ...) because it will lead to an infinite loop. Use
configure_file if you want to generate input files to
CMake.
MODULES
The following modules are provided with CMake. They can be
used with INCLUDE(ModuleName).
cmake 2.8.6 Last change: June 17, 2014 141
User Commands cmake(1)
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 com-
piler 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 applica-
tion.
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 GetPrerequi-
sites.cmake.
FIXUP_BUNDLE(<app> <libs> <dirs>)
cmake 2.8.6 Last change: June 17, 2014 142
User Commands cmake(1)
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 parame-
ter, you should install them or copy them into the bun-
dle 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(<src> <dst> <libs> <dirs>)
Makes a copy of the bundle <src> at location <dst> and
then fixes up the new copied bundle in-place at
<dst>...
VERIFY_APP(<app>)
Verifies that an application <app> appears valid based
on running analysis tools on it. Calls "mes-
sage(FATAL_ERROR" if the application is not verified.
GET_BUNDLE_MAIN_EXECUTABLE(<bundle> <result_var>)
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(<exe> <dotapp_dir_var>)
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 con-
taining the executable.
cmake 2.8.6 Last change: June 17, 2014 143
User Commands cmake(1)
The returned directory may or may not exist.
GET_BUNDLE_AND_EXECUTABLE(<app> <bundle_var> <executable_var> <valid_var>)
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 <bundle_var> and
the path to its main executable in <executable_var>
GET_BUNDLE_ALL_EXECUTABLES(<bundle> <exes_var>)
Scans the given bundle recursively for all executable
files and accumulates them into a variable.
GET_ITEM_KEY(<item> <key_var>)
Given a file (item) name, generate a key that should be
unique considering the set of libraries that need copy-
ing 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(<keys_var>)
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(<keys_var> <context> <item> <exepath> <dirs>
<copyflag>)
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(<app> <libs> <dirs> <keys_var>)
cmake 2.8.6 Last change: June 17, 2014 144
User Commands cmake(1)
Loop over all the executable and library files within
the bundle (and given as extra <libs>) 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(<resolved_item> <resolved_embedded_item>)
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(<resolved_item> <resolved_embedded_item>)
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 call-
ing fixup_bundle. By default, COPY_RESOLVED_FRAME-
WORK_INTO_BUNDLE copies the framework dylib itself plus
the framework Resources directory.
FIXUP_BUNDLE_ITEM(<resolved_embedded_item> <exepath> <dirs>)
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.
cmake 2.8.6 Last change: June 17, 2014 145
User Commands cmake(1)
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 bun-
dle items will be marked writable before
install_name_tool tries to change them.
VERIFY_BUNDLE_PREREQUISITES(<bundle> <result_var> <info_var>)
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(<bundle> <result_var> <info_var>)
Verifies that any symlinks found in the bundle point to
other files that are already also in the bundle... Any-
thing that points to an external file causes this func-
tion to fail the verification.
CMakeBackwardCompatibilityCXX
define a bunch of backwards compatibility variables
CMAKE_ANSI_CXXFLAGS - flag for ansi c++
CMAKE_HAS_ANSI_STRING_STREAM - has <strstream>
INCLUDE(TestForANSIStreamHeaders)
INCLUDE(CheckIncludeFileCXX)
INCLUDE(TestForSTDNamespace)
INCLUDE(TestForANSIForScope)
CMakeDependentOption
Macro to provide an option dependent on other options.
This macro presents an option to the user only if a set
of other conditions are true. When the option is not
presented a default value is used, but any value set by
the user is preserved for when the option is presented
again. Example invocation:
CMAKE_DEPENDENT_OPTION(USE_FOO "Use Foo" ON
"USE_BAR;NOT USE_ZOT" OFF)
If USE_BAR is true and USE_ZOT is false, this provides
an option called USE_FOO that defaults to ON. Other-
wise, it sets USE_FOO to OFF. If the status of USE_BAR
cmake 2.8.6 Last change: June 17, 2014 146
User Commands cmake(1)
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 try-
ing 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()
===========================
CMakeFindFrameworks
helper module to find OSX frameworks
CMakeFindPackageMode
cmake 2.8.6 Last change: June 17, 2014 147
User Commands cmake(1)
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 signa-
ture:
CMAKE_FORCE_C_COMPILER(<compiler> <compiler-id>)
It sets CMAKE_C_COMPILER to the given compiler and the
cmake internal variable CMAKE_C_COMPILER_ID to the
given compiler-id. It also bypasses the check for work-
ing compiler and basic compiler information tests.
Macro CMAKE_FORCE_CXX_COMPILER has the following signa-
ture:
CMAKE_FORCE_CXX_COMPILER(<compiler> <compiler-id>)
It sets CMAKE_CXX_COMPILER to the given compiler and
the cmake internal variable CMAKE_CXX_COMPILER_ID to
the given compiler-id. It also bypasses the check for
working compiler and basic compiler information tests.
Macro CMAKE_FORCE_Fortran_COMPILER has the following
signature:
CMAKE_FORCE_Fortran_COMPILER(<compiler> <compiler-id>)
cmake 2.8.6 Last change: June 17, 2014 148
User Commands cmake(1)
It sets CMAKE_Fortran_COMPILER to the given compiler
and the cmake internal variable CMAKE_Fortran_COM-
PILER_ID to the given compiler-id. It also bypasses the
check for working compiler and basic compiler informa-
tion 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)
CMakeParseArguments
CMAKE_PARSE_ARGUMENTS(<prefix> <options>
<one_value_keywords> <multi_value_keywords> 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 <options> 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 <one_value_keywords> argument contains all keywords
for this macro which are followed by one value, like
e.g. DESTINATION keyword of the install() command.
The <multi_value_keywords> argument contains all key-
words 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 <options>,
<one_value_keywords> and <multi_value_keywords> a vari-
able composed of the given <prefix> followed by "_" and
the name of the respective keyword. These variables
cmake 2.8.6 Last change: June 17, 2014 149
User Commands cmake(1)
will then hold the respective value from the argument
list. For the <options> keywords this will be TRUE or
FALSE.
All remaining arguments are collected in a variable
<prefix>_UNPARSED_ARGUMENTS, this can be checked after-
wards to see whether your macro was called with unrec-
ognized 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
cmake 2.8.6 Last change: June 17, 2014 150
User Commands cmake(1)
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_func-
tion_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 2.8.6 Last change: June 17, 2014 151
User Commands cmake(1)
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
foreach generator, it then
The CPack module generates binary and source installers
in a variety of formats using the cpack program. Inclu-
sion 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 depre-
cated INSTALL_FILES, INSTALL_PROGRAMS, and INSTALL_TAR-
GETS 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 indi-
vidual application components to install. See CPackCom-
ponent 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 auto-
matically on a per-generator basis. It only need con-
tain overrides.
cmake 2.8.6 Last change: June 17, 2014 152
User Commands cmake(1)
Here's how it works:
CPACK_GENERATOR list variable (unless told to use just a
specific one via -G on the command line...)
- 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 cur-
rently being used* and then include the
CPACK_PROJECT_CONFIG_FILE.
Before including this CPack module in your CMake-
Lists.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_VERSION_MAJOR - Package major Version
CPACK_PACKAGE_VERSION_MINOR - Package minor Version
CPACK_PACKAGE_VERSION_PATCH - Package patch Version
cmake 2.8.6 Last change: June 17, 2014 153
User Commands cmake(1)
CPACK_PACKAGE_DESCRIPTION_FILE - A text file used to describe the
project. Used, for example, the introduction screen of a
CPack-generated Windows installer to describe the project.
CPACK_PACKAGE_DESCRIPTION_SUMMARY - Short description of the
project (only a few words).
CPACK_PACKAGE_FILE_NAME - The name of the package file to generate,
not including the extension. For example, cmake-2.6.1-Linux-i686.
CPACK_PACKAGE_INSTALL_DIRECTORY - Installation directory on the
target system, e.g., "CMake 2.5".
CPACK_PROJECT_CONFIG_FILE - File included at cpack time, once per
generator after setting CPACK_GENERATOR to the actual generator
being used. Allows per-generator setting of CPACK_* variables at
cpack time.
CPACK_RESOURCE_FILE_LICENSE - License file for the project, which
will typically be displayed to the user (often with an explicit
"Accept" button, for graphical installers) prior to installation.
CPACK_RESOURCE_FILE_README - ReadMe file for the project, which
typically describes in some detail
CPACK_RESOURCE_FILE_WELCOME - Welcome file for the project, which
welcomes users to this installer. Typically used in the graphical
installers on Windows and Mac OS X.
cmake 2.8.6 Last change: June 17, 2014 154
User Commands cmake(1)
CPACK_MONOLITHIC_INSTALL - Disables the component-based
installation mechanism, so that all components are always installed.
CPACK_GENERATOR - List of CPack generators to use. If not
specified, CPack will create a set of options (e.g.,
CPACK_BINARY_NSIS) allowing the user to enable/disable individual
generators.
CPACK_OUTPUT_CONFIG_FILE - The name of the CPack configuration file
for binary installers that will be generated by the CPack
module. Defaults to CPackConfig.cmake.
CPACK_PACKAGE_EXECUTABLES - Lists each of the executables along
with a text label, to be used to create Start Menu shortcuts on
Windows. For example, setting this to the list ccmake;CMake will
create a shortcut named "CMake" that will execute the installed
executable ccmake.
CPACK_STRIP_FILES - List of files to be stripped. Starting with
CMake 2.6.0 CPACK_STRIP_FILES will be a boolean variable which
enables stripping of all files (a list of files evaluates to TRUE
in CMake, so this change is compatible).
The following CPack variables are specific to source
packages, and will not affect binary packages:
CPACK_SOURCE_PACKAGE_FILE_NAME - The name of the source package,
e.g., cmake-2.6.1
CPACK_SOURCE_STRIP_FILES - List of files in the source tree that
will be stripped. Starting with CMake 2.6.0
CPACK_SOURCE_STRIP_FILES will be a boolean variable which enables
stripping of all files (a list of files evaluates to TRUE in CMake,
cmake 2.8.6 Last change: June 17, 2014 155
User Commands cmake(1)
so this change is compatible).
CPACK_SOURCE_GENERATOR - List of generators used for the source
packages. As with CPACK_GENERATOR, if this is not specified then
CPack will create a set of options (e.g., CPACK_SOURCE_ZIP)
allowing users to select which packages will be generated.
CPACK_SOURCE_OUTPUT_CONFIG_FILE - The name of the CPack
configuration file for source installers that will be generated by
the CPack module. Defaults to CPackSourceConfig.cmake.
CPACK_SOURCE_IGNORE_FILES - Pattern of files in the source tree
that won't be packaged when building a source package. This is a
list of patterns, e.g., /CVS/;/\\.svn/;\\.swp$;\\.#;/#;.*~;cscope.*
The following variables are specific to the 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 which 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.
cmake 2.8.6 Last change: June 17, 2014 156
User Commands cmake(1)
CPACK_DMG_BACKGROUND_IMAGE - Path to an image file which is to 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.)
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.
cmake 2.8.6 Last change: June 17, 2014 157
User Commands cmake(1)
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.
CPackBundle
CPack Bundle generator (Mac OS X) specific options
cmake 2.8.6 Last change: June 17, 2014 158
User Commands cmake(1)
Installers built on Mac OS X using the Bundle generator
use the aforementioned DragNDrop variables, plus the
following Bundle-specific parameters:
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
as the Info.plist 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 icns 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_SCRIPT - 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 gen-
eral 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 indi-
vidual application components to install. The contents
of each of the components are identified by the COMPO-
NENT argument of CMake's INSTALL command. These compo-
nents can be annotated with user-friendly names and
descriptions, inter-component dependencies, etc., and
grouped in various ways to customize the resulting
cmake 2.8.6 Last change: June 17, 2014 159
User Commands cmake(1)
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_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
cmake 2.8.6 Last change: June 17, 2014 160
User Commands cmake(1)
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.
cmake 2.8.6 Last change: June 17, 2014 161
User Commands cmake(1)
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.
cmake 2.8.6 Last change: June 17, 2014 162
User Commands cmake(1)
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.
cmake 2.8.6 Last change: June 17, 2014 163
User Commands cmake(1)
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
cmake 2.8.6 Last change: June 17, 2014 164
User Commands cmake(1)
components will reside, e.g., http://www.cmake.org/files/2.6.1/installer/
All of the archives produced by CPack should be uploaded to that location.
UPLOAD_DIRECTORY is the local directory where CPack will create the
various archives for each of the components. The contents of this
directory should be uploaded to a location accessible by the URL given
in the site argument. If omitted, CPack will use the directory
CPackUploads inside the CMake binary directory to store the generated
archives.
The ALL flag indicates that all components be downloaded. Otherwise, only
those components explicitly marked as DOWNLOADED or that have a specified
ARCHIVE_FILE will be downloaded. Additionally, the ALL option implies
ADD_REMOVE (unless NO_ADD_REMOVE is specified).
ADD_REMOVE indicates that CPack should install a copy of the installer
that can be called from Windows' Add/Remove Programs dialog (via the
"Modify" button) to change the set of installed components. NO_ADD_REMOVE
turns off this behavior. This option is ignored on Mac OS X.
CPackDeb
The builtin (binary) CPack Deb generator (Unix only)
CPackDeb may be used to create Deb package using CPack.
CPackDeb is a CPack generator thus it uses the
CPACK_XXX variables used by CPack :
http://www.cmake.org/Wiki/CMake:CPackConfiguration.
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 spe-
cific variables:
cmake 2.8.6 Last change: June 17, 2014 165
User Commands cmake(1)
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
cmake 2.8.6 Last change: June 17, 2014 166
User Commands cmake(1)
Mandatory : YES
Default : 'optional'
The debian package priority
CPACK_DEBIAN_PACKAGE_HOMEPAGE
Mandatory : NO
Default : -
The URL of the web site for this package
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
cmake 2.8.6 Last change: June 17, 2014 167
User Commands cmake(1)
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.
CPackNSIS
CPack NSIS generator specific options
The following variables are specific to the graphical
installers built on Windows using the Nullsoft Instal-
lation System.
CPACK_PACKAGE_INSTALL_REGISTRY_KEY - Registry key used when
installing this project.
CPACK_NSIS_INSTALL_ROOT - The default installation directory presented
cmake 2.8.6 Last change: June 17, 2014 168
User Commands cmake(1)
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 - The icon file (.ico) for the generated
install program.
CPACK_NSIS_MUI_UNIICON - The icon file (.ico) for the generated
uninstall program.
CPACK_PACKAGE_ICON - A branding image that will be displayed inside
the installer.
CPACK_NSIS_EXTRA_INSTALL_COMMANDS - Extra NSIS commands that will
be added to the install Section.
CPACK_NSIS_EXTRA_UNINSTALL_COMMANDS - Extra NSIS commands that will
be added to the uninstall Section.
CPACK_NSIS_COMPRESSOR - The arguments that will be passed to the
NSIS SetCompressor command.
CPACK_NSIS_MODIFY_PATH - If this is set to "ON", then an extra page
will appear in the installer that will allow the user to choose
whether the program directory should be added to the system PATH
variable.
CPACK_NSIS_DISPLAY_NAME - The display name string that appears in
cmake 2.8.6 Last change: June 17, 2014 169
User Commands cmake(1)
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.
cmake 2.8.6 Last change: June 17, 2014 170
User Commands cmake(1)
CPACK_NSIS_MUI_FINISHPAGE_RUN - Specify an executable to add an option
to run on the finish page of the NSIS installer.
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 con-
trolled by the specifics CPACK_RPM_XXX variables. Usu-
ally 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 spe-
cific variables:
CPACK_RPM_PACKAGE_SUMMARY
Mandatory : YES
Default : CPACK_PACKAGE_DESCRIPTION_SUMMARY
The RPM package summary
CPACK_RPM_PACKAGE_NAME
Mandatory : YES
Default : CPACK_PACKAGE_NAME
The RPM package name
CPACK_RPM_PACKAGE_VERSION
Mandatory : YES
Default : CPACK_PACKAGE_VERSION
The RPM package version
CPACK_RPM_PACKAGE_ARCHITECTURE
Mandatory : NO
Default : -
The RPM package architecture. This may be set to "noarch" if you
know you are building a noarch package.
CPACK_RPM_PACKAGE_RELEASE
Mandatory : YES
Default : 1
The RPM package release. This is the numbering of the RPM package
itself, i.e. the version of the packaging and not the version of the
content (see CPACK_RPM_PACKAGE_VERSION). One may change the default
value if the previous packaging was buggy and/or you want to put here
a fancy Linux distro specific numbering.
cmake 2.8.6 Last change: June 17, 2014 171
User Commands cmake(1)
CPACK_RPM_PACKAGE_LICENSE
Mandatory : YES
Default : "unknown"
The RPM package license policy.
CPACK_RPM_PACKAGE_GROUP
Mandatory : YES
Default : "unknown"
The RPM package group.
CPACK_RPM_PACKAGE_VENDOR
Mandatory : YES
Default : CPACK_PACKAGE_VENDOR if set or "unknown"
The RPM package vendor.
CPACK_RPM_PACKAGE_URL
Mandatory : NO
Default : -
The projects URL.
CPACK_RPM_PACKAGE_DESCRIPTION
Mandatory : YES
Default : CPACK_PACKAGE_DESCRIPTION_FILE if set or "no package description available"
CPACK_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
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
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
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
Mandatory : NO
Default : -
May be used to set RPM packages that are obsoleted by this one.
CPACK_RPM_PACKAGE_RELOCATABLE
cmake 2.8.6 Last change: June 17, 2014 172
User Commands cmake(1)
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
Mandatory : NO
Default : -
May be used to set an RPM post-install command inside the spec file.
For example setting it to "/bin/true" may be used to prevent
rpmbuild to strip binaries.
CPACK_RPM_SPEC_MORE_DEFINE
Mandatory : NO
Default : -
May be used to add any %define lines to the generated spec file.
CPACK_RPM_PACKAGE_DEBUG
Mandatory : NO
Default : -
May be set when invoking cpack in order to trace debug 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
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
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 overriden with
CPACK_RPM_<COMPONENT>_PRE_INSTALL_SCRIPT_FILE and
CPACK_RPM_<COMPONENT>_PRE_UNINSTALL_SCRIPT_FILE
One may verify which scriptlet has been included with
cmake 2.8.6 Last change: June 17, 2014 173
User Commands cmake(1)
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 overriden with
CPACK_RPM_<COMPONENT>_POST_INSTALL_SCRIPT_FILE and
CPACK_RPM_<COMPONENT>_POST_UNINSTALL_SCRIPT_FILE
One may verify which scriptlet has been included with
rpm -qp --scripts package.rpm
CPACK_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 sub-
missions 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")
cmake 2.8.6 Last change: June 17, 2014 174
User Commands cmake(1)
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 gener-
ators to invoke every command in the generated build
system through a CTest launcher program. (Currently
the CTEST_USE_LAUNCHERS option is ignored on non-Make-
file 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 CTest-
Config.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(<flag> <var>)
cmake 2.8.6 Last change: June 17, 2014 175
User Commands cmake(1)
<flag> - the compiler flag
<var> - variable to store the result
This internally calls the check_c_source_compiles
macro. See help for CheckCSourceCompiles for a listing
of variables that can modify the build.
CheckCSourceCompiles
Check if given C source compiles and links into an exe-
cutable
CHECK_C_SOURCE_COMPILES(<code> <var> [FAIL_REGEX
<fail-regex>])
<code> - source code to try to compile, must define 'main'
<var> - variable to store whether the source code compiled
<fail-regex> - fail if test output matches this regex
The following variables may be set before calling this
macro to modify the way the check is run:
CMAKE_REQUIRED_FLAGS = string of compile command line flags
CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
CMAKE_REQUIRED_INCLUDES = list of include directories
CMAKE_REQUIRED_LIBRARIES = list of libraries to link
CheckCSourceRuns
Check if the given C source code compiles and runs.
CHECK_C_SOURCE_RUNS(<code> <var>)
<code> - source code to try to compile
<var> - variable to store the result
(1 for success, empty for failure)
The following variables may be set before calling this
macro to modify the way the check is run:
CMAKE_REQUIRED_FLAGS = string of compile command line flags
CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
CMAKE_REQUIRED_INCLUDES = list of include directories
CMAKE_REQUIRED_LIBRARIES = list of libraries to link
CheckCXXCompilerFlag
Check whether the CXX compiler supports a given flag.
cmake 2.8.6 Last change: June 17, 2014 176
User Commands cmake(1)
CHECK_CXX_COMPILER_FLAG(<flag> <var>)
<flag> - the compiler flag
<var> - variable to store the result
This internally calls the check_cxx_source_compiles
macro. See help for CheckCXXSourceCompiles for a list-
ing of variables that can modify the build.
CheckCXXSourceCompiles
Check if given C++ source compiles and links into an
executable
CHECK_CXX_SOURCE_COMPILES(<code> <var> [FAIL_REGEX
<fail-regex>])
<code> - source code to try to compile, must define 'main'
<var> - variable to store whether the source code compiled
<fail-regex> - fail if test output matches this regex
The following variables may be set before calling this
macro to modify the way the check is run:
CMAKE_REQUIRED_FLAGS = string of compile command line flags
CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
CMAKE_REQUIRED_INCLUDES = list of include directories
CMAKE_REQUIRED_LIBRARIES = list of libraries to link
CheckCXXSourceRuns
Check if the given C++ source code compiles and runs.
CHECK_CXX_SOURCE_RUNS(<code> <var>)
<code> - source code to try to compile
<var> - variable to store the result
(1 for success, empty for failure)
The following variables may be set before calling this
macro to modify the way the check is run:
CMAKE_REQUIRED_FLAGS = string of compile command line flags
CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
CMAKE_REQUIRED_INCLUDES = list of include directories
CMAKE_REQUIRED_LIBRARIES = list of libraries to link
cmake 2.8.6 Last change: June 17, 2014 177
User Commands cmake(1)
CheckCXXSymbolExists
Check if a symbol exists as a function, variable, or
macro in C++
CHECK_CXX_SYMBOL_EXISTS(<symbol> <files> <variable>)
Check that the <symbol> is available after including
given header <files> and store the result in a <vari-
able>. 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_SYM-
BOL_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 vari-
able then the symbol must also be available for link-
ing. If the symbol is a type or enum value it will not
be recognized (consider using CheckTypeSize or CheckC-
SourceCompiles).
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
cmake 2.8.6 Last change: June 17, 2014 178
User Commands cmake(1)
CheckFunctionExists
Check if a C function can be linked
CHECK_FUNCTION_EXISTS(<function> <variable>)
Check that the <function> is provided by libraries on
the system and store the result in a <variable>. 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.
cmake 2.8.6 Last change: June 17, 2014 179
User Commands cmake(1)
CHECK_INCLUDE_FILE_CXX(INCLUDE VARIABLE)
INCLUDE - name of include file
VARIABLE - variable to return result
An optional third argument is the CFlags to add to the
compile line or you can use CMAKE_REQUIRED_FLAGS.
The following variables may be set before calling this
macro to modify the way the check is run:
CMAKE_REQUIRED_FLAGS = string of compile command line flags
CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
CMAKE_REQUIRED_INCLUDES = list of include directories
CheckIncludeFiles
Check if the files can be included
CHECK_INCLUDE_FILES(INCLUDE VARIABLE)
INCLUDE - list of files to include
VARIABLE - variable to return result
The following variables may be set before calling this
macro to modify the way the check is run:
CMAKE_REQUIRED_FLAGS = string of compile command line flags
CMAKE_REQUIRED_DEFINITIONS = list of macros to define (-DFOO=bar)
CMAKE_REQUIRED_INCLUDES = list of include directories
CheckLibraryExists
Check if the function exists.
cmake 2.8.6 Last change: June 17, 2014 180
User Commands cmake(1)
CHECK_LIBRARY_EXISTS (LIBRARY FUNCTION LOCATION VARI-
ABLE)
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
cmake 2.8.6 Last change: June 17, 2014 181
User Commands cmake(1)
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(<symbol> <files> <variable>)
Check that the <symbol> is available after including
given header <files> and store the result in a <vari-
able>. 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 vari-
able then the symbol must also be available for link-
ing. If the symbol is a type or enum value it will not
be recognized (consider using CheckTypeSize or CheckC-
SourceCompiles). 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++.
cmake 2.8.6 Last change: June 17, 2014 182
User Commands cmake(1)
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:
<size> = type has non-zero size <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 map-
ping 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 <sys/types.h>, <stdint.h>, and
<stddef.h>, 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 sup-
porting 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 2.8.6 Last change: June 17, 2014 183
User Commands cmake(1)
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. Typi-
cal usage:
INCLUDE(Dart)
IF(BUILD_TESTING)
# ... testing related CMake code ...
ENDIF(BUILD_TESTING)
The BUILD_TESTING option is created by the Dart module
to determine whether testing support should be enabled.
The default is ON.
Documentation
cmake 2.8.6 Last change: June 17, 2014 184
User Commands cmake(1)
DocumentationVTK.cmake
This file provides support for the VTK documentation
framework. It relies on several tools (Doxygen, Perl,
etc).
ExternalProject
Create custom targets to build projects in external
trees
The 'ExternalProject_Add' function creates a custom
target to drive download, update/patch, configure,
build, install and test steps of an external project:
ExternalProject_Add(<name> # Name for custom target
[DEPENDS projects...] # Targets on which the project depends
[PREFIX dir] # Root dir for entire project
[LIST_SEPARATOR sep] # Sep to be replaced by ; in cmd lines
[TMP_DIR dir] # Directory to store temporary files
[STAMP_DIR dir] # Directory to store step timestamps
#--Download step--------------
[DOWNLOAD_DIR dir] # Directory to store downloaded files
[DOWNLOAD_COMMAND cmd...] # Command to download source tree
[CVS_REPOSITORY cvsroot] # CVSROOT of CVS repository
[CVS_MODULE mod] # Module to checkout from CVS repo
[CVS_TAG tag] # Tag to checkout from CVS repo
[SVN_REPOSITORY url] # URL of Subversion repo
[SVN_REVISION rev] # Revision to checkout from Subversion repo
[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
cmake 2.8.6 Last change: June 17, 2014 185
User Commands cmake(1)
#--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 pre-
fix:
TMP_DIR = <prefix>/tmp
STAMP_DIR = <prefix>/src/<name>-stamp
DOWNLOAD_DIR = <prefix>/src
SOURCE_DIR = <prefix>/src/<name>
BINARY_DIR = <prefix>/src/<name>-build
INSTALL_DIR = <prefix>
Otherwise, if the EP_BASE directory property is set
then components of an external project are stored under
the specified base:
TMP_DIR = <base>/tmp/<name>
STAMP_DIR = <base>/Stamp/<name>
DOWNLOAD_DIR = <base>/Download/<name>
SOURCE_DIR = <base>/Source/<name>
BINARY_DIR = <base>/Build/<name>
INSTALL_DIR = <base>/Install/<name>
If no PREFIX, EP_PREFIX, or EP_BASE is specified then
the default is to set PREFIX to "<name>-prefix". Rela-
tive paths are interpreted with respect to the build
directory corresponding to the source directory in
which ExternalProject_Add is invoked.
cmake 2.8.6 Last change: June 17, 2014 186
User Commands cmake(1)
If SOURCE_DIR is explicitly set to an existing direc-
tory the project will be built from it. Otherwise a
download step must be specified using one of the DOWN-
LOAD_COMMAND, CVS_*, SVN_*, or URL options. The URL
option may refer locally to a directory or source tar-
ball, or refer to a remote tarball (e.g.
http://.../src.tgz).
The 'ExternalProject_Add_Step' function adds a custom
step to an external project:
ExternalProject_Add_Step(<name> <step> # Names of project and custom step
[COMMAND cmd...] # Command line invoked by this step
[COMMENT "text..."] # Text printed when step executes
[DEPENDEES steps...] # Steps on which this step depends
[DEPENDERS steps...] # Steps that depend on this step
[DEPENDS files...] # Files on which this step depends
[ALWAYS 1] # No stamp file, step always runs
[WORKING_DIRECTORY dir] # Working directory for command
[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 <SOURCE_DIR>, <BINARY_DIR>, <INSTALL_DIR>, and
<TMP_DIR> with corresponding property values.
The 'ExternalProject_Get_Property' function retrieves
external project target properties:
ExternalProject_Get_Property(<name> [prop1 [prop2 [...]]])
It stores property values in variables of the same
name. Property names correspond to the keyword argument
names of 'ExternalProject_Add'.
The 'ExternalProject_Add_StepTargets' function gener-
ates custom targets for the steps listed:
ExternalProject_Add_StepTargets(<name> [step1 [step2 [...]]])
If STEP_TARGETS is set then ExternalProject_Add_Step-
Targets is automatically called at the end of matching
cmake 2.8.6 Last change: June 17, 2014 187
User Commands cmake(1)
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 Exter-
nalProject_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_pack-
age_info(), set_feature_info(), print_enabled_fea-
tures() 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:
cmake 2.8.6 Last change: June 17, 2014 188
User Commands cmake(1)
LibXml2 (required version >= 2.4) , XML processing library. , <http://xmlsoft.org>
* Enables HTML-import in MyWordProcessor
* Enables odt-export in MyWordProcessor
PNG , A PNG image library. , <http://www.libpng.org/pub/png/>
* Enables saving screenshots
-- The following OPTIONAL packages have not been found:
Lua51 , The Lua scripting language. , <http://www.lua.org>
* Enables macros in MyWordProcessor
Foo , Foo provides cool stuff.
FEATURE_SUMMARY( [FILENAME <file>]
[APPEND]
[VAR <variable_name>]
[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 infor-
mation about enabled or disabled packages or features
of a project. By default, only the names of the fea-
tures/packages will be printed and their required ver-
sion when one was specified. Use SET_PACKAGE_PROPER-
TIES() to add more useful information, like e.g. a
download URL for the respective package or their pur-
pose 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
cmake 2.8.6 Last change: June 17, 2014 189
User Commands cmake(1)
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 con-
tent. 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(<name> PROPERTIES [ URL <url> ]
[ DESCRIPTION <description> ]
[ TYPE (RUNTIME|OPTIONAL|RECOMMENDED|REQUIRED) ]
cmake 2.8.6 Last change: June 17, 2014 190
User Commands cmake(1)
[ PURPOSE <purpose> ]
)
Use this macro to set up information about the named
package, which can then be displayed via FEATURE_SUM-
MARY(). 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 < RECOM-
MENDED < 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
cmake 2.8.6 Last change: June 17, 2014 191
User Commands cmake(1)
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-spe-
cific, 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(<name> <enabled> <description>)
Use this macro to add information about a feature with
the given <name>. <enabled> contains whether this fea-
ture is enabled or not, <description> is a text
describing the feature. The information can be dis-
played 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)
cmake 2.8.6 Last change: June 17, 2014 192
User Commands cmake(1)
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(<name> <description> [<url> [<purpose>] ] )
Use this macro to set up information about the named
package, which can then be displayed via FEATURE_SUM-
MARY(). 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(<name> <description> [<url>] )
Does the same as SET_PACKAGE_INFO(<name> <description>
<url> )
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
cmake 2.8.6 Last change: June 17, 2014 193
User Commands cmake(1)
ALSA_INCLUDE_DIR - where to find asoundlib.h, etc.
ALSA_LIBRARY - the asound library
FindASPELL
Try to find ASPELL
Once done this will define
ASPELL_FOUND - system has ASPELL
ASPELL_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:
cmake 2.8.6 Last change: June 17, 2014 194
User Commands cmake(1)
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_pack-
age(BISON 2.1.3)
If bison is found, the module defines the macros:
BISON_TARGET(<Name> <YaccInput> <CodeOutput> [VERBOSE <file>]
[COMPILE_FLAGS <string>])
which will create a custom rule to generate a parser.
<YaccInput> is the path to a yacc file. <CodeOutput>
is the name of the source file generated by bison. A
header file is also be generated, and contains the
token list. If COMPILE_FLAGS option is specified,
the next parameter is added in the bison command
line. if VERBOSE option is specified, <file> is cre-
ated and contains verbose descriptions of the grammar
and parser. The macro defines a set of variables:
BISON_${Name}_DEFINED - true is the macro ran successfully
BISON_${Name}_INPUT - The input source file, an alias for <YaccInput>
BISON_${Name}_OUTPUT_SOURCE - The source file generated by bison
BISON_${Name}_OUTPUT_HEADER - The header file generated by bison
BISON_${Name}_OUTPUTS - The sources files generated by bison
BISON_${Name}_COMPILE_FLAGS - Options used in the bison command line
cmake 2.8.6 Last change: June 17, 2014 195
User Commands cmake(1)
====================================================================
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.source-
forge.net/ac-archive/acx_blas.html).
This module sets the following variables:
BLAS_FOUND - set to true if a library implementing the BLAS interface
is found
BLAS_LINKER_FLAGS - uncached list of required linker flags (excluding -l
and -L).
BLAS_LIBRARIES - uncached list of libraries (using full path name) to
link against to use BLAS
BLAS95_LIBRARIES - uncached list of libraries (using full path name)
to link against to use BLAS95 interface
BLAS95_FOUND - set to true if a library implementing the BLAS f95 interface
is found
BLA_STATIC if set on this determines what kind of linkage we do (static)
BLA_VENDOR if set checks only the specified vendor, if not set checks
all the possibilities
BLA_F95 if set on tries to find the f95 interfaces for BLAS/LAPACK
######### ## List of vendors (BLA_VENDOR) valid in this
module # Goto,ATLAS PhiPACK,CXML,DXML,Sun-
Perf,SCSL,SGIMATH,IBMESSL,Intel10_32 (intel mkl v10 32
bit),Intel10_64lp (intel mkl v10 64 bit,lp thread
model, lp64 model), # Intel( older versions of mkl 32
and 64 bit), ACML,ACML_MP,ACML_GPU,Apple, NAS, Generic
C/CXX should be enabled to use Intel mkl
FindBZip2
Try to find BZip2
cmake 2.8.6 Last change: June 17, 2014 196
User Commands cmake(1)
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_
FindBoost
Try to find Boost include dirs and libraries
Usage of this module as follows:
NOTE: Take note of the Boost_ADDITIONAL_VERSIONS vari-
able below. Due to Boost naming conventions and limita-
tions 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()
cmake 2.8.6 Last change: June 17, 2014 197
User Commands cmake(1)
The components list needs to contain actual names of
boost libraries only, such as "date_time" for "lib-
boost_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
cmake 2.8.6 Last change: June 17, 2014 198
User Commands cmake(1)
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
NOTE: If you add a new major 1.x version in Boost_ADDI-
TIONAL_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.
cmake 2.8.6 Last change: June 17, 2014 199
User Commands cmake(1)
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 :(
cmake 2.8.6 Last change: June 17, 2014 200
User Commands cmake(1)
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]
cmake 2.8.6 Last change: June 17, 2014 201
User Commands cmake(1)
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
cmake 2.8.6 Last change: June 17, 2014 202
User Commands cmake(1)
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 reason-
ably up to date with CUDA C releases.
This script makes use of the standard find_package
arguments of <VERSION>, REQUIRED and QUIET. CUDA_FOUND
will report if an acceptable version of CUDA was found.
The script will prompt the user to specify CUDA_TOOL-
KIT_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_TOOL-
KIT_ROOT_DIR, various components that depend on the
path will be relocated.
It might be necessary to set CUDA_TOOLKIT_ROOT_DIR man-
ually on certain platforms, or to use a cuda runtime
not installed in the default location. In newer ver-
sions 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_EXE-
CUTABLE, CUDA_ADD_LIBRARY, CUDA_COMPILE, CUDA_COM-
PILE_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.
cmake 2.8.6 Last change: June 17, 2014 203
User Commands cmake(1)
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.
cmake 2.8.6 Last change: June 17, 2014 204
User Commands cmake(1)
CUDA_NVCC_FLAGS
CUDA_NVCC_FLAGS_<CONFIG>
-- Additional NVCC command line arguments. NOTE: multiple arguments must be
semi-colon delimited (e.g. --compiler-options;-Wall)
CUDA_PROPAGATE_HOST_FLAGS (Default ON)
-- Set to ON to propagate CMAKE_{C,CXX}_FLAGS and their configuration
dependent counterparts (e.g. CMAKE_C_FLAGS_DEBUG) automatically to the
host compiler through nvcc's -Xcompiler flag. This helps make the
generated host code match the rest of the system better. Sometimes
certain flags give nvcc problems, and this will help you turn the flag
propagation off. This does not affect the flags supplied directly to nvcc
via CUDA_NVCC_FLAGS or through the OPTION flags specified through
CUDA_ADD_LIBRARY, CUDA_ADD_EXECUTABLE, or CUDA_WRAP_SRCS. Flags used for
shared library compilation are not affected by this flag.
CUDA_VERBOSE_BUILD (Default OFF)
-- Set to ON to see all the commands used when building the CUDA file. When
using a Makefile generator the value defaults to VERBOSE (run make
VERBOSE=1 to see output), although setting CUDA_VERBOSE_BUILD to ON will
always print the output.
The script creates the following macros (in alphebeti-
cal 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
cmake 2.8.6 Last change: June 17, 2014 205
User Commands cmake(1)
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 ...] )
cmake 2.8.6 Last change: June 17, 2014 206
User Commands cmake(1)
-- 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.
cmake 2.8.6 Last change: June 17, 2014 207
User Commands cmake(1)
2. nvcc has been known to not delete incomplete results when it
encounters problems. This confuses build systems into thinking the
target was generated when in fact an unusable file exists. The script
now deletes the output files if there was an error.
3. By putting all the options that affect the build into a file and then
make the build rule dependent on the file, the output files will be
regenerated when the options change.
This script also looks at optional arguments STATIC, SHARED, or MODULE to
determine when to target the object compilation for a shared library.
BUILD_SHARED_LIBS is ignored in CUDA_WRAP_SRCS, but it is respected in
CUDA_ADD_LIBRARY. On some systems special flags are added for building
objects intended for shared libraries. A preprocessor macro,
<target_name>_EXPORTS is defined when a shared library compilation is
detected.
Flags passed into add_definitions with -D or /D are passed along to nvcc.
The script defines the following variables:
CUDA_VERSION_MAJOR -- The major version of cuda as reported by nvcc.
CUDA_VERSION_MINOR -- The minor version.
CUDA_VERSION
CUDA_VERSION_STRING -- CUDA_VERSION_MAJOR.CUDA_VERSION_MINOR
CUDA_TOOLKIT_ROOT_DIR -- Path to the CUDA Toolkit (defined if not set).
CUDA_SDK_ROOT_DIR -- Path to the CUDA SDK. Use this to find files in the
SDK. This script will not directly support finding
specific libraries or headers, as that isn't
supported by NVIDIA. If you want to change
libraries when the path changes see the
FindCUDA.cmake script for an example of how to clear
these variables. There are also examples of how to
use the CUDA_SDK_ROOT_DIR to locate headers or
libraries, if you so choose (at your own risk).
cmake 2.8.6 Last change: June 17, 2014 208
User Commands cmake(1)
CUDA_INCLUDE_DIRS -- Include directory for cuda headers. Added automatically
for CUDA_ADD_EXECUTABLE and CUDA_ADD_LIBRARY.
CUDA_LIBRARIES -- Cuda RT library.
CUDA_CUFFT_LIBRARIES -- Device or emulation library for the Cuda FFT
implementation (alternative to:
CUDA_ADD_CUFFT_TO_TARGET macro)
CUDA_CUBLAS_LIBRARIES -- Device or emulation library for the Cuda BLAS
implementation (alterative to:
CUDA_ADD_CUBLAS_TO_TARGET macro).
James Bigler, NVIDIA Corp (nvidia.com - jbigler)
Abe Stephens, SCI Institute -- http://www.sci.utah.edu/~abe/FindCuda.html
Copyright (c) 2008 - 2009 NVIDIA Corporation. All rights reserved.
Copyright (c) 2007-2009
Scientific Computing and Imaging Institute, University of Utah
This code is licensed under the MIT License. See the FindCUDA.cmake script
for the text of the license.
FindCURL
Find curl
Find the native CURL headers and libraries.
CURL_INCLUDE_DIRS - where to find curl/curl.h, etc.
CURL_LIBRARIES - List of libraries when using curl.
CURL_FOUND - True if curl found.
FindCVS
The module defines the following variables:
cmake 2.8.6 Last change: June 17, 2014 209
User Commands cmake(1)
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 visu-
alization http://www.coin3d.org/
This module defines the following variables
COIN3D_FOUND - system has Coin3D - Open Inventor
COIN3D_INCLUDE_DIRS - where the Inventor include directory can be found
COIN3D_LIBRARIES - Link to this to use Coin3D
FindCups
Try to find the Cups printing system
Once done this will define
CUPS_FOUND - system has Cups
CUPS_INCLUDE_DIR - the Cups include directory
CUPS_LIBRARIES - Libraries needed to use Cups
Set CUPS_REQUIRE_IPP_DELETE_ATTRIBUTE to TRUE if you need a version which
features this function (i.e. at least 1.1.19)
FindCurses
Find the curses include file and library
CURSES_FOUND - system has Curses
CURSES_INCLUDE_DIR - the Curses include directory
cmake 2.8.6 Last change: June 17, 2014 210
User Commands cmake(1)
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_PACK-
AGE() 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.
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
cmake 2.8.6 Last change: June 17, 2014 211
User Commands cmake(1)
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(<test_name> <gen_source_file> <input_files_to_testgen...>)
Creates a CxxTest runner and adds it to the CTest testing suite
Parameters:
test_name The name of the test
gen_source_file The generated source filename to be
generated by CxxTest
input_files_to_testgen The list of header files containing the
CxxTest::TestSuite's to be included in
this runner
#==============
Example Usage:
find_package(CxxTest)
if(CXXTEST_FOUND)
include_directories(${CXXTEST_INCLUDE_DIR})
enable_testing()
CXXTEST_ADD_TEST(unittest_foo foo_test.cc
${CMAKE_CURRENT_SOURCE_DIR}/foo_test.h)
target_link_libraries(unittest_foo foo) # as needed
endif()
cmake 2.8.6 Last change: June 17, 2014 212
User Commands cmake(1)
This will (if CxxTest is found):
1. Invoke the testgen executable to autogenerate foo_test.cc in the
binary tree from "foo_test.h" in the current source directory.
2. Create an executable and test called unittest_foo.
#=============
Example foo_test.h:
#include <cxxtest/TestSuite.h>
class MyTestSuite : public CxxTest::TestSuite
{
public:
void testAddition( void )
{
TS_ASSERT( 1 + 1 > 1 );
TS_ASSERT_EQUALS( 1 + 1, 2 );
}
};
FindCygwin
this module looks for Cygwin
FindDCMTK
find DCMTK libraries 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
cmake 2.8.6 Last change: June 17, 2014 213
User Commands cmake(1)
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 applica-
tion. ILU_LIBRARIES the name of the ILU library. Again,
the full path. This library is for filters and effects,
not actual loading. It doesn't have to be linked if the
functionality it provides is not used. ILUT_LIBRARIES
the name of the ILUT library. Full path. This part of
the library interfaces with OpenGL. It is not strictly
needed in applications. IL_INCLUDE_DIR where to find
the il.h, ilu.h and ilut.h files. IL_FOUND this is set
to TRUE if all the above variables were set. This will
be set to false if ILU or ILUT are not found, even if
they are not needed. In most systems, if one library is
found all the others are as well. That's the way the
DevIL developers release it.
FindDoxygen
This module looks for Doxygen and the path to
Graphviz's dot
Doxygen is a documentation generation tool. Please see
http://www.doxygen.org
This module accepts the following optional variables:
DOXYGEN_SKIP_DOT = If true this module will skip trying to find Dot
(an optional component often used by Doxygen)
This modules defines the following variables:
DOXYGEN_EXECUTABLE = The path to the doxygen command.
DOXYGEN_FOUND = Was Doxygen found or not?
DOXYGEN_DOT_EXECUTABLE = The path to the dot program used by doxygen.
DOXYGEN_DOT_FOUND = Was Dot found or not?
DOXYGEN_DOT_PATH = The path to dot not including the executable
cmake 2.8.6 Last change: June 17, 2014 214
User Commands cmake(1)
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 <string>])
which creates a custom command to generate the <Flex-
Output> file from the <FlexInput> file. If COM-
PILE_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:
cmake 2.8.6 Last change: June 17, 2014 215
User Commands cmake(1)
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 gener-
ated by Bison. This module also defines a macro:
ADD_FLEX_BISON_DEPENDENCY(FlexTarget BisonTarget)
which adds the required dependency between a scan-
ner and a parser where <FlexTarget> and <BisonTar-
get> 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
cmake 2.8.6 Last change: June 17, 2014 216
User Commands cmake(1)
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
cmake 2.8.6 Last change: June 17, 2014 217
User Commands cmake(1)
FLTK2_FLUID_EXECUTABLE, where to find the Fluid tool
FLTK2_WRAP_UI, This enables the FLTK2_WRAP_UI command
FLTK2_INCLUDE_DIR, where to find include files
FLTK2_LIBRARIES, list of fltk2 libraries
FLTK2_FOUND, Don't use FLTK2 if false.
The following settings should not be used in general.
FLTK2_BASE_LIBRARY = the full path to fltk2.lib
FLTK2_GL_LIBRARY = the full path to fltk2_gl.lib
FLTK2_IMAGES_LIBRARY = the full path to fltk2_images.lib
FindFreetype
Locate FreeType library
This module defines
FREETYPE_LIBRARIES, the library to link against
FREETYPE_FOUND, if false, do not try to link to FREETYPE
FREETYPE_INCLUDE_DIRS, where to find headers.
This is the concatenation of the paths:
FREETYPE_INCLUDE_DIR_ft2build
FREETYPE_INCLUDE_DIR_freetype2
$FREETYPE_DIR is an environment variable that would
correspond to the ./configure --prefix=$FREETYPE_DIR
used in building FREETYPE.
FindGCCXML
Find the GCC-XML front-end executable.
This module will define the following variables:
GCCXML - the GCC-XML front-end executable.
FindGDAL
Locate gdal
cmake 2.8.6 Last change: June 17, 2014 218
User Commands cmake(1)
This module accepts the following environment vari-
ables:
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 corre-
spond 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
cmake 2.8.6 Last change: June 17, 2014 219
User Commands cmake(1)
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 sev-
eral 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
cmake 2.8.6 Last change: June 17, 2014 220
User Commands cmake(1)
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.
cmake 2.8.6 Last change: June 17, 2014 221
User Commands cmake(1)
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})
cmake 2.8.6 Last change: June 17, 2014 222
User Commands cmake(1)
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 fix-
tures.
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 mod-
ule defines the following values:
GETTEXT_MSGMERGE_EXECUTABLE: the full path to the msgmerge tool.
GETTEXT_MSGFMT_EXECUTABLE: the full path to the msgfmt tool.
GETTEXT_FOUND: True if gettext has been found.
Additionally it provides the following macros: GET-
TEXT_CREATE_TRANSLATIONS ( outputFile [ALL] file1 ...
fileN )
cmake 2.8.6 Last change: June 17, 2014 223
User Commands cmake(1)
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( <potfile> [ALL] [INSTALL_DESTINA-
TION <destdir>] LANGUAGES <lang1> <lang2> ... )
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( <lang> [ALL] [INSTALL_DESTI-
NATION <dir>] PO_FILES <po1> <po2> ... )
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
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
cmake 2.8.6 Last change: June 17, 2014 224
User Commands cmake(1)
GNUTLS_FOUND - System has gnutls
GNUTLS_INCLUDE_DIR - The gnutls include directory
GNUTLS_LIBRARIES - The libraries needed to use gnutls
GNUTLS_DEFINITIONS - Compiler switches required for using gnutls
FindGnuplot
this module looks for gnuplot
Once done this will define
GNUPLOT_FOUND - system has Gnuplot
GNUPLOT_EXECUTABLE - the Gnuplot executable
FindHDF5
Find HDF5, a library for reading and writing self
describing array data.
This module invokes the HDF5 wrapper compiler that
should be installed alongside HDF5. Depending upon the
HDF5 Configuration, the wrapper compiler is called
either h5cc or h5pcc. If this succeeds, the module
will then call the compiler with the -show argument to
see what flags are used when compiling an HDF5 client
application.
The module will optionally accept the COMPONENTS argu-
ment. 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.
cmake 2.8.6 Last change: June 17, 2014 225
User Commands cmake(1)
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
cmake 2.8.6 Last change: June 17, 2014 226
User Commands cmake(1)
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. Typi-
cal components include, but are not limited to (future
versions of ImageMagick might have additional compo-
nents 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.
cmake 2.8.6 Last change: June 17, 2014 227
User Commands cmake(1)
ImageMagick_EXECUTABLE_DIR - Full path to executables directory.
ImageMagick_<component>_FOUND - TRUE if <component> is found.
ImageMagick_<component>_EXECUTABLE - Full path to <component> executable.
There are also components for the following ImageMagick
APIs:
Magick++
MagickWand
MagickCore
For these components the following variables are set:
ImageMagick_FOUND - TRUE if all components are found.
ImageMagick_INCLUDE_DIRS - Full paths to all include dirs.
ImageMagick_LIBRARIES - Full paths to all libraries.
ImageMagick_<component>_FOUND - TRUE if <component> is found.
ImageMagick_<component>_INCLUDE_DIRS - Full path to <component> include dirs.
ImageMagick_<component>_LIBRARIES - Full path to <component> libraries.
Example Usages:
FIND_PACKAGE(ImageMagick)
FIND_PACKAGE(ImageMagick COMPONENTS convert)
FIND_PACKAGE(ImageMagick COMPONENTS convert mogrify display)
FIND_PACKAGE(ImageMagick COMPONENTS Magick++)
FIND_PACKAGE(ImageMagick COMPONENTS Magick++ convert)
Note that the standard FIND_PACKAGE features are sup-
ported (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
cmake 2.8.6 Last change: June 17, 2014 228
User Commands cmake(1)
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
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:
cmake 2.8.6 Last change: June 17, 2014 229
User Commands cmake(1)
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_VER-
SION_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_<component>_FOUND - TRUE if <component> is found.
Example Usages:
FIND_PACKAGE(Java)
FIND_PACKAGE(Java COMPONENTS Runtime)
FIND_PACKAGE(Java COMPONENTS Development)
cmake 2.8.6 Last change: June 17, 2014 230
User Commands cmake(1)
FindKDE3
Find the KDE3 include and library dirs, KDE preproces-
sors 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.
cmake 2.8.6 Last change: June 17, 2014 231
User Commands cmake(1)
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 )
cmake 2.8.6 Last change: June 17, 2014 232
User Commands cmake(1)
Currently identical to ADD_EXECUTABLE(), may provide some advanced features in the future.
KDE3_ADD_KPART(name [WITH_PREFIX] file1 ... fileN )
Create a KDE plugin (KPart, kioslave, etc.) from the given source files.
If WITH_PREFIX is given, the resulting plugin will have the prefix "lib", otherwise it won't.
It creates and installs an appropriate libtool la-file.
KDE3_ADD_KDEINIT_EXECUTABLE(name file1 ... fileN )
Create a KDE application in the form of a module loadable via kdeinit.
A library named kdeinit_<name> will be created and a small executable which links to it.
The option KDE3_ENABLE_FINAL to enable all-in-one com-
pilation is no longer supported.
Author: Alexander Neundorf <neundorf@kde.org>
FindKDE4
Find KDE4 and provide all necessary variables and
macros to compile software for it. It looks for KDE 4
in the following directories in the given order:
CMAKE_INSTALL_PREFIX
KDEDIRS
/opt/kde4
Please look in FindKDE4Internal.cmake and
KDE4Macros.cmake for more information. They are
installed with the KDE 4 libraries in
cmake 2.8.6 Last change: June 17, 2014 233
User Commands cmake(1)
$KDEDIRS/share/apps/cmake/modules/.
Author: Alexander Neundorf <neundorf@kde.org>
FindLAPACK
Find LAPACK library
This module finds an installed fortran library that
implements the LAPACK linear-algebra interface (see
http://www.netlib.org/lapack/).
The approach follows that taken for the autoconf macro
file, acx_lapack.m4 (distributed at http://ac-ar-
chive.sourceforge.net/ac-archive/acx_lapack.html).
This module sets the following variables:
LAPACK_FOUND - set to true if a library implementing the LAPACK interface
is found
LAPACK_LINKER_FLAGS - uncached list of required linker flags (excluding -l
and -L).
LAPACK_LIBRARIES - uncached list of libraries (using full path name) to
link against to use LAPACK
LAPACK95_LIBRARIES - uncached list of libraries (using full path name) to
link against to use LAPACK95
LAPACK95_FOUND - set to true if a library implementing the LAPACK f95
interface is found
BLA_STATIC if set on this determines what kind of linkage we do (static)
BLA_VENDOR if set checks only the specified vendor, if not set checks
all the possibilities
BLA_F95 if set on tries to find the f95 interfaces for BLAS/LAPACK
## List of vendors (BLA_VENDOR) valid in this module #
Intel(mkl), ACML,Apple, NAS, Generic
FindLATEX
Find Latex
This module finds if Latex is installed and determines
where the executables are. This code sets the following
variables:
LATEX_COMPILER: path to the LaTeX compiler
PDFLATEX_COMPILER: path to the PdfLaTeX compiler
cmake 2.8.6 Last change: June 17, 2014 234
User Commands cmake(1)
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
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
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
FindLua50
Locate Lua library This module defines
cmake 2.8.6 Last change: June 17, 2014 235
User Commands cmake(1)
LUA50_FOUND, if false, do not try to link to Lua
LUA_LIBRARIES, both lua and lualib
LUA_INCLUDE_DIR, where to find lua.h and lualib.h (and probably lauxlib.h)
Note that the expected include convention is
#include "lua.h"
and not
#include <lua/lua.h>
This is because, the lua location is not standardized
and may exist in locations other than lua/
FindLua51
Locate Lua library This module defines
LUA51_FOUND, if false, do not try to link to Lua
LUA_LIBRARIES
LUA_INCLUDE_DIR, where to find lua.h
Note that the expected include convention is
#include "lua.h"
and not
#include <lua/lua.h>
This is because, the lua location is not standardized
and may exist in locations other than lua/
FindMFC
Find MFC on Windows
Find the native MFC - i.e. decide if an application can
cmake 2.8.6 Last change: June 17, 2014 236
User Commands cmake(1)
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
cmake 2.8.6 Last change: June 17, 2014 237
User Commands cmake(1)
to link against, etc., and this module tries to smooth
out those differences.
=== Variables ===
This module will set the following variables per lan-
guage in your project, where <lang> is one of C, CXX,
or Fortran:
MPI_<lang>_FOUND TRUE if FindMPI found MPI flags for <lang>
MPI_<lang>_COMPILER MPI Compiler wrapper for <lang>
MPI_<lang>_COMPILE_FLAGS Compilation flags for MPI programs
MPI_<lang>_INCLUDE_PATH Include path(s) for MPI header
MPI_<lang>_LINK_FLAGS Linking flags for MPI programs
MPI_<lang>_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 CMake-
Lists.txt file, or run find_package(MPI), then run
CMake. If you are happy with the auto- detected con-
figuration for your language, then you're done. If
not, you have two options:
1. Set MPI_<lang>_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_<lang>_LIBRARIES and
MPI_<lang>_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_<lang>_COMPILER
will be set to the compiler wrapper for <lang>, if it
was found. MPI_<lang>_FOUND and other variables above
cmake 2.8.6 Last change: June 17, 2014 238
User Commands cmake(1)
will be set if any MPI implementation was found for
<lang>, regardless of whether a compiler was found.
When using MPIEXEC to execute MPI applications, you
should typically use all of the MPIEXEC flags as fol-
lows:
${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 Find-
MPI, 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_<lang>_XXX equiva-
lents.
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
cmake 2.8.6 Last change: June 17, 2014 239
User Commands cmake(1)
MOTIF_INCLUDE_DIR - include paths to use Motif
MOTIF_LIBRARIES - Link these to use Motif
FindOpenAL
Locate OpenAL This module defines OPENAL_LIBRARY OPE-
NAL_FOUND, if false, do not try to link to OpenAL OPE-
NAL_INCLUDE_DIR, where to find the headers
$OPENALDIR is an environment variable that would corre-
spond to the ./configure --prefix=$OPENALDIR used in
building OpenAL.
Created by Eric Wing. This was influenced by the Find-
SDL.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
cmake 2.8.6 Last change: June 17, 2014 240
User Commands cmake(1)
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 (eg. 0.9.8)
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
cmake 2.8.6 Last change: June 17, 2014 241
User Commands cmake(1)
require CMake >= 2.6.3 with cmake_minimum_required(VER-
SION 2.6.3) or download and place Find-
OpenThreads.cmake, Findosg_functions.cmake, Find-
osg.cmake, and Find<etc>.cmake files into your
CMAKE_MODULE_PATH.
==================================
This module accepts the following variables (note mixed
case)
OpenSceneGraph_DEBUG - Enable debugging output
OpenSceneGraph_MARK_AS_ADVANCED - Mark cache variables as advanced
automatically
The following environment variables are also respected
for finding the OSG and it's various components.
CMAKE_PREFIX_PATH can also be used for this (see
find_library() CMake documentation).
<MODULE>_DIR (where MODULE is of the form "OSGVOLUME" and there is a FindosgVolume.cmake file)
OSG_DIR
OSGDIR
OSG_ROOT
This module defines the following output variables:
OPENSCENEGRAPH_FOUND - Was the OSG and all of the specified components found?
OPENSCENEGRAPH_VERSION - The version of the OSG which was found
cmake 2.8.6 Last change: June 17, 2014 242
User Commands cmake(1)
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 con-
sider 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.
cmake 2.8.6 Last change: June 17, 2014 243
User Commands cmake(1)
FindPHP4
Find PHP4
This module finds if PHP4 is installed and determines
where the include files and libraries are. It also
determines what the name of the library is. This code
sets the following variables:
PHP4_INCLUDE_PATH = path to where php.h can be found
PHP4_EXECUTABLE = full path to the php4 binary
FindPNG
Find the native PNG includes and library
This module defines
PNG_INCLUDE_DIR, where to find png.h, etc.
PNG_LIBRARIES, the libraries to link against to use PNG.
PNG_DEFINITIONS - You should add_definitons(${PNG_DEFINITIONS}) before compiling code that includes png library files.
PNG_FOUND, If false, do not try to use PNG.
also defined, but not for general use are
PNG_LIBRARY, where to find the PNG library.
None of the above will be defined unles zlib can be
found. PNG depends on Zlib
FindPackageHandleStandardArgs
FIND_PACKAGE_HANDLE_STANDARD_ARGS(<name> ... )
This function is intended to be used in FindXXX.cmake
modules files. It handles the REQUIRED, QUIET and ver-
sion-related arguments to FIND_PACKAGE(). It also sets
the <UPPERCASED_NAME>_FOUND variable. The package is
considered found if all variables <var1>... listed con-
tain valid results, e.g. valid filepaths.
cmake 2.8.6 Last change: June 17, 2014 244
User Commands cmake(1)
There are two modes of this function. The first argu-
ment 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(<name> (DEFAULT_MSG|"Custom failure message") <var1>...<varN> )
If the variables <var1> to <varN> are all valid, then
<UPPERCASED_NAME>_FOUND will be set to TRUE. If
DEFAULT_MSG is given as second argument, then the func-
tion will generate itself useful success and error mes-
sages. 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 ver-
sion checking:
FIND_PACKAGE_HANDLE_STANDARD_ARGS(NAME [REQUIRED_VARS <var1>...<varN>]
[VERSION_VAR <versionvar>
[CONFIG_MODE]
[FAIL_MESSAGE "Custom failure message"] )
As above, if <var1> through <varN> are all valid,
<UPPERCASED_NAME>_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. Use the option CONFIG_MODE if
your FindXXX.cmake module is a wrapper for a find_pack-
age(... NO_MODULE) call, in this case all the informa-
tion provided by the config-mode of find_package() will
be evaluated automatically. 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:
cmake 2.8.6 Last change: June 17, 2014 245
User Commands cmake(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, inde-
pendent whether QUIET was used or not. If it is found,
success will be reported, including the content of
<var1>. 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_PACK-
AGE_HANDLE_STANDARD_ARGS() call produces a proper suc-
cess/error message.
FindPackageMessage
FIND_PACKAGE_MESSAGE(<name> "message for user" "find
result details")
This macro is intended to be used in FindXXX.cmake mod-
ules files. It will print a message once for each
unique find result. This is useful for telling the user
cmake 2.8.6 Last change: June 17, 2014 246
User Commands cmake(1)
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 com-
mand.
Example:
IF(X11_FOUND)
FIND_PACKAGE_MESSAGE(X11 "Found X11: ${X11_X11_LIB}"
"[${X11_X11_LIB}][${X11_INCLUDE_DIR}]")
ELSE(X11_FOUND)
...
ENDIF(X11_FOUND)
FindPerl
Find perl
this module looks for Perl
PERL_EXECUTABLE - the full path to perl
PERL_FOUND - If false, don't attempt to use perl.
FindPerlLibs
Find Perl libraries
This module finds if PERL is installed and determines
where the include files and libraries are. It also
determines what the name of the library is. This code
sets the following variables:
PERLLIBS_FOUND = True if perl.h & libperl were found
PERL_INCLUDE_PATH = path to where perl.h is found
PERL_LIBRARY = path to libperl
PERL_EXECUTABLE = full path to the perl binary
The minimum required version of Perl can be specified
using the standard syntax, e.g. FIND_PACKAGE(PerlLibs
6.0)
cmake 2.8.6 Last change: June 17, 2014 247
User Commands cmake(1)
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 corre-
spond 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
cmake 2.8.6 Last change: June 17, 2014 248
User Commands cmake(1)
a pkg-config module for CMake
Usage:
pkg_check_modules(<PREFIX> [REQUIRED] [QUIET] <MODULE> [<MODULE>]*)
checks for all the given modules
pkg_search_module(<PREFIX> [REQUIRED] [QUIET] <MODULE> [<MODULE>]*)
checks for given modules and uses the first working one
When the 'REQUIRED' argument was set, macros will fail
with an error when module(s) could not be found
When the 'QUIET' argument is set, no status messages
will be printed.
It sets the following variables:
PKG_CONFIG_FOUND ... true if pkg-config works on the system
PKG_CONFIG_EXECUTABLE ... pathname of the pkg-config program
<PREFIX>_FOUND ... set to 1 if module(s) exist
For the following variables two sets of values exist;
first one is the common one and has the given PREFIX.
The second set contains flags which are given out when
pkgconfig was called with the '--static' option.
<XPREFIX>_LIBRARIES ... only the libraries (w/o the '-l')
<XPREFIX>_LIBRARY_DIRS ... the paths of the libraries (w/o the '-L')
<XPREFIX>_LDFLAGS ... all required linker flags
<XPREFIX>_LDFLAGS_OTHER ... all other linker flags
<XPREFIX>_INCLUDE_DIRS ... the '-I' preprocessor flags (w/o the '-I')
<XPREFIX>_CFLAGS ... all required cflags
<XPREFIX>_CFLAGS_OTHER ... the other compiler flags
cmake 2.8.6 Last change: June 17, 2014 249
User Commands cmake(1)
<XPREFIX> = <PREFIX> for common case
<XPREFIX> = <PREFIX>_STATIC for static linking
There are some special variables whose prefix depends
on the count of given modules. When there is only one
module, <PREFIX> stays unchanged. When there are multi-
ple modules, the prefix will be changed to <PRE-
FIX>_<MODNAME>:
<XPREFIX>_VERSION ... version of the module
<XPREFIX>_PREFIX ... prefix-directory of the module
<XPREFIX>_INCLUDEDIR ... include-dir of the module
<XPREFIX>_LIBDIR ... lib-dir of the module
<XPREFIX> = <PREFIX> when |MODULES| == 1, else
<XPREFIX> = <PREFIX>_<MODNAME>
A <MODULE> parameter can have the following formats:
{MODNAME} ... matches any version
{MODNAME}>={VERSION} ... at least version <VERSION> is required
{MODNAME}={VERSION} ... exactly version <VERSION> is required
{MODNAME}<={VERSION} ... modules must not be newer than <VERSION>
Examples
pkg_check_modules (GLIB2 glib-2.0)
pkg_check_modules (GLIB2 glib-2.0>=2.10)
requires at least version 2.10 of glib2 and defines e.g.
GLIB2_VERSION=2.10.3
cmake 2.8.6 Last change: June 17, 2014 250
User Commands cmake(1)
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.
Usage: In your CMakeLists.txt file do something like
this: ... # PostgreSQL FIND_PACKAGE(PostgreSQL) ... if(
PostgreSQL_FOUND )
include_directories(${PostgreSQL_INCLUDE_DIRS})
endif( PostgreSQL_FOUND ) ... Remember to include
${PostgreSQL_LIBRARIES} in the target_link_libraries()
statement.
In Windows, we make the assumption that, if the Post-
greSQL files are installed, the default directory will
be C:\Program Files\PostgreSQL.
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.
cmake 2.8.6 Last change: June 17, 2014 251
User Commands cmake(1)
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 Pro-
ducer 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.
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]
cmake 2.8.6 Last change: June 17, 2014 252
User Commands cmake(1)
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.
====================================================================
cmake 2.8.6 Last change: June 17, 2014 253
User Commands cmake(1)
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
Python_ADDITIONAL_VERSIONS - list of additional Python versions to search for
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)
cmake 2.8.6 Last change: June 17, 2014 254
User Commands cmake(1)
PYTHON_INCLUDE_DIRS - path to where Python.h is found
PYTHON_DEBUG_LIBRARIES - path to the debug library
Python_ADDITIONAL_VERSIONS - list of additional Python versions to search for
FindQt
Searches for all installed versions of QT.
This should only be used if your project can work with
multiple versions of QT. If not, you should just
directly use FindQt4 or FindQt3. If multiple versions
of QT are found on the machine, then The user must set
the option DESIRED_QT_VERSION to the version they want
to use. If only one version of qt is found on the
machine, then the DESIRED_QT_VERSION is set to that
version and the matching FindQt3 or FindQt4 module is
included. Once the user sets DESIRED_QT_VERSION, then
the FindQt3 or FindQt4 module is included.
QT_REQUIRED if this is set to TRUE then if CMake can
not find QT4 or QT3 an error is raised
and a message is sent to the user.
DESIRED_QT_VERSION OPTION is created
QT4_INSTALLED is set to TRUE if qt4 is found.
QT3_INSTALLED is set to TRUE if qt3 is found.
FindQt3
Locate Qt include paths and libraries
This module defines:
QT_INCLUDE_DIR - where to find qt.h, etc.
QT_LIBRARIES - the libraries to link against to use Qt.
QT_DEFINITIONS - definitions to use when
compiling code that uses Qt.
QT_FOUND - If false, don't try to use Qt.
If you need the multithreaded version of Qt, set
QT_MT_REQUIRED to TRUE
Also defined, but not for general use are:
cmake 2.8.6 Last change: June 17, 2014 255
User Commands cmake(1)
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 vari-
able.
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 ver-
sion used in the find_package() command overrides the
one from QT_MIN_VERSION.
When using the components argument, QT_USE_QT* vari-
ables 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
cmake 2.8.6 Last change: June 17, 2014 256
User Commands cmake(1)
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
cmake 2.8.6 Last change: June 17, 2014 257
User Commands cmake(1)
are also added. Options may be given to moc, such as those found
when executing "moc -help".
macro QT4_WRAP_UI(outfiles inputfile ... OPTIONS ...)
create code from a list of Qt designer ui files.
Options may be given to uic, such as those found
when executing "uic -help"
macro QT4_ADD_RESOURCES(outfiles inputfile ... OPTIONS ...)
create code from a list of Qt resource files.
Options may be given to rcc, such as those found
when executing "rcc -help"
macro QT4_GENERATE_MOC(inputfile outputfile )
creates a rule to run moc on infile and create outfile.
Use this if for some reason QT4_WRAP_CPP() isn't appropriate, e.g.
because you need a custom filename for the moc file or something similar.
macro QT4_AUTOMOC(sourcefile1 sourcefile2 ... )
This macro is still experimental.
It can be used to have moc automatically handled.
So if you have the files foo.h and foo.cpp, and in foo.h a
a class uses the Q_OBJECT macro, moc has to run on it. If you don't
want to use QT4_WRAP_CPP() (which is reliable and mature), you can insert
#include "foo.moc"
in foo.cpp and then give foo.cpp as argument to QT4_AUTOMOC(). This will the
scan all listed files at cmake-time for such included moc files and if it finds
them cause a rule to be generated to run moc at build time on the
accompanying header file foo.h.
If a source file has the SKIP_AUTOMOC property set it will be ignored by this macro.
macro QT4_ADD_DBUS_INTERFACE(outfiles interface basename)
create a the interface header and implementation files with the
given basename from the given interface xml file and add it to
the list of sources
cmake 2.8.6 Last change: June 17, 2014 258
User Commands cmake(1)
macro QT4_ADD_DBUS_INTERFACES(outfiles inputfile ... )
create the interface header and implementation files
for all listed interface xml files
the name will be automatically determined from the name of the xml file
macro QT4_ADD_DBUS_ADAPTOR(outfiles xmlfile parentheader parentclassname [basename] [classname])
create a dbus adaptor (header and implementation file) from the xml file
describing the interface, and add it to the list of sources. The adaptor
forwards the calls to a parent class, defined in parentheader and named
parentclassname. The name of the generated files will be
<basename>adaptor.{cpp,h} where basename defaults to the basename of the xml file.
If <classname> is provided, then it will be used as the classname of the
adaptor itself.
macro QT4_GENERATE_DBUS_INTERFACE( header [interfacename] OPTIONS ...)
generate the xml interface file from the given header.
If the optional argument interfacename is omitted, the name of the
interface file is constructed from the basename of the header with
the suffix .xml appended.
Options may be given to qdbuscpp2xml, such as those found when executing "qdbuscpp2xml --help"
macro QT4_CREATE_TRANSLATION( qm_files directories ... sources ...
ts_files ... OPTIONS ...)
out: qm_files
in: directories sources ts_files
options: flags to pass to lupdate, such as -extensions to specify
extensions for a directory scan.
generates commands to create .ts (vie lupdate) and .qm
(via lrelease) - files from directories and/or sources. The ts files are
created and/or updated in the source tree (unless given with full paths).
The qm files are generated in the build tree.
Updating the translations can be done by adding the qm_files
to the source list of your library/executable, so they are
always updated, or by adding a custom target to control when
they get updated/generated.
macro QT4_ADD_TRANSLATION( qm_files ts_files ... )
out: qm_files
in: ts_files
generates commands to create .qm from .ts - files. The generated
cmake 2.8.6 Last change: June 17, 2014 259
User Commands cmake(1)
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.
cmake 2.8.6 Last change: June 17, 2014 260
User Commands cmake(1)
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"
cmake 2.8.6 Last change: June 17, 2014 261
User Commands cmake(1)
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 vari-
ables 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
cmake 2.8.6 Last change: June 17, 2014 262
User Commands cmake(1)
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_QTDECLARA-
TIVE_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 (com-
pared 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
cmake 2.8.6 Last change: June 17, 2014 263
User Commands cmake(1)
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 par-
ticular RTI implementation.
http://en.wikipedia.org/wiki/Run-Time_Infrastructure_(simulation)
This code sets the following variables:
RTI_INCLUDE_DIR = the directory where RTI includes file are found
RTI_LIBRARIES = The libraries to link against to use RTI
RTI_DEFINITIONS = -DRTI_USES_STD_FSTREAM
RTI_FOUND = Set to FALSE if any HLA RTI was not found
Report problems to <certi-devel@nongnu.org>
FindRuby
Find Ruby
This module finds if Ruby is installed and determines
where the include files and libraries are. Ruby 1.8 and
cmake 2.8.6 Last change: June 17, 2014 264
User Commands cmake(1)
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_BUILD-
ING_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 applica-
tion 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.
cmake 2.8.6 Last change: June 17, 2014 265
User Commands cmake(1)
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, lib-
sdl.so, SDL.framework, etc). Set SDL_LIBRARY_TEMP to
point to your SDL library, and configure again. Simi-
larly, 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 corre-
spond to the ./configure --prefix=$SDLDIR used in
building SDL. l.e.galup 9-20-02
Modified by Eric Wing. Added code to assist with auto-
mated 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 cor-
rected the header search path to follow "proper" SDL
guidelines. Added a search for SDLmain which is needed
by some platforms. Added a search for threads which is
needed by some platforms. Added needed compile switches
for MinGW.
On OSX, this will prefer the Framework version (if
found) over others. People will have to manually change
the cache values of SDL_LIBRARY to override this
selection or set the CMake environment
CMAKE_INCLUDE_PATH to modify the search paths.
Note that the header path has changed from SDL/SDL.h to
just SDL.h This needed to change because "proper" SDL
convention is #include "SDL.h", not <SDL/SDL.h>. This
is done for portability reasons because not all systems
place things in SDL/ (see FreeBSD).
FindSDL_image
Locate SDL_image library This module defines SDLIM-
AGE_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
cmake 2.8.6 Last change: June 17, 2014 266
User Commands cmake(1)
$SDLDIR is an environment variable that would corre-
spond to the ./configure --prefix=$SDLDIR used in
building SDL.
Created by Eric Wing. This was influenced by the Find-
SDL.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 corre-
spond to the ./configure --prefix=$SDLDIR used in
building SDL.
Created by Eric Wing. This was influenced by the Find-
SDL.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 SDL-
NET_LIBRARY, the name of the library to link against
SDLNET_FOUND, if false, do not try to link against SDL-
NET_INCLUDE_DIR, where to find the headers
$SDLDIR is an environment variable that would corre-
spond to the ./configure --prefix=$SDLDIR used in
building SDL.
Created by Eric Wing. This was influenced by the Find-
SDL.cmake module, but with modifications to recognize
OS X frameworks and additional Unix paths (FreeBSD,
etc).
FindSDL_sound
cmake 2.8.6 Last change: June 17, 2014 267
User Commands cmake(1)
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 corre-
spond to the ./configure --prefix=$SDLDIR used in
building SDL.
Created by Eric Wing. This was influenced by the Find-
SDL.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 fol-
lowing 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 com-
mand line by means of setting SWIG_EXECUTABLE
FindSelfPackers
Find upx
This module looks for some executable packers (i.e.
cmake 2.8.6 Last change: June 17, 2014 268
User Commands cmake(1)
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 sup-
port 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
cmake 2.8.6 Last change: June 17, 2014 269
User Commands cmake(1)
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 spec-
ified using the standard syntax, e.g. FIND_PACKAGE(Sub-
version 1.4)
If the command line client executable is found two
macros are defined:
Subversion_WC_INFO(<dir> <var-prefix>)
Subversion_WC_LOG(<dir> <var-prefix>)
Subversion_WC_INFO extracts information of a subversion
working copy at a given location. This macro defines
the following variables:
<var-prefix>_WC_URL - url of the repository (at <dir>)
<var-prefix>_WC_ROOT - root url of the repository
<var-prefix>_WC_REVISION - current revision
<var-prefix>_WC_LAST_CHANGED_AUTHOR - author of last commit
<var-prefix>_WC_LAST_CHANGED_DATE - date of last commit
<var-prefix>_WC_LAST_CHANGED_REV - revision of last commit
<var-prefix>_WC_INFO - output of command `svn info <dir>'
Subversion_WC_LOG retrieves the log message of the base
revision of a subversion working copy at a given loca-
tion. This macro defines the variable:
<var-prefix>_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}")
cmake 2.8.6 Last change: June 17, 2014 270
User Commands cmake(1)
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
cmake 2.8.6 Last change: June 17, 2014 271
User Commands cmake(1)
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 Find-
TCL.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
cmake 2.8.6 Last change: June 17, 2014 272
User Commands cmake(1)
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 sys-
tem.
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
cmake 2.8.6 Last change: June 17, 2014 273
User Commands cmake(1)
(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 compati-
bility 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:
cmake 2.8.6 Last change: June 17, 2014 274
User Commands cmake(1)
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_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_Xpm_INCLUDE_PATH, X11_Xpm_LIB, X11_Xpm_FOUND
cmake 2.8.6 Last change: June 17, 2014 275
User Commands cmake(1)
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 "xml-
rpc-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
cmake 2.8.6 Last change: June 17, 2014 276
User Commands cmake(1)
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 com-
patibility
ZLIB_MAJOR_VERSION - The major version of zlib
ZLIB_MINOR_VERSION - The minor version of zlib
ZLIB_PATCH_VERSION - The patch version of zlib
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 Open-
SceneGraph 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 (per-
haps 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
cmake 2.8.6 Last change: June 17, 2014 277
User Commands cmake(1)
$OSGDIR is an environment variable that would corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgAnimation
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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? OSGANIMA-
TION_INCLUDE_DIR - Where to find the headers OSGANIMA-
TION_LIBRARIES - The libraries to link against for the
OSG (use this)
OSGANIMATION_LIBRARY - The OSG library OSGANIMA-
TION_LIBRARY_DEBUG - The OSG debug library
$OSGDIR is an environment variable that would corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgDB
This is part of the Findosg* suite used to find Open-
SceneGraph components. Each component is separate and
cmake 2.8.6 Last change: June 17, 2014 278
User Commands cmake(1)
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 (per-
haps 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 corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgFX
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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
cmake 2.8.6 Last change: June 17, 2014 279
User Commands cmake(1)
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 corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgGA
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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 corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
cmake 2.8.6 Last change: June 17, 2014 280
User Commands cmake(1)
Created by Eric Wing.
FindosgIntrospection
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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 head-
ers 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 corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgManipulator
This is part of the Findosg* suite used to find Open-
SceneGraph 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
cmake 2.8.6 Last change: June 17, 2014 281
User Commands cmake(1)
case you need to opt out of certain components or
change the Find behavior for a particular module (per-
haps 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? OSGMA-
NIPULATOR_INCLUDE_DIR - Where to find the headers OSG-
MANIPULATOR_LIBRARIES - The libraries to link for osg-
Manipulator (use this)
OSGMANIPULATOR_LIBRARY - The osgManipulator library
OSGMANIPULATOR_LIBRARY_DEBUG - The osgManipulator debug
library
$OSGDIR is an environment variable that would corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgParticle
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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
cmake 2.8.6 Last change: June 17, 2014 282
User Commands cmake(1)
OSGPARTICLE_FOUND - Was osgParticle found? OSGPARTI-
CLE_INCLUDE_DIR - Where to find the headers OSGPARTI-
CLE_LIBRARIES - The libraries to link for osgParticle
(use this)
OSGPARTICLE_LIBRARY - The osgParticle library OSGPARTI-
CLE_LIBRARY_DEBUG - The osgParticle debug library
$OSGDIR is an environment variable that would corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgProducer
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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? OSGPRO-
DUCER_INCLUDE_DIR - Where to find the headers OSGPRO-
DUCER_LIBRARIES - The libraries to link for osgProducer
(use this)
OSGPRODUCER_LIBRARY - The osgProducer library OSGPRO-
DUCER_LIBRARY_DEBUG - The osgProducer debug library
$OSGDIR is an environment variable that would corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
cmake 2.8.6 Last change: June 17, 2014 283
User Commands cmake(1)
Created by Eric Wing.
FindosgShadow
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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 corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgSim
This is part of the Findosg* suite used to find Open-
SceneGraph 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
cmake 2.8.6 Last change: June 17, 2014 284
User Commands cmake(1)
change the Find behavior for a particular module (per-
haps 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 corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgTerrain
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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? OSGTER-
RAIN_INCLUDE_DIR - Where to find the headers OSGTER-
RAIN_LIBRARIES - The libraries to link for osgTerrain
cmake 2.8.6 Last change: June 17, 2014 285
User Commands cmake(1)
(use this)
OSGTERRAIN_LIBRARY - The osgTerrain library OSGTER-
RAIN_LIBRARY_DEBUG - The osgTerrain debug library
$OSGDIR is an environment variable that would corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgText
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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 OSG-
TEXT_LIBRARY_DEBUG - The osgText debug library
$OSGDIR is an environment variable that would corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
cmake 2.8.6 Last change: June 17, 2014 286
User Commands cmake(1)
FindosgUtil
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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 corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgViewer
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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
cmake 2.8.6 Last change: June 17, 2014 287
User Commands cmake(1)
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 corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgVolume
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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? OSGVOL-
UME_INCLUDE_DIR - Where to find the headers OSGVOL-
UME_LIBRARIES - The libraries to link for osgVolume
(use this)
cmake 2.8.6 Last change: June 17, 2014 288
User Commands cmake(1)
OSGVOLUME_LIBRARY - The osgVolume library OSGVOL-
UME_LIBRARY_DEBUG - The osgVolume debug library
$OSGDIR is an environment variable that would corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
Created by Eric Wing.
FindosgWidget
This is part of the Findosg* suite used to find Open-
SceneGraph 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 (per-
haps 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? OSGWID-
GET_INCLUDE_DIR - Where to find the headers OSGWID-
GET_LIBRARIES - The libraries to link for osgWidget
(use this)
OSGWIDGET_LIBRARY - The osgWidget library OSGWID-
GET_LIBRARY_DEBUG - The osgWidget debug library
$OSGDIR is an environment variable that would corre-
spond to the ./configure --prefix=$OSGDIR used in
building osg.
FindosgWidget.cmake tweaked from Findosg* suite as cre-
ated by Eric Wing.
cmake 2.8.6 Last change: June 17, 2014 289
User Commands cmake(1)
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, univer-
sal/non-universal, and static/shared in the QtDialog or
ccmake interfaces by turning ON/OFF the following vari-
ables:
cmake 2.8.6 Last change: June 17, 2014 290
User Commands cmake(1)
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-con-
fig utility. For example, to use the base toolkit found
in the /usr/local path, set the variable (before call-
ing 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:
cmake 2.8.6 Last change: June 17, 2014 291
User Commands cmake(1)
TARGET_LINK_LIBRARIES(<YourTarget> ${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(<YourTarget> ${wxWidgets_LIBRARIES})
FindwxWindows
Find wxWindows (wxWidgets) installation
This module finds if wxWindows/wxWidgets is installed
and determines where the include files and libraries
are. It also determines what the name of the library
is. Please note this file is DEPRECATED and replaced by
FindwxWidgets.cmake. This code sets the following vari-
ables:
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++
cmake 2.8.6 Last change: June 17, 2014 292
User Commands cmake(1)
For convenience include Use_wxWindows.cmake in your
project's CMakeLists.txt using INCLUDE(Use_wxWindows).
USAGE
SET(WXWINDOWS_USE_GL 1)
FIND_PACKAGE(wxWindows)
NOTES wxWidgets 2.6.x is supported for monolithic
builds e.g. compiled in wx/build/msw dir as:
nmake -f makefile.vc BUILD=debug SHARED=0 USE_OPENGL=1 MONOLITHIC=1
DEPRECATED
CMAKE_WX_CAN_COMPILE
WXWINDOWS_LIBRARY
CMAKE_WX_CXX_FLAGS
WXWINDOWS_INCLUDE_PATH
AUTHOR Jan Woetzel <http://www.mip.infor-
matik.uni-kiel.de/~jw> (07/2003-01/2006)
FortranCInterface
Fortran/C Interface Detection
This module automatically detects the API by which C
and Fortran languages interact. Variables indicate if
the mangling is found:
FortranCInterface_GLOBAL_FOUND = Global subroutines and functions
FortranCInterface_MODULE_FOUND = Module subroutines and functions
(declared by "MODULE PROCEDURE")
A function is provided to generate a C header file con-
taining macros to mangle symbol names:
cmake 2.8.6 Last change: June 17, 2014 293
User Commands cmake(1)
FortranCInterface_HEADER(<file>
[MACRO_NAMESPACE <macro-ns>]
[SYMBOL_NAMESPACE <ns>]
[SYMBOLS [<module>:]<function> ...])
It generates in <file> definitions of the following
macros:
#define FortranCInterface_GLOBAL (name,NAME) ...
#define FortranCInterface_GLOBAL_(name,NAME) ...
#define FortranCInterface_MODULE (mod,name, MOD,NAME) ...
#define FortranCInterface_MODULE_(mod,name, MOD,NAME) ...
These macros mangle four categories of Fortran symbols,
respectively:
- Global symbols without '_': call mysub()
- Global symbols with '_' : call my_sub()
- Module symbols without '_': use mymod; call mysub()
- Module symbols with '_' : use mymod; call my_sub()
If mangling for a category is not known, its macro is
left undefined. All macros require raw names in both
lower case and upper case. The MACRO_NAMESPACE option
replaces the default "FortranCInterface_" prefix with a
given namespace "<macro-ns>".
The SYMBOLS option lists symbols to mangle automati-
cally with C preprocessor definitions:
<function> ==> #define <ns><function> ...
<module>:<function> ==> #define <ns><module>_<function> ...
If the mangling for some symbol is not known then no
preprocessor definition is created, and a warning is
displayed. The SYMBOL_NAMESPACE option prefixes all
preprocessor definitions generated by the SYMBOLS
option with a given namespace "<ns>".
Example usage:
include(FortranCInterface)
FortranCInterface_HEADER(FC.h MACRO_NAMESPACE "FC_")
This creates a "FC.h" header that defines mangling
macros FC_GLOBAL(), FC_GLOBAL_(), FC_MODULE(), and
cmake 2.8.6 Last change: June 17, 2014 294
User Commands cmake(1)
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 FortranC-
Interface_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 MOD-
ULE manglings for many Fortran compilers, but it also
provides an interface to specify new possible man-
glings. 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)
cmake 2.8.6 Last change: June 17, 2014 295
User Commands cmake(1)
# ^^^^^^^^ ^^^^^ ^^^^^^^^^ ^^^^^^
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 vari-
ables:
CMAKE_INSTALL_<dir> - destination for files of a given type
CMAKE_INSTALL_FULL_<dir> - corresponding absolute path
where <dir> 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)
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_<dir> value may be passed to the
DESTINATION options of install() commands for the cor-
responding 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_<dir> value contains an abso-
lute path constructed from the corresponding destina-
tion by prepending (if necessary) the value of
CMAKE_INSTALL_PREFIX.
cmake 2.8.6 Last change: June 17, 2014 296
User Commands cmake(1)
GenerateExportHeader
Function for generation of export macros for libraries
This module provides the function GENER-
ATE_EXPORT_HEADER() and the accompanying ADD_COM-
PILER_EXPORT_FLAGS() function.
The GENERATE_EXPORT_HEADER function can be used to gen-
erate a file suitable for preprocessor inclusion which
contains EXPORT macros to be used in library classes.
GENERATE_EXPORT_HEADER( LIBRARY_TARGET
[BASE_NAME <base_name>]
[EXPORT_MACRO_NAME <export_macro_name>]
[EXPORT_FILE_NAME <export_file_name>]
[DEPRECATED_MACRO_NAME <deprecated_macro_name>]
[NO_EXPORT_MACRO_NAME <no_export_macro_name>]
[STATIC_DEFINE <static_define>]
[NO_DEPRECATED_MACRO_NAME <no_deprecated_macro_name>]
[DEFINE_NO_DEPRECATED]
[PREFIX_NAME <prefix_name>]
)
ADD_COMPILER_EXPORT_FLAGS( [FATAL_WARNINGS] )
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 option-
ally pass a single argument to ADD_COM-
PILER_EXPORT_FLAGS that will be populated with the
required CXX_FLAGS required to enable visibility sup-
port 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})
cmake 2.8.6 Last change: June 17, 2014 297
User Commands cmake(1)
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 con-
taining 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
)
cmake 2.8.6 Last change: June 17, 2014 298
User Commands cmake(1)
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})
cmake 2.8.6 Last change: June 17, 2014 299
User Commands cmake(1)
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 prerequi-
sites.
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)
cmake 2.8.6 Last change: June 17, 2014 300
User Commands cmake(1)
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(<target> <prerequisites_var> <exclude_system> <recurse>
<dirs>)
Get the list of shared library files required by <tar-
get>. The list in the variable named <prerequi-
sites_var> should be empty on first entry to this func-
tion. On exit, <prerequisites_var> will contain the
list of required shared library files.
<target> is the full path to an executable file. <pre-
requisites_var> is the name of a CMake variable to con-
tain the results. <exclude_system> must be 0 or 1 indi-
cating whether to include or exclude "system" prerequi-
sites. If <recurse> is set to 1 all prerequisites will
be found recursively, if set to 0 only direct prerequi-
sites are listed. <exepath> is the path to the top
level executable used for @executable_path replacment
on the Mac. <dirs> 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(<target> [<recurse> [<exclude_system> [<verbose>]]])
Print a message listing the prerequisites of <target>.
<target> is the name of a shared library or executable
target or the full path to a shared library or
cmake 2.8.6 Last change: June 17, 2014 301
User Commands cmake(1)
executable file. If <recurse> is set to 1 all prerequi-
sites will be found recursively, if set to 0 only
direct prerequisites are listed. <exclude_system> must
be 0 or 1 indicating whether to include or exclude
"system" prerequisites. With <verbose> 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(<glob_arg> <glob_exp>)
Print the prerequisites of shared library and exe-
cutable files matching a globbing pattern. <glob_arg>
is GLOB or GLOB_RECURSE and <glob_exp> 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_prerequi-
sites calls.
GP_APPEND_UNIQUE(<list_var> <value>)
Append <value> to the list variable <list_var> only if
the value is not already in the list.
IS_FILE_EXECUTABLE(<file> <result_var>)
Return 1 in <result_var> if <file> is a binary exe-
cutable, 0 otherwise.
GP_ITEM_DEFAULT_EMBEDDED_PATH(<item> <default_embedded_path_var>)
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(<context> <item> <exepath> <dirs> <resolved_item_var>)
Resolve an item into an existing full path file.
cmake 2.8.6 Last change: June 17, 2014 302
User Commands cmake(1)
Override on a per-project basis by providing a
project-specific gp_resolve_item_override function.
GP_RESOLVED_FILE_TYPE(<original_file> <file> <exepath> <dirs> <type_var>)
Return the type of <file> with respect to <origi-
nal_file>. String describing type of prerequisite is
returned in variable named <type_var>.
Use <exepath> and <dirs> if necessary to resolve
non-absolute <file> 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 func-
tion.
GP_FILE_TYPE(<original_file> <file> <type_var>)
Return the type of <file> with respect to <origi-
nal_file>. String describing type of prerequisite is
returned in variable named <type_var>.
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 2.8.6 Last change: June 17, 2014 303
User Commands cmake(1)
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_DESTI-
NATION 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 dis-
couraged. 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_PROP-
ERTY(SOURCE <file> 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 physi-
cal cores available on the machine if the information
cmake 2.8.6 Last change: June 17, 2014 304
User Commands cmake(1)
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 Win-
dows.
This function is guaranteed to return a positive inte-
ger (>=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 reason-
able. Of course, knowledge of what else might be run-
ning 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
cmake 2.8.6 Last change: June 17, 2014 305
User Commands cmake(1)
select_library_configurations( basename )
This macro takes a library base name as an argument,
and will choose good values for basename_LIBRARY, base-
name_LIBRARIES, basename_LIBRARY_DEBUG, and base-
name_LIBRARY_RELEASE depending on what has been found
and set. If only basename_LIBRARY_RELEASE is defined,
basename_LIBRARY, basename_LIBRARY_DEBUG, and base-
name_LIBRARY_RELEASE will be set to the release value.
If only basename_LIBRARY_DEBUG is defined, then base-
name_LIBRARY, basename_LIBRARY_DEBUG and base-
name_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 sup-
port 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
cmake 2.8.6 Last change: June 17, 2014 306
User Commands cmake(1)
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
cmake 2.8.6 Last change: June 17, 2014 307
User Commands cmake(1)
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 Find-
Java.cmake for information on how to load Java into
your CMake project.
cmake 2.8.6 Last change: June 17, 2014 308
User Commands cmake(1)
add_jar(TARGET_NAME SRC1 SRC2 .. SRCN RCS1 RCS2 ..
RCSN)
This command creates a <TARGET_NAME>.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 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.
cmake 2.8.6 Last change: June 17, 2014 309
User Commands cmake(1)
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 <target_name> PROPERTY <propery_name>)
command.
cmake 2.8.6 Last change: June 17, 2014 310
User Commands cmake(1)
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(<VAR>
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 <VAR> 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
<VAR>-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 argu-
ment. Additional search locations can be specified
after the PATHS argument. If you require special a ver-
sion 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)
cmake 2.8.6 Last change: June 17, 2014 311
User Commands cmake(1)
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(<VAR>
PACKAGES pkg1 [pkg2 ...]
[SOURCEPATH <sourcepath>]
[CLASSPATH <classpath>]
[INSTALLPATH <install path>]
[DOCTITLE "the documentation title"]
[WINDOWTITLE "the title of the document"]
[AUTHOR TRUE|FALSE]
[USE TRUE|FALSE]
[VERSION TRUE|FALSE]
)
Create jave 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_PATH}
CLASSPATH ${CMAKE_JAVA_INCLUDE_PATH}
WINDOWTITLE "My example"
DOCTITLE "<h1>My example</h1>"
AUTHOR TRUE
USE TRUE
VERSION TRUE
)
The second signature for create_javadoc works on a
given list of files.
create_javadoc(<VAR>
FILES file1 [file2 ...]
cmake 2.8.6 Last change: June 17, 2014 312
User Commands cmake(1)
[CLASSPATH <classpath>]
[INSTALLPATH <install path>]
[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 "<h1>My example</h1>"
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 CLASS-
PATH, DOCTITLE, WINDOWTITLE, AUTHOR, USE and VERSION.
The documentation will be by default installed to
${CMAKE_INSTALL_PREFIX}/share/javadoc/<VAR>
if you don't set the INSTALLPATH.
UseJavaClassFilelist
cmake 2.8.6 Last change: June 17, 2014 313
User Commands cmake(1)
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 spec-
ified 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:
cmake 2.8.6 Last change: June 17, 2014 314
User Commands cmake(1)
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_MOD-
ULE_${name}_REAL_NAME}. Set Source files properties
such as CPLUSPLUS and SWIG_FLAGS to specify special
behavior of SWIG. Also global CMAKE_SWIG_FLAGS can be
used to add special flags to all swig calls. Another
special variable is CMAKE_SWIG_OUTDIR, it allows one to
specify where to write all the swig generated module
(swig -outdir option) The name-specific variable
SWIG_MODULE_<name>_EXTRA_DEPS may be used to specify
extra dependencies for the generated modules. If the
source file generated by swig need some special flag
you can use SET_SOURCE_FILES_PROPERTIES( ${swig_gener-
ated_file_fullname}
PROPERTIES COMPILE_FLAGS "-bla")
Use_wxWindows
---------------------------------------------------
This convenience include finds if wxWindows is
installed and set the appropriate libs, incdirs, flags
etc. author Jan Woetzel <jw -at- mip.infor-
matik.uni-kiel.de> (07/2003)
USAGE:
just include Use_wxWindows.cmake
in your projects CMakeLists.txt
INCLUDE( ${CMAKE_MODULE_PATH}/Use_wxWindows.cmake)
if you are sure you need GL then
SET(WXWINDOWS_USE_GL 1)
*before* you include this file.
cmake 2.8.6 Last change: June 17, 2014 315
User Commands cmake(1)
UsewxWidgets
Convenience include for using wxWidgets library.
Determines if wxWidgets was FOUND and sets the appro-
priate 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(<YourTarget> ${wxWidgets_LIBRARIES})
DEPRECATED
LINK_LIBRARIES is not called in favor of adding dependencies per target.
AUTHOR
Jan Woetzel <jw -at- mip.informatik.uni-kiel.de>
WriteBasicConfigVersionFile
WRITE_BASIC_CONFIG_VERSION_FILE( filename VERSION major.minor.patch COMPATIBILITY (AnyNewerVersion|SameMajorVersion) )
Writes a file for use as <package>ConfigVersion.cmake
file to <filename>. See the documentation of FIND_PACK-
AGE() 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
cmake 2.8.6 Last change: June 17, 2014 316
User Commands cmake(1)
if it is newer or exactly the same as the requested
version. 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. 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.
Example:
write_basic_config_version_file(${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake
VERSION 1.2.3
COMPATIBILITY SameMajorVersion )
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/FooConfigVersion.cmake
${CMAKE_CURRENT_BINARY_DIR}/FooConfig.cmake
DESTINATION lib/cmake/Foo )
Internally, this macro executes configure_file() to
create the resulting version file. Depending on the
COMPATIBLITY, either the file BasicConfigVer-
sion-SameMajorVersion.cmake.in or BasicConfigVer-
sion-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 sophis-
ticted custom ConfigVersion.cmake files.
POLICIES
CMP0000
A minimum required CMake version must be specified.
CMake requires that projects specify the version of
CMake to which they have been written. This policy has
been put in place so users trying to build the project
may be told when they need to update their CMake.
Specifying a version also helps the project build with
CMake versions newer than that specified. Use the
cmake_minimum_required command at the top of your main
CMakeLists.txt file:
cmake_minimum_required(VERSION <major>.<minor>)
where "<major>.<minor>" is the version of CMake you
cmake 2.8.6 Last change: June 17, 2014 317
User Commands cmake(1)
want to support (such as "2.6"). The command will
ensure that at least the given version of CMake is run-
ning and help newer versions be compatible with the
project. See documentation of cmake_minimum_required
for details.
Note that the command invocation must appear in the
CMakeLists.txt file itself; a call in an included file
is not sufficient. However, the cmake_policy command
may be called to set policy CMP0000 to OLD or NEW
behavior explicitly. The OLD behavior is to silently
ignore the missing invocation. The NEW behavior is to
issue an error instead of a warning. An included file
may set CMP0000 explicitly to affect how this policy is
enforced for the main CMakeLists.txt file.
This policy was introduced in CMake version 2.6.0.
CMP0001
CMAKE_BACKWARDS_COMPATIBILITY should no longer be used.
The OLD behavior is to check CMAKE_BACKWARDS_COMPATI-
BILITY and present it to the user. The NEW behavior is
to ignore CMAKE_BACKWARDS_COMPATIBILITY completely.
In CMake 2.4 and below the variable CMAKE_BACK-
WARDS_COMPATIBILITY was used to request compatibility
with earlier versions of CMake. In CMake 2.6 and above
all compatibility issues are handled by policies and
the cmake_policy command. However, CMake must still
check CMAKE_BACKWARDS_COMPATIBILITY for projects writ-
ten for CMake 2.4 and below.
This policy was introduced in CMake version 2.6.0.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0002
Logical target names must be globally unique.
Targets names created with add_executable, add_library,
or add_custom_target are logical build target names.
Logical target names must be globally unique because:
cmake 2.8.6 Last change: June 17, 2014 318
User Commands cmake(1)
- Unique names may be referenced unambiguously both in CMake
code and on make tool command lines.
- Logical names are used by Xcode and VS IDE generators
to produce meaningful project names for the targets.
The logical name of executable and library targets does
not have to correspond to the physical file names
built. Consider using the OUTPUT_NAME target property
to create two targets with the same physical name while
keeping logical names distinct. Custom targets must
simply have globally unique names (unless one uses the
global property ALLOW_DUPLICATE_CUSTOM_TARGETS with a
Makefiles generator).
This policy was introduced in CMake version 2.6.0.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0003
Libraries linked via full path no longer produce linker
search paths.
This policy affects how libraries whose full paths are
NOT known are found at link time, but was created due
to a change in how CMake deals with libraries whose
full paths are known. Consider the code
target_link_libraries(myexe /path/to/libA.so)
CMake 2.4 and below implemented linking to libraries
whose full paths are known by splitting them on the
link line into separate components consisting of the
linker search path and the library name. The example
code might have produced something like
... -L/path/to -lA ...
in order to link to library A. An analysis was per-
formed to order multiple link directories such that the
linker would find library A in the desired location,
but there are cases in which this does not work. CMake
versions 2.6 and above use the more reliable approach
of passing the full path to libraries directly to the
linker in most cases. The example code now produces
something like
cmake 2.8.6 Last change: June 17, 2014 319
User Commands cmake(1)
... /path/to/libA.so ....
Unfortunately this change can break code like
target_link_libraries(myexe /path/to/libA.so B)
where "B" is meant to find "/path/to/libB.so". This
code is wrong because the user is asking the linker to
find library B but has not provided a linker search
path (which may be added with the link_directories com-
mand). However, with the old linking implementation
the code would work accidentally because the linker
search path added for library A allowed library B to be
found.
In order to support projects depending on linker search
paths added by linking to libraries with known full
paths, the OLD behavior for this policy will add the
linker search paths even though they are not needed for
their own libraries. When this policy is set to OLD,
CMake will produce a link line such as
... -L/path/to /path/to/libA.so -lB ...
which will allow library B to be found as it was previ-
ously. When this policy is set to NEW, CMake will pro-
duce a link line such as
... /path/to/libA.so -lB ...
which more accurately matches what the project speci-
fied.
The setting for this policy used when generating the
link line is that in effect when the target is created
by an add_executable or add_library command. For the
example described above, the code
cmake_policy(SET CMP0003 OLD) # or cmake_policy(VERSION 2.4)
add_executable(myexe myexe.c)
target_link_libraries(myexe /path/to/libA.so B)
will work and suppress the warning for this policy. It
may also be updated to work with the corrected linking
approach:
cmake 2.8.6 Last change: June 17, 2014 320
User Commands cmake(1)
cmake_policy(SET CMP0003 NEW) # or cmake_policy(VERSION 2.6)
link_directories(/path/to) # needed to find library B
add_executable(myexe myexe.c)
target_link_libraries(myexe /path/to/libA.so B)
Even better, library B may be specified with a full
path:
add_executable(myexe myexe.c)
target_link_libraries(myexe /path/to/libA.so /path/to/libB.so)
When all items on the link line have known paths CMake
does not check this policy so it has no effect.
Note that the warning for this policy will be issued
for at most one target. This avoids flooding users
with messages for every target when setting the policy
once will probably fix all targets.
This policy was introduced in CMake version 2.6.0.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0004
Libraries linked may not have leading or trailing
whitespace.
CMake versions 2.4 and below silently removed leading
and trailing whitespace from libraries linked with code
like
target_link_libraries(myexe " A ")
This could lead to subtle errors in user projects.
The OLD behavior for this policy is to silently remove
leading and trailing whitespace. The NEW behavior for
this policy is to diagnose the existence of such white-
space as an error. The setting for this policy used
when checking the library names is that in effect when
the target is created by an add_executable or
add_library command.
This policy was introduced in CMake version 2.6.0.
cmake 2.8.6 Last change: June 17, 2014 321
User Commands cmake(1)
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0005
Preprocessor definition values are now escaped automat-
ically.
This policy determines whether or not CMake should gen-
erate escaped preprocessor definition values added via
add_definitions. CMake versions 2.4 and below assumed
that only trivial values would be given for macros in
add_definitions calls. It did not attempt to escape
non-trivial values such as string literals in generated
build rules. CMake versions 2.6 and above support
escaping of most values, but cannot assume the user has
not added escapes already in an attempt to work around
limitations in earlier versions.
The OLD behavior for this policy is to place definition
values given to add_definitions directly in the gener-
ated build rules without attempting to escape anything.
The NEW behavior for this policy is to generate correct
escapes for all native build tools automatically. See
documentation of the COMPILE_DEFINITIONS target prop-
erty for limitations of the escaping implementation.
This policy was introduced in CMake version 2.6.0.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0006
Installing MACOSX_BUNDLE targets requires a BUNDLE DES-
TINATION.
This policy determines whether the install(TARGETS)
command must be given a BUNDLE DESTINATION when asked
to install a target with the MACOSX_BUNDLE property
set. CMake 2.4 and below did not distinguish applica-
tion bundles from normal executables when installing
targets. CMake 2.6 provides a BUNDLE option to the
install(TARGETS) command that specifies rules specific
to application bundles on the Mac. Projects should use
this option when installing a target with the
MACOSX_BUNDLE property set.
cmake 2.8.6 Last change: June 17, 2014 322
User Commands cmake(1)
The OLD behavior for this policy is to fall back to the
RUNTIME DESTINATION if a BUNDLE DESTINATION is not
given. The NEW behavior for this policy is to produce
an error if a bundle target is installed without a BUN-
DLE DESTINATION.
This policy was introduced in CMake version 2.6.0.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0007
list command no longer ignores empty elements.
This policy determines whether the list command will
ignore empty elements in the list. CMake 2.4 and below
list commands ignored all empty elements in the list.
For example, a;b;;c would have length 3 and not 4. The
OLD behavior for this policy is to ignore empty list
elements. The NEW behavior for this policy is to cor-
rectly count empty elements in a list.
This policy was introduced in CMake version 2.6.0.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0008
Libraries linked by full-path must have a valid library
file name.
In CMake 2.4 and below it is possible to write code
like
target_link_libraries(myexe /full/path/to/somelib)
where "somelib" is supposed to be a valid library file
name such as "libsomelib.a" or "somelib.lib". For
Makefile generators this produces an error at build
time because the dependency on the full path cannot be
found. For VS IDE and Xcode generators this used to
work by accident because CMake would always split off
the library directory and ask the linker to search for
the library by name (-lsomelib or somelib.lib).
Despite the failure with Makefiles, some projects have
code like this and build only with VS and/or Xcode.
This version of CMake prefers to pass the full path
cmake 2.8.6 Last change: June 17, 2014 323
User Commands cmake(1)
directly to the native build tool, which will fail in
this case because it does not name a valid library
file.
This policy determines what to do with full paths that
do not appear to name a valid library file. The OLD
behavior for this policy is to split the library name
from the path and ask the linker to search for it. The
NEW behavior for this policy is to trust the given path
and pass it directly to the native build tool
unchanged.
This policy was introduced in CMake version 2.6.1.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0009
FILE GLOB_RECURSE calls should not follow symlinks by
default.
In CMake 2.6.1 and below, FILE GLOB_RECURSE calls would
follow through symlinks, sometimes coming up with unex-
pectedly large result sets because of symlinks to top
level directories that contain hundreds of thousands of
files.
This policy determines whether or not to follow sym-
links encountered during a FILE GLOB_RECURSE call. The
OLD behavior for this policy is to follow the symlinks.
The NEW behavior for this policy is not to follow the
symlinks by default, but only if FOLLOW_SYMLINKS is
given as an additional argument to the FILE command.
This policy was introduced in CMake version 2.6.2.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0010
Bad variable reference syntax is an error.
In CMake 2.6.2 and below, incorrect variable reference
syntax such as a missing close-brace ("${FOO") was
reported but did not stop processing of CMake code.
This policy determines whether a bad variable reference
cmake 2.8.6 Last change: June 17, 2014 324
User Commands cmake(1)
is an error. The OLD behavior for this policy is to
warn about the error, leave the string untouched, and
continue. The NEW behavior for this policy is to report
an error.
This policy was introduced in CMake version 2.6.3.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0011
Included scripts do automatic cmake_policy PUSH and
POP.
In CMake 2.6.2 and below, CMake Policy settings in
scripts loaded by the include() and find_package() com-
mands would affect the includer. Explicit invocations
of cmake_policy(PUSH) and cmake_policy(POP) were
required to isolate policy changes and protect the
includer. While some scripts intend to affect the
policies of their includer, most do not. In CMake
2.6.3 and above, include() and find_package() by
default PUSH and POP an entry on the policy stack
around an included script, but provide a NO_POL-
ICY_SCOPE option to disable it. This policy determines
whether or not to imply NO_POLICY_SCOPE for compatibil-
ity. The OLD behavior for this policy is to imply
NO_POLICY_SCOPE for include() and find_package() com-
mands. The NEW behavior for this policy is to allow
the commands to do their default cmake_policy PUSH and
POP.
This policy was introduced in CMake version 2.6.3.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0012
if() recognizes numbers and boolean constants.
In CMake versions 2.6.4 and lower the if() command
implicitly dereferenced arguments corresponding to
variables, even those named like numbers or boolean
constants, except for 0 and 1. Numbers and boolean
constants such as true, false, yes, no, on, off, y, n,
notfound, ignore (all case insensitive) were recognized
in some cases but not all. For example, the code
"if(TRUE)" might have evaluated as false. Numbers such
cmake 2.8.6 Last change: June 17, 2014 325
User Commands cmake(1)
as 2 were recognized only in boolean expressions like
"if(NOT 2)" (leading to false) but not as a sin-
gle-argument like "if(2)" (also leading to false).
Later versions of CMake prefer to treat numbers and
boolean constants literally, so they should not be used
as variable names.
The OLD behavior for this policy is to implicitly
dereference variables named like numbers and boolean
constants. The NEW behavior for this policy is to rec-
ognize numbers and boolean constants without derefer-
encing variables with such names.
This policy was introduced in CMake version 2.8.0.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0013
Duplicate binary directories are not allowed.
CMake 2.6.3 and below silently permitted add_subdirec-
tory() calls to create the same binary directory multi-
ple times. During build system generation files would
be written and then overwritten in the build tree and
could lead to strange behavior. CMake 2.6.4 and above
explicitly detect duplicate binary directories. CMake
2.6.4 always considers this case an error. In CMake
2.8.0 and above this policy determines whether or not
the case is an error. The OLD behavior for this policy
is to allow duplicate binary directories. The NEW
behavior for this policy is to disallow duplicate
binary directories with an error.
This policy was introduced in CMake version 2.8.0.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0014
Input directories must have CMakeLists.txt.
CMake versions before 2.8 silently ignored missing
CMakeLists.txt files in directories referenced by
add_subdirectory() or subdirs(), treating them as if
present but empty. In CMake 2.8.0 and above this pol-
icy determines whether or not the case is an error.
cmake 2.8.6 Last change: June 17, 2014 326
User Commands cmake(1)
The OLD behavior for this policy is to silently ignore
the problem. The NEW behavior for this policy is to
report an error.
This policy was introduced in CMake version 2.8.0.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0015
link_directories() treats paths relative to the source
dir.
In CMake 2.8.0 and lower the link_directories() command
passed relative paths unchanged to the linker. In
CMake 2.8.1 and above the link_directories() command
prefers to interpret relative paths with respect to
CMAKE_CURRENT_SOURCE_DIR, which is consistent with
include_directories() and other commands. The OLD
behavior for this policy is to use relative paths ver-
batim in the linker command. The NEW behavior for this
policy is to convert relative paths to absolute paths
by appending the relative path to CMAKE_CUR-
RENT_SOURCE_DIR.
This policy was introduced in CMake version 2.8.1.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0016
target_link_libraries() reports error if only argument
is not a target.
In CMake 2.8.2 and lower the target_link_libraries()
command silently ignored if it was called with only one
argument, and this argument wasn't a valid target. In
CMake 2.8.3 and above it reports an error in this case.
This policy was introduced in CMake version 2.8.3.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
CMP0017
Prefer files from the CMake module directory when
cmake 2.8.6 Last change: June 17, 2014 327
User Commands cmake(1)
including from there.
Starting with CMake 2.8.4, if a cmake-module shipped
with CMake (i.e. located in the CMake module directory)
calls include() or find_package(), the files located in
the the CMake module directory are preferred over the
files in CMAKE_MODULE_PATH. This makes sure that the
modules belonging to CMake always get those files
included which they expect, and against which they were
developed and tested. In call other cases, the files
found in CMAKE_MODULE_PATH still take precedence over
the ones in the CMake module directory. The OLD behav-
iour is to always prefer files from CMAKE_MODULE_PATH
over files from the CMake modules directory.
This policy was introduced in CMake version 2.8.4.
CMake version 2.8.6 warns when the policy is not set
and uses OLD behavior. Use the cmake_policy command to
set it to OLD or NEW explicitly.
VARIABLES
VARIABLES THAT CHANGE BEHAVIOR
BUILD_SHARED_LIBS
Global flag to cause add_library to create shared
libraries if on.
If present and true, this will cause all libraries to
be built shared unless the library was explicitly added
as a static library. This variable is often added to
projects as an OPTION so that each user of a project
can decide if they want to build the project using
shared or static libraries.
CMAKE_BACKWARDS_COMPATIBILITY
Version of cmake required to build project
From the point of view of backwards compatibility, this
specifies what version of CMake should be supported. By
default this value is the version number of CMake that
you are running. You can set this to an older version
of CMake to support deprecated commands of CMake in
projects that were written to use older versions of
CMake. This can be set by the user or set at the begin-
ning of a CMakeLists file.
CMAKE_BUILD_TYPE
Specifies the build type for make based generators.
cmake 2.8.6 Last change: June 17, 2014 328
User Commands cmake(1)
This specifies what build type will be built in this
tree. Possible values are empty, Debug, Release, Rel-
WithDebInfo and MinSizeRel. This variable is only sup-
ported for make based generators. If this variable is
supported, then CMake will also provide initial values
for the variables with the name
CMAKE_C_FLAGS_[DEBUG|RELEASE|RELWITHDEBINFO|MINSIZ-
EREL]. For example, if CMAKE_BUILD_TYPE is Debug, then
CMAKE_C_FLAGS_DEBUG will be added to the CMAKE_C_FLAGS.
CMAKE_COLOR_MAKEFILE
Enables color output when using the Makefile generator.
When enabled, the generated Makefiles will produce col-
ored output. Default is ON.
CMAKE_CONFIGURATION_TYPES
Specifies the available build types.
This specifies what build types will be available such
as Debug, Release, RelWithDebInfo etc. This has reason-
able defaults on most platforms. But can be extended to
provide other build types. See also CMAKE_BUILD_TYPE.
CMAKE_DISABLE_FIND_PACKAGE_<PackageName>
Variable for disabling find_package() calls.
Every non-REQUIRED find_package() call in a project can
be disabled by setting the variable CMAKE_DIS-
ABLE_FIND_PACKAGE_<PackageName> to TRUE. This can be
used to build a project without an optional package,
although that package is installed.
This switch should be used during the initial CMake
run. Otherwise if the package has already been found in
a previous CMake run, the variables which have been
stored in the cache will still be there. In the case it
is recommended to remove the cache variables for this
package from the cache using the cache editor or cmake
-U
CMAKE_FIND_LIBRARY_PREFIXES
Prefixes to prepend when looking for libraries.
This specifies what prefixes to add to library names
when the find_library command looks for libraries. On
UNIX systems this is typically lib, meaning that when
cmake 2.8.6 Last change: June 17, 2014 329
User Commands cmake(1)
trying to find the foo library it will look for libfoo.
CMAKE_FIND_LIBRARY_SUFFIXES
Suffixes to append when looking for libraries.
This specifies what suffixes to add to library names
when the find_library command looks for libraries. On
Windows systems this is typically .lib and .dll, mean-
ing that when trying to find the foo library it will
look for foo.dll etc.
CMAKE_IGNORE_PATH
Path to be ignored by FIND_XXX() commands.
Specifies directories to be ignored by searches in
FIND_XXX() commands This is useful in cross-compiled
environments where some system directories contain
incompatible but possibly linkable libraries. For exam-
ple, on cross-compiled cluster environments, this
allows a user to ignore directories containing
libraries meant for the front-end machine that modules
like FindX11 (and others) would normally search. By
default this is empty; it is intended to be set by the
project. Note that CMAKE_IGNORE_PATH takes a list of
directory names, NOT a list of prefixes. If you want to
ignore paths under prefixes (bin, include, lib, etc.),
you'll need to specify them explicitly. See also
CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH,
CMAKE_INCLUDE_PATH, CMAKE_PROGRAM_PATH.
CMAKE_INCLUDE_PATH
Path used for searching by FIND_FILE() and FIND_PATH().
Specifies a path which will be used both by FIND_FILE()
and FIND_PATH(). Both commands will check each of the
contained directories for the existence of the file
which is currently searched. By default it is empty, it
is intended to be set by the project. See also
CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_PREFIX_PATH.
CMAKE_INSTALL_PREFIX
Install directory used by install.
If "make install" is invoked or INSTALL is built, this
directory is pre-pended onto all install directories.
This variable defaults to /usr/local on UNIX and
c:/Program Files on Windows.
cmake 2.8.6 Last change: June 17, 2014 330
User Commands cmake(1)
CMAKE_LIBRARY_PATH
Path used for searching by FIND_LIBRARY().
Specifies a path which will be used by FIND_LIBRARY().
FIND_LIBRARY() will check each of the contained direc-
tories for the existence of the library which is cur-
rently searched. By default it is empty, it is intended
to be set by the project. See also CMAKE_SYS-
TEM_LIBRARY_PATH, CMAKE_PREFIX_PATH.
CMAKE_MFC_FLAG
Tell cmake to use MFC for an executable or dll.
This can be set in a CMakeLists.txt file and will
enable MFC in the application. It should be set to 1
for static the static MFC library, and 2 for the shared
MFC library. This is used in visual studio 6 and 7
project files. The CMakeSetup dialog used MFC and the
CMakeLists.txt looks like this:
add_definitions(-D_AFXDLL)
set(CMAKE_MFC_FLAG 2)
add_executable(CMakeSetup WIN32 ${SRCS})
CMAKE_MODULE_PATH
List of directories to search for CMake modules.
Commands like include() and find_package() search for
files in directories listed by this variable before
checking the default modules that come with CMake.
CMAKE_NOT_USING_CONFIG_FLAGS
Skip _BUILD_TYPE flags if true.
This is an internal flag used by the generators in
CMake to tell CMake to skip the _BUILD_TYPE flags.
CMAKE_POLICY_DEFAULT_CMP<NNNN>
Default for CMake Policy CMP<NNNN> when it is otherwise
left unset.
Commands cmake_minimum_required(VERSION) and
cmake 2.8.6 Last change: June 17, 2014 331
User Commands cmake(1)
cmake_policy(VERSION) by default leave policies intro-
duced after the given version unset. Set CMAKE_POL-
ICY_DEFAULT_CMP<NNNN> to OLD or NEW to specify the
default for policy CMP<NNNN>, where <NNNN> is the pol-
icy number.
This variable should not be set by a project in CMake
code; use cmake_policy(SET) instead. Users running
CMake may set this variable in the cache (e.g.
-DCMAKE_POLICY_DEFAULT_CMP<NNNN>=<OLD|NEW>) to set a
policy not otherwise set by the project. Set to OLD to
quiet a policy warning while using old behavior or to
NEW to try building the project with new behavior.
CMAKE_PREFIX_PATH
Path used for searching by FIND_XXX(), with appropriate
suffixes added.
Specifies a path which will be used by the FIND_XXX()
commands. It contains the "base" directories, the
FIND_XXX() commands append appropriate subdirectories
to the base directories. So FIND_PROGRAM() adds /bin to
each of the directories in the path, FIND_LIBRARY()
appends /lib to each of the directories, and
FIND_PATH() and FIND_FILE() append /include . By
default it is empty, it is intended to be set by the
project. See also CMAKE_SYSTEM_PREFIX_PATH,
CMAKE_INCLUDE_PATH, CMAKE_LIBRARY_PATH, CMAKE_PRO-
GRAM_PATH.
CMAKE_PROGRAM_PATH
Path used for searching by FIND_PROGRAM().
Specifies a path which will be used by FIND_PROGRAM().
FIND_PROGRAM() will check each of the contained direc-
tories for the existence of the program which is cur-
rently searched. By default it is empty, it is intended
to be set by the project. See also CMAKE_SYSTEM_PRO-
GRAM_PATH, CMAKE_PREFIX_PATH.
CMAKE_SKIP_INSTALL_ALL_DEPENDENCY
Don't make the install target depend on the all target.
By default, the "install" target depends on the "all"
target. This has the effect, that when "make install"
is invoked or INSTALL is built, first the "all" target
is built, then the installation starts. If
CMAKE_SKIP_INSTALL_ALL_DEPENDENCY is set to TRUE, this
cmake 2.8.6 Last change: June 17, 2014 332
User Commands cmake(1)
dependency is not created, so the installation process
will start immediately, independent from whether the
project has been completely built or not.
CMAKE_SYSTEM_IGNORE_PATH
Path to be ignored by FIND_XXX() commands.
Specifies directories to be ignored by searches in
FIND_XXX() commands This is useful in cross-compiled
environments where some system directories contain
incompatible but possibly linkable libraries. For exam-
ple, on cross-compiled cluster environments, this
allows a user to ignore directories containing
libraries meant for the front-end machine that modules
like FindX11 (and others) would normally search. By
default this contains a list of directories containing
incompatible binaries for the host system. See also
CMAKE_SYSTEM_PREFIX_PATH, CMAKE_SYSTEM_LIBRARY_PATH,
CMAKE_SYSTEM_INCLUDE_PATH, and CMAKE_SYSTEM_PRO-
GRAM_PATH.
CMAKE_SYSTEM_INCLUDE_PATH
Path used for searching by FIND_FILE() and FIND_PATH().
Specifies a path which will be used both by FIND_FILE()
and FIND_PATH(). Both commands will check each of the
contained directories for the existence of the file
which is currently searched. By default it contains the
standard directories for the current system. It is NOT
intended to be modified by the project, use
CMAKE_INCLUDE_PATH for this. See also CMAKE_SYSTEM_PRE-
FIX_PATH.
CMAKE_SYSTEM_LIBRARY_PATH
Path used for searching by FIND_LIBRARY().
Specifies a path which will be used by FIND_LIBRARY().
FIND_LIBRARY() will check each of the contained direc-
tories for the existence of the library which is cur-
rently searched. By default it contains the standard
directories for the current system. It is NOT intended
to be modified by the project, use CMAKE_LIBRARY_PATH
for this. See also CMAKE_SYSTEM_PREFIX_PATH.
CMAKE_SYSTEM_PREFIX_PATH
Path used for searching by FIND_XXX(), with appropriate
suffixes added.
cmake 2.8.6 Last change: June 17, 2014 333
User Commands cmake(1)
Specifies a path which will be used by the FIND_XXX()
commands. It contains the "base" directories, the
FIND_XXX() commands append appropriate subdirectories
to the base directories. So FIND_PROGRAM() adds /bin to
each of the directories in the path, FIND_LIBRARY()
appends /lib to each of the directories, and
FIND_PATH() and FIND_FILE() append /include . By
default this contains the standard directories for the
current system. It is NOT intended to be modified by
the project, use CMAKE_PREFIX_PATH for this. See also
CMAKE_SYSTEM_INCLUDE_PATH, CMAKE_SYSTEM_LIBRARY_PATH,
CMAKE_SYSTEM_PROGRAM_PATH, and CMAKE_SYS-
TEM_IGNORE_PATH.
CMAKE_SYSTEM_PROGRAM_PATH
Path used for searching by FIND_PROGRAM().
Specifies a path which will be used by FIND_PROGRAM().
FIND_PROGRAM() will check each of the contained direc-
tories for the existence of the program which is cur-
rently searched. By default it contains the standard
directories for the current system. It is NOT intended
to be modified by the project, use CMAKE_PROGRAM_PATH
for this. See also CMAKE_SYSTEM_PREFIX_PATH.
CMAKE_USER_MAKE_RULES_OVERRIDE
Specify a CMake file that overrides platform informa-
tion.
CMake loads the specified file while enabling support
for each language from either the project() or
enable_language() commands. It is loaded after CMake's
builtin compiler and platform information modules have
been loaded but before the information is used. The
file may set platform information variables to override
CMake's defaults.
This feature is intended for use only in overriding
information variables that must be set before CMake
builds its first test project to check that the com-
piler for a language works. It should not be used to
load a file in cases that a normal include() will work.
Use it only as a last resort for behavior that cannot
be achieved any other way. For example, one may set
CMAKE_C_FLAGS_INIT to change the default value used to
initialize CMAKE_C_FLAGS before it is cached. The
override file should NOT be used to set anything that
could be set after languages are enabled, such as vari-
ables like CMAKE_RUNTIME_OUTPUT_DIRECTORY that affect
cmake 2.8.6 Last change: June 17, 2014 334
User Commands cmake(1)
the placement of binaries. Information set in the file
will be used for try_compile and try_run builds too.
VARIABLES THAT DESCRIBE THE SYSTEM
APPLE
True if running on Mac OSX.
Set to true on Mac OSX.
BORLAND
True of the borland compiler is being used.
This is set to true if the Borland compiler is being
used.
CMAKE_CL_64
Using the 64 bit compiler from Microsoft
Set to true when using the 64 bit cl compiler from
Microsoft.
CMAKE_COMPILER_2005
Using the Visual Studio 2005 compiler from Microsoft
Set to true when using the Visual Studio 2005 compiler
from Microsoft.
CMAKE_HOST_APPLE
True for Apple OSXoperating systems.
Set to true when the host system is Apple OSX.
CMAKE_HOST_SYSTEM
Name of system cmake is being run on.
The same as CMAKE_SYSTEM but for the host system
instead of the target system when cross compiling.
CMAKE_HOST_SYSTEM_NAME
Name of the OS CMake is running on.
The same as CMAKE_SYSTEM_NAME but for the host system
instead of the target system when cross compiling.
cmake 2.8.6 Last change: June 17, 2014 335
User Commands cmake(1)
CMAKE_HOST_SYSTEM_PROCESSOR
The name of the CPU CMake is running on.
The same as CMAKE_SYSTEM_PROCESSOR but for the host
system instead of the target system when cross compil-
ing.
CMAKE_HOST_SYSTEM_VERSION
OS version CMake is running on.
The same as CMAKE_SYSTEM_VERSION but for the host sys-
tem instead of the target system when cross compiling.
CMAKE_HOST_UNIX
True for UNIX and UNIX like operating systems.
Set to true when the host system is UNIX or UNIX like
(i.e. APPLE and CYGWIN).
CMAKE_HOST_WIN32
True on windows systems, including win64.
Set to true when the host system is Windows and on cyg-
win.
CMAKE_LIBRARY_ARCHITECTURE
Target architecture library directory name, if
detected.
This is the value of CMAKE_<lang>_LIBRARY_ARCHITECTURE
as detected for one of the enabled languages.
CMAKE_LIBRARY_ARCHITECTURE_REGEX
Regex matching possible target architecture library
directory names.
This is used to detect CMAKE_<lang>_LIBRARY_ARCHITEC-
TURE from the implicit linker search path by matching
the <arch> name.
CMAKE_OBJECT_PATH_MAX
Maximum object file full-path length allowed by native
build tools.
CMake computes for every source file an object file
name that is unique to the source file and
cmake 2.8.6 Last change: June 17, 2014 336
User Commands cmake(1)
deterministic with respect to the full path to the
source file. This allows multiple source files in a
target to share the same name if they lie in different
directories without rebuilding when one is added or
removed. However, it can produce long full paths in a
few cases, so CMake shortens the path using a hashing
scheme when the full path to an object file exceeds a
limit. CMake has a built-in limit for each platform
that is sufficient for common tools, but some native
tools may have a lower limit. This variable may be set
to specify the limit explicitly. The value must be an
integer no less than 128.
CMAKE_SYSTEM
Name of system cmake is compiling for.
This variable is the composite of CMAKE_SYSTEM_NAME and
CMAKE_SYSTEM_VERSION, like this ${CMAKE_SYS-
TEM_NAME}-${CMAKE_SYSTEM_VERSION}. If CMAKE_SYSTEM_VER-
SION is not set, then CMAKE_SYSTEM is the same as
CMAKE_SYSTEM_NAME.
CMAKE_SYSTEM_NAME
Name of the OS CMake is building for.
This is the name of the operating system on which CMake
is targeting. On systems that have the uname command,
this variable is set to the output of uname -s. Linux,
Windows, and Darwin for Mac OSX are the values found
on the big three operating systems.
CMAKE_SYSTEM_PROCESSOR
The name of the CPU CMake is building for.
On systems that support uname, this variable is set to
the output of uname -p, on windows it is set to the
value of the environment variable PROCESSOR_ARCHITEC-
TURE
CMAKE_SYSTEM_VERSION
OS version CMake is building for.
A numeric version string for the system, on systems
that support uname, this variable is set to the output
of uname -r. On other systems this is set to
major-minor version numbers.
cmake 2.8.6 Last change: June 17, 2014 337
User Commands cmake(1)
CYGWIN
True for cygwin.
Set to true when using CYGWIN.
MSVC True when using Microsoft Visual C
Set to true when the compiler is some version of
Microsoft Visual C.
MSVC80
True when using Microsoft Visual C 8.0
Set to true when the compiler is version 8.0 of
Microsoft Visual C.
MSVC_IDE
True when using the Microsoft Visual C IDE
Set to true when the target platform is the Microsoft
Visual C IDE, as opposed to the command line compiler.
MSVC_VERSION
The version of Microsoft Visual C/C++ being used if
any.
Known version numbers are:
1200 = VS 6.0
1300 = VS 7.0
1310 = VS 7.1
1400 = VS 8.0
1500 = VS 9.0
1600 = VS 10.0
UNIX True for UNIX and UNIX like operating systems.
Set to true when the target system is UNIX or UNIX like
(i.e. APPLE and CYGWIN).
WIN32
True on windows systems, including win64.
Set to true when the target system is Windows.
cmake 2.8.6 Last change: June 17, 2014 338
User Commands cmake(1)
XCODE_VERSION
Version of Xcode (Xcode generator only).
Under the Xcode generator, this is the version of Xcode
as specified in "Xcode.app/Contents/version.plist"
(such as "3.1.2").
VARIABLES FOR LANGUAGES
CMAKE_<LANG>_ARCHIVE_APPEND
Rule variable to append to a static archive.
This is a rule variable that tells CMake how to append
to a static archive. It is used in place of
CMAKE_<LANG>_CREATE_STATIC_LIBRARY on some platforms in
order to support large object counts. See also
CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_AR-
CHIVE_FINISH.
CMAKE_<LANG>_ARCHIVE_CREATE
Rule variable to create a new static archive.
This is a rule variable that tells CMake how to create
a static archive. It is used in place of
CMAKE_<LANG>_CREATE_STATIC_LIBRARY on some platforms in
order to support large object counts. See also
CMAKE_<LANG>_ARCHIVE_APPEND and CMAKE_<LANG>_AR-
CHIVE_FINISH.
CMAKE_<LANG>_ARCHIVE_FINISH
Rule variable to finish an existing static archive.
This is a rule variable that tells CMake how to finish
a static archive. It is used in place of
CMAKE_<LANG>_CREATE_STATIC_LIBRARY on some platforms in
order to support large object counts. See also
CMAKE_<LANG>_ARCHIVE_CREATE and CMAKE_<LANG>_AR-
CHIVE_APPEND.
CMAKE_<LANG>_COMPILER
The full path to the compiler for LANG.
This is the command that will be used as the <LANG>
compiler. Once set, you can not change this variable.
CMAKE_<LANG>_COMPILER_ABI
An internal variable subject to change.
cmake 2.8.6 Last change: June 17, 2014 339
User Commands cmake(1)
This is used in determining the compiler ABI and is
subject to change.
CMAKE_<LANG>_COMPILER_ID
An internal variable subject to change.
This is used in determining the compiler and is subject
to change.
CMAKE_<LANG>_COMPILER_LOADED
Defined to true if the language is enabled.
When language <LANG> is enabled by project() or
enable_language() this variable is defined to 1.
CMAKE_<LANG>_COMPILE_OBJECT
Rule variable to compile a single object file.
This is a rule variable that tells CMake how to compile
a single object file for for the language <LANG>.
CMAKE_<LANG>_CREATE_SHARED_LIBRARY
Rule variable to create a shared library.
This is a rule variable that tells CMake how to create
a shared library for the language <LANG>.
CMAKE_<LANG>_CREATE_SHARED_MODULE
Rule variable to create a shared module.
This is a rule variable that tells CMake how to create
a shared library for the language <LANG>.
CMAKE_<LANG>_CREATE_STATIC_LIBRARY
Rule variable to create a static library.
This is a rule variable that tells CMake how to create
a static library for the language <LANG>.
CMAKE_<LANG>_FLAGS_DEBUG
Flags for Debug build type or configuration.
<LANG> flags used when CMAKE_BUILD_TYPE is Debug.
cmake 2.8.6 Last change: June 17, 2014 340
User Commands cmake(1)
CMAKE_<LANG>_FLAGS_MINSIZEREL
Flags for MinSizeRel build type or configuration.
<LANG> flags used when CMAKE_BUILD_TYPE is MinSiz-
eRel.Short for minimum size release.
CMAKE_<LANG>_FLAGS_RELEASE
Flags for Release build type or configuration.
<LANG> flags used when CMAKE_BUILD_TYPE is Release
CMAKE_<LANG>_FLAGS_RELWITHDEBINFO
Flags for RelWithDebInfo type or configuration.
<LANG> flags used when CMAKE_BUILD_TYPE is RelWithDe-
bInfo. Short for Release With Debug Information.
CMAKE_<LANG>_IGNORE_EXTENSIONS
File extensions that should be ignored by the build.
This is a list of file extensions that may be part of a
project for a given language but are not compiled.
CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES
Directories implicitly searched by the compiler for
header files.
CMake does not explicitly specify these directories on
compiler command lines for language <LANG>. This pre-
vents system include directories from being treated as
user include directories on some compilers.
CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES
Implicit linker search path detected for language
<LANG>.
Compilers typically pass directories containing lan-
guage runtime libraries and default library search
paths when they invoke a linker. These paths are
implicit linker search directories for the compiler's
language. CMake automatically detects these directo-
ries for each language and reports the results in this
variable.
CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES
Implicit link libraries and flags detected for language
cmake 2.8.6 Last change: June 17, 2014 341
User Commands cmake(1)
<LANG>.
Compilers typically pass language runtime library names
and other flags when they invoke a linker. These flags
are implicit link options for the compiler's language.
CMake automatically detects these libraries and flags
for each language and reports the results in this vari-
able.
CMAKE_<LANG>_LIBRARY_ARCHITECTURE
Target architecture library directory name detected for
<lang>.
If the <lang> compiler passes to the linker an archi-
tecture-specific system library search directory such
as <prefix>/lib/<arch> this variable contains the
<arch> name if/as detected by CMake.
CMAKE_<LANG>_LINKER_PREFERENCE
Preference value for linker language selection.
The "linker language" for executable, shared library,
and module targets is the language whose compiler will
invoke the linker. The LINKER_LANGUAGE target property
sets the language explicitly. Otherwise, the linker
language is that whose linker preference value is high-
est among languages compiled and linked into the tar-
get. See also the CMAKE_<LANG>_LINKER_PREFERENCE_PROP-
AGATES variable.
CMAKE_<LANG>_LINKER_PREFERENCE_PROPAGATES
True if CMAKE_<LANG>_LINKER_PREFERENCE propagates
across targets.
This is used when CMake selects a linker language for a
target. Languages compiled directly into the target
are always considered. A language compiled into static
libraries linked by the target is considered if this
variable is true.
CMAKE_<LANG>_LINK_EXECUTABLE
Rule variable to link and executable.
Rule variable to link and executable for the given lan-
guage.
CMAKE_<LANG>_OUTPUT_EXTENSION
cmake 2.8.6 Last change: June 17, 2014 342
User Commands cmake(1)
Extension for the output of a compile for a single
file.
This is the extension for an object file for the given
<LANG>. For example .obj for C on Windows.
CMAKE_<LANG>_PLATFORM_ID
An internal variable subject to change.
This is used in determining the platform and is subject
to change.
CMAKE_<LANG>_SIZEOF_DATA_PTR
Size of pointer-to-data types for language <LANG>.
This holds the size (in bytes) of pointer-to-data types
in the target platform ABI. It is defined for lan-
guages C and CXX (C++).
CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS
Extensions of source files for the given language.
This is the list of extensions for a given languages
source files.
CMAKE_COMPILER_IS_GNU<LANG>
True if the compiler is GNU.
If the selected <LANG> compiler is the GNU compiler
then this is TRUE, if not it is FALSE.
CMAKE_Fortran_MODDIR_DEFAULT
Fortran default module output directory.
Most Fortran compilers write .mod files to the current
working directory. For those that do not, this is set
to "." and used when the Fortran_MODULE_DIRECTORY tar-
get property is not set.
CMAKE_Fortran_MODDIR_FLAG
Fortran flag for module output directory.
This stores the flag needed to pass the value of the
Fortran_MODULE_DIRECTORY target property to the com-
piler.
cmake 2.8.6 Last change: June 17, 2014 343
User Commands cmake(1)
CMAKE_Fortran_MODOUT_FLAG
Fortran flag to enable module output.
Most Fortran compilers write .mod files out by default.
For others, this stores the flag needed to enable mod-
ule output.
CMAKE_INTERNAL_PLATFORM_ABI
An internal variable subject to change.
This is used in determining the compiler ABI and is
subject to change.
CMAKE_USER_MAKE_RULES_OVERRIDE_<LANG>
Specify a CMake file that overrides platform informa-
tion for <LANG>.
This is a language-specific version of
CMAKE_USER_MAKE_RULES_OVERRIDE loaded only when
enabling language <LANG>.
VARIABLES THAT CONTROL THE BUILD
CMAKE_<CONFIG>_POSTFIX
Default filename postfix for libraries under configura-
tion <CONFIG>.
When a non-executable target is created its <CON-
FIG>_POSTFIX target property is initialized with the
value of this variable if it is set.
CMAKE_ARCHIVE_OUTPUT_DIRECTORY
Where to put all the ARCHIVE targets when built.
This variable is used to initialize the ARCHIVE_OUT-
PUT_DIRECTORY property on all the targets. See that
target property for additional information.
CMAKE_AUTOMOC
Whether to handle moc automatically for Qt targets.
This variable is used to initialize the AUTOMOC prop-
erty on all the targets. See that target property for
additional information.
CMAKE_BUILD_WITH_INSTALL_RPATH
Use the install path for the RPATH
cmake 2.8.6 Last change: June 17, 2014 344
User Commands cmake(1)
Normally CMake uses the build tree for the RPATH when
building executables etc on systems that use RPATH.
When the software is installed the executables etc are
relinked by CMake to have the install RPATH. If this
variable is set to true then the software is always
built with the install path for the RPATH and does not
need to be relinked when installed.
CMAKE_DEBUG_POSTFIX
See variable CMAKE_<CONFIG>_POSTFIX.
This variable is a special case of the more-general
CMAKE_<CONFIG>_POSTFIX variable for the DEBUG configu-
ration.
CMAKE_EXE_LINKER_FLAGS
Linker flags used to create executables.
Flags used by the linker when creating an executable.
CMAKE_EXE_LINKER_FLAGS_[CMAKE_BUILD_TYPE]
Flag used when linking an executable.
Same as CMAKE_C_FLAGS_* but used by the linker when
creating executables.
CMAKE_Fortran_FORMAT
Set to FIXED or FREE to indicate the Fortran source
layout.
This variable is used to initialize the Fortran_FORMAT
property on all the targets. See that target property
for additional information.
CMAKE_Fortran_MODULE_DIRECTORY
Fortran module output directory.
This variable is used to initialize the Fortran_MOD-
ULE_DIRECTORY property on all the targets. See that
target property for additional information.
CMAKE_INCLUDE_CURRENT_DIR
Automatically add the current source- and build direc-
tories to the include path.
If this variable is enabled, CMake automatically adds
cmake 2.8.6 Last change: June 17, 2014 345
User Commands cmake(1)
in each directory ${CMAKE_CURRENT_SOURCE_DIR} and
${CMAKE_CURRENT_BINARY_DIR} to the include path for
this directory. These additional include directories do
not propagate down to subdirectories. This is useful
mainly for out-of-source builds, where files generated
into the build tree are included by files located in
the source tree.
By default CMAKE_INCLUDE_CURRENT_DIR is OFF.
CMAKE_INSTALL_NAME_DIR
Mac OSX directory name for installed targets.
CMAKE_INSTALL_NAME_DIR is used to initialize the
INSTALL_NAME_DIR property on all targets. See that tar-
get property for more information.
CMAKE_INSTALL_RPATH
The rpath to use for installed targets.
A semicolon-separated list specifying the rpath to use
in installed targets (for platforms that support it).
This is used to initialize the target property
INSTALL_RPATH for all targets.
CMAKE_INSTALL_RPATH_USE_LINK_PATH
Add paths to linker search and installed rpath.
CMAKE_INSTALL_RPATH_USE_LINK_PATH is a boolean that if
set to true will append directories in the linker
search path and outside the project to the
INSTALL_RPATH. This is used to initialize the target
property INSTALL_RPATH_USE_LINK_PATH for all targets.
CMAKE_LIBRARY_OUTPUT_DIRECTORY
Where to put all the LIBRARY targets when built.
This variable is used to initialize the LIBRARY_OUT-
PUT_DIRECTORY property on all the targets. See that
target property for additional information.
CMAKE_LIBRARY_PATH_FLAG
The flag used to add a library search path to a com-
piler.
The flag used to specify a library directory to the
cmake 2.8.6 Last change: June 17, 2014 346
User Commands cmake(1)
compiler. On most compilers this is "-L".
CMAKE_LINK_DEF_FILE_FLAG
Linker flag used to specify a .def file for dll cre-
ation.
The flag used to add a .def file when creating a dll on
Windows, this is only defined on Windows.
CMAKE_LINK_LIBRARY_FILE_FLAG
Flag used to link a library specified by a path to its
file.
The flag used before a library file path is given to
the linker. This is needed only on very few platforms.
CMAKE_LINK_LIBRARY_FLAG
Flag used to link a library into an executable.
The flag used to specify a library to link to an exe-
cutable. On most compilers this is "-l".
CMAKE_NO_BUILTIN_CHRPATH
Do not use the builtin ELF editor to fix RPATHs on
installation.
When an ELF binary needs to have a different RPATH
after installation than it does in the build tree,
CMake uses a builtin editor to change the RPATH in the
installed copy. If this variable is set to true then
CMake will relink the binary before installation
instead of using its builtin editor.
CMAKE_RUNTIME_OUTPUT_DIRECTORY
Where to put all the RUNTIME targets when built.
This variable is used to initialize the RUNTIME_OUT-
PUT_DIRECTORY property on all the targets. See that
target property for additional information.
CMAKE_SKIP_BUILD_RPATH
Do not include RPATHs in the build tree.
Normally CMake uses the build tree for the RPATH when
building executables etc on systems that use RPATH.
When the software is installed the executables etc are
cmake 2.8.6 Last change: June 17, 2014 347
User Commands cmake(1)
relinked by CMake to have the install RPATH. If this
variable is set to true then the software is always
built with no RPATH.
CMAKE_TRY_COMPILE_CONFIGURATION
Build configuration used for try_compile and try_run
projects.
Projects built by try_compile and try_run are built
synchronously during the CMake configuration step.
Therefore a specific build configuration must be chosen
even if the generated build system supports multiple
configurations.
CMAKE_USE_RELATIVE_PATHS
Use relative paths (May not work!).
If this is set to TRUE, then the CMake will use rela-
tive paths between the source and binary tree. This
option does not work for more complicated projects, and
relative paths are used when possible. In general, it
is not possible to move CMake generated makefiles to a
different location regardless of the value of this
variable.
EXECUTABLE_OUTPUT_PATH
Old executable location variable.
The target property RUNTIME_OUTPUT_DIRECTORY supercedes
this variable for a target if it is set. Executable
targets are otherwise placed in this directory.
LIBRARY_OUTPUT_PATH
Old library location variable.
The target properties ARCHIVE_OUTPUT_DIRECTORY,
LIBRARY_OUTPUT_DIRECTORY, and RUNTIME_OUTPUT_DIRECTORY
supercede this variable for a target if they are set.
Library targets are otherwise placed in this directory.
VARIABLES THAT PROVIDE INFORMATION
variables defined by cmake, that give information about the
project, and cmake
CMAKE_AR
Name of archiving tool for static libraries.
cmake 2.8.6 Last change: June 17, 2014 348
User Commands cmake(1)
This specifies name of the program that creates archive
or static libraries.
CMAKE_ARGC
Number of command line arguments passed to CMake in
script mode.
When run in -P script mode, CMake sets this variable to
the number of command line arguments. See also
CMAKE_ARGV0, 1, 2 ...
CMAKE_ARGV0
Command line argument passed to CMake in script mode.
When run in -P script mode, CMake sets this variable to
the first command line argument. It then also sets
CMAKE_ARGV1, CMAKE_ARGV2, ... and so on, up to the num-
ber of command line arguments given. See also
CMAKE_ARGC.
CMAKE_BINARY_DIR
The path to the top level of the build tree.
This is the full path to the top level of the current
CMake build tree. For an in-source build, this would be
the same as CMAKE_SOURCE_DIR.
CMAKE_BUILD_TOOL
Tool used for the actual build process.
This variable is set to the program that will be needed
to build the output of CMake. If the generator
selected was Visual Studio 6, the CMAKE_MAKE_PROGRAM
will be set to msdev, for Unix makefiles it will be set
to make or gmake, and for Visual Studio 7 it set to
devenv. For Nmake Makefiles the value is nmake. This
can be useful for adding special flags and commands
based on the final build environment.
CMAKE_CACHEFILE_DIR
The directory with the CMakeCache.txt file.
This is the full path to the directory that has the
CMakeCache.txt file in it. This is the same as
CMAKE_BINARY_DIR.
cmake 2.8.6 Last change: June 17, 2014 349
User Commands cmake(1)
CMAKE_CACHE_MAJOR_VERSION
Major version of CMake used to create the CMake-
Cache.txt file
This is stores the major version of CMake used to write
a CMake cache file. It is only different when a differ-
ent version of CMake is run on a previously created
cache file.
CMAKE_CACHE_MINOR_VERSION
Minor version of CMake used to create the CMake-
Cache.txt file
This is stores the minor version of CMake used to write
a CMake cache file. It is only different when a differ-
ent version of CMake is run on a previously created
cache file.
CMAKE_CACHE_PATCH_VERSION
Patch version of CMake used to create the CMake-
Cache.txt file
This is stores the patch version of CMake used to write
a CMake cache file. It is only different when a differ-
ent version of CMake is run on a previously created
cache file.
CMAKE_CFG_INTDIR
Build-time reference to per-configuration output subdi-
rectory.
For native build systems supporting multiple configura-
tions in the build tree (such as Visual Studio and
Xcode), the value is a reference to a build-time vari-
able specifying the name of the per-configuration out-
put subdirectory. On Makefile generators this evalu-
ates to "." because there is only one configuration in
a build tree. Example values:
$(IntDir) = Visual Studio 6
$(OutDir) = Visual Studio 7, 8, 9
$(Configuration) = Visual Studio 10
$(CONFIGURATION) = Xcode
. = Make-based tools
Since these values are evaluated by the native build
system, this variable is suitable only for use in com-
mand lines that will be evaluated at build time.
cmake 2.8.6 Last change: June 17, 2014 350
User Commands cmake(1)
Example of intended usage:
add_executable(mytool mytool.c)
add_custom_command(
OUTPUT out.txt
COMMAND ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INTDIR}/mytool
${CMAKE_CURRENT_SOURCE_DIR}/in.txt out.txt
DEPENDS mytool in.txt
)
add_custom_target(drive ALL DEPENDS out.txt)
Note that CMAKE_CFG_INTDIR is no longer necessary for
this purpose but has been left for compatibility with
existing projects. Instead add_custom_command() recog-
nizes executable target names in its COMMAND option, so
"${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_CFG_INT-
DIR}/mytool" can be replaced by just "mytool".
This variable is read-only. Setting it is undefined
behavior. In multi-configuration build systems the
value of this variable is passed as the value of pre-
processor symbol "CMAKE_INTDIR" to the compilation of
all source files.
CMAKE_COMMAND
The full path to the cmake executable.
This is the full path to the CMake executable cmake
which is useful from custom commands that want to use
the cmake -E option for portable system commands. (e.g.
/usr/local/bin/cmake
CMAKE_CROSSCOMPILING
Is CMake currently cross compiling.
This variable will be set to true by CMake if CMake is
cross compiling. Specifically if the build platform is
different from the target platform.
CMAKE_CTEST_COMMAND
Full path to ctest command installed with cmake.
This is the full path to the CTest executable ctest
which is useful from custom commands that want to use
the cmake -E option for portable system commands.
cmake 2.8.6 Last change: June 17, 2014 351
User Commands cmake(1)
CMAKE_CURRENT_BINARY_DIR
The path to the binary directory currently being pro-
cessed.
This the full path to the build directory that is cur-
rently being processed by cmake. Each directory added
by add_subdirectory will create a binary directory in
the build tree, and as it is being processed this vari-
able will be set. For in-source builds this is the cur-
rent source directory being processed.
CMAKE_CURRENT_LIST_DIR
Full directory of the listfile currently being pro-
cessed.
As CMake processes the listfiles in your project this
variable will always be set to the directory where the
listfile which is currently being processed (CMAKE_CUR-
RENT_LIST_FILE) is located. The value has dynamic
scope. When CMake starts processing commands in a
source file it sets this variable to the directory
where this file is located. When CMake finishes pro-
cessing commands from the file it restores the previous
value. Therefore the value of the variable inside a
macro or function is the directory of the file invoking
the bottom-most entry on the call stack, not the direc-
tory of the file containing the macro or function defi-
nition.
See also CMAKE_CURRENT_LIST_FILE.
CMAKE_CURRENT_LIST_FILE
Full path to the listfile currently being processed.
As CMake processes the listfiles in your project this
variable will always be set to the one currently being
processed. The value has dynamic scope. When CMake
starts processing commands in a source file it sets
this variable to the location of the file. When CMake
finishes processing commands from the file it restores
the previous value. Therefore the value of the vari-
able inside a macro or function is the file invoking
the bottom-most entry on the call stack, not the file
containing the macro or function definition.
See also CMAKE_PARENT_LIST_FILE.
cmake 2.8.6 Last change: June 17, 2014 352
User Commands cmake(1)
CMAKE_CURRENT_LIST_LINE
The line number of the current file being processed.
This is the line number of the file currently being
processed by cmake.
CMAKE_CURRENT_SOURCE_DIR
The path to the source directory currently being pro-
cessed.
This the full path to the source directory that is cur-
rently being processed by cmake.
CMAKE_DL_LIBS
Name of library containing dlopen and dlcose.
The name of the library that has dlopen and dlclose in
it, usually -ldl on most UNIX machines.
CMAKE_EDIT_COMMAND
Full path to cmake-gui or ccmake.
This is the full path to the CMake executable that can
graphically edit the cache. For example, cmake-gui,
ccmake, or cmake -i.
CMAKE_EXECUTABLE_SUFFIX
The suffix for executables on this platform.
The suffix to use for the end of an executable if any,
.exe on Windows.
CMAKE_EXECUTABLE_SUFFIX_<LANG> overrides this for lan-
guage <LANG>.
CMAKE_EXTRA_GENERATOR
The extra generator used to build the project.
When using the Eclipse, CodeBlocks or KDevelop genera-
tors, CMake generates Makefiles (CMAKE_GENERATOR) and
additionally project files for the respective IDE. This
IDE project file generator is stored in
CMAKE_EXTRA_GENERATOR (e.g. "Eclipse CDT4").
CMAKE_EXTRA_SHARED_LIBRARY_SUFFIXES
cmake 2.8.6 Last change: June 17, 2014 353
User Commands cmake(1)
Additional suffixes for shared libraries.
Extensions for shared libraries other than that speci-
fied by CMAKE_SHARED_LIBRARY_SUFFIX, if any. CMake
uses this to recognize external shared library files
during analysis of libraries linked by a target.
CMAKE_GENERATOR
The generator used to build the project.
The name of the generator that is being used to gener-
ate the build files. (e.g. "Unix Makefiles", "Visual
Studio 6", etc.)
CMAKE_HOME_DIRECTORY
Path to top of source tree.
This is the path to the top level of the source tree.
CMAKE_IMPORT_LIBRARY_PREFIX
The prefix for import libraries that you link to.
The prefix to use for the name of an import library if
used on this platform.
CMAKE_IMPORT_LIBRARY_PREFIX_<LANG> overrides this for
language <LANG>.
CMAKE_IMPORT_LIBRARY_SUFFIX
The suffix for import libraries that you link to.
The suffix to use for the end of an import library if
used on this platform.
CMAKE_IMPORT_LIBRARY_SUFFIX_<LANG> overrides this for
language <LANG>.
CMAKE_LINK_LIBRARY_SUFFIX
The suffix for libraries that you link to.
The suffix to use for the end of a library, .lib on
Windows.
CMAKE_MAJOR_VERSION
cmake 2.8.6 Last change: June 17, 2014 354
User Commands cmake(1)
The Major version of cmake (i.e. the 2 in 2.X.X)
This specifies the major version of the CMake exe-
cutable being run.
CMAKE_MAKE_PROGRAM
See CMAKE_BUILD_TOOL.
This variable is around for backwards compatibility,
see CMAKE_BUILD_TOOL.
CMAKE_MINOR_VERSION
The Minor version of cmake (i.e. the 4 in X.4.X).
This specifies the minor version of the CMake exe-
cutable being run.
CMAKE_PARENT_LIST_FILE
Full path to the parent listfile of the one currently
being processed.
As CMake processes the listfiles in your project this
variable will always be set to the listfile that
included or somehow invoked the one currently being
processed. See also CMAKE_CURRENT_LIST_FILE.
CMAKE_PATCH_VERSION
The patch version of cmake (i.e. the 3 in X.X.3).
This specifies the patch version of the CMake exe-
cutable being run.
CMAKE_PROJECT_NAME
The name of the current project.
This specifies name of the current project from the
closest inherited PROJECT command.
CMAKE_RANLIB
Name of randomizing tool for static libraries.
This specifies name of the program that randomizes
libraries on UNIX, not used on Windows, but may be
present.
cmake 2.8.6 Last change: June 17, 2014 355
User Commands cmake(1)
CMAKE_ROOT
Install directory for running cmake.
This is the install root for the running CMake and the
Modules directory can be found here. This is commonly
used in this format: ${CMAKE_ROOT}/Modules
CMAKE_SCRIPT_MODE_FILE
Full path to the -P script file currently being pro-
cessed.
When run in -P script mode, CMake sets this variable to
the full path of the script file. When run to configure
a CMakeLists.txt file, this variable is not set.
CMAKE_SHARED_LIBRARY_PREFIX
The prefix for shared libraries that you link to.
The prefix to use for the name of a shared library, lib
on UNIX.
CMAKE_SHARED_LIBRARY_PREFIX_<LANG> overrides this for
language <LANG>.
CMAKE_SHARED_LIBRARY_SUFFIX
The suffix for shared libraries that you link to.
The suffix to use for the end of a shared library, .dll
on Windows.
CMAKE_SHARED_LIBRARY_SUFFIX_<LANG> overrides this for
language <LANG>.
CMAKE_SHARED_MODULE_PREFIX
The prefix for loadable modules that you link to.
The prefix to use for the name of a loadable module on
this platform.
CMAKE_SHARED_MODULE_PREFIX_<LANG> overrides this for
language <LANG>.
CMAKE_SHARED_MODULE_SUFFIX
The suffix for shared libraries that you link to.
cmake 2.8.6 Last change: June 17, 2014 356
User Commands cmake(1)
The suffix to use for the end of a loadable module on
this platform
CMAKE_SHARED_MODULE_SUFFIX_<LANG> overrides this for
language <LANG>.
CMAKE_SIZEOF_VOID_P
Size of a void pointer.
This is set to the size of a pointer on the machine,
and is determined by a try compile. If a 64 bit size is
found, then the library search path is modified to look
for 64 bit libraries first.
CMAKE_SKIP_RPATH
If true, do not add run time path information.
If this is set to TRUE, then the rpath information is
not added to compiled executables. The default is to
add rpath information if the platform supports it.This
allows for easy running from the build tree.
CMAKE_SOURCE_DIR
The path to the top level of the source tree.
This is the full path to the top level of the current
CMake source tree. For an in-source build, this would
be the same as CMAKE_BINARY_DIR.
CMAKE_STANDARD_LIBRARIES
Libraries linked into every executable and shared
library.
This is the list of libraries that are linked into all
executables and libraries.
CMAKE_STATIC_LIBRARY_PREFIX
The prefix for static libraries that you link to.
The prefix to use for the name of a static library, lib
on UNIX.
CMAKE_STATIC_LIBRARY_PREFIX_<LANG> overrides this for
language <LANG>.
cmake 2.8.6 Last change: June 17, 2014 357
User Commands cmake(1)
CMAKE_STATIC_LIBRARY_SUFFIX
The suffix for static libraries that you link to.
The suffix to use for the end of a static library, .lib
on Windows.
CMAKE_STATIC_LIBRARY_SUFFIX_<LANG> overrides this for
language <LANG>.
CMAKE_TWEAK_VERSION
The tweak version of cmake (i.e. the 1 in X.X.X.1).
This specifies the tweak version of the CMake exe-
cutable being run. Releases use tweak < 20000000 and
development versions use the date format CCYYMMDD for
the tweak level.
CMAKE_USING_VC_FREE_TOOLS
True if free visual studio tools being used.
This is set to true if the compiler is Visual Studio
free tools.
CMAKE_VERBOSE_MAKEFILE
Create verbose makefiles if on.
This variable defaults to false. You can set this vari-
able to true to make CMake produce verbose makefiles
that show each command line as it is used.
CMAKE_VERSION
The full version of cmake in
major.minor.patch[.tweak[-id]] format.
This specifies the full version of the CMake executable
being run. This variable is defined by versions 2.6.3
and higher. See variables CMAKE_MAJOR_VERSION,
CMAKE_MINOR_VERSION, CMAKE_PATCH_VERSION, and
CMAKE_TWEAK_VERSION for individual version components.
The [-id] component appears in non-release versions and
may be arbitrary text.
PROJECT_BINARY_DIR
Full path to build directory for project.
This is the binary directory of the most recent PROJECT
cmake 2.8.6 Last change: June 17, 2014 358
User Commands cmake(1)
command.
PROJECT_NAME
Name of the project given to the project command.
This is the name given to the most recent PROJECT com-
mand.
PROJECT_SOURCE_DIR
Top level source directory for the current project.
This is the source directory of the most recent PROJECT
command.
[Project name]_BINARY_DIR
Top level binary directory for the named project.
A variable is created with the name used in the PROJECT
command, and is the binary directory for the project.
This can be useful when SUBDIR is used to connect sev-
eral projects.
[Project name]_SOURCE_DIR
Top level source directory for the named project.
A variable is created with the name used in the PROJECT
command, and is the source directory for the project.
This can be useful when add_subdirectory is used to
connect several projects.
COPYRIGHT
Copyright 2000-2009 Kitware, Inc., Insight Software Consor-
tium. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the fol-
lowing conditions are met:
Redistributions of source code must retain the above copy-
right notice, this list of conditions and the following dis-
claimer.
Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
cmake 2.8.6 Last change: June 17, 2014 359
User Commands cmake(1)
disclaimer in the documentation and/or other materials pro-
vided 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 CON-
TRIBUTORS "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 CON-
TRIBUTORS 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 SOFT-
WARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
ATTRIBUTES
See attributes(5) for descriptions of the following
attributes:
+---------------+-----------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+-----------------------+
|Availability | developer/build/cmake |
+---------------+-----------------------+
|Stability | Uncommitted |
+---------------+-----------------------+
SEE ALSO
ccmake(1), cpack(1), ctest(1), cmakecommands(1), cmakecom-
pat(1), cmakemodules(1),
The following resources are available to get help using
CMake:
Home Page
http://www.cmake.org
The primary starting point for learning about CMake.
cmake 2.8.6 Last change: June 17, 2014 360
User Commands cmake(1)
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 mem-
ber-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
AUTHOR
This manual page was generated by the "--help-man" option.
NOTES
This software was built from source available at
https://java.net/projects/solaris-userland. The original
community source was downloaded from
http://www.cmake.org/files/v2.8/cmake-2.8.6.tar.gz
Further information about this software can be found on the
open source community website at http://www.cmake.org/.
cmake 2.8.6 Last change: June 17, 2014 361