diff options
| author | Brad King <brad.king@kitware.com> | 2013-11-04 16:03:33 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-11-04 16:06:14 (GMT) |
| commit | d1e8a0240b6218628af0992c8cc3e89d7609a311 (patch) | |
| tree | 5dfd3bce384be43b0b0fe2ed8a7c730e0baf20d5 /Help/manual/cmake.1.rst | |
| parent | f4253d7bf644ce93eb1fb909432317d47423a788 (diff) | |
| download | CMake-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.
Diffstat (limited to 'Help/manual/cmake.1.rst')
| -rw-r--r-- | Help/manual/cmake.1.rst | 12 |
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. |