File: option.rst

package info (click to toggle)
cmake 3.18.4-2%2Bdeb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 95,096 kB
  • sloc: ansic: 326,336; cpp: 218,301; yacc: 3,207; sh: 3,067; python: 2,637; lex: 1,324; asm: 371; lisp: 273; f90: 240; objc: 205; perl: 198; java: 197; xml: 178; cs: 140; fortran: 126; makefile: 84; javascript: 83; pascal: 63; tcl: 55; php: 25; ruby: 22
file content (16 lines) | stat: -rw-r--r-- 505 bytes parent folder | download 
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 or cache 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`.