diff options
| author | Martin Duffy <martin.duffy@kitware.com> | 2023-08-31 17:08:06 (GMT) |
|---|---|---|
| committer | Martin Duffy <martin.duffy@kitware.com> | 2023-09-27 22:01:12 (GMT) |
| commit | 4e503209788159bba7eda427014e7dd58cf73b06 (patch) | |
| tree | 2ed8be3f5a88f87f3659ea82fd108f08bd510eba /Help | |
| parent | 72beefa91b7d6ea6eeffaf0977219e9e3fc4943d (diff) | |
| download | CMake-4e503209788159bba7eda427014e7dd58cf73b06.zip CMake-4e503209788159bba7eda427014e7dd58cf73b06.tar.gz CMake-4e503209788159bba7eda427014e7dd58cf73b06.tar.bz2 | |
Help: Allow help for arbitrary keywords
Changes `cmake --help [arg]` to search `Help/*/` instead of `Help/command/`
Allows editors to easily display manual for `<cword>`
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. |