Help/manual/cmake-modules.7.rst

   1 .. cmake-manual-description: CMake Modules Reference
   2
   3 cmake-modules(7)
   4 ****************
   5
   6 The modules listed here are part of the CMake distribution.
   7 Projects may provide further modules; their location(s)
   8 can be specified in the :variable:`CMAKE_MODULE_PATH` variable.
   9
  10 Utility Modules
  11 ^^^^^^^^^^^^^^^
  12
  13 These modules are loaded using the :command:`include` command.
  14
  15 .. toctree::
  16    :maxdepth: 1
  17
  18    /module/AndroidTestUtilities
  19    /module/BundleUtilities
  20    /module/CheckCCompilerFlag
  21    /module/CheckCompilerFlag
  22    /module/CheckCSourceCompiles
  23    /module/CheckCSourceRuns
  24    /module/CheckCXXCompilerFlag
  25    /module/CheckCXXSourceCompiles
  26    /module/CheckCXXSourceRuns
  27    /module/CheckCXXSymbolExists
  28    /module/CheckFortranCompilerFlag
  29    /module/CheckFortranFunctionExists
  30    /module/CheckFortranSourceCompiles
  31    /module/CheckFortranSourceRuns
  32    /module/CheckFunctionExists
  33    /module/CheckIncludeFileCXX
  34    /module/CheckIncludeFile
  35    /module/CheckIncludeFiles
  36    /module/CheckIPOSupported
  37    /module/CheckLanguage
  38    /module/CheckLibraryExists
  39    /module/CheckLinkerFlag
  40    /module/CheckOBJCCompilerFlag
  41    /module/CheckOBJCSourceCompiles
  42    /module/CheckOBJCSourceRuns
  43    /module/CheckOBJCXXCompilerFlag
  44    /module/CheckOBJCXXSourceCompiles
  45    /module/CheckOBJCXXSourceRuns
  46    /module/CheckPIESupported
  47    /module/CheckPrototypeDefinition
  48    /module/CheckSourceCompiles
  49    /module/CheckSourceRuns
  50    /module/CheckStructHasMember
  51    /module/CheckSymbolExists
  52    /module/CheckTypeSize
  53    /module/CheckVariableExists
  54    /module/CMakeAddFortranSubdirectory
  55    /module/CMakeBackwardCompatibilityCXX
  56    /module/CMakeDependentOption
  57    /module/CMakeFindDependencyMacro
  58    /module/CMakeFindFrameworks
  59    /module/CMakeFindPackageMode
  60    /module/CMakeGraphVizOptions
  61    /module/CMakePackageConfigHelpers
  62    /module/CMakePrintHelpers
  63    /module/CMakePrintSystemInformation
  64    /module/CMakePushCheckState
  65    /module/CMakeVerifyManifest
  66    /module/CPack
  67    /module/CPackComponent
  68    /module/CPackIFW
  69    /module/CPackIFWConfigureFile
  70    /module/CSharpUtilities
  71    /module/CTest
  72    /module/CTestCoverageCollectGCOV
  73    /module/CTestScriptMode
  74    /module/CTestUseLaunchers
  75    /module/Dart
  76    /module/DeployQt4
  77    /module/ExternalData
  78    /module/ExternalProject
  79    /module/FeatureSummary
  80    /module/FetchContent
  81    /module/FindPackageHandleStandardArgs
  82    /module/FindPackageMessage
  83    /module/FortranCInterface
  84    /module/GenerateExportHeader
  85    /module/GetPrerequisites
  86    /module/GNUInstallDirs
  87    /module/GoogleTest
  88    /module/InstallRequiredSystemLibraries
  89    /module/ProcessorCount
  90    /module/SelectLibraryConfigurations
  91    /module/SquishTestScript
  92    /module/TestBigEndian
  93    /module/TestForANSIForScope
  94    /module/TestForANSIStreamHeaders
  95    /module/TestForSSTREAM
  96    /module/TestForSTDNamespace
  97    /module/UseEcos
  98    /module/UseJava
  99    /module/UseSWIG
 100    /module/UsewxWidgets
 101
 102 Find Modules
 103 ^^^^^^^^^^^^
 104
 105 These modules search for third-party software.
 106 They are normally called through the :command:`find_package` command.
 107
 108 .. toctree::
 109    :maxdepth: 1
 110
 111    /module/FindALSA
 112    /module/FindArmadillo
 113    /module/FindASPELL
 114    /module/FindAVIFile
 115    /module/FindBacktrace
 116    /module/FindBISON
 117    /module/FindBLAS
 118    /module/FindBoost
 119    /module/FindBullet
 120    /module/FindBZip2
 121    /module/FindCABLE
 122    /module/FindCoin3D
 123    /module/FindCUDAToolkit
 124    /module/FindCups
 125    /module/FindCURL
 126    /module/FindCurses
 127    /module/FindCVS
 128    /module/FindCxxTest
 129    /module/FindCygwin
 130    /module/FindDart
 131    /module/FindDCMTK
 132    /module/FindDevIL
 133    /module/FindDoxygen
 134    /module/FindEnvModules
 135    /module/FindEXPAT
 136    /module/FindFLEX
 137    /module/FindFLTK
 138    /module/FindFLTK2
 139    /module/FindFontconfig
 140    /module/FindFreetype
 141    /module/FindGCCXML
 142    /module/FindGDAL
 143    /module/FindGettext
 144    /module/FindGIF
 145    /module/FindGit
 146    /module/FindGLEW
 147    /module/FindGLUT
 148    /module/FindGnuplot
 149    /module/FindGnuTLS
 150    /module/FindGSL
 151    /module/FindGTest
 152    /module/FindGTK
 153    /module/FindGTK2
 154    /module/FindHDF5
 155    /module/FindHg
 156    /module/FindHSPELL
 157    /module/FindHTMLHelp
 158    /module/FindIce
 159    /module/FindIconv
 160    /module/FindIcotool
 161    /module/FindICU
 162    /module/FindImageMagick
 163    /module/FindIntl
 164    /module/FindITK
 165    /module/FindJasper
 166    /module/FindJava
 167    /module/FindJNI
 168    /module/FindJPEG
 169    /module/FindKDE3
 170    /module/FindKDE4
 171    /module/FindLAPACK
 172    /module/FindLATEX
 173    /module/FindLibArchive
 174    /module/FindLibinput
 175    /module/FindLibLZMA
 176    /module/FindLibXml2
 177    /module/FindLibXslt
 178    /module/FindLTTngUST
 179    /module/FindLua
 180    /module/FindLua50
 181    /module/FindLua51
 182    /module/FindMatlab
 183    /module/FindMFC
 184    /module/FindMotif
 185    /module/FindMPEG
 186    /module/FindMPEG2
 187    /module/FindMPI
 188    /module/FindMsys
 189    /module/FindODBC
 190    /module/FindOpenACC
 191    /module/FindOpenAL
 192    /module/FindOpenCL
 193    /module/FindOpenGL
 194    /module/FindOpenMP
 195    /module/FindOpenSceneGraph
 196    /module/FindOpenSP
 197    /module/FindOpenSSL
 198    /module/FindOpenThreads
 199    /module/Findosg
 200    /module/Findosg_functions
 201    /module/FindosgAnimation
 202    /module/FindosgDB
 203    /module/FindosgFX
 204    /module/FindosgGA
 205    /module/FindosgIntrospection
 206    /module/FindosgManipulator
 207    /module/FindosgParticle
 208    /module/FindosgPresentation
 209    /module/FindosgProducer
 210    /module/FindosgQt
 211    /module/FindosgShadow
 212    /module/FindosgSim
 213    /module/FindosgTerrain
 214    /module/FindosgText
 215    /module/FindosgUtil
 216    /module/FindosgViewer
 217    /module/FindosgVolume
 218    /module/FindosgWidget
 219    /module/FindPatch
 220    /module/FindPerl
 221    /module/FindPerlLibs
 222    /module/FindPHP4
 223    /module/FindPhysFS
 224    /module/FindPike
 225    /module/FindPkgConfig
 226    /module/FindPNG
 227    /module/FindPostgreSQL
 228    /module/FindProducer
 229    /module/FindProtobuf
 230    /module/FindPython
 231    /module/FindPython2
 232    /module/FindPython3
 233    /module/FindQt3
 234    /module/FindQt4
 235    /module/FindQuickTime
 236    /module/FindRTI
 237    /module/FindRuby
 238    /module/FindSDL
 239    /module/FindSDL_image
 240    /module/FindSDL_gfx
 241    /module/FindSDL_mixer
 242    /module/FindSDL_net
 243    /module/FindSDL_sound
 244    /module/FindSDL_ttf
 245    /module/FindSelfPackers
 246    /module/FindSquish
 247    /module/FindSQLite3
 248    /module/FindSubversion
 249    /module/FindSWIG
 250    /module/FindTCL
 251    /module/FindTclsh
 252    /module/FindTclStub
 253    /module/FindThreads
 254    /module/FindTIFF
 255    /module/FindUnixCommands
 256    /module/FindVTK
 257    /module/FindVulkan
 258    /module/FindWget
 259    /module/FindWish
 260    /module/FindwxWidgets
 261    /module/FindX11
 262    /module/FindXalanC
 263    /module/FindXCTest
 264    /module/FindXercesC
 265    /module/FindXMLRPC
 266    /module/FindZLIB
 267
 268 Deprecated Modules
 269 ^^^^^^^^^^^^^^^^^^^
 270
 271 Deprecated Utility Modules
 272 ==========================
 273
 274 .. toctree::
 275    :maxdepth: 1
 276
 277    /module/AddFileDependencies
 278    /module/CMakeDetermineVSServicePack
 279    /module/CMakeExpandImportedTargets
 280    /module/CMakeForceCompiler
 281    /module/CMakeParseArguments
 282    /module/Documentation
 283    /module/MacroAddFileDependencies
 284    /module/TestCXXAcceptsFlag
 285    /module/UseJavaClassFilelist
 286    /module/UseJavaSymlinks
 287    /module/UsePkgConfig
 288    /module/Use_wxWindows
 289    /module/WriteBasicConfigVersionFile
 290    /module/WriteCompilerDetectionHeader
 291
 292 Deprecated Find Modules
 293 =======================
 294
 295 .. toctree::
 296    :maxdepth: 1
 297
 298    /module/FindCUDA
 299    /module/FindPythonInterp
 300    /module/FindPythonLibs
 301    /module/FindQt
 302    /module/FindwxWindows
 303
 304 Legacy CPack Modules
 305 ====================
 306
 307 These modules used to be mistakenly exposed to the user, and have been moved
 308 out of user visibility. They are for CPack internal use, and should never be
 309 used directly.
 310
 311 .. toctree::
 312    :maxdepth: 1
 313
 314    /module/CPackArchive
 315    /module/CPackBundle
 316    /module/CPackCygwin
 317    /module/CPackDeb
 318    /module/CPackDMG
 319    /module/CPackFreeBSD
 320    /module/CPackNSIS
 321    /module/CPackNuGet
 322    /module/CPackProductBuild
 323    /module/CPackRPM
 324    /module/CPackWIX