summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake.1.rst
diff options
context:
space:
mode:
authorAlex Turbov <i.zaufi@gmail.com>2022-08-04 09:45:23 (GMT)
committerAlex Turbov <i.zaufi@gmail.com>2022-08-04 15:34:45 (GMT)
commit04843d743e08beeb257f6ce781633b2a9647ab07 (patch)
tree46607d1f086a823e01f540d40ed27f2ee8891b87 /Help/manual/cmake.1.rst
parent09446266ee701513315b483d8a0169a51b69e783 (diff)
downloadCMake-04843d743e08beeb257f6ce781633b2a9647ab07.zip
CMake-04843d743e08beeb257f6ce781633b2a9647ab07.tar.gz
CMake-04843d743e08beeb257f6ce781633b2a9647ab07.tar.bz2
Help: Replace a bunch of more ``--option`` to `:option:` role
Diffstat (limited to 'Help/manual/cmake.1.rst')
-rw-r--r--Help/manual/cmake.1.rst13
1 files changed, 8 insertions, 5 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index 2c2ff5f..13ae21c 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -96,7 +96,7 @@ Build Tree
Generator
This chooses the kind of buildsystem to generate. See the
:manual:`cmake-generators(7)` manual for documentation of all generators.
- Run ``cmake --help`` to see a list of generators available locally.
+ Run :option:`cmake --help` to see a list of generators available locally.
Optionally use the :option:`-G <cmake -G>` option below to specify a
generator, or simply accept the default CMake chooses for the current
platform.
@@ -558,7 +558,7 @@ following options:
.. option:: --clean-first
Build target ``clean`` first, then build.
- (To clean only, use ``--target clean``.)
+ (To clean only, use :option:`--target clean <cmake --target>`.)
.. option:: --resolve-package-references=<on|off|only>
@@ -601,7 +601,7 @@ following options:
Pass remaining options to the native tool.
-Run ``cmake --build`` with no options for quick help.
+Run :option:`cmake --build` with no options for quick help.
Install a Project
=================
@@ -647,7 +647,7 @@ The options are:
This option can be omitted if :envvar:`VERBOSE` environment variable is set.
-Run ``cmake --install`` with no options for quick help.
+Run :option:`cmake --install` with no options for quick help.
Open a Project
==============
@@ -700,7 +700,10 @@ CMake provides builtin command-line tools through the signature
cmake -E <command> [<options>]
-Run ``cmake -E`` or ``cmake -E help`` for a summary of commands.
+.. option:: -E [help]
+
+ Run ``cmake -E`` or ``cmake -E help`` for a summary of commands.
+
Available commands are:
.. option:: capabilities