kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Minor documentation fixes

This commit is contained in:
Andy Cedilnik 2003-02-17 09:56:41 -05:00
parent 70dc3c4cb1
commit d54e7a6888
1 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Source/cmDocumentation.cxx
View File

@ -30,7 +30,7 @@ static const cmDocumentationEntry cmDocumentationStandardOptions[] =
"also convenient if the man page is not installed."}, "also convenient if the man page is not installed."},
{"--help-html", "Print full help in HTML format.", {"--help-html", "Print full help in HTML format.",
"This option is used by CMake authors to help produce web pages."}, "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."}, "This option is used by CMake authors to generate the UNIX man page."},
{"--version", "Show program name/version banner and exit.", 0}, {"--version", "Show program name/version banner and exit.", 0},
{0,0,0} {0,0,0}
@ -44,6 +44,16 @@ static const cmDocumentationEntry cmDocumentationCommandsHeader[] =
{0,0,0} {0,0,0}
}; };
//----------------------------------------------------------------------------
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[] = const cmDocumentationEntry cmDocumentationCopyright[] =
{ {
@ -293,6 +303,8 @@ void cmDocumentation::PrintHelpHTML(std::ostream& os)
this->PrintHelpHTMLSection(os, this->Description, 0); this->PrintHelpHTMLSection(os, this->Description, 0);
this->PrintHelpHTMLSection(os, &this->Options[0], "Command-line Options"); this->PrintHelpHTMLSection(os, &this->Options[0], "Command-line Options");
this->PrintHelpHTMLSection(os, &this->Commands[0], "Listfile Commands"); this->PrintHelpHTMLSection(os, &this->Commands[0], "Listfile Commands");
//this->PrintHelpHTMLSection(os, cmDocumentationCopyright, "Copyright");
//this->PrintHelpHTMLSection(os, cmDocumentationMailingList, "Mailing List");
os << "</body>\n" os << "</body>\n"
<< "</html>\n"; << "</html>\n";
} }
@ -317,7 +329,7 @@ void cmDocumentation::PrintManPage(std::ostream& os)
<< ".B http://www.cmake.org\n" << ".B http://www.cmake.org\n"
<< "before posting questions to the list.\n"; << "before posting questions to the list.\n";
os << ".SH AUTHOR\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) || if((strcmp(argv[i], "-help") == 0) ||
(strcmp(argv[i], "--help") == 0) || (strcmp(argv[i], "--help") == 0) ||
(strcmp(argv[i], "/?") == 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; return cmDocumentation::Usage;
} }
@ -562,7 +576,7 @@ cmDocumentation::Type cmDocumentation::CheckOptions(int argc, char** argv)
{ {
return cmDocumentation::HelpHTML; return cmDocumentation::HelpHTML;
} }
if(strcmp(argv[i], "--man") == 0) if(strcmp(argv[i], "--help-man") == 0)
{ {
return cmDocumentation::Man; return cmDocumentation::Man;
} }
@ -570,7 +584,10 @@ cmDocumentation::Type cmDocumentation::CheckOptions(int argc, char** argv)
{ {
return cmDocumentation::Copyright; 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; return cmDocumentation::Version;
} }