summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2018-04-30 13:02:43 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2018-04-30 13:14:35 (GMT)
commitb81280ba1f5ce36f4cc38fc92409a9696efe7966 (patch)
tree336c08a5ba3661b2e6d6d9603ba698e32ccb2829 /Help
parent81aeb065e9e76cef22f39002bfff31ed4d826e74 (diff)
downloadCMake-b81280ba1f5ce36f4cc38fc92409a9696efe7966.zip
CMake-b81280ba1f5ce36f4cc38fc92409a9696efe7966.tar.gz
CMake-b81280ba1f5ce36f4cc38fc92409a9696efe7966.tar.bz2
Help: add list of command signatures to top of INSTALL page
Diffstat (limited to 'Help')
-rw-r--r--Help/command/install.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/Help/command/install.rst b/Help/command/install.rst
index d3818d6..b11b35a 100644
--- a/Help/command/install.rst
+++ b/Help/command/install.rst
@@ -7,6 +7,14 @@ install
Specify rules to run at install time.
+This command accepts several signatures:
+
+* :ref:`install(TARGETS) <install-targets>`
+* :ref:`install(FILES|PROGRAMS) <install-files>`
+* :ref:`install(DIRECTORY) <install-directory>`
+* :ref:`install(SCRIPT|CODE) <install-script>`
+* :ref:`install(EXPORT|EXPORT_ANDROID_MK) <install-export>`
+
Introduction
^^^^^^^^^^^^
@@ -81,6 +89,8 @@ Command signatures that install files may print messages during
installation. Use the :variable:`CMAKE_INSTALL_MESSAGE` variable
to control which messages are printed.
+.. _install-targets:
+
Installing Targets
^^^^^^^^^^^^^^^^^^
@@ -197,6 +207,8 @@ The install destination given to the target install ``DESTINATION`` may
use "generator expressions" with the syntax ``$<...>``. See the
:manual:`cmake-generator-expressions(7)` manual for available expressions.
+.. _install-files:
+
Installing Files
^^^^^^^^^^^^^^^^
@@ -230,6 +242,8 @@ The install destination given to the files install ``DESTINATION`` may
use "generator expressions" with the syntax ``$<...>``. See the
:manual:`cmake-generator-expressions(7)` manual for available expressions.
+.. _install-directory:
+
Installing Directories
^^^^^^^^^^^^^^^^^^^^^^
@@ -311,6 +325,8 @@ given to the directory install ``DESTINATION`` may use "generator expressions"
with the syntax ``$<...>``. See the :manual:`cmake-generator-expressions(7)`
manual for available expressions.
+.. _install-script:
+
Custom Installation Logic
^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -332,6 +348,8 @@ example, the code
will print a message during installation.
+.. _install-export:
+
Installing Exports
^^^^^^^^^^^^^^^^^^