diff options
author | Brad King <brad.king@kitware.com> | 2013-10-16 16:54:52 (GMT) |
---|---|---|
committer | Brad King <brad.king@kitware.com> | 2013-10-16 20:24:51 (GMT) |
commit | 9b212ad01a31bebe30975ab43a6a675eb78f9144 (patch) | |
tree | 6066e4fc9ed2a2972185a419439429a74dc78793 /Help/manual | |
parent | 5dde65ac5b1ecdcc5b47bdba1b806a25fe6d3402 (diff) | |
download | CMake-9b212ad01a31bebe30975ab43a6a675eb78f9144.zip CMake-9b212ad01a31bebe30975ab43a6a675eb78f9144.tar.gz CMake-9b212ad01a31bebe30975ab43a6a675eb78f9144.tar.bz2 |
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.
Diffstat (limited to 'Help/manual')
-rw-r--r-- | Help/manual/OPTIONS_HELP.txt | 111 | ||||
-rw-r--r-- | Help/manual/ccmake.1.rst | 29 | ||||
-rw-r--r-- | Help/manual/cmake-gui.1.rst | 30 | ||||
-rw-r--r-- | Help/manual/cmake.1.rst | 155 | ||||
-rw-r--r-- | Help/manual/cpack.1.rst | 74 | ||||
-rw-r--r-- | Help/manual/ctest.1.rst | 42 |
6 files changed, 116 insertions, 325 deletions
diff --git a/Help/manual/OPTIONS_HELP.txt b/Help/manual/OPTIONS_HELP.txt new file mode 100644 index 0000000..baaab0f --- /dev/null +++ b/Help/manual/OPTIONS_HELP.txt @@ -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| diff --git a/Help/manual/ccmake.1.rst b/Help/manual/ccmake.1.rst index 5d6bc0c..62a7dcf 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 96ca80c..e773ee1 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 fd4bc67..64d0fb3 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 707c174..5c6567c 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 9e810e1..43fb961 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 <cmd> [<file>]``: Show help for a single command and exit. - - Prints the help for the command to stdout or to the specified file. - -* ``--help-command-list [<file>]``: List available commands and exit. - - 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. +.. include:: OPTIONS_HELP.txt See Also ======== |