1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
WELCOME TO CROSS-PLATFORM MAKE (CMake)
-------------------------------------
CMake is a cross-platform, extensible build environment. It currently generates
Unix makefiles and Microsoft Visual C++ projects/workspaces.
To use CMake, create CMakeLists.txt in each directory that makes up your
source repository. The CMakeLists.txt file contains rules. Each rule does
something different, like defining a list of source code, include directories,
etc. Once CMake has processed all the rules in all the CMakeLists.txt files,
it generates the appropriate "makefile(s)" for the system/compiler that you
are on.
THE BOOK OF RULES
-----------------
The key to using CMake is to learn the rules. Each rule has the same format:
NAME_OF_RULE(args....)
where args is a white-space separated listed of arguments. (Arguments
containing spaces should be quoted). For example:
INCLUDE_DIRECTORIES(./ d:/include "c:/Program Files/include")
note that Unix-style slashes are used. The rules may reference CMake
variables, either built-in or defined variables. Two important variables
are built-in to CMake:
CMAKE_SOURCE_DIR - The root directory of the source code
directory tree.
CMAKE_BINARY_DIR - The root directory of the build tree
where binaries are placed. This includes
object files, libraries, and executables.
A rule might reference these as follows:
INCLUDE_DIRECTORIES(${CMAKE_SOURCE_DIR})
using the ${} delimiters.
Here is a list of current rules. You may also wish to view
the Doxygen documentation (if available) or generate it with
the doxygen.config file in this directory.
Rules: (Generated with cmDumpDocumentation)
------------------------------------------
ABSTRACT_FILES - A list of abstract classes, useful for wrappers.
Usage: ABSTRACT_FILES(file1 file2 ..)
ADD_TARGET - Add an extra target to the build system.
Usage: ADD_TARGET(Name "command to run")
AUX_SOURCE_DIRECTORY - Add all the source files found in the specified directory to
the build.
Usage: AUX_SOURCE_DIRECTORY(dir)
EXECUTABLES - Add a list of executables files.
Usage: EXECUTABLES(file1 file2 ...)
FIND_INCLUDE - Find an include path.
Usage: FIND_INCLUDE(DEFINE try1 try2 ...)
FIND_LIBRARY - Find a library.
Usage: FIND_LIBRARY(DEFINE try1 try2)
FIND_PROGRARM - Find an executable program.
Usage: FIND_PROGRAM(NAME executable1 executable2 ...)
INCLUDE_DIRECTORIES - Add include directories to the build.
Usage: INCLUDE_DIRECTORIES(dir1 dir2 ...).
LIBRARY - Set a name for a library.
Usage: LIBRARY(libraryname)
LINK_DIRECTORIES - Specify link directories.
Usage: Specify the paths to the libraries that will be linked in.
LINK_DIRECTORIES(directory1 directory2 ...)
The directories can use built in definitions like
CMAKE_BINARY_DIR and CMAKE_SOURCE_DIR.
LINK_LIBRARIES - Specify a list of libraries to be linked into executables or
shared objects.
Usage: Specify a list of libraries to be linked into executables or
shared objects. This rule is passed down to all other rules.LINK_LIBRARIES(library1 library2).
The library name should be the same as the name used in the
LIBRARY(library) rule.
PROJECT - Set a name for the entire project. One argument.
Usage: Set the name for the entire project. This takes one argument.
PROJECT(projectname)
SOURCE_FILES - Add a list of source files.
Usage: SOURCE_FILES(file1 file2 ...)
SOURCE_FILES_REQUIRE - Add a list of source files if the required variables are set.
Usage: SOURCE_FILES_REQUIRE(var1 var2 ... SOURCES_BEGIN file1 file2 ...)
SUBDIRS - Add a list of subdirectories to the build.
Usage: Add a list of subdirectories to the build.
SUBDIRS(dir1 dir2 ...)
This will cause any CMakeLists.txt files in the sub directories
to be processed by CMake.
TESTS - Add a list of executables files that are run as tests.
Usage: TESTS(file1 file2 ...)
UNIX_DEFINES - Add -D flags to the command line for Unix only.
Usage: Add -D flags to the command line for Unix only.
UNIX_DEFINES(-DFOO -DBAR)
UNIX_LIBRARIES - Add libraries that are only used for Unix programs.
Usage: UNIX_LIBRARIES(library -lm ...)
WIN32_DEFINES - Add -D define flags to command line for Win32 environments.
Usage: Add -D define flags to command line for Win32 environments.
WIN32_DEFINES(-DFOO -DBAR ...)
WIN32_LIBRARIES - Add libraries that are only used for Win32 programs.
Usage: WIN32_LIBRARIES(library -lm ...)
USING / BUILDING WITH CMAKE
---------------------------
Windows:
-------
These programs are used to drive CMake on Windows:
CMakeSetup.exe -> window MFC based GUI for configure on windows
CMakeSetupCMD.exe -> windows command line version of CMakeConfigure
To build a project on Windows:
load CMake/Source/CMakeSetup.dsw
Build it
Run it
Specify paths
Load ITK.dsw
Build Common, Numerics, then any of the many executables,
or do a Batch build with debug only.
Unix:
----
These programs/files are used to drive CMake on Unix:
configure -> run on unix to configure for build
CMakeBuildTargets -> Unix program to read CMakeLists.txt and
generate CMakeTargets.make
makefile fragments:
CMakeMaster.make -> main file to be included by makefiles
CMakeVariables.make -> all make varibles are set in this file
CMakeRules.make -> All build rules are here (except Simple Rules)
CMakeSimpleRules.make -> simple build rules for .o to .cxx, this is separate
to be able to build CMakeBuildTargets itself.
CMakeLocal.make -> Place for hand configuration
CMakeTargets.make -> generated rules for make style build in each directory
MakefileTemplate.make -> master makefile template used by configure to
generate Makefiles
Unix install:
In place (object files end up in source code directory):
./configure
make
Other directory (object files are in another directory):
mkdir Insight-build
cd Insight-build
../Insight/configure
make
FOR MORE INFORMATION
--------------------
Contact Bill Hoffman bill.hoffman@kitware.com who is the
principal developer.
|
