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

Merge topic 'help-manual-cleanup' 

9b212ad Make --help-* options available from all command-line tools
5dde65a Help: De-duplicate manual/(cmake|ccmake).1.rst build options
ae944d1 Help: Organize manual/*.1.rst sections
4f7d708 Help: Drop leftover conversion content from manual/*.1.rst
This commit is contained in:
Brad King 2013-10-17 08:57:45 -04:00 committed by CMake Topic Stage
parent fa8fc51aec 9b212ad01a
commit 8f2b0c3307
15 changed files with 283 additions and 870 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
Help/manual/LINKS.txt Normal file
View File

@ -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.

57
Help/manual/OPTIONS_BUILD.txt Normal file
View File

@ -0,0 +1,57 @@
* ``-C <initial-cache>``: 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 <var>:<type>=<value>``: 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 <globbing_expr>``: 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 <generator-name>``: 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 <toolset-name>``: 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.

111
Help/manual/OPTIONS_HELP.txt Normal file
View File

@ -0,0 +1,111 @@
.. |file| replace:: The help is printed to a named <f>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 [<f>]``: Show program name/version banner and exit.
If a file is specified, the version is written into it.
|file|
* ``--help-manual <man> [<f>]``: Print one help manual and exit.
The specified manual is printed in a human-readable text format.
|file|
* ``--help-manual-list [<f>]``: 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 <cmd> [<f>]``: Print help for one command and exit.
The :manual:`cmake-commands(7)` manual entry for ``<cmd>`` is
printed in a human-readable text format.
|file|
* ``--help-command-list [<f>]``: 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 [<f>]``: Print cmake-commands manual and exit.
The :manual:`cmake-commands(7)` manual is printed in a
human-readable text format.
|file|
* ``--help-module <mod> [<f>]``: Print help for one module and exit.
The :manual:`cmake-modules(7)` manual entry for ``<mod>`` is printed
in a human-readable text format.
|file|
* ``--help-module-list [<f>]``: 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 [<f>]``: Print cmake-modules manual and exit.
The :manual:`cmake-modules(7)` manual is printed in a human-readable
text format.
|file|
* ``--help-policy <cmp> [<f>]``: Print help for one policy and exit.
The :manual:`cmake-policies(7)` manual entry for ``<cmp>`` is
printed in a human-readable text format.
|file|
* ``--help-policy-list [<f>]``: 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 [<f>]``: Print cmake-policies manual and exit.
The :manual:`cmake-policies(7)` manual is printed in a
human-readable text format.
|file|
* ``--help-property <prop> [<f>]``: Print help for one property and exit.
The :manual:`cmake-properties(7)` manual entries for ``<prop>`` are
printed in a human-readable text format.
|file|
* ``--help-property-list [<f>]``: 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 [<f>]``: Print cmake-properties manual and exit.
The :manual:`cmake-properties(7)` manual is printed in a
human-readable text format.
|file|
* ``--help-variable <var> [<f>]``: Print help for one variable and exit.
The :manual:`cmake-variables(7)` manual entry for ``<var>`` is
printed in a human-readable text format.
|file|
* ``--help-variable-list [<f>]``: 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 [<f>]``: Print cmake-variables manual and exit.
The :manual:`cmake-variables(7)` manual is printed in a
human-readable text format.
|file|

161
Help/manual/ccmake.1.rst
View File

@ -1,15 +1,17 @@
ccmake(1) ccmake(1)
********* *********
:: Synopsis
========
ccmake - Curses Interface for CMake.
:: ::
ccmake <path-to-source> ccmake <path-to-source>
ccmake <path-to-existing-build> ccmake <path-to-existing-build>
Description
===========
The "ccmake" executable is the CMake curses interface. Project The "ccmake" executable is the CMake curses interface. Project
configuration settings may be specified interactively through this configuration settings may be specified interactively through this
GUI. Brief instructions are provided at the bottom of the terminal GUI. Brief instructions are provided at the bottom of the terminal
@ -21,154 +23,11 @@ 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 Users build a project by using CMake to generate a build system for a
native tool on their platform. native tool on their platform.
.. include:: OPTIONS_BUILD.txt
* ``-C <initial-cache>``: Pre-load a script to populate the cache. .. include:: OPTIONS_HELP.txt
When cmake is first run in an empty build tree, it creates a See Also
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 <var>:<type>=<value>``: Create a cmake cache entry. .. include:: LINKS.txt
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 <globbing_expr>``: 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 <generator-name>``: 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 <toolset-name>``: 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.
* ``--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.
::
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.
* ``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.

126
Help/manual/cmake-gui.1.rst
View File

@ -1,9 +1,8 @@
cmake-gui(1) cmake-gui(1)
************ ************
:: Synopsis
========
cmake-gui - CMake GUI.
:: ::
@ -11,6 +10,9 @@ cmake-gui(1)
cmake-gui [options] <path-to-source> cmake-gui [options] <path-to-source>
cmake-gui [options] <path-to-existing-build> cmake-gui [options] <path-to-existing-build>
Description
===========
The "cmake-gui" executable is the CMake GUI. Project configuration The "cmake-gui" executable is the CMake GUI. Project configuration
settings may be specified interactively. Brief instructions are settings may be specified interactively. Brief instructions are
provided at the bottom of the window when the program is running. provided at the bottom of the window when the program is running.
@ -21,119 +23,9 @@ 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 Users build a project by using CMake to generate a build system for a
native tool on their platform. native tool on their platform.
.. include:: OPTIONS_HELP.txt
* ``--copyright [file]``: Print the CMake copyright and exit. See Also
========
If a file is specified, the copyright is written into it. .. include:: LINKS.txt
* ``--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.
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.
* ``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.

313
Help/manual/cmake.1.rst
View File

@ -1,15 +1,17 @@
cmake(1) cmake(1)
******** ********
:: Synopsis
========
cmake - Cross-Platform Makefile Generator.
:: ::
cmake [options] <path-to-source> cmake [options] <path-to-source>
cmake [options] <path-to-existing-build> cmake [options] <path-to-existing-build>
Description
===========
The "cmake" executable is the CMake command-line interface. It may be The "cmake" executable is the CMake command-line interface. It may be
used to configure projects in scripts. Project configuration settings used to configure projects in scripts. Project configuration settings
may be specified on the command line with the -D option. The -i may be specified on the command line with the -D option. The -i
@ -21,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 Users build a project by using CMake to generate a build system for a
native tool on their platform. native tool on their platform.
.. include:: OPTIONS_BUILD.txt
* ``-C <initial-cache>``: 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 <var>:<type>=<value>``: 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 <globbing_expr>``: 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 <generator-name>``: 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 <toolset-name>``: 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.
* ``-E``: CMake command mode. * ``-E``: CMake command mode.
@ -196,247 +141,9 @@ native tool on their platform.
in CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR. This flag tells CMake to in CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR. This flag tells CMake to
warn about other files as well. warn about other files as well.
* ``--help-command cmd [file]``: Print help for a single command and exit. .. include:: OPTIONS_HELP.txt
Full documentation specific to the given command is displayed. If a See Also
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. .. include:: LINKS.txt
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.
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.
* ``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.

146
Help/manual/cpack.1.rst
View File

@ -1,14 +1,16 @@
cpack(1) cpack(1)
******** ********
:: Synopsis
========
cpack - Packaging driver provided by CMake.
:: ::
cpack -G <generator> [options] cpack -G <generator> [options]
Description
===========
The "cpack" executable is the CMake packaging program. The "cpack" executable is the CMake packaging program.
CMake-generated build trees created for projects that use the CMake-generated build trees created for projects that use the
INSTALL_* commands have packaging support. This program will generate INSTALL_* commands have packaging support. This program will generate
@ -73,139 +75,9 @@ native tool on their platform.
If vendor is not specified on cpack command line (or inside If vendor is not specified on cpack command line (or inside
CMakeLists.txt) thenCPack.cmake defines it with a default value CMakeLists.txt) thenCPack.cmake defines it with a default value
* ``--help-command cmd [file]``: Print help for a single command and exit. .. include:: OPTIONS_HELP.txt
Full documentation specific to the given command is displayed. If a See Also
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. .. include:: LINKS.txt
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.
::
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.
* ``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.

126
Help/manual/ctest.1.rst
View File

@ -1,14 +1,16 @@
ctest(1) ctest(1)
******** ********
:: Synopsis
========
ctest - Testing driver provided by CMake.
:: ::
ctest [options] ctest [options]
Description
===========
The "ctest" executable is the CMake test driver program. The "ctest" executable is the CMake test driver program.
CMake-generated build trees created for projects that use the CMake-generated build trees created for projects that use the
ENABLE_TESTING and ADD_TEST commands have testing support. This ENABLE_TESTING and ADD_TEST commands have testing support. This
@ -302,119 +304,9 @@ program will run the tests and report results.
This option will not run any tests, it will simply print the list of This option will not run any tests, it will simply print the list of
all labels associated with the test set. all labels associated with the test set.
* ``--help-command <cmd> [<file>]``: Show help for a single command and exit. .. include:: OPTIONS_HELP.txt
Prints the help for the command to stdout or to the specified file. See Also
========
* ``--help-command-list [<file>]``: List available commands and exit. .. include:: LINKS.txt
Prints the list of all available listfile commands to stdout or the
specified file.
* ``--help-commands [<file>]``: 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.
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.
* ``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.

8
Source/CPack/cpack.cxx
View File

@ -55,13 +55,6 @@ static const char * cmDocumentationOptions[][2] =
{"-R <package version>","override/define CPACK_PACKAGE_VERSION"}, {"-R <package version>","override/define CPACK_PACKAGE_VERSION"},
{"-B <package directory>","override/define CPACK_PACKAGE_DIRECTORY"}, {"-B <package directory>","override/define CPACK_PACKAGE_DIRECTORY"},
{"--vendor <vendor name>","override/define CPACK_PACKAGE_VENDOR"}, {"--vendor <vendor name>","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} {0,0}
}; };
@ -235,6 +228,7 @@ int main (int argc, char *argv[])
// This part is used for cpack documentation lookup as well. // This part is used for cpack documentation lookup as well.
cminst.AddCMakePaths(); cminst.AddCMakePaths();
doc.SetCMakeRoot(cminst.GetCacheDefinition("CMAKE_ROOT"));
if ( parsed && !help ) if ( parsed && !help )
{ {

2
Source/CursesDialog/ccmake.cxx
View File

@ -86,6 +86,8 @@ int main(int argc, char** argv)
if(doc.CheckOptions(argc, argv)) if(doc.CheckOptions(argc, argv))
{ {
cmake hcm; cmake hcm;
hcm.AddCMakePaths();
doc.SetCMakeRoot(hcm.GetCacheDefinition("CMAKE_ROOT"));
std::vector<cmDocumentationEntry> generators; std::vector<cmDocumentationEntry> generators;
hcm.GetGeneratorDocumentation(generators); hcm.GetGeneratorDocumentation(generators);
doc.SetName("ccmake"); doc.SetName("ccmake");

7
Source/QtDialog/CMakeSetup.cxx
View File

@ -58,12 +58,7 @@ int main(int argc, char** argv)
// Construct and print requested documentation. // Construct and print requested documentation.
cmake hcm; cmake hcm;
hcm.AddCMakePaths(); hcm.AddCMakePaths();
// just incase the install is bad avoid a seg fault doc.SetCMakeRoot(hcm.GetCacheDefinition("CMAKE_ROOT"));
const char* root = hcm.GetCacheDefinition("CMAKE_ROOT");
if(root)
{
doc.SetCMakeRoot(root);
}
std::vector<cmDocumentationEntry> generators; std::vector<cmDocumentationEntry> generators;
hcm.GetGeneratorDocumentation(generators); hcm.GetGeneratorDocumentation(generators);

44
Source/cmDocumentation.cxx
View File

@ -25,12 +25,44 @@
//---------------------------------------------------------------------------- //----------------------------------------------------------------------------
static const char *cmDocumentationStandardOptions[][2] = static const char *cmDocumentationStandardOptions[][2] =
{ {
{"--copyright [file]", "Print the CMake copyright and exit."}, {"--help,-help,-usage,-h,-H,/?",
{"--help,-help,-usage,-h,-H,/?", "Print usage information and exit."}, "Print usage information and exit."},
{"--help-full [file]", "Print full help and exit."}, {"--version,-version,/V [<f>]",
{"--help-html [file]", "Print full help in HTML format."}, "Print version number and exit."},
{"--help-man [file]", "Print full help as a UNIX man page and exit."}, {"--help-manual <man> [<f>]",
{"--version,-version,/V [file]"}, "Print one help manual and exit."},
{"--help-manual-list [<f>]",
"List help manuals available and exit."},
{"--help-command <cmd> [<f>]",
"Print help for one command and exit."},
{"--help-command-list [<f>]",
"List commands with help available and exit."},
{"--help-commands [<f>]",
"Print cmake-commands manual and exit."},
{"--help-module <mod> [<f>]",
"Print help for one module and exit."},
{"--help-module-list [<f>]",
"List modules with help available and exit."},
{"--help-modules [<f>]",
"Print cmake-modules manual and exit."},
{"--help-policy <cmp> [<f>]",
"Print help for one policy and exit."},
{"--help-policy-list [<f>]",
"List policies with help available and exit."},
{"--help-policies [<f>]",
"Print cmake-policies manual and exit."},
{"--help-property <prop> [<f>]",
"Print help for one property and exit."},
{"--help-property-list [<f>]",
"List properties with help available and exit."},
{"--help-properties [<f>]",
"Print cmake-properties manual and exit."},
{"--help-variable var [<f>]",
"Print help for one variable and exit."},
{"--help-variable-list [<f>]",
"List variables with help available and exit."},
{"--help-variables [<f>]",
"Print cmake-variables manual and exit."},
{0,0} {0,0}
}; };

2
Source/cmDocumentation.h
View File

@ -84,7 +84,7 @@ public:
cmDocumentationEntry &docs); cmDocumentationEntry &docs);
/** Set cmake root so we can find installed files */ /** 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) */ /** Add common (to all tools) documentation section(s) */
void addCommonStandardDocSections(); void addCommonStandardDocSections();

