summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-11-04 16:03:33 (GMT)
committerBrad King <brad.king@kitware.com>2013-11-04 16:06:14 (GMT)
commitd1e8a0240b6218628af0992c8cc3e89d7609a311 (patch)
tree5dfd3bce384be43b0b0fe2ed8a7c730e0baf20d5
parentf4253d7bf644ce93eb1fb909432317d47423a788 (diff)
downloadCMake-d1e8a0240b6218628af0992c8cc3e89d7609a311.zip
CMake-d1e8a0240b6218628af0992c8cc3e89d7609a311.tar.gz
CMake-d1e8a0240b6218628af0992c8cc3e89d7609a311.tar.bz2
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.
-rw-r--r--Help/manual/ccmake.1.rst8
-rw-r--r--Help/manual/cmake-gui.1.rst10
-rw-r--r--Help/manual/cmake.1.rst12
-rw-r--r--Help/manual/cpack.1.rst6
-rw-r--r--Help/manual/ctest.1.rst6
5 files changed, 28 insertions, 14 deletions
diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst
index 0c4f47e..a5fe191 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
diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst
index ff01332..032b51f 100644
--- a/Help/manual/cmake-gui.1.rst
+++ b/Help/manual/cmake-gui.1.rst
@@ -6,11 +6,10 @@ cmake-gui(1)
Synopsis
========
-::
+.. parsed-literal::
- cmake-gui [options]
- cmake-gui [options] <path-to-source>
- cmake-gui [options] <path-to-existing-build>
+ cmake-gui [<options>]
+ cmake-gui [<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_HELP.txt
See Also
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.
diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst
index 22e5d5a..5967d6f 100644
--- a/Help/manual/cpack.1.rst
+++ b/Help/manual/cpack.1.rst
@@ -6,9 +6,9 @@ cpack(1)
Synopsis
========
-::
+.. parsed-literal::
- cpack -G <generator> [options]
+ cpack -G <generator> [<options>]
Description
===========
@@ -24,6 +24,8 @@ 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
+=======
* ``-G <generator>``: Use the specified generator to generate package.
diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst
index 4a5f12e..ed9195e 100644
--- a/Help/manual/ctest.1.rst
+++ b/Help/manual/ctest.1.rst
@@ -6,9 +6,9 @@ ctest(1)
Synopsis
========
-::
+.. parsed-literal::
- ctest [options]
+ ctest [<options>]
Description
===========
@@ -18,6 +18,8 @@ CMake-generated build trees created for projects that use the
ENABLE_TESTING and ADD_TEST commands have testing support. This
program will run the tests and report results.
+Options
+=======
* ``-C <cfg>, --build-config <cfg>``: Choose configuration to test.