cmake-modules.7.rst 7.42 KB
Newer Older
1 2
.. cmake-manual-description: CMake Modules Reference

3 4 5
cmake-modules(7)
****************

6 7 8
The modules listed here are part of the CMake distribution.
Projects may provide further modules; their location(s)
can be specified in the :variable:`CMAKE_MODULE_PATH` variable.
9

10 11
Utility Modules
^^^^^^^^^^^^^^^
12

13
These modules are loaded using the :command:`include` command.
14 15

.. toctree::
16 17
   :maxdepth: 1

18
   /module/AddFileDependencies
19
   /module/AndroidTestUtilities
20 21 22 23 24 25 26 27
   /module/BundleUtilities
   /module/CheckCCompilerFlag
   /module/CheckCSourceCompiles
   /module/CheckCSourceRuns
   /module/CheckCXXCompilerFlag
   /module/CheckCXXSourceCompiles
   /module/CheckCXXSourceRuns
   /module/CheckCXXSymbolExists
28
   /module/CheckFortranCompilerFlag
29
   /module/CheckFortranFunctionExists
30
   /module/CheckFortranSourceCompiles
31
   /module/CheckFortranSourceRuns
32
   /module/CheckFunctionExists
33
   /module/CheckIPOSupported
34 35 36 37 38
   /module/CheckIncludeFileCXX
   /module/CheckIncludeFile
   /module/CheckIncludeFiles
   /module/CheckLanguage
   /module/CheckLibraryExists
39 40 41
   /module/CheckOBJCCompilerFlag
   /module/CheckOBJCSourceCompiles
   /module/CheckOBJCSourceRuns
42 43 44
   /module/CheckOBJCXXCompilerFlag
   /module/CheckOBJCXXSourceCompiles
   /module/CheckOBJCXXSourceRuns
45
   /module/CheckPIESupported
46 47 48 49 50 51 52 53
   /module/CheckPrototypeDefinition
   /module/CheckStructHasMember
   /module/CheckSymbolExists
   /module/CheckTypeSize
   /module/CheckVariableExists
   /module/CMakeAddFortranSubdirectory
   /module/CMakeBackwardCompatibilityCXX
   /module/CMakeDependentOption
54
   /module/CMakeFindDependencyMacro
55 56 57 58 59 60 61 62 63
   /module/CMakeFindFrameworks
   /module/CMakeFindPackageMode
   /module/CMakeGraphVizOptions
   /module/CMakePackageConfigHelpers
   /module/CMakePrintHelpers
   /module/CMakePrintSystemInformation
   /module/CMakePushCheckState
   /module/CMakeVerifyManifest
   /module/CPackComponent
64
   /module/CPackIFW
65
   /module/CPackIFWConfigureFile
66
   /module/CPack
67
   /module/CSharpUtilities
68
   /module/CTest
69
   /module/CTestCoverageCollectGCOV
70 71 72 73 74 75 76 77
   /module/CTestScriptMode
   /module/CTestUseLaunchers
   /module/Dart
   /module/DeployQt4
   /module/Documentation
   /module/ExternalData
   /module/ExternalProject
   /module/FeatureSummary
78
   /module/FetchContent
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
   /module/FindPackageHandleStandardArgs
   /module/FindPackageMessage
   /module/FortranCInterface
   /module/GenerateExportHeader
   /module/GetPrerequisites
   /module/GNUInstallDirs
   /module/GoogleTest
   /module/InstallRequiredSystemLibraries
   /module/ProcessorCount
   /module/SelectLibraryConfigurations
   /module/SquishTestScript
   /module/TestBigEndian
   /module/TestForANSIForScope
   /module/TestForANSIStreamHeaders
   /module/TestForSSTREAM
   /module/TestForSTDNamespace
   /module/UseEcos
   /module/UseJavaClassFilelist
   /module/UseJava
   /module/UseJavaSymlinks
   /module/UseSWIG
   /module/UsewxWidgets
   /module/WriteCompilerDetectionHeader

Find Modules
^^^^^^^^^^^^

These modules search for third-party software.
They are normally called through the :command:`find_package` command.

.. toctree::
   :maxdepth: 1

112 113 114 115 116 117
   /module/FindALSA
   /module/FindArmadillo
   /module/FindASPELL
   /module/FindAVIFile
   /module/FindBISON
   /module/FindBLAS
118
   /module/FindBacktrace
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
   /module/FindBoost
   /module/FindBullet
   /module/FindBZip2
   /module/FindCABLE
   /module/FindCoin3D
   /module/FindCups
   /module/FindCURL
   /module/FindCurses
   /module/FindCVS
   /module/FindCxxTest
   /module/FindCygwin
   /module/FindDart
   /module/FindDCMTK
   /module/FindDevIL
   /module/FindDoxygen
134
   /module/FindEnvModules
135 136 137 138
   /module/FindEXPAT
   /module/FindFLEX
   /module/FindFLTK2
   /module/FindFLTK
139
   /module/FindFontconfig
140 141 142 143 144 145 146 147 148 149
   /module/FindFreetype
   /module/FindGCCXML
   /module/FindGDAL
   /module/FindGettext
   /module/FindGIF
   /module/FindGit
   /module/FindGLEW
   /module/FindGLUT
   /module/FindGnuplot
   /module/FindGnuTLS
150
   /module/FindGSL
