diff options
Diffstat (limited to 'Help/command/option.rst')
| -rw-r--r-- | Help/command/option.rst | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/Help/command/option.rst b/Help/command/option.rst new file mode 100644 index 000000000..91cd0a778 --- /dev/null +++ b/Help/command/option.rst @@ -0,0 +1,15 @@ +option +------ + +Provides an option that the user can optionally select. + +:: + + option(<option_variable> "help string describing option" + [initial value]) + +Provide an option for the user to select as ``ON`` or ``OFF``. If no +initial value is provided, ``OFF`` is used. + +If you have options that depend on the values of other options, see +the module help for :module:`CMakeDependentOption`. |