CMake (Fake)

6.0.0

Lookig for older versions of the documentation, pre FAKE v6? See

CMake Module

Namespace: Fake.Build
Assembly: Fake.Build.CMake.dll

Contains tasks which allow to use CMake to build CMakeLists files.

Types

Type	Description
CMakeBuildParams	The CMakeBuild parameter type.
CMakeGenerateParams	The CMakeGenerate parameter type.
CMakeValue	The possible variable value types for CMake variables.
CMakeVariable	A CMake variable.

Functions and values

Function or value	Description
`CMake.Build setParams` Full Usage: `CMake.Build setParams` Parameters: setParams : `CMakeBuildParams -> CMakeBuildParams` - Function used to manipulate the default CMake parameters. See `CMakeBuildParams`.	Calls `cmake --build` to build a project. setParams : `CMakeBuildParams -> CMakeBuildParams` Function used to manipulate the default CMake parameters. See `CMakeBuildParams`.
`CMake.CMakeBuildDefaults` Full Usage: `CMake.CMakeBuildDefaults` Returns: `CMakeBuildParams`	The default option set given to CMakeBuild. Returns: `CMakeBuildParams`
`CMake.CMakeGenerateDefaults` Full Usage: `CMake.CMakeGenerateDefaults` Returns: `CMakeGenerateParams`	The default option set given to CMakeGenerate. Returns: `CMakeGenerateParams`
`CMake.FindExe exeName` Full Usage: `CMake.FindExe exeName` Parameters: exeName : `string` - The name of the CMake executable (e.g. `cmake`, `ctest`, etc.) to find. The `.exe` suffix will be automatically appended on Windows. Returns: `string option`	Tries to find the specified CMake executable: Locally in `./<tools\|packages<cmake.portable>\|<cmake>/bin` In the `PATH` environment variable. In the `<ProgramFilesx86>\CMake\bin` directory. exeName : `string` The name of the CMake executable (e.g. `cmake`, `ctest`, etc.) to find. The `.exe` suffix will be automatically appended on Windows. Returns: `string option`
`CMake.Generate setParams` Full Usage: `CMake.Generate setParams` Parameters: setParams : `CMakeGenerateParams -> CMakeGenerateParams` - Function used to manipulate the default CMake parameters. See `CMakeGenerateParams`.	Calls `cmake` to generate a project. setParams : `CMakeGenerateParams -> CMakeGenerateParams` Function used to manipulate the default CMake parameters. See `CMakeGenerateParams`.