Revision 3278d7b4499e6d653739c9e2ded6616ad50690d6 authored by Brad King on 02 October 2023, 12:59:53 UTC, committed by Kitware Robot on 02 October 2023, 13:00:02 UTC
2 parent s ad4bed1 + 1969600
Raw File
option.rst
option
------

Provide a boolean option that the user can optionally select.

.. code-block:: cmake

  option(<variable> "<help_text>" [value])

If no initial ``<value>`` is provided, boolean ``OFF`` is the default value.
If ``<variable>`` is already set as a normal or cache variable,
then the command does nothing (see policy :policy:`CMP0077`).

For options that depend on the values of other options, see
the module help for :module:`CMakeDependentOption`.

In CMake project mode, a boolean cache variable is created with the option
value. In CMake script mode, a boolean variable is set with the option value.
back to top