cmake-modules.7.rst 7.22 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
   /module/CheckPIESupported
40 41 42 43 44 45 46 47
   /module/CheckPrototypeDefinition
   /module/CheckStructHasMember
   /module/CheckSymbolExists
   /module/CheckTypeSize
   /module/CheckVariableExists
   /module/CMakeAddFortranSubdirectory
   /module/CMakeBackwardCompatibilityCXX
   /module/CMakeDependentOption
48
   /module/CMakeFindDependencyMacro
49 50 51 52 53 54 55 56 57
   /module/CMakeFindFrameworks
   /module/CMakeFindPackageMode
   /module/CMakeGraphVizOptions
   /module/CMakePackageConfigHelpers
   /module/CMakePrintHelpers
   /module/CMakePrintSystemInformation
   /module/CMakePushCheckState
   /module/CMakeVerifyManifest
   /module/CPackComponent
58
   /module/CPackIFW
59
   /module/CPackIFWConfigureFile
60
   /module/CPack
61
   /module/CSharpUtilities
62
   /module/CTest
63
   /module/CTestCoverageCollectGCOV
64 65 66 67 68 69 70 71
   /module/CTestScriptMode
   /module/CTestUseLaunchers
   /module/Dart
   /module/DeployQt4
   /module/Documentation
   /module/ExternalData
   /module/ExternalProject
   /module/FeatureSummary
72
   /module/FetchContent
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
   /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

106 107 108 109 110 111
   /module/FindALSA
   /module/FindArmadillo
   /module/FindASPELL
   /module/FindAVIFile
   /module/FindBISON
   /module/FindBLAS
112
   /module/FindBacktrace
113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
   /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
128
   /module/FindEnvModules
129 130 131 132
   /module/FindEXPAT
   /module/FindFLEX
   /module/FindFLTK2
   /module/FindFLTK
133
   /module/FindFontconfig
134 135 136 137 138 139 140 141 142 143
   /module/FindFreetype
   /module/FindGCCXML
   /module/FindGDAL
   /module/FindGettext
   /module/FindGIF
   /module/FindGit
   /module/FindGLEW
   /module/FindGLUT
   /module/FindGnuplot
   /module/FindGnuTLS
144
   /module/FindGSL
145 146 147 148 149 150 151
   /module/FindGTest
   /module/FindGTK2
   /module/FindGTK
   /module/FindHDF5
   /module/FindHg
   /module/FindHSPELL
   /module/FindHTMLHelp
152
   /module/FindIce
153
   /module/FindIcotool
Roger Leigh's avatar
Roger Leigh committed
154
   /module/FindICU
155
   /module/FindImageMagick
156
   /module/FindIconv
157
   /module/FindIntl
158 159 160 161 162 163 164 165 166 167
   /module/FindITK
   /module/FindJasper
   /module/FindJava
   /module/FindJNI
   /module/FindJPEG
   /module/FindKDE3
   /module/FindKDE4
   /module/FindLAPACK
   /module/FindLATEX
   /module/FindLibArchive
168
   /module/FindLibinput
169 170 171
   /module/FindLibLZMA
   /module/FindLibXml2
   /module/FindLibXslt
172
   /module/FindLTTngUST
173 174 175 176 177 178 179 180 181
   /module/FindLua50
   /module/FindLua51
   /module/FindLua
   /module/FindMatlab
   /module/FindMFC
   /module/FindMotif
   /module/FindMPEG2
   /module/FindMPEG
   /module/FindMPI
182
   /module/FindODBC
183
   /module/FindOpenACC
184
   /module/FindOpenAL
Matthäus Chajdas's avatar
Matthäus Chajdas committed
185
   /module/FindOpenCL
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210
   /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
211
   /module/FindPatch
212 213 214 215 216 217 218 219 220 221
   /module/FindPerlLibs
   /module/FindPerl
   /module/FindPHP4
   /module/FindPhysFS
   /module/FindPike
   /module/FindPkgConfig
   /module/FindPNG
   /module/FindPostgreSQL
   /module/FindProducer
   /module/FindProtobuf
222 223 224
   /module/FindPython
   /module/FindPython2
   /module/FindPython3
225 226 227 228 229 230 231 232 233 234 235 236 237
   /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
238
   /module/FindSQLite3
239 240 241 242 243 244 245 246 247
   /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
248
   /module/FindVulkan
249 250 251
   /module/FindWget
   /module/FindWish
   /module/FindwxWidgets
Gregor Jasny's avatar
Gregor Jasny committed
252
   /module/FindXCTest
253
   /module/FindXalanC
254
   /module/FindXercesC
255 256 257
   /module/FindX11
   /module/FindXMLRPC
   /module/FindZLIB
258 259 260 261 262 263 264 265 266 267 268 269 270

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

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

.. toctree::
   :maxdepth: 1

   /module/CMakeDetermineVSServicePack
   /module/CMakeExpandImportedTargets
   /module/CMakeForceCompiler
271
   /module/CMakeParseArguments
272
   /module/MacroAddFileDependencies
273
   /module/TestCXXAcceptsFlag
274
   /module/UsePkgConfig
275
   /module/Use_wxWindows
276
   /module/WriteBasicConfigVersionFile
277 278 279 280 281 282 283 284 285 286

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

.. toctree::
   :maxdepth: 1

   /module/FindCUDA
   /module/FindPythonInterp
   /module/FindPythonLibs
287
   /module/FindQt
288
   /module/FindwxWindows
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311

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