21
Source/cmakemain.cxx
View File

@ -79,27 +79,6 @@ static const char * cmDocumentationOptions[][2] =
{"--no-warn-unused-cli", "Don't warn about command line options."}, {"--no-warn-unused-cli", "Don't warn about command line options."},
{"--check-system-vars", "Find problems with variable usage in system " {"--check-system-vars", "Find problems with variable usage in system "
"files."}, "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} {0,0}
}; };

8
Source/ctest.cxx
View File

@ -107,10 +107,6 @@ static const char * cmDocumentationOptions[][2] =
{"--http1.0", "Submit using HTTP 1.0."}, {"--http1.0", "Submit using HTTP 1.0."},
{"--no-compress-output", "Do not compress test output when submitting."}, {"--no-compress-output", "Do not compress test output when submitting."},
{"--print-labels", "Print all available test labels."}, {"--print-labels", "Print all available test labels."},
{"--help-command <cmd> [<file>]",
"Show 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."},
{0,0} {0,0}
}; };
@ -153,6 +149,10 @@ int main (int argc, char *argv[])
doc.addCTestStandardDocSections(); doc.addCTestStandardDocSections();
if(doc.CheckOptions(argc, argv)) if(doc.CheckOptions(argc, argv))
{ {
cmake hcm;
hcm.AddCMakePaths();
doc.SetCMakeRoot(hcm.GetCacheDefinition("CMAKE_ROOT"));
// Construct and print requested documentation. // Construct and print requested documentation.
cmCTestScriptHandler* ch = cmCTestScriptHandler* ch =
static_cast<cmCTestScriptHandler*>(inst.GetHandler("script")); static_cast<cmCTestScriptHandler*>(inst.GetHandler("script"));