summaryrefslogtreecommitdiffstats
path: root/Help/command/option.rst
blob: b939a2d0c6e3974bf8559969449981f322aae7b0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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`).

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.

See Also
^^^^^^^^

* The :module:`CMakeDependentOption` module to specify boolean options that
  depend on the values of other options or a set of conditions.