diff options
author | Brad King <brad.king@kitware.com> | 2013-11-05 13:17:01 (GMT) |
---|---|---|
committer | CMake Topic Stage <kwrobot@kitware.com> | 2013-11-05 13:17:01 (GMT) |
commit | 3e2eacb638b5e3b19c58b9c87c96517b33bcb3df (patch) | |
tree | 77714e0bf8b5c131d534fcce99e86acf05bc2478 /Help | |
parent | 46316a056971084c5d3534796b4c521bf1415f08 (diff) | |
parent | d1e8a0240b6218628af0992c8cc3e89d7609a311 (diff) | |
download | CMake-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')
-rw-r--r-- | Help/manual/ccmake.1.rst | 8 | ||||
-rw-r--r-- | Help/manual/cmake-gui.1.rst | 10 | ||||
-rw-r--r-- | Help/manual/cmake.1.rst | 12 | ||||
-rw-r--r-- | Help/manual/cpack.1.rst | 6 | ||||
-rw-r--r-- | Help/manual/ctest.1.rst | 6 |
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. |