Forrest logo
back to the cmake tool

cmake:help

cmake: Display help, obtain a list of generators.
$ cmake --help
try on your machine

The command cmake --help is used to display help and usage information for the CMake build system.

CMake is an open-source, cross-platform build system that enables developers to build, test, and package software across different environments and platforms. It uses CMakeLists.txt files to specify the build process.

When you run cmake --help, it displays a list of available command-line options and their descriptions. This includes information about commonly used command-line arguments, variables, and generator-specific options.

The help information typically includes detailed descriptions of how to use CMake commands, set project properties, configure build targets, enable features, specify build types, define target-specific options, and more.

By referring to the output of cmake --help, developers can better understand how to use and configure CMake to suit their specific build requirements and project needs.

This explanation was created by an AI. In most cases those are correct. But please always be careful and never run a command you are not sure if it is safe.
back to the cmake tool