Help: Refine manual/*.1.rst usage summaries
Use a parsed-literal block to list possible command-line signatures. Add an "Options" section header before the list of options.
This commit is contained in:
parent
f4253d7bf6
commit
d1e8a0240b
|
@ -6,10 +6,9 @@ ccmake(1)
|
||||||
Synopsis
|
Synopsis
|
||||||
========
|
========
|
||||||
|
|
||||||
::
|
.. parsed-literal::
|
||||||
|
|
||||||
ccmake <path-to-source>
|
ccmake [<options>] (<path-to-source> | <path-to-existing-build>)
|
||||||
ccmake <path-to-existing-build>
|
|
||||||
|
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
@ -25,6 +24,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.
|
||||||
|
|
||||||
|
Options
|
||||||
|
=======
|
||||||
|
|
||||||
.. include:: OPTIONS_BUILD.txt
|
.. include:: OPTIONS_BUILD.txt
|
||||||
|
|
||||||
.. include:: OPTIONS_HELP.txt
|
.. include:: OPTIONS_HELP.txt
|
||||||
|
|
|
@ -6,11 +6,10 @@ cmake-gui(1)
|
||||||
Synopsis
|
Synopsis
|
||||||
========
|
========
|
||||||
|
|
||||||
::
|
.. parsed-literal::
|
||||||
|
|
||||||
cmake-gui [options]
|
cmake-gui [<options>]
|
||||||
cmake-gui [options] <path-to-source>
|
cmake-gui [<options>] (<path-to-source> | <path-to-existing-build>)
|
||||||
cmake-gui [options] <path-to-existing-build>
|
|
||||||
|
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
@ -25,6 +24,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.
|
||||||
|
|
||||||
|
Options
|
||||||
|
=======
|
||||||
|
|
||||||
.. include:: OPTIONS_HELP.txt
|
.. include:: OPTIONS_HELP.txt
|
||||||
|
|
||||||
See Also
|
See Also
|
||||||
|
|
|
@ -6,10 +6,13 @@ cmake(1)
|
||||||
Synopsis
|
Synopsis
|
||||||
========
|
========
|
||||||
|
|
||||||
::
|
.. parsed-literal::
|
||||||
|
|
||||||
cmake [options] <path-to-source>
|
cmake [<options>] (<path-to-source> | <path-to-existing-build>)
|
||||||
cmake [options] <path-to-existing-build>
|
cmake [(-D<var>=<value>)...] -P <cmake-script-file>
|
||||||
|
cmake --build <dir> [<options>] [-- <build-tool-options>...]
|
||||||
|
cmake -E <command> [<options>]
|
||||||
|
cmake --find-package <options>...
|
||||||
|
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
@ -25,6 +28,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.
|
||||||
|
|
||||||
|
Options
|
||||||
|
=======
|
||||||
|
|
||||||
.. include:: OPTIONS_BUILD.txt
|
.. include:: OPTIONS_BUILD.txt
|
||||||
|
|
||||||
* ``-E``: CMake command mode.
|
* ``-E``: CMake command mode.
|
||||||
|
|
|
@ -6,9 +6,9 @@ cpack(1)
|
||||||
Synopsis
|
Synopsis
|
||||||
========
|
========
|
||||||
|
|
||||||
::
|
.. parsed-literal::
|
||||||
|
|
||||||
cpack -G <generator> [options]
|
cpack -G <generator> [<options>]
|
||||||
|
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
@ -24,6 +24,8 @@ 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.
|
||||||
|
|
||||||
|
Options
|
||||||
|
=======
|
||||||
|
|
||||||
* ``-G <generator>``: Use the specified generator to generate package.
|
* ``-G <generator>``: Use the specified generator to generate package.
|
||||||
|
|
||||||
|
|
|
@ -6,9 +6,9 @@ ctest(1)
|
||||||
Synopsis
|
Synopsis
|
||||||
========
|
========
|
||||||
|
|
||||||
::
|
.. parsed-literal::
|
||||||
|
|
||||||
ctest [options]
|
ctest [<options>]
|
||||||
|
|
||||||
Description
|
Description
|
||||||
===========
|
===========
|
||||||
|
@ -18,6 +18,8 @@ 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
|
||||||
program will run the tests and report results.
|
program will run the tests and report results.
|
||||||
|
|
||||||
|
Options
|
||||||
|
=======
|
||||||
|
|
||||||
* ``-C <cfg>, --build-config <cfg>``: Choose configuration to test.
|
* ``-C <cfg>, --build-config <cfg>``: Choose configuration to test.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue