summaryrefslogtreecommitdiff
path: root/Help/manual/ccmake.1.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-11-04 11:03:33 -0500
committerBrad King <brad.king@kitware.com>2013-11-04 11:06:14 -0500
commitd1e8a0240b6218628af0992c8cc3e89d7609a311 (patch)
tree5dfd3bce384be43b0b0fe2ed8a7c730e0baf20d5 /Help/manual/ccmake.1.rst
parentf4253d7bf644ce93eb1fb909432317d47423a788 (diff)
downloadcmake-d1e8a0240b6218628af0992c8cc3e89d7609a311.tar.gz
Help: Refine manual/*.1.rst usage summaries
Use a parsed-literal block to list possible command-line signatures. Add an "Options" section header before the list of options.
Diffstat (limited to 'Help/manual/ccmake.1.rst')
-rw-r--r--Help/manual/ccmake.1.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst
index 0c4f47e564..a5fe191683 100644
--- a/Help/manual/ccmake.1.rst
+++ b/Help/manual/ccmake.1.rst
@@ -6,10 +6,9 @@ ccmake(1)
Synopsis
========
-::
+.. parsed-literal::
- ccmake <path-to-source>
- ccmake <path-to-existing-build>
+ ccmake [<options>] (<path-to-source> | <path-to-existing-build>)
Description
===========
@@ -25,6 +24,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
.. include:: OPTIONS_HELP.txt