kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
CMake/Help/manual/cmake-modules.7.rst

251 lines
5.9 KiB
ReStructuredText
Raw Normal View History

Help: Glob manual/*.rst in Sphinx configuration Add the man page description line as explicit markup at the top of each Help/manual/*.rst file and scan it from conf.py to automatically generate the man_pages Sphinx configuration value. This reduces the number of places that need to be changed when a new manual is added.
2013-10-30 17:58:25 +04:00
.. cmake-manual-description: CMake Modules Reference
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
cmake-modules(7)
****************
Help: Drop TOC from latex manuals A latex document can have its own TOC.
2014-11-06 19:37:24 +03:00
.. only:: html
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
.. contents::
All Modules
===========
.. toctree::
Help: Limit reference manual toctree depth to 1 Add a :maxdepth: option to all toctree directives to limit their depth to 1. We do not want subheadings from individual documents to pollute the already large lists of CMake Domain objects.
2013-11-01 19:12:02 +04:00
:maxdepth: 1
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/AddFileDependencies
AndroidTestUtilities: Add module to help drive Android device tests Add a module to manage the data needed for the project tests. It will move the test data to the build directory and transfer necessary data to an Android device if that is enabled.
2016-09-15 22:31:39 +03:00
/module/AndroidTestUtilities
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/BundleUtilities
/module/CheckCCompilerFlag
/module/CheckCSourceCompiles
/module/CheckCSourceRuns
/module/CheckCXXCompilerFlag
/module/CheckCXXSourceCompiles
/module/CheckCXXSourceRuns
/module/CheckCXXSymbolExists
CheckFortranCompilerFlag: Add module to check Fortran flag existence Copy the CheckCCompilerFlag module and replace 'C' with 'Fortran'. Also update the common patterns module to match some Fortran compiler messages.
2015-02-03 03:07:04 +03:00
/module/CheckFortranCompilerFlag
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/CheckFortranFunctionExists
Add CheckFortranSourceCompiles module (#14656) Copy the CheckCSourceCompiles module and port it to Fortran. Extend the FortranOnly test to try using the new module. Suggested-by: Nicolas Bock <nicolasbock@gmail.com>
2014-08-06 18:27:17 +04:00
/module/CheckFortranSourceCompiles
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/CheckFunctionExists
/module/CheckIncludeFileCXX
/module/CheckIncludeFile
/module/CheckIncludeFiles
/module/CheckLanguage
/module/CheckLibraryExists
/module/CheckPrototypeDefinition
/module/CheckStructHasMember
/module/CheckSymbolExists
/module/CheckTypeSize
/module/CheckVariableExists
/module/CMakeAddFortranSubdirectory
/module/CMakeBackwardCompatibilityCXX
/module/CMakeDependentOption
/module/CMakeDetermineVSServicePack
/module/CMakeExpandImportedTargets
Split the find_dependency macro into a separate file. This allows Config file authors to use it without having to use CONFIGURE_PACKAGE_CONFIG_FILE.
2013-11-27 16:43:52 +04:00
/module/CMakeFindDependencyMacro
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/CMakeFindFrameworks
/module/CMakeFindPackageMode
/module/CMakeForceCompiler
/module/CMakeGraphVizOptions
/module/CMakePackageConfigHelpers
/module/CMakeParseArguments
/module/CMakePrintHelpers
/module/CMakePrintSystemInformation
/module/CMakePushCheckState
/module/CMakeVerifyManifest
/module/CPackBundle
/module/CPackComponent
/module/CPackCygwin
/module/CPackDeb
/module/CPackDMG
CPack: Add an "IFW" generator for Qt Framework Installer Add support for packaging with the Qt Framework Installer tools: http://qt-project.org/doc/qtinstallerframework/index.html Reviewed-by: Nils Gladitz <nilsgladitz@gmail.com>
2014-07-23 11:01:59 +04:00
/module/CPackIFW
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/CPackNSIS
/module/CPackPackageMaker
productbuild: Add new productbuild cpack generator. This cpack generator basically replaces the obsolete PackageMaker generator.
2013-11-02 20:24:53 +04:00
/module/CPackProductBuild
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/CPackRPM
/module/CPack
/module/CPackWIX
/module/CTest
CTestCoverageCollectGCOV: Add module to run gcov Provide a function to run gcov and create a tarball of results. Since CDash tracks the md5sum of the files uploaded, use the --mtime option with "cmake -E tar" so that tar files could be created that would have the same md5sum with the same content.
2015-01-14 18:52:26 +03:00
/module/CTestCoverageCollectGCOV
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/CTestScriptMode
/module/CTestUseLaunchers
/module/Dart
/module/DeployQt4
/module/Documentation
/module/ExternalData
/module/ExternalProject
/module/FeatureSummary
/module/FindALSA
/module/FindArmadillo
/module/FindASPELL
/module/FindAVIFile
/module/FindBISON
/module/FindBLAS
Add FindBacktrace.cmake module. It designed to search for implementation of backtrace(3) routine. Currently it is used in OpenBSD Ports for building Clementine music player. A lot of input from brad.king@ and neundorf@.
2013-07-28 14:31:30 +04:00
/module/FindBacktrace
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/FindBoost
/module/FindBullet
/module/FindBZip2
/module/FindCABLE
/module/FindCoin3D
/module/FindCUDA
/module/FindCups
/module/FindCURL
/module/FindCurses
/module/FindCVS
/module/FindCxxTest
/module/FindCygwin
/module/FindDart
/module/FindDCMTK
/module/FindDevIL
/module/FindDoxygen
/module/FindEXPAT
/module/FindFLEX
/module/FindFLTK2
/module/FindFLTK
/module/FindFreetype
/module/FindGCCXML
/module/FindGDAL
/module/FindGettext
/module/FindGIF
/module/FindGit
/module/FindGLEW
/module/FindGLUT
/module/FindGnuplot
/module/FindGnuTLS
FindGSL: Add module to find the GNU Scientific Library
2014-12-17 18:10:23 +03:00
/module/FindGSL
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/FindGTest
/module/FindGTK2
/module/FindGTK
/module/FindHDF5
/module/FindHg
/module/FindHSPELL
/module/FindHTMLHelp
FindIce: New module to find ZeroC Ice - autodetects Ice on all major platforms - allows building with all supported Visual Studio versions on Windows - autodetects the slice path on most platforms - separately detects the Ice programs, headers, slice files and libraries so that any Ice configuration or installation errors can be accurately reported, making diagnosis of Ice problems simpler
2014-08-07 21:37:36 +04:00
/module/FindIce
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/FindIcotool
FindICU: New module
2016-07-10 20:34:39 +03:00
/module/FindICU
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/FindImageMagick
FindIntl: New module to find Gettext libintl Add support for Sun/Uniforum/GNU gettext libintl. This belongs in CMake rather than upstream because: * There are multiple upstreams (Sun, GNU). * It may or may not be in the glibc C library depending upon the platform and build options used. Although we already have a FindGettext module, that is for the tools. This module is for the library, and is independent because it's perfectly OK to use libintl without the gettext tools (and vice versa), and they might not all be found. Add cross references between the two modules in notes to make the relationship clearer.
2014-11-10 01:46:58 +03:00
/module/FindIntl
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/FindITK
/module/FindJasper
/module/FindJava
/module/FindJNI
/module/FindJPEG
/module/FindKDE3
/module/FindKDE4
/module/FindLAPACK
/module/FindLATEX
/module/FindLibArchive
/module/FindLibLZMA
/module/FindLibXml2
/module/FindLibXslt
Add FindLTTngUST module to find LTTng-UST library Also detect the library version number. Provide results as variables and as an imported target, LTTng::UST. Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
2016-02-29 20:35:27 +03:00
/module/FindLTTngUST
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/FindLua50
/module/FindLua51
/module/FindLua
/module/FindMatlab
/module/FindMFC
/module/FindMotif
/module/FindMPEG2
/module/FindMPEG
/module/FindMPI
/module/FindOpenAL
Add FindOpenCL module
2014-02-22 22:57:17 +04:00
/module/FindOpenCL
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/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
/module/FindPackageHandleStandardArgs
/module/FindPackageMessage
/module/FindPerlLibs
/module/FindPerl
/module/FindPHP4
/module/FindPhysFS
/module/FindPike
/module/FindPkgConfig
/module/FindPNG
/module/FindPostgreSQL
/module/FindProducer
/module/FindProtobuf
/module/FindPythonInterp
/module/FindPythonLibs
/module/FindQt3
/module/FindQt4
/module/FindQt
/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
/module/FindSubversion
/module/FindSWIG
/module/FindTCL
/module/FindTclsh
/module/FindTclStub
/module/FindThreads
/module/FindTIFF
/module/FindUnixCommands
/module/FindVTK
Add FindVulkan.cmake. This adds FindVulkan with corresponding tests.
2016-06-04 21:48:23 +03:00
/module/FindVulkan
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/FindWget
/module/FindWish
/module/FindwxWidgets
/module/FindwxWindows
OS X: Add FindXCTest module Add a module to lookup XCTest Framework and xctest utility. It also provides APIs for creating 'xctest' targets. Signed-off-by: Gregor Jasny <gjasny@googlemail.com>
2015-02-26 23:55:45 +03:00
/module/FindXCTest
FindXalanC: New module to find the Apache Xalan-C++ library
2016-01-19 16:32:38 +03:00
/module/FindXalanC
Modules: Rename FindXerces to FindXercesC The FindXerces module was added in commit v3.1.0-rc1~155^2 (FindXerces: New module to find Apache Xerces-C++, 2014-08-17). However, there are two implementations of Xerces, one in C++: http://xerces.apache.org/xerces-c/ and one in Java: http://xerces.apache.org/xerces-j/ Rename FindXerces to FindXercesC to clarify that it is about the C++ implementation. While at it, add the missing CMake 3.1 release note about this module. Suggested-by: Erik Sjölund <erik.sjolund@gmail.com>
2014-12-04 18:36:21 +03:00
/module/FindXercesC
Convert builtin help to reStructuredText source files Run the convert-help.bash script to convert documentation: ./convert-help.bash "/path/to/CMake-build/bin" Then remove it.
2013-10-15 19:17:36 +04:00
/module/FindX11
/module/FindXMLRPC
/module/FindZLIB
/module/FortranCInterface
/module/GenerateExportHeader
/module/GetPrerequisites
/module/GNUInstallDirs
/module/InstallRequiredSystemLibraries
/module/MacroAddFileDependencies
/module/ProcessorCount
/module/SelectLibraryConfigurations
/module/SquishTestScript
/module/TestBigEndian
/module/TestCXXAcceptsFlag
/module/TestForANSIForScope
/module/TestForANSIStreamHeaders
/module/TestForSSTREAM
/module/TestForSTDNamespace
/module/UseEcos
/module/UseJavaClassFilelist
/module/UseJava
/module/UseJavaSymlinks
/module/UsePkgConfig
/module/UseSWIG
/module/UsewxWidgets
/module/Use_wxWindows
/module/WriteBasicConfigVersionFile
Add the WriteCompilerDetectionHeader module. Provide a function to write a portable header to detect compiler features. Generate a preprocessor #error for unknown compilers and compiler versions whose features are not yet recorded. This error condition might be relaxed in the future, but for now it is useful for verification of expectations.
2013-10-21 18:59:40 +04:00
/module/WriteCompilerDetectionHeader