summaryrefslogtreecommitdiffstats
path: root/Help/manual/cmake.1.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-11-05 13:17:01 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2013-11-05 13:17:01 (GMT)
commit3e2eacb638b5e3b19c58b9c87c96517b33bcb3df (patch)
tree77714e0bf8b5c131d534fcce99e86acf05bc2478 /Help/manual/cmake.1.rst
parent46316a056971084c5d3534796b4c521bf1415f08 (diff)
parentd1e8a0240b6218628af0992c8cc3e89d7609a311 (diff)
downloadCMake-3e2eacb638b5e3b19c58b9c87c96517b33bcb3df.zip
CMake-3e2eacb638b5e3b19c58b9c87c96517b33bcb3df.tar.gz
CMake-3e2eacb638b5e3b19c58b9c87c96517b33bcb3df.tar.bz2
Merge topic 'doc-tool-usage'
d1e8a02 Help: Refine manual/*.1.rst usage summaries
Diffstat (limited to 'Help/manual/cmake.1.rst')
-rw-r--r--Help/manual/cmake.1.rst12
1 files changed, 9 insertions, 3 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst
index f74402e..b1f1dc0 100644
--- a/Help/manual/cmake.1.rst
+++ b/Help/manual/cmake.1.rst
@@ -6,10 +6,13 @@ cmake(1)
Synopsis
========
-::
+.. parsed-literal::
- cmake [options] <path-to-source>
- cmake [options] <path-to-existing-build>
+ cmake [<options>] (<path-to-source> | <path-to-existing-build>)
+ cmake [(-D<var>=<value>)...] -P <cmake-script-file>
+ cmake --build <dir> [<options>] [-- <build-tool-options>...]
+ cmake -E <command> [<options>]
+ cmake --find-package <options>...
Description
===========
@@ -25,6 +28,9 @@ in each directory of a source tree with the name CMakeLists.txt.
Users build a project by using CMake to generate a build system for a
native tool on their platform.
+Options
+=======
+
.. include:: OPTIONS_BUILD.txt
* ``-E``: CMake command mode.