diff options
Diffstat (limited to 'Help/manual/cmake.1.rst')
| -rw-r--r-- | Help/manual/cmake.1.rst | 42 |
1 files changed, 37 insertions, 5 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 868dac4..d22317e 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -516,6 +516,8 @@ Options Build a Project =============== +.. program:: cmake + CMake provides a command-line signature to build an already-generated project binary tree: @@ -532,6 +534,8 @@ following options: Project binary directory to be built. This is required (unless a preset is specified) and must be first. +.. program:: cmake--build + .. option:: --preset <preset>, --preset=<preset> Use a build preset to specify build options. The project binary directory @@ -567,7 +571,7 @@ following options: .. option:: --clean-first Build target ``clean`` first, then build. - (To clean only, use :option:`--target clean <cmake --target>`.) + (To clean only, use :option:`--target clean <cmake--build --target>`.) .. option:: --resolve-package-references=<value> @@ -616,6 +620,8 @@ Run :option:`cmake --build` with no options for quick help. Install a Project ================= +.. program:: cmake + CMake provides a command-line signature to install an already-generated project binary tree: @@ -631,6 +637,8 @@ The options are: Project binary directory to install. This is required and must be first. +.. program:: cmake--install + .. option:: --config <cfg> For multi-configuration generators, choose configuration ``<cfg>``. @@ -662,6 +670,8 @@ Run :option:`cmake --install` with no options for quick help. Open a Project ============== +.. program:: cmake + .. code-block:: shell cmake --open <dir> @@ -675,16 +685,20 @@ supported by some generators. Run a Script ============ -.. program:: cmake_P +.. program:: cmake .. code-block:: shell cmake [-D <var>=<value>]... -P <cmake-script-file> [-- <unparsed-options>...] +.. program:: cmake-P + .. option:: -D <var>=<value> Define a variable for script mode. +.. program:: cmake + .. option:: -P <cmake-script-file> Process the given cmake file as a script written in the CMake @@ -702,7 +716,7 @@ script (including the ``--`` itself). Run a Command-Line Tool ======================= -.. program:: cmake_E +.. program:: cmake CMake provides builtin command-line tools through the signature @@ -714,6 +728,8 @@ CMake provides builtin command-line tools through the signature Run ``cmake -E`` or ``cmake -E help`` for a summary of commands. +.. program:: cmake-E + Available commands are: .. option:: capabilities @@ -1169,6 +1185,8 @@ The following ``cmake -E`` commands are available only on Windows: Run the Find-Package Tool ========================= +.. program:: cmake--find-package + CMake provides a pkg-config like helper for Makefile-based projects: .. code-block:: shell @@ -1189,9 +1207,23 @@ autoconf-based projects (via ``share/aclocal/cmake.m4``). Run a Workflow Preset ===================== +.. program:: cmake + :manual:`CMake Presets <cmake-presets(7)>` provides a way to execute multiple build steps in order: +.. code-block:: shell + + cmake --workflow [<options>] + +The options are: + +.. option:: --workflow + + Select a :ref:`Workflow Preset` using one of the following options. + +.. program:: cmake--workflow + .. option:: --preset <preset>, --preset=<preset> Use a workflow preset to specify a workflow. The project binary directory @@ -1207,6 +1239,8 @@ build steps in order: View Help ========= +.. program:: cmake + To print selected pages from the CMake documentation, use .. code-block:: shell @@ -1215,8 +1249,6 @@ To print selected pages from the CMake documentation, use with one of the following options: -.. program:: cmake - .. include:: OPTIONS_HELP.txt To view the presets available for a project, use |