diff options
| author | Brad King <brad.king@kitware.com> | 2013-10-16 14:25:43 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2013-10-16 20:23:32 (GMT) |
| commit | ae944d176ee77611bb492d5977b7c51c4ab9720f (patch) | |
| tree | c927339e3b45b8668cb9a31a3d160d9d478d108c /Help/manual/cmake.1.rst | |
| parent | 4f7d708ac71239f18a42f1866e7f09ac64b64a92 (diff) | |
| download | CMake-ae944d176ee77611bb492d5977b7c51c4ab9720f.zip CMake-ae944d176ee77611bb492d5977b7c51c4ab9720f.tar.gz CMake-ae944d176ee77611bb492d5977b7c51c4ab9720f.tar.bz2 | |
Help: Organize manual/*.1.rst sections
Add "Synopsis", "Description", and "See Also" manual page section
headers. These are typical of .1 man section pages. Also de-duplicate
the See Also section links using a separate LINKS.txt file included from
each manual.
Diffstat (limited to 'Help/manual/cmake.1.rst')
| -rw-r--r-- | Help/manual/cmake.1.rst | 32 |
1 files changed, 8 insertions, 24 deletions
diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 9dbd922..5b67174 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -1,15 +1,17 @@ cmake(1) ******** -:: - - cmake - Cross-Platform Makefile Generator. +Synopsis +======== :: cmake [options] <path-to-source> cmake [options] <path-to-existing-build> +Description +=========== + The "cmake" executable is the CMake command-line interface. It may be used to configure projects in scripts. Project configuration settings may be specified on the command line with the -D option. The -i @@ -21,7 +23,6 @@ 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. - * ``-C <initial-cache>``: Pre-load a script to populate the cache. When cmake is first run in an empty build tree, it creates a @@ -351,24 +352,7 @@ native tool on their platform. If a file is specified, the version is written into it. -The following resources are available to get help using CMake: - -* ``Home Page``: http://www.cmake.org - - The primary starting point for learning about CMake. - -* ``Frequently Asked Questions``: http://www.cmake.org/Wiki/CMake_FAQ - - A Wiki is provided containing answers to frequently asked questions. - -* ``Online Documentation``: http://www.cmake.org/HTML/Documentation.html - - Links to available documentation may be found on this web page. - -* ``Mailing List``: http://www.cmake.org/HTML/MailingLists.html +See Also +======== - For help and discussion about using cmake, a mailing list is - provided at cmake@cmake.org. The list is member-post-only but one - may sign up on the CMake web page. Please first read the full - documentation at http://www.cmake.org before posting questions to - the list. +.. include:: LINKS.txt |