summaryrefslogtreecommitdiffstats
path: root/Source/cmakemain.cxx
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2003-07-11 03:15:45 (GMT)
committerBrad King <brad.king@kitware.com>2003-07-11 03:15:45 (GMT)
commit7c2b4e3a029ffe1205553fb80883434677167b2c (patch)
tree662fdbc709b4c19f872567e6c8e1a97c744a3e72 /Source/cmakemain.cxx
parentc08062795747714b6db50a4261543ff4035dc843 (diff)
downloadCMake-7c2b4e3a029ffe1205553fb80883434677167b2c.zip
CMake-7c2b4e3a029ffe1205553fb80883434677167b2c.tar.gz
CMake-7c2b4e3a029ffe1205553fb80883434677167b2c.tar.bz2
ENH: Added SEE ALSO section to generated man page. Minor formatting improvements for generated text-only documentation.
Diffstat (limited to 'Source/cmakemain.cxx')
-rw-r--r--Source/cmakemain.cxx15
1 files changed, 14 insertions, 1 deletions
diff --git a/Source/cmakemain.cxx b/Source/cmakemain.cxx
index 784502a..5b142c3 100644
--- a/Source/cmakemain.cxx
+++ b/Source/cmakemain.cxx
@@ -41,7 +41,11 @@ static const cmDocumentationEntry cmDocumentationUsage[] =
static const cmDocumentationEntry cmDocumentationDescription[] =
{
{0,
- "CMake reads ... ", 0},
+ "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 option "
+ "will cause cmake to interactively prompt for such settings.", 0},
+ CMAKE_STANDARD_INTRODUCTION,
{0,0,0}
};
@@ -67,6 +71,14 @@ static const cmDocumentationEntry cmDocumentationOptions[] =
};
//----------------------------------------------------------------------------
+static const cmDocumentationEntry cmDocumentationSeeAlso[] =
+{
+ {0, "ccmake", 0},
+ {0, "ctest", 0},
+ {0, 0, 0}
+};
+
+//----------------------------------------------------------------------------
static const cmDocumentationEntry cmDocumentationNOTE[] =
{
{0,
@@ -107,6 +119,7 @@ int do_cmake(int ac, char** av)
doc.SetGeneratorsSection(&generators[0]);
doc.SetOptionsSection(cmDocumentationOptions);
doc.SetCommandsSection(&commands[0]);
+ doc.SetSeeAlsoList(cmDocumentationSeeAlso);
int result = doc.PrintRequestedDocumentation(std::cout)? 0:1;
// If we were run with no arguments, but a CMakeLists.txt file