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/FindOpenSSL
 197    /module/FindOpenThreads
 198    /module/Findosg
 199    /module/Findosg_functions
 200    /module/FindosgAnimation
 201    /module/FindosgDB
 202    /module/FindosgFX
 203    /module/FindosgGA
 204    /module/FindosgIntrospection
 205    /module/FindosgManipulator
 206    /module/FindosgParticle
 207    /module/FindosgPresentation
 208    /module/FindosgProducer
 209    /module/FindosgQt
 210    /module/FindosgShadow
 211    /module/FindosgSim
 212    /module/FindosgTerrain
 213    /module/FindosgText
 214    /module/FindosgUtil
 215    /module/FindosgViewer
 216    /module/FindosgVolume
 217    /module/FindosgWidget
 218    /module/FindPatch
 219    /module/FindPerl
 220    /module/FindPerlLibs
 221    /module/FindPHP4
 222    /module/FindPhysFS
 223    /module/FindPike
 224    /module/FindPkgConfig
 225    /module/FindPNG
 226    /module/FindPostgreSQL
 227    /module/FindProducer
 228    /module/FindProtobuf
 229    /module/FindPython
 230    /module/FindPython2
 231    /module/FindPython3
 232    /module/FindQt3
 233    /module/FindQt4
 234    /module/FindQuickTime
 235    /module/FindRTI
 236    /module/FindRuby
 237    /module/FindSDL
 238    /module/FindSDL_image
 239    /module/FindSDL_mixer
 240    /module/FindSDL_net
 241    /module/FindSDL_sound
 242    /module/FindSDL_ttf
 243    /module/FindSelfPackers
 244    /module/FindSquish
 245    /module/FindSQLite3
 246    /module/FindSubversion
 247    /module/FindSWIG
 248    /module/FindTCL
 249    /module/FindTclsh
 250    /module/FindTclStub
 251    /module/FindThreads
 252    /module/FindTIFF
 253    /module/FindUnixCommands
 254    /module/FindVTK
 255    /module/FindVulkan
 256    /module/FindWget
 257    /module/FindWish
 258    /module/FindwxWidgets
 259    /module/FindX11
 260    /module/FindXalanC
 261    /module/FindXCTest
 262    /module/FindXercesC
 263    /module/FindXMLRPC
 264    /module/FindZLIB
 265
 266 Deprecated Modules
 267 ^^^^^^^^^^^^^^^^^^^
 268
 269 Deprecated Utility Modules
 270 ==========================
 271
 272 .. toctree::
 273    :maxdepth: 1
 274
 275    /module/AddFileDependencies
 276    /module/CMakeDetermineVSServicePack
 277    /module/CMakeExpandImportedTargets
 278    /module/CMakeForceCompiler
 279    /module/CMakeParseArguments
 280    /module/Documentation
 281    /module/MacroAddFileDependencies
 282    /module/TestCXXAcceptsFlag
 283    /module/UseJavaClassFilelist
 284    /module/UseJavaSymlinks
 285    /module/UsePkgConfig
 286    /module/Use_wxWindows
 287    /module/WriteBasicConfigVersionFile
 288    /module/WriteCompilerDetectionHeader
 289
 290 Deprecated Find Modules
 291 =======================
 292
 293 .. toctree::
 294    :maxdepth: 1
 295
 296    /module/FindCUDA
 297    /module/FindPythonInterp
 298    /module/FindPythonLibs
 299    /module/FindQt
 300    /module/FindwxWindows
 301
 302 Legacy CPack Modules
 303 ====================
 304
 305 These modules used to be mistakenly exposed to the user, and have been moved
 306 out of user visibility. They are for CPack internal use, and should never be
 307 used directly.
 308
 309 .. toctree::
 310    :maxdepth: 1
 311
 312    /module/CPackArchive
 313    /module/CPackBundle
 314    /module/CPackCygwin
 315    /module/CPackDeb
 316    /module/CPackDMG
 317    /module/CPackFreeBSD
 318    /module/CPackNSIS
 319    /module/CPackNuGet
 320    /module/CPackProductBuild
 321    /module/CPackRPM
 322    /module/CPackWIX