diff options
| author | Brad King <brad.king@kitware.com> | 2023-09-29 13:36:02 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2023-09-29 13:36:24 (GMT) |
| commit | b3205afcdedd645cd2d77eda82479008fe703f1c (patch) | |
| tree | a5eb5bef1ee7a9ebb559fcd3838ace701b44a028 /Help | |
| parent | 32902d816a8c002f3cbe919f96cc0e9781fa4a90 (diff) | |
| parent | 4e503209788159bba7eda427014e7dd58cf73b06 (diff) | |
| download | CMake-b3205afcdedd645cd2d77eda82479008fe703f1c.zip CMake-b3205afcdedd645cd2d77eda82479008fe703f1c.tar.gz CMake-b3205afcdedd645cd2d77eda82479008fe703f1c.tar.bz2 | |
Merge topic 'help-arbitrary'
4e50320978 Help: Allow help for arbitrary keywords
Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: buildbot <buildbot@kitware.com>
Merge-request: !8674
Diffstat (limited to 'Help')
| -rw-r--r-- | Help/manual/OPTIONS_HELP.txt | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/Help/manual/OPTIONS_HELP.txt b/Help/manual/OPTIONS_HELP.txt index 78ee245..f4f2dbe 100644 --- a/Help/manual/OPTIONS_HELP.txt +++ b/Help/manual/OPTIONS_HELP.txt @@ -11,6 +11,21 @@ Usage describes the basic command line interface and its options. +.. option:: --help <keyword> [<file>] + + Print help for one CMake keyword. + + ``<keyword>`` can be a property, variable, command, policy, generator + or module. + + The relevant manual entry for ``<keyword>`` is + printed in a human-readable text format. + |file| + + .. versionchanged:: 3.28 + + Prior to CMake 3.28, this option supported command names only. + .. option:: --help-full [<file>] Print all help manuals and exit. |