summaryrefslogtreecommitdiffstats
path: root/Help/manual/ccmake.1.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-10-16 14:25:43 (GMT)
committerBrad King <brad.king@kitware.com>2013-10-16 20:23:32 (GMT)
commitae944d176ee77611bb492d5977b7c51c4ab9720f (patch)
treec927339e3b45b8668cb9a31a3d160d9d478d108c /Help/manual/ccmake.1.rst
parent4f7d708ac71239f18a42f1866e7f09ac64b64a92 (diff)
downloadCMake-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/ccmake.1.rst')
-rw-r--r--Help/manual/ccmake.1.rst31
1 files changed, 8 insertions, 23 deletions
diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst
index e340d2c..2b5f8ca 100644
--- a/Help/manual/ccmake.1.rst
+++ b/Help/manual/ccmake.1.rst
@@ -1,15 +1,17 @@
ccmake(1)
*********
-::
-
- ccmake - Curses Interface for CMake.
+Synopsis
+========
::
ccmake <path-to-source>
ccmake <path-to-existing-build>
+Description
+===========
+
The "ccmake" executable is the CMake curses interface. Project
configuration settings may be specified interactively through this
GUI. Brief instructions are provided at the bottom of the terminal
@@ -109,24 +111,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