diff options
author | Jiang Yi <jiangyilism@gmail.com> | 2019-03-06 12:49:51 (GMT) |
---|---|---|
committer | Jiang Yi <jiangyilism@gmail.com> | 2019-03-16 17:31:25 (GMT) |
commit | 73f23d1e0087a3b025ab7ba6b3e6195f19b40e1b (patch) | |
tree | 2b2d3e527cd174812505c6a0b3a3f339bc532c7e /Help | |
parent | 7358f317e356dff8ef2c1cdd216b9e6063cd4d9a (diff) | |
download | CMake-73f23d1e0087a3b025ab7ba6b3e6195f19b40e1b.zip CMake-73f23d1e0087a3b025ab7ba6b3e6195f19b40e1b.tar.gz CMake-73f23d1e0087a3b025ab7ba6b3e6195f19b40e1b.tar.bz2 |
cmake: add '--install <dir>' option
Fixes: #19023
Diffstat (limited to 'Help')
-rw-r--r-- | Help/manual/cmake.1.rst | 42 | ||||
-rw-r--r-- | Help/release/dev/cmake--install_option.rst | 6 |
2 files changed, 46 insertions, 2 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index e9a08b5..3ea6bc4 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -16,6 +16,9 @@ Synopsis `Build a Project`_ cmake --build <dir> [<options>] [-- <build-tool-options>] + `Install a Project`_ + cmake --install <dir> [<options>] + `Open a Project`_ cmake --open <dir> @@ -39,8 +42,8 @@ buildsystem generator CMake. The above `Synopsis`_ lists various actions the tool can perform as described in sections below. To build a software project with CMake, `Generate a Project Buildsystem`_. -Optionally use **cmake** to `Build a Project`_ or just run the -corresponding build tool (e.g. ``make``) directly. **cmake** can also +Optionally use **cmake** to `Build a Project`_, `Install a Project`_ or just +run the corresponding build tool (e.g. ``make``) directly. **cmake** can also be used to `View Help`_. The other actions are meant for use by software developers writing @@ -302,6 +305,41 @@ following options: Run ``cmake --build`` with no options for quick help. +Install a Project +================= + +CMake provides a command-line signature to install an already-generated +project binary tree: + +.. code-block:: shell + + cmake --install <dir> [<options>] + +This may be used after building a project to run installation without +using the generated build system or the native build tool. +The options are: + +``--install <dir>`` + Project binary directory to install. This is required and must be first. + +``--config <cfg>`` + For multi-configuration tools, choose configuration ``<cfg>``. + +``--component <comp>`` + Component-based install. Only install component ``<comp>``. + +``--prefix <prefix>`` + The installation prefix CMAKE_INSTALL_PREFIX. + +``--strip`` + Strip before installing by setting CMAKE_INSTALL_DO_STRIP. + +``-v, --verbose`` + Enable verbose output. + + This option can be omitted if :envvar:`VERBOSE` environment variable is set. + +Run ``cmake --install`` with no options for quick help. Open a Project ============== diff --git a/Help/release/dev/cmake--install_option.rst b/Help/release/dev/cmake--install_option.rst new file mode 100644 index 0000000..8e526a0 --- /dev/null +++ b/Help/release/dev/cmake--install_option.rst @@ -0,0 +1,6 @@ +cmake--install-option +--------------------- + +* A new ``--install`` option was added to :manual:`cmake(1)`. + This may be used after building a project to run installation without + using the generated build system or the native build tool. |