summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentation.cxx
diff options
context:
space:
mode:
authorAndy Cedilnik <andy.cedilnik@kitware.com>2003-02-17 14:56:41 (GMT)
committerAndy Cedilnik <andy.cedilnik@kitware.com>2003-02-17 14:56:41 (GMT)
commitd54e7a68885e43c53a8929a57b50b34b2be03d2d (patch)
tree65010eb957f7e826229bb3782ef45121c1ab120b /Source/cmDocumentation.cxx
parent70dc3c4cb1cb84b2629fcf234497655b1c07bca8 (diff)
downloadCMake-d54e7a68885e43c53a8929a57b50b34b2be03d2d.zip
CMake-d54e7a68885e43c53a8929a57b50b34b2be03d2d.tar.gz
CMake-d54e7a68885e43c53a8929a57b50b34b2be03d2d.tar.bz2
Minor documentation fixes
Diffstat (limited to 'Source/cmDocumentation.cxx')
-rw-r--r--Source/cmDocumentation.cxx27
1 files changed, 22 insertions, 5 deletions
diff --git a/Source/cmDocumentation.cxx b/Source/cmDocumentation.cxx
index 299374d..8ea414e 100644
--- a/Source/cmDocumentation.cxx
+++ b/Source/cmDocumentation.cxx
@@ -30,7 +30,7 @@ static const cmDocumentationEntry cmDocumentationStandardOptions[] =
"also convenient if the man page is not installed."},
{"--help-html", "Print full help in HTML format.",
"This option is used by CMake authors to help produce web pages."},
- {"--man", "Print a UNIX man page and exit.",
+ {"--help-man", "Print a UNIX man page and exit.",
"This option is used by CMake authors to generate the UNIX man page."},
{"--version", "Show program name/version banner and exit.", 0},
{0,0,0}
@@ -45,6 +45,16 @@ static const cmDocumentationEntry cmDocumentationCommandsHeader[] =
};
//----------------------------------------------------------------------------
+const cmDocumentationEntry cmDocumentationMailingList[] =
+{
+ {0,
+ "For help and discussion about using cmake, a mailing list is provided "
+ "at cmake@www.cmake.org. Please first read the full documentation at "
+ "http://www.cmake.org before posting questions to the list.", 0},
+ {0,0,0}
+};
+
+//----------------------------------------------------------------------------
const cmDocumentationEntry cmDocumentationCopyright[] =
{
{0,
@@ -293,6 +303,8 @@ void cmDocumentation::PrintHelpHTML(std::ostream& os)
this->PrintHelpHTMLSection(os, this->Description, 0);
this->PrintHelpHTMLSection(os, &this->Options[0], "Command-line Options");
this->PrintHelpHTMLSection(os, &this->Commands[0], "Listfile Commands");
+ //this->PrintHelpHTMLSection(os, cmDocumentationCopyright, "Copyright");
+ //this->PrintHelpHTMLSection(os, cmDocumentationMailingList, "Mailing List");
os << "</body>\n"
<< "</html>\n";
}
@@ -317,7 +329,7 @@ void cmDocumentation::PrintManPage(std::ostream& os)
<< ".B http://www.cmake.org\n"
<< "before posting questions to the list.\n";
os << ".SH AUTHOR\n"
- << "This manual page was generated by \"cmake --man\".\n";
+ << "This manual page was generated by \"cmake --help-man\".\n";
}
//----------------------------------------------------------------------------
@@ -550,7 +562,9 @@ cmDocumentation::Type cmDocumentation::CheckOptions(int argc, char** argv)
if((strcmp(argv[i], "-help") == 0) ||
(strcmp(argv[i], "--help") == 0) ||
(strcmp(argv[i], "/?") == 0) ||
- (strcmp(argv[i], "-usage") == 0))
+ (strcmp(argv[i], "-usage") == 0) ||
+ (strcmp(argv[i], "-h") == 0) ||
+ (strcmp(argv[i], "-H") == 0))
{
return cmDocumentation::Usage;
}
@@ -562,7 +576,7 @@ cmDocumentation::Type cmDocumentation::CheckOptions(int argc, char** argv)
{
return cmDocumentation::HelpHTML;
}
- if(strcmp(argv[i], "--man") == 0)
+ if(strcmp(argv[i], "--help-man") == 0)
{
return cmDocumentation::Man;
}
@@ -570,7 +584,10 @@ cmDocumentation::Type cmDocumentation::CheckOptions(int argc, char** argv)
{
return cmDocumentation::Copyright;
}
- if(strcmp(argv[i], "--version") == 0)
+ if((strcmp(argv[i], "--version") == 0) ||
+ (strcmp(argv[i], "-version") == 0) ||
+ (strcmp(argv[i], "-V") == 0) ||
+ (strcmp(argv[i], "/V") == 0))
{
return cmDocumentation::Version;
}