summaryrefslogtreecommitdiffstats
path: root/Help/command/option.rst
blob: 8956307c54ef08cf8e976059be78f29098e83917 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
option
------

Provide an option that the user can optionally select.

.. code-block:: cmake

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

Provides an option for the user to select as ``ON`` or ``OFF``.
If no initial ``<value>`` is provided, ``OFF`` is used.
If ``<variable>`` is already set as a normal variable
then the command does nothing (see policy :policy:`CMP0077`).

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