diff options
author | Alex Turbov <i.zaufi@gmail.com> | 2022-08-04 06:04:36 (GMT) |
---|---|---|
committer | Alex Turbov <i.zaufi@gmail.com> | 2022-08-04 15:15:06 (GMT) |
commit | 8ffc5e1bbbcf0307562e0045f7c5ada64415c15b (patch) | |
tree | 98db47f965bdbf786b2e8b4ec1203379af54a916 /Help/manual/cmake-gui.1.rst | |
parent | 57fb264085f7ed9349350cafb45b91bc924a7022 (diff) | |
download | CMake-8ffc5e1bbbcf0307562e0045f7c5ada64415c15b.zip CMake-8ffc5e1bbbcf0307562e0045f7c5ada64415c15b.tar.gz CMake-8ffc5e1bbbcf0307562e0045f7c5ada64415c15b.tar.bz2 |
Help: Use `option` directive for the executables manual pages
It'll allow to refer to a particular option of any executable.
There are two "fake" programs added for the CMake script mode (`cmake_P`)
and CMake CLI Tool mode (`cmake_E`).
Diffstat (limited to 'Help/manual/cmake-gui.1.rst')
-rw-r--r-- | Help/manual/cmake-gui.1.rst | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst index 281986f..493b625 100644 --- a/Help/manual/cmake-gui.1.rst +++ b/Help/manual/cmake-gui.1.rst @@ -29,19 +29,25 @@ native tool on their platform. Options ======= -``-S <path-to-source>`` +.. program:: cmake-gui + +.. option:: -S <path-to-source> + Path to root directory of the CMake project to build. -``-B <path-to-build>`` +.. option:: -B <path-to-build> + Path to directory which CMake will use as the root of build directory. If the directory doesn't already exist CMake will make it. -``--preset=<preset-name>`` +.. option:: --preset=<preset-name> + Name of the preset to use from the project's :manual:`presets <cmake-presets(7)>` files, if it has them. -``--browse-manual`` +.. option:: --browse-manual + Open the CMake reference manual in a browser and immediately exit. .. include:: OPTIONS_HELP.txt |