151 152 153 154 155 156 157
   /module/FindGTest
   /module/FindGTK2
   /module/FindGTK
   /module/FindHDF5
   /module/FindHg
   /module/FindHSPELL
   /module/FindHTMLHelp
158
   /module/FindIce
159
   /module/FindIcotool
Roger Leigh's avatar
Roger Leigh committed
160
   /module/FindICU
161
   /module/FindImageMagick
162
   /module/FindIconv
163
   /module/FindIntl
164 165 166 167 168 169 170 171 172 173
   /module/FindITK
   /module/FindJasper
   /module/FindJava
   /module/FindJNI
   /module/FindJPEG
   /module/FindKDE3
   /module/FindKDE4
   /module/FindLAPACK
   /module/FindLATEX
   /module/FindLibArchive
174
   /module/FindLibinput
175 176 177
   /module/FindLibLZMA
   /module/FindLibXml2
   /module/FindLibXslt
178
   /module/FindLTTngUST
179 180 181 182 183 184 185 186 187
   /module/FindLua50
   /module/FindLua51
   /module/FindLua
   /module/FindMatlab
   /module/FindMFC
   /module/FindMotif
   /module/FindMPEG2
   /module/FindMPEG
   /module/FindMPI
188
   /module/FindODBC
189
   /module/FindOpenACC
190
   /module/FindOpenAL
Matthäus Chajdas's avatar
Matthäus Chajdas committed
191
   /module/FindOpenCL
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
   /module/FindOpenGL
   /module/FindOpenMP
   /module/FindOpenSceneGraph
   /module/FindOpenSSL
   /module/FindOpenThreads
   /module/FindosgAnimation
   /module/FindosgDB
   /module/Findosg_functions
   /module/FindosgFX
   /module/FindosgGA
   /module/FindosgIntrospection
   /module/FindosgManipulator
   /module/FindosgParticle
   /module/FindosgPresentation
   /module/FindosgProducer
   /module/FindosgQt
   /module/Findosg
   /module/FindosgShadow
   /module/FindosgSim
   /module/FindosgTerrain
   /module/FindosgText
   /module/FindosgUtil
   /module/FindosgViewer
   /module/FindosgVolume
   /module/FindosgWidget
217
   /module/FindPatch
218 219 220 221 222 223 224 225 226 227
   /module/FindPerlLibs
   /module/FindPerl
   /module/FindPHP4
   /module/FindPhysFS
   /module/FindPike
   /module/FindPkgConfig
   /module/FindPNG
   /module/FindPostgreSQL
   /module/FindProducer
   /module/FindProtobuf
228 229 230
   /module/FindPython
   /module/FindPython2
   /module/FindPython3
231 232 233 234 235 236 237 238 239 240 241 242 243
   /module/FindQt3
   /module/FindQt4
   /module/FindQuickTime
   /module/FindRTI
   /module/FindRuby
   /module/FindSDL_image
   /module/FindSDL_mixer
   /module/FindSDL_net
   /module/FindSDL
   /module/FindSDL_sound
   /module/FindSDL_ttf
   /module/FindSelfPackers
   /module/FindSquish
244
   /module/FindSQLite3
245 246 247 248 249 250 251 252 253
   /module/FindSubversion
   /module/FindSWIG
   /module/FindTCL
   /module/FindTclsh
   /module/FindTclStub
   /module/FindThreads
   /module/FindTIFF
   /module/FindUnixCommands
   /module/FindVTK
Matthäus Chajdas's avatar
Matthäus Chajdas committed
254
   /module/FindVulkan
255 256 257
   /module/FindWget
   /module/FindWish
   /module/FindwxWidgets
Gregor Jasny's avatar
Gregor Jasny committed
258
   /module/FindXCTest
259
   /module/FindXalanC
260
   /module/FindXercesC
261 262 263
   /module/FindX11
   /module/FindXMLRPC
   /module/FindZLIB
264 265 266 267 268 269 270 271 272 273 274 275 276

Deprecated Modules
^^^^^^^^^^^^^^^^^^^

Deprecated Utility Modules
==========================

.. toctree::
   :maxdepth: 1

   /module/CMakeDetermineVSServicePack
   /module/CMakeExpandImportedTargets
   /module/CMakeForceCompiler
277
   /module/CMakeParseArguments
278
   /module/MacroAddFileDependencies
279
   /module/TestCXXAcceptsFlag
280
   /module/UsePkgConfig
281
   /module/Use_wxWindows
282
   /module/WriteBasicConfigVersionFile
283 284 285 286 287 288 289 290 291 292

Deprecated Find Modules
=======================

.. toctree::
   :maxdepth: 1

   /module/FindCUDA
   /module/FindPythonInterp
   /module/FindPythonLibs
293
   /module/FindQt
294
   /module/FindwxWindows
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317

Legacy CPack Modules
====================

These modules used to be mistakenly exposed to the user, and have been moved
out of user visibility. They are for CPack internal use, and should never be
used directly.

.. toctree::
   :maxdepth: 1

   /module/CPackArchive
   /module/CPackBundle
   /module/CPackCygwin
   /module/CPackDeb
   /module/CPackDMG
   /module/CPackFreeBSD
   /module/CPackNSIS
   /module/CPackNuGet
   /module/CPackPackageMaker
   /module/CPackProductBuild
   /module/CPackRPM
   /module/CPackWIX