summaryrefslogtreecommitdiffstats
path: root/Help/manual
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2023-02-10 15:03:06 (GMT)
committerKitware Robot <kwrobot@kitware.com>2023-02-10 15:03:30 (GMT)
commit78299083d24fc09c777292effb4fdb9d9ed1d7d3 (patch)
tree6a9d7ae4618bd2f1124d51760160bcd56d9d1caa /Help/manual
parentf888d03c700524802327e5c5e81464e937c81b23 (diff)
parentb5383bc76798284dc928dd1d63b5f95d1a00f6b6 (diff)
downloadCMake-78299083d24fc09c777292effb4fdb9d9ed1d7d3.zip
CMake-78299083d24fc09c777292effb4fdb9d9ed1d7d3.tar.gz
CMake-78299083d24fc09c777292effb4fdb9d9ed1d7d3.tar.bz2
Merge topic 'cmake-gui-browse-manual-page'
b5383bc767 cmake-gui: Add optional filename argument to --browse-manual Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: buildbot <buildbot@kitware.com> Merge-request: !8190
Diffstat (limited to 'Help/manual')
-rw-r--r--Help/manual/cmake-gui.1.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst
index cdb860f..367b0a7 100644
--- a/Help/manual/cmake-gui.1.rst
+++ b/Help/manual/cmake-gui.1.rst
@@ -11,7 +11,7 @@ Synopsis
cmake-gui [<options>]
cmake-gui [<options>] <path-to-source | path-to-existing-build>
cmake-gui [<options>] -S <path-to-source> -B <path-to-build>
- cmake-gui [<options>] --browse-manual
+ cmake-gui [<options>] --browse-manual [<filename>]
Description
===========
@@ -46,9 +46,11 @@ Options
Name of the preset to use from the project's
:manual:`presets <cmake-presets(7)>` files, if it has them.
-.. option:: --browse-manual
+.. option:: --browse-manual [<filename>]
- Open the CMake reference manual in a browser and immediately exit.
+ Open the CMake reference manual in a browser and immediately exit. If
+ ``<filename>`` is specified, open that file within the reference manual
+ instead of ``index.html``.
.. include:: OPTIONS_HELP.txt