From 4f7d708ac71239f18a42f1866e7f09ac64b64a92 Mon Sep 17 00:00:00 2001 From: Brad King Date: Wed, 16 Oct 2013 10:04:46 -0400 Subject: [PATCH 1/4] Help: Drop leftover conversion content from manual/*.1.rst Some text in these manuals is left from the old full help transition text generated by the automatic conversion process. Drop it. --- Help/manual/ccmake.1.rst | 42 ----------------------- Help/manual/cmake-gui.1.rst | 65 ----------------------------------- Help/manual/cmake.1.rst | 68 ------------------------------------- Help/manual/cpack.1.rst | 41 ---------------------- Help/manual/ctest.1.rst | 53 ----------------------------- 5 files changed, 269 deletions(-) diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst index b5146e71d..e340d2c17 100644 --- a/Help/manual/ccmake.1.rst +++ b/Help/manual/ccmake.1.rst @@ -109,50 +109,8 @@ native tool on their platform. If a file is specified, the version is written into it. -:: - - CMake Properties - Properties supported by CMake, the Cross-Platform Makefile Generator. - -This is the documentation for the properties supported by CMake. -Properties can have different scopes. They can either be assigned to -a source file, a directory, a target or globally to CMake. By -modifying the values of properties the behaviour of the build system -can be customized. - -Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. All -rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - -Redistributions of source code must retain the above copyright notice, -this list of conditions and the following disclaimer. - -Redistributions in binary form must reproduce the above copyright -notice, this list of conditions and the following disclaimer in the -documentation and/or other materials provided with the distribution. - -Neither the names of Kitware, Inc., the Insight Software Consortium, -nor the names of their contributors may be used to endorse or promote -products derived from this software without specific prior written -permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - The following resources are available to get help using CMake: - * ``Home Page``: http://www.cmake.org The primary starting point for learning about CMake. diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst index b4f295f6a..ef8a73fdf 100644 --- a/Help/manual/cmake-gui.1.rst +++ b/Help/manual/cmake-gui.1.rst @@ -51,73 +51,8 @@ native tool on their platform. If a file is specified, the version is written into it. -The following generators are available on this platform: - -:: - - CMake Properties - Properties supported by CMake, the Cross-Platform Makefile Generator. - -This is the documentation for the properties supported by CMake. -Properties can have different scopes. They can either be assigned to -a source file, a directory, a target or globally to CMake. By -modifying the values of properties the behaviour of the build system -can be customized. - -:: - - CMake Compatibility Listfile Commands - Obsolete commands supported by CMake for compatibility. - -This is the documentation for now obsolete listfile commands from -previous CMake versions, which are still supported for compatibility -reasons. You should instead use the newer, faster and shinier new -commands. ;-) - -The following modules are provided with CMake. They can be used with -INCLUDE(ModuleName). - -:: - - CMake Modules - Modules coming with CMake, the Cross-Platform Makefile Generator. - -This is the documentation for the modules and scripts coming with -CMake. Using these modules you can check the computer system for -installed software packages, features of the compiler and the -existence of headers to name just a few. - -Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. All -rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - -Redistributions of source code must retain the above copyright notice, -this list of conditions and the following disclaimer. - -Redistributions in binary form must reproduce the above copyright -notice, this list of conditions and the following disclaimer in the -documentation and/or other materials provided with the distribution. - -Neither the names of Kitware, Inc., the Insight Software Consortium, -nor the names of their contributors may be used to endorse or promote -products derived from this software without specific prior written -permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - The following resources are available to get help using CMake: - * ``Home Page``: http://www.cmake.org The primary starting point for learning about CMake. diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index ace93074e..9dbd9226d 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -351,76 +351,8 @@ native tool on their platform. If a file is specified, the version is written into it. -The following generators are available on this platform: - -:: - - CMake Properties - Properties supported by CMake, the Cross-Platform Makefile Generator. - -This is the documentation for the properties supported by CMake. -Properties can have different scopes. They can either be assigned to -a source file, a directory, a target or globally to CMake. By -modifying the values of properties the behaviour of the build system -can be customized. - -:: - - CMake Compatibility Listfile Commands - Obsolete commands supported by CMake for compatibility. - -This is the documentation for now obsolete listfile commands from -previous CMake versions, which are still supported for compatibility -reasons. You should instead use the newer, faster and shinier new -commands. ;-) - -The following modules are provided with CMake. They can be used with -INCLUDE(ModuleName). - -:: - - CMake Modules - Modules coming with CMake, the Cross-Platform Makefile Generator. - -This is the documentation for the modules and scripts coming with -CMake. Using these modules you can check the computer system for -installed software packages, features of the compiler and the -existence of headers to name just a few. - -variables defined by cmake, that give information about the project, -and cmake - -Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. All -rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - -Redistributions of source code must retain the above copyright notice, -this list of conditions and the following disclaimer. - -Redistributions in binary form must reproduce the above copyright -notice, this list of conditions and the following disclaimer in the -documentation and/or other materials provided with the distribution. - -Neither the names of Kitware, Inc., the Insight Software Consortium, -nor the names of their contributors may be used to endorse or promote -products derived from this software without specific prior written -permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - The following resources are available to get help using CMake: - * ``Home Page``: http://www.cmake.org The primary starting point for learning about CMake. diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst index 401283c54..679f0c515 100644 --- a/Help/manual/cpack.1.rst +++ b/Help/manual/cpack.1.rst @@ -147,49 +147,8 @@ native tool on their platform. If a file is specified, the version is written into it. -:: - - CMake Compatibility Listfile Commands - Obsolete commands supported by CMake for compatibility. - -This is the documentation for now obsolete listfile commands from -previous CMake versions, which are still supported for compatibility -reasons. You should instead use the newer, faster and shinier new -commands. ;-) - -Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. All -rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - -Redistributions of source code must retain the above copyright notice, -this list of conditions and the following disclaimer. - -Redistributions in binary form must reproduce the above copyright -notice, this list of conditions and the following disclaimer in the -documentation and/or other materials provided with the distribution. - -Neither the names of Kitware, Inc., the Insight Software Consortium, -nor the names of their contributors may be used to endorse or promote -products derived from this software without specific prior written -permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - The following resources are available to get help using CMake: - * ``Home Page``: http://www.cmake.org The primary starting point for learning about CMake. diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 1ce59aef2..940322588 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -344,61 +344,8 @@ program will run the tests and report results. If a file is specified, the version is written into it. -The following generators are available on this platform: - -:: - - CMake Properties - Properties supported by CMake, the Cross-Platform Makefile Generator. - -This is the documentation for the properties supported by CMake. -Properties can have different scopes. They can either be assigned to -a source file, a directory, a target or globally to CMake. By -modifying the values of properties the behaviour of the build system -can be customized. - -:: - - CMake Compatibility Listfile Commands - Obsolete commands supported by CMake for compatibility. - -This is the documentation for now obsolete listfile commands from -previous CMake versions, which are still supported for compatibility -reasons. You should instead use the newer, faster and shinier new -commands. ;-) - -Copyright 2000-2012 Kitware, Inc., Insight Software Consortium. All -rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are -met: - -Redistributions of source code must retain the above copyright notice, -this list of conditions and the following disclaimer. - -Redistributions in binary form must reproduce the above copyright -notice, this list of conditions and the following disclaimer in the -documentation and/or other materials provided with the distribution. - -Neither the names of Kitware, Inc., the Insight Software Consortium, -nor the names of their contributors may be used to endorse or promote -products derived from this software without specific prior written -permission. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS -"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT -LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR -A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT -HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, -SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT -LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, -DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY -THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - The following resources are available to get help using CMake: - * ``Home Page``: http://www.cmake.org The primary starting point for learning about CMake. From ae944d176ee77611bb492d5977b7c51c4ab9720f Mon Sep 17 00:00:00 2001 From: Brad King Date: Wed, 16 Oct 2013 10:25:43 -0400 Subject: [PATCH 2/4] 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. --- Help/manual/LINKS.txt | 21 +++++++++++++++++++++ Help/manual/ccmake.1.rst | 31 ++++++++----------------------- Help/manual/cmake-gui.1.rst | 31 ++++++++----------------------- Help/manual/cmake.1.rst | 32 ++++++++------------------------ Help/manual/cpack.1.rst | 31 ++++++++----------------------- Help/manual/ctest.1.rst | 31 ++++++++----------------------- 6 files changed, 61 insertions(+), 116 deletions(-) create mode 100644 Help/manual/LINKS.txt diff --git a/Help/manual/LINKS.txt b/Help/manual/LINKS.txt new file mode 100644 index 000000000..fcd8533ae --- /dev/null +++ b/Help/manual/LINKS.txt @@ -0,0 +1,21 @@ +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 + + 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. diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst index e340d2c17..2b5f8ca0f 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 ccmake +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: +See Also +======== -* ``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 - - 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 diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst index ef8a73fdf..96ca80cbe 100644 --- a/Help/manual/cmake-gui.1.rst +++ b/Help/manual/cmake-gui.1.rst @@ -1,9 +1,8 @@ cmake-gui(1) ************ -:: - - cmake-gui - CMake GUI. +Synopsis +======== :: @@ -11,6 +10,9 @@ cmake-gui(1) cmake-gui [options] cmake-gui [options] +Description +=========== + The "cmake-gui" executable is the CMake GUI. Project configuration settings may be specified interactively. Brief instructions are provided at the bottom of the window when the program is running. @@ -51,24 +53,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: +See Also +======== -* ``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 - - 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 diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 9dbd9226d..5b671742a 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] cmake [options] +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 ``: 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: +See Also +======== -* ``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 - - 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 diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst index 679f0c515..707c174a4 100644 --- a/Help/manual/cpack.1.rst +++ b/Help/manual/cpack.1.rst @@ -1,14 +1,16 @@ cpack(1) ******** -:: - - cpack - Packaging driver provided by CMake. +Synopsis +======== :: cpack -G [options] +Description +=========== + The "cpack" executable is the CMake packaging program. CMake-generated build trees created for projects that use the INSTALL_* commands have packaging support. This program will generate @@ -147,24 +149,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: +See Also +======== -* ``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 - - 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 diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 940322588..9e810e168 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -1,14 +1,16 @@ ctest(1) ******** -:: - - ctest - Testing driver provided by CMake. +Synopsis +======== :: ctest [options] +Description +=========== + The "ctest" executable is the CMake test driver program. CMake-generated build trees created for projects that use the ENABLE_TESTING and ADD_TEST commands have testing support. This @@ -344,24 +346,7 @@ program will run the tests and report results. If a file is specified, the version is written into it. -The following resources are available to get help using CMake: +See Also +======== -* ``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 - - 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 From 5dde65ac5b1ecdcc5b47bdba1b806a25fe6d3402 Mon Sep 17 00:00:00 2001 From: Brad King Date: Wed, 16 Oct 2013 11:24:16 -0400 Subject: [PATCH 3/4] Help: De-duplicate manual/(cmake|ccmake).1.rst build options Move common build options out of cmake and ccmake manuals into an OPTIONS_BUILD.txt file and include it from the original locations. --- Help/manual/OPTIONS_BUILD.txt | 57 +++++++++++++++++++++++++++++++++ Help/manual/ccmake.1.rst | 59 +---------------------------------- Help/manual/cmake.1.rst | 58 +--------------------------------- 3 files changed, 59 insertions(+), 115 deletions(-) create mode 100644 Help/manual/OPTIONS_BUILD.txt diff --git a/Help/manual/OPTIONS_BUILD.txt b/Help/manual/OPTIONS_BUILD.txt new file mode 100644 index 000000000..3aded5c26 --- /dev/null +++ b/Help/manual/OPTIONS_BUILD.txt @@ -0,0 +1,57 @@ +* ``-C ``: Pre-load a script to populate the cache. + + When cmake is first run in an empty build tree, it creates a + CMakeCache.txt file and populates it with customizable settings for + the project. This option may be used to specify a file from which + to load cache entries before the first pass through the project's + cmake listfiles. The loaded entries take priority over the + project's default values. The given file should be a CMake script + containing SET commands that use the CACHE option, not a + cache-format file. + +* ``-D :=``: Create a cmake cache entry. + + When cmake is first run in an empty build tree, it creates a + CMakeCache.txt file and populates it with customizable settings for + the project. This option may be used to specify a setting that + takes priority over the project's default value. The option may be + repeated for as many cache entries as desired. + +* ``-U ``: Remove matching entries from CMake cache. + + This option may be used to remove one or more variables from the + CMakeCache.txt file, globbing expressions using * and ? are + supported. The option may be repeated for as many cache entries as + desired. + + Use with care, you can make your CMakeCache.txt non-working. + +* ``-G ``: Specify a build system generator. + + CMake may support multiple native build systems on certain + platforms. A generator is responsible for generating a particular + build system. Possible generator names are specified in the + Generators section. + +* ``-T ``: Specify toolset name if supported by generator. + + Some CMake generators support a toolset name to be given to the + native build system to choose a compiler. This is supported only on + specific generators: + + :: + + Visual Studio >= 10 + Xcode >= 3.0 + + See native build system documentation for allowed toolset names. + +* ``-Wno-dev``: Suppress developer warnings. + + Suppress warnings that are meant for the author of the + CMakeLists.txt files. + +* ``-Wdev``: Enable developer warnings. + + Enable warnings that are meant for the author of the CMakeLists.txt + files. diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst index 2b5f8ca0f..5d6bc0c34 100644 --- a/Help/manual/ccmake.1.rst +++ b/Help/manual/ccmake.1.rst @@ -23,64 +23,7 @@ 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 ``: Pre-load a script to populate the cache. - - When cmake is first run in an empty build tree, it creates a - CMakeCache.txt file and populates it with customizable settings for - the project. This option may be used to specify a file from which - to load cache entries before the first pass through the project's - cmake listfiles. The loaded entries take priority over the - project's default values. The given file should be a CMake script - containing SET commands that use the CACHE option, not a - cache-format file. - -* ``-D :=``: Create a cmake cache entry. - - When cmake is first run in an empty build tree, it creates a - CMakeCache.txt file and populates it with customizable settings for - the project. This option may be used to specify a setting that - takes priority over the project's default value. The option may be - repeated for as many cache entries as desired. - -* ``-U ``: Remove matching entries from CMake cache. - - This option may be used to remove one or more variables from the - CMakeCache.txt file, globbing expressions using * and ? are - supported. The option may be repeated for as many cache entries as - desired. - - Use with care, you can make your CMakeCache.txt non-working. - -* ``-G ``: Specify a build system generator. - - CMake may support multiple native build systems on certain - platforms. A generator is responsible for generating a particular - build system. Possible generator names are specified in the - Generators section. - -* ``-T ``: Specify toolset name if supported by generator. - - Some CMake generators support a toolset name to be given to the - native build system to choose a compiler. This is supported only on - specific generators: - - :: - - Visual Studio >= 10 - Xcode >= 3.0 - - See native build system documentation for allowed toolset names. - -* ``-Wno-dev``: Suppress developer warnings. - - Suppress warnings that are meant for the author of the - CMakeLists.txt files. - -* ``-Wdev``: Enable developer warnings. - - Enable warnings that are meant for the author of the CMakeLists.txt - files. +.. include:: OPTIONS_BUILD.txt * ``--copyright [file]``: Print the CMake copyright and exit. diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index 5b671742a..fd4bc670b 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -23,63 +23,7 @@ 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 ``: Pre-load a script to populate the cache. - - When cmake is first run in an empty build tree, it creates a - CMakeCache.txt file and populates it with customizable settings for - the project. This option may be used to specify a file from which - to load cache entries before the first pass through the project's - cmake listfiles. The loaded entries take priority over the - project's default values. The given file should be a CMake script - containing SET commands that use the CACHE option, not a - cache-format file. - -* ``-D :=``: Create a cmake cache entry. - - When cmake is first run in an empty build tree, it creates a - CMakeCache.txt file and populates it with customizable settings for - the project. This option may be used to specify a setting that - takes priority over the project's default value. The option may be - repeated for as many cache entries as desired. - -* ``-U ``: Remove matching entries from CMake cache. - - This option may be used to remove one or more variables from the - CMakeCache.txt file, globbing expressions using * and ? are - supported. The option may be repeated for as many cache entries as - desired. - - Use with care, you can make your CMakeCache.txt non-working. - -* ``-G ``: Specify a build system generator. - - CMake may support multiple native build systems on certain - platforms. A generator is responsible for generating a particular - build system. Possible generator names are specified in the - Generators section. - -* ``-T ``: Specify toolset name if supported by generator. - - Some CMake generators support a toolset name to be given to the - native build system to choose a compiler. This is supported only on - specific generators: - - :: - - Visual Studio >= 10 - Xcode >= 3.0 - - See native build system documentation for allowed toolset names. - -* ``-Wno-dev``: Suppress developer warnings. - - Suppress warnings that are meant for the author of the - CMakeLists.txt files. - -* ``-Wdev``: Enable developer warnings. - - Enable warnings that are meant for the author of the CMakeLists.txt - files. +.. include:: OPTIONS_BUILD.txt * ``-E``: CMake command mode. From 9b212ad01a31bebe30975ab43a6a675eb78f9144 Mon Sep 17 00:00:00 2001 From: Brad King Date: Wed, 16 Oct 2013 12:54:52 -0400 Subject: [PATCH 4/4] Make --help-* options available from all command-line tools Make the standard --help-* options available from all command-line tools. Drop options that are no longer supported: --copyright, --help-full, --help-html, --help-man, --help-compatcommands, --help-custom-modules De-duplicate Help/manual/*.1.rst help options by using an OPTIONS_HELP.txt file included from each manual. --- Help/manual/OPTIONS_HELP.txt | 111 +++++++++++++++++++++++ Help/manual/ccmake.1.rst | 29 +----- Help/manual/cmake-gui.1.rst | 30 +------ Help/manual/cmake.1.rst | 155 +-------------------------------- Help/manual/cpack.1.rst | 74 +--------------- Help/manual/ctest.1.rst | 42 +-------- Source/CPack/cpack.cxx | 8 +- Source/CursesDialog/ccmake.cxx | 2 + Source/QtDialog/CMakeSetup.cxx | 7 +- Source/cmDocumentation.cxx | 44 ++++++++-- Source/cmDocumentation.h | 2 +- Source/cmakemain.cxx | 21 ----- Source/ctest.cxx | 8 +- 13 files changed, 163 insertions(+), 370 deletions(-) create mode 100644 Help/manual/OPTIONS_HELP.txt diff --git a/Help/manual/OPTIONS_HELP.txt b/Help/manual/OPTIONS_HELP.txt new file mode 100644 index 000000000..baaab0f4d --- /dev/null +++ b/Help/manual/OPTIONS_HELP.txt @@ -0,0 +1,111 @@ +.. |file| replace:: The help is printed to a named ile if given. + +* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. + + Usage describes the basic command line interface and its options. + +* ``--version,-version,/V []``: Show program name/version banner and exit. + + If a file is specified, the version is written into it. + |file| + +* ``--help-manual []``: Print one help manual and exit. + + The specified manual is printed in a human-readable text format. + |file| + +* ``--help-manual-list []``: List help manuals available and exit. + + The list contains all manuals for which help may be obtained by + using the ``--help-manual`` option followed by a manual name. + |file| + +* ``--help-command []``: Print help for one command and exit. + + The :manual:`cmake-commands(7)` manual entry for ```` is + printed in a human-readable text format. + |file| + +* ``--help-command-list []``: List commands with help available and exit. + + The list contains all commands for which help may be obtained by + using the ``--help-command`` option followed by a command name. + |file| + +* ``--help-commands []``: Print cmake-commands manual and exit. + + The :manual:`cmake-commands(7)` manual is printed in a + human-readable text format. + |file| + +* ``--help-module []``: Print help for one module and exit. + + The :manual:`cmake-modules(7)` manual entry for ```` is printed + in a human-readable text format. + |file| + +* ``--help-module-list []``: List modules with help available and exit. + + The list contains all modules for which help may be obtained by + using the ``--help-module`` option followed by a module name. + |file| + +* ``--help-modules []``: Print cmake-modules manual and exit. + + The :manual:`cmake-modules(7)` manual is printed in a human-readable + text format. + |file| + +* ``--help-policy []``: Print help for one policy and exit. + + The :manual:`cmake-policies(7)` manual entry for ```` is + printed in a human-readable text format. + |file| + +* ``--help-policy-list []``: List policies with help available and exit. + + The list contains all policies for which help may be obtained by + using the ``--help-policy`` option followed by a policy name. + |file| + +* ``--help-policies []``: Print cmake-policies manual and exit. + + The :manual:`cmake-policies(7)` manual is printed in a + human-readable text format. + |file| + +* ``--help-property []``: Print help for one property and exit. + + The :manual:`cmake-properties(7)` manual entries for ```` are + printed in a human-readable text format. + |file| + +* ``--help-property-list []``: List properties with help available and exit. + + The list contains all properties for which help may be obtained by + using the ``--help-property`` option followed by a property name. + |file| + +* ``--help-properties []``: Print cmake-properties manual and exit. + + The :manual:`cmake-properties(7)` manual is printed in a + human-readable text format. + |file| + +* ``--help-variable []``: Print help for one variable and exit. + + The :manual:`cmake-variables(7)` manual entry for ```` is + printed in a human-readable text format. + |file| + +* ``--help-variable-list []``: List variables with help available and exit. + + The list contains all variables for which help may be obtained by + using the ``--help-variable`` option followed by a variable name. + |file| + +* ``--help-variables []``: Print cmake-variables manual and exit. + + The :manual:`cmake-variables(7)` manual is printed in a + human-readable text format. + |file| diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst index 5d6bc0c34..62a7dcf8d 100644 --- a/Help/manual/ccmake.1.rst +++ b/Help/manual/ccmake.1.rst @@ -25,34 +25,7 @@ native tool on their platform. .. include:: OPTIONS_BUILD.txt -* ``--copyright [file]``: Print the CMake copyright and exit. - - If a file is specified, the copyright is written into it. - -* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. - - Usage describes the basic command line interface and its options. - -* ``--help-full [file]``: Print full help and exit. - - Full help displays most of the documentation provided by the UNIX - man page. It is provided for use on non-UNIX platforms, but is also - convenient if the man page is not installed. If a file is - specified, the help is written into it. - -* ``--help-html [file]``: Print full help in HTML format. - - This option is used by CMake authors to help produce web pages. If - a file is specified, the help is written into it. - -* ``--help-man [file]``: Print full help as a UNIX man page and exit. - - This option is used by the cmake build to generate the UNIX man - page. If a file is specified, the help is written into it. - -* ``--version,-version,/V [file]``: Show program name/version banner and exit. - - If a file is specified, the version is written into it. +.. include:: OPTIONS_HELP.txt See Also ======== diff --git a/Help/manual/cmake-gui.1.rst b/Help/manual/cmake-gui.1.rst index 96ca80cbe..e773ee169 100644 --- a/Help/manual/cmake-gui.1.rst +++ b/Help/manual/cmake-gui.1.rst @@ -23,35 +23,7 @@ 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. - -* ``--copyright [file]``: Print the CMake copyright and exit. - - If a file is specified, the copyright is written into it. - -* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. - - Usage describes the basic command line interface and its options. - -* ``--help-full [file]``: Print full help and exit. - - Full help displays most of the documentation provided by the UNIX - man page. It is provided for use on non-UNIX platforms, but is also - convenient if the man page is not installed. If a file is - specified, the help is written into it. - -* ``--help-html [file]``: Print full help in HTML format. - - This option is used by CMake authors to help produce web pages. If - a file is specified, the help is written into it. - -* ``--help-man [file]``: Print full help as a UNIX man page and exit. - - This option is used by the cmake build to generate the UNIX man - page. If a file is specified, the help is written into it. - -* ``--version,-version,/V [file]``: Show program name/version banner and exit. - - If a file is specified, the version is written into it. +.. include:: OPTIONS_HELP.txt See Also ======== diff --git a/Help/manual/cmake.1.rst b/Help/manual/cmake.1.rst index fd4bc670b..64d0fb3f3 100644 --- a/Help/manual/cmake.1.rst +++ b/Help/manual/cmake.1.rst @@ -141,160 +141,7 @@ native tool on their platform. in CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR. This flag tells CMake to warn about other files as well. -* ``--help-command cmd [file]``: Print help for a single command and exit. - - Full documentation specific to the given command is displayed. If a - file is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-command-list [file]``: List available listfile commands and exit. - - The list contains all commands for which help may be obtained by - using the --help-command argument followed by a command name. If a - file is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-commands [file]``: Print help for all commands and exit. - - Full documentation specific for all current commands is displayed.If - a file is specified, the documentation is written into and the - output format is determined depending on the filename suffix. - Supported are man page, HTML, DocBook and plain text. - -* ``--help-compatcommands [file]``: Print help for compatibility commands. - - Full documentation specific for all compatibility commands is - displayed.If a file is specified, the documentation is written into - and the output format is determined depending on the filename - suffix. Supported are man page, HTML, DocBook and plain text. - -* ``--help-module module [file]``: Print help for a single module and exit. - - Full documentation specific to the given module is displayed.If a - file is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-module-list [file]``: List available modules and exit. - - The list contains all modules for which help may be obtained by - using the --help-module argument followed by a module name. If a - file is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-modules [file]``: Print help for all modules and exit. - - Full documentation for all modules is displayed. If a file is - specified, the documentation is written into and the output format - is determined depending on the filename suffix. Supported are man - page, HTML, DocBook and plain text. - -* ``--help-custom-modules [file]``: Print help for all custom modules and exit. - - Full documentation for all custom modules is displayed. If a file - is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-policy cmp [file]``: Print help for a single policy and exit. - - Full documentation specific to the given policy is displayed.If a - file is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-policy-list [file]``: List available policies and exit. - - The list contains all policies for which help may be obtained by - using the --help-policy argument followed by a policy name. If a - file is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-policies [file]``: Print help for all policies and exit. - - Full documentation for all policies is displayed.If a file is - specified, the documentation is written into and the output format - is determined depending on the filename suffix. Supported are man - page, HTML, DocBook and plain text. - -* ``--help-property prop [file]``: Print help for a single property and exit. - - Full documentation specific to the given property is displayed.If a - file is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-property-list [file]``: List available properties and exit. - - The list contains all properties for which help may be obtained by - using the --help-property argument followed by a property name. If - a file is specified, the help is written into it.If a file is - specified, the documentation is written into and the output format - is determined depending on the filename suffix. Supported are man - page, HTML, DocBook and plain text. - -* ``--help-properties [file]``: Print help for all properties and exit. - - Full documentation for all properties is displayed.If a file is - specified, the documentation is written into and the output format - is determined depending on the filename suffix. Supported are man - page, HTML, DocBook and plain text. - -* ``--help-variable var [file]``: Print help for a single variable and exit. - - Full documentation specific to the given variable is displayed.If a - file is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-variable-list [file]``: List documented variables and exit. - - The list contains all variables for which help may be obtained by - using the --help-variable argument followed by a variable name. If - a file is specified, the help is written into it.If a file is - specified, the documentation is written into and the output format - is determined depending on the filename suffix. Supported are man - page, HTML, DocBook and plain text. - -* ``--help-variables [file]``: Print help for all variables and exit. - - Full documentation for all variables is displayed.If a file is - specified, the documentation is written into and the output format - is determined depending on the filename suffix. Supported are man - page, HTML, DocBook and plain text. - -* ``--copyright [file]``: Print the CMake copyright and exit. - - If a file is specified, the copyright is written into it. - -* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. - - Usage describes the basic command line interface and its options. - -* ``--help-full [file]``: Print full help and exit. - - Full help displays most of the documentation provided by the UNIX - man page. It is provided for use on non-UNIX platforms, but is also - convenient if the man page is not installed. If a file is - specified, the help is written into it. - -* ``--help-html [file]``: Print full help in HTML format. - - This option is used by CMake authors to help produce web pages. If - a file is specified, the help is written into it. - -* ``--help-man [file]``: Print full help as a UNIX man page and exit. - - This option is used by the cmake build to generate the UNIX man - page. If a file is specified, the help is written into it. - -* ``--version,-version,/V [file]``: Show program name/version banner and exit. - - If a file is specified, the version is written into it. +.. include:: OPTIONS_HELP.txt See Also ======== diff --git a/Help/manual/cpack.1.rst b/Help/manual/cpack.1.rst index 707c174a4..5c6567c7d 100644 --- a/Help/manual/cpack.1.rst +++ b/Help/manual/cpack.1.rst @@ -75,79 +75,7 @@ native tool on their platform. If vendor is not specified on cpack command line (or inside CMakeLists.txt) thenCPack.cmake defines it with a default value -* ``--help-command cmd [file]``: Print help for a single command and exit. - - Full documentation specific to the given command is displayed. If a - file is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-command-list [file]``: List available commands and exit. - - The list contains all commands for which help may be obtained by - using the --help-command argument followed by a command name. If a - file is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-commands [file]``: Print help for all commands and exit. - - Full documentation specific for all current command is displayed.If - a file is specified, the documentation is written into and the - output format is determined depending on the filename suffix. - Supported are man page, HTML, DocBook and plain text. - -* ``--help-variable var [file]``: Print help for a single variable and exit. - - Full documentation specific to the given variable is displayed.If a - file is specified, the documentation is written into and the output - format is determined depending on the filename suffix. Supported - are man page, HTML, DocBook and plain text. - -* ``--help-variable-list [file]``: List documented variables and exit. - - The list contains all variables for which help may be obtained by - using the --help-variable argument followed by a variable name. If - a file is specified, the help is written into it.If a file is - specified, the documentation is written into and the output format - is determined depending on the filename suffix. Supported are man - page, HTML, DocBook and plain text. - -* ``--help-variables [file]``: Print help for all variables and exit. - - Full documentation for all variables is displayed.If a file is - specified, the documentation is written into and the output format - is determined depending on the filename suffix. Supported are man - page, HTML, DocBook and plain text. - -* ``--copyright [file]``: Print the CMake copyright and exit. - - If a file is specified, the copyright is written into it. - -* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. - - Usage describes the basic command line interface and its options. - -* ``--help-full [file]``: Print full help and exit. - - Full help displays most of the documentation provided by the UNIX - man page. It is provided for use on non-UNIX platforms, but is also - convenient if the man page is not installed. If a file is - specified, the help is written into it. - -* ``--help-html [file]``: Print full help in HTML format. - - This option is used by CMake authors to help produce web pages. If - a file is specified, the help is written into it. - -* ``--help-man [file]``: Print full help as a UNIX man page and exit. - - This option is used by the cmake build to generate the UNIX man - page. If a file is specified, the help is written into it. - -* ``--version,-version,/V [file]``: Show program name/version banner and exit. - - If a file is specified, the version is written into it. +.. include:: OPTIONS_HELP.txt See Also ======== diff --git a/Help/manual/ctest.1.rst b/Help/manual/ctest.1.rst index 9e810e168..43fb96109 100644 --- a/Help/manual/ctest.1.rst +++ b/Help/manual/ctest.1.rst @@ -304,47 +304,7 @@ program will run the tests and report results. This option will not run any tests, it will simply print the list of all labels associated with the test set. -* ``--help-command []``: Show help for a single command and exit. - - Prints the help for the command to stdout or to the specified file. - -* ``--help-command-list []``: List available commands and exit. - - Prints the list of all available listfile commands to stdout or the - specified file. - -* ``--help-commands []``: Print help for all commands and exit. - - Prints the help for all commands to stdout or to the specified file. - -* ``--copyright [file]``: Print the CMake copyright and exit. - - If a file is specified, the copyright is written into it. - -* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. - - Usage describes the basic command line interface and its options. - -* ``--help-full [file]``: Print full help and exit. - - Full help displays most of the documentation provided by the UNIX - man page. It is provided for use on non-UNIX platforms, but is also - convenient if the man page is not installed. If a file is - specified, the help is written into it. - -* ``--help-html [file]``: Print full help in HTML format. - - This option is used by CMake authors to help produce web pages. If - a file is specified, the help is written into it. - -* ``--help-man [file]``: Print full help as a UNIX man page and exit. - - This option is used by the cmake build to generate the UNIX man - page. If a file is specified, the help is written into it. - -* ``--version,-version,/V [file]``: Show program name/version banner and exit. - - If a file is specified, the version is written into it. +.. include:: OPTIONS_HELP.txt See Also ======== diff --git a/Source/CPack/cpack.cxx b/Source/CPack/cpack.cxx index 677f5b1ae..169ae9a4b 100644 --- a/Source/CPack/cpack.cxx +++ b/Source/CPack/cpack.cxx @@ -55,13 +55,6 @@ static const char * cmDocumentationOptions[][2] = {"-R ","override/define CPACK_PACKAGE_VERSION"}, {"-B ","override/define CPACK_PACKAGE_DIRECTORY"}, {"--vendor ","override/define CPACK_PACKAGE_VENDOR"}, - {"--help-command cmd [file]", "Print help for a single command and exit."}, - {"--help-command-list [file]", "List available commands and exit."}, - {"--help-commands [file]", "Print help for all commands and exit."}, - {"--help-variable var [file]", - "Print help for a single variable and exit."}, - {"--help-variable-list [file]", "List documented variables and exit."}, - {"--help-variables [file]", "Print help for all variables and exit."}, {0,0} }; @@ -235,6 +228,7 @@ int main (int argc, char *argv[]) // This part is used for cpack documentation lookup as well. cminst.AddCMakePaths(); + doc.SetCMakeRoot(cminst.GetCacheDefinition("CMAKE_ROOT")); if ( parsed && !help ) { diff --git a/Source/CursesDialog/ccmake.cxx b/Source/CursesDialog/ccmake.cxx index 3855d530a..fdfe331c3 100644 --- a/Source/CursesDialog/ccmake.cxx +++ b/Source/CursesDialog/ccmake.cxx @@ -86,6 +86,8 @@ int main(int argc, char** argv) if(doc.CheckOptions(argc, argv)) { cmake hcm; + hcm.AddCMakePaths(); + doc.SetCMakeRoot(hcm.GetCacheDefinition("CMAKE_ROOT")); std::vector generators; hcm.GetGeneratorDocumentation(generators); doc.SetName("ccmake"); diff --git a/Source/QtDialog/CMakeSetup.cxx b/Source/QtDialog/CMakeSetup.cxx index cfefab2ee..095aeb648 100644 --- a/Source/QtDialog/CMakeSetup.cxx +++ b/Source/QtDialog/CMakeSetup.cxx @@ -58,12 +58,7 @@ int main(int argc, char** argv) // Construct and print requested documentation. cmake hcm; hcm.AddCMakePaths(); - // just incase the install is bad avoid a seg fault - const char* root = hcm.GetCacheDefinition("CMAKE_ROOT"); - if(root) - { - doc.SetCMakeRoot(root); - } + doc.SetCMakeRoot(hcm.GetCacheDefinition("CMAKE_ROOT")); std::vector generators; hcm.GetGeneratorDocumentation(generators); diff --git a/Source/cmDocumentation.cxx b/Source/cmDocumentation.cxx index 2d7feab77..682478eed 100644 --- a/Source/cmDocumentation.cxx +++ b/Source/cmDocumentation.cxx @@ -25,12 +25,44 @@ //---------------------------------------------------------------------------- static const char *cmDocumentationStandardOptions[][2] = { - {"--copyright [file]", "Print the CMake copyright and exit."}, - {"--help,-help,-usage,-h,-H,/?", "Print usage information and exit."}, - {"--help-full [file]", "Print full help and exit."}, - {"--help-html [file]", "Print full help in HTML format."}, - {"--help-man [file]", "Print full help as a UNIX man page and exit."}, - {"--version,-version,/V [file]"}, + {"--help,-help,-usage,-h,-H,/?", + "Print usage information and exit."}, + {"--version,-version,/V []", + "Print version number and exit."}, + {"--help-manual []", + "Print one help manual and exit."}, + {"--help-manual-list []", + "List help manuals available and exit."}, + {"--help-command []", + "Print help for one command and exit."}, + {"--help-command-list []", + "List commands with help available and exit."}, + {"--help-commands []", + "Print cmake-commands manual and exit."}, + {"--help-module []", + "Print help for one module and exit."}, + {"--help-module-list []", + "List modules with help available and exit."}, + {"--help-modules []", + "Print cmake-modules manual and exit."}, + {"--help-policy []", + "Print help for one policy and exit."}, + {"--help-policy-list []", + "List policies with help available and exit."}, + {"--help-policies []", + "Print cmake-policies manual and exit."}, + {"--help-property []", + "Print help for one property and exit."}, + {"--help-property-list []", + "List properties with help available and exit."}, + {"--help-properties []", + "Print cmake-properties manual and exit."}, + {"--help-variable var []", + "Print help for one variable and exit."}, + {"--help-variable-list []", + "List variables with help available and exit."}, + {"--help-variables []", + "Print cmake-variables manual and exit."}, {0,0} }; diff --git a/Source/cmDocumentation.h b/Source/cmDocumentation.h index a4072c51c..07e614db6 100644 --- a/Source/cmDocumentation.h +++ b/Source/cmDocumentation.h @@ -84,7 +84,7 @@ public: cmDocumentationEntry &docs); /** Set cmake root so we can find installed files */ - void SetCMakeRoot(const char* root) { this->CMakeRoot = root;} + void SetCMakeRoot(const char* root) { this->CMakeRoot = root? root:"";} /** Add common (to all tools) documentation section(s) */ void addCommonStandardDocSections(); diff --git a/Source/cmakemain.cxx b/Source/cmakemain.cxx index 6e2125fac..5b534f0ea 100644 --- a/Source/cmakemain.cxx +++ b/Source/cmakemain.cxx @@ -79,27 +79,6 @@ static const char * cmDocumentationOptions[][2] = {"--no-warn-unused-cli", "Don't warn about command line options."}, {"--check-system-vars", "Find problems with variable usage in system " "files."}, - {"--help-command cmd [file]", "Print help for a single command and exit."}, - {"--help-command-list [file]", "List available listfile commands and exit."}, - {"--help-commands [file]", "Print help for all commands and exit."}, - {"--help-compatcommands [file]", "Print help for compatibility commands. "}, - {"--help-module module [file]", "Print help for a single module and exit."}, - {"--help-module-list [file]", "List available modules and exit."}, - {"--help-modules [file]", "Print help for all modules and exit."}, - {"--help-custom-modules [file]" , "Print help for all custom modules and " - "exit."}, - {"--help-policy cmp [file]", - "Print help for a single policy and exit."}, - {"--help-policy-list [file]", "List available policies and exit."}, - {"--help-policies [file]", "Print help for all policies and exit."}, - {"--help-property prop [file]", - "Print help for a single property and exit."}, - {"--help-property-list [file]", "List available properties and exit."}, - {"--help-properties [file]", "Print help for all properties and exit."}, - {"--help-variable var [file]", - "Print help for a single variable and exit."}, - {"--help-variable-list [file]", "List documented variables and exit."}, - {"--help-variables [file]", "Print help for all variables and exit."}, {0,0} }; diff --git a/Source/ctest.cxx b/Source/ctest.cxx index 6e3a86b4e..16cdd1365 100644 --- a/Source/ctest.cxx +++ b/Source/ctest.cxx @@ -107,10 +107,6 @@ static const char * cmDocumentationOptions[][2] = {"--http1.0", "Submit using HTTP 1.0."}, {"--no-compress-output", "Do not compress test output when submitting."}, {"--print-labels", "Print all available test labels."}, - {"--help-command []", - "Show help for a single command and exit."}, - {"--help-command-list []", "List available commands and exit."}, - {"--help-commands []", "Print help for all commands and exit."}, {0,0} }; @@ -153,6 +149,10 @@ int main (int argc, char *argv[]) doc.addCTestStandardDocSections(); if(doc.CheckOptions(argc, argv)) { + cmake hcm; + hcm.AddCMakePaths(); + doc.SetCMakeRoot(hcm.GetCacheDefinition("CMAKE_ROOT")); + // Construct and print requested documentation. cmCTestScriptHandler* ch = static_cast(inst.GetHandler("script"));