diff options
Diffstat (limited to 'Help/manual/OPTIONS_HELP.txt')
-rw-r--r-- | Help/manual/OPTIONS_HELP.txt | 68 |
1 files changed, 43 insertions, 25 deletions
diff --git a/Help/manual/OPTIONS_HELP.txt b/Help/manual/OPTIONS_HELP.txt index feeca7d..78ee245 100644 --- a/Help/manual/OPTIONS_HELP.txt +++ b/Help/manual/OPTIONS_HELP.txt @@ -1,134 +1,152 @@ -.. |file| replace:: The help is printed to a named <f>ile if given. +.. |file| replace:: The output is printed to a named ``<file>`` if given. + +.. option:: -version [<file>], --version [<file>], /V [<file>] + + Show program name/version banner and exit. + |file| + +.. option:: -h, -H, --help, -help, -usage, /? -``--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. +.. option:: --help-full [<file>] - If a file is specified, the version is written into it. - |file| - -``--help-full [<f>]`` Print all help manuals and exit. All manuals are printed in a human-readable text format. |file| -``--help-manual <man> [<f>]`` +.. option:: --help-manual <man> [<file>] + Print one help manual and exit. The specified manual is printed in a human-readable text format. |file| -``--help-manual-list [<f>]`` +.. option:: --help-manual-list [<file>] + 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>]`` +.. option:: --help-command <cmd> [<file>] + 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>]`` +.. option:: --help-command-list [<file>] + 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>]`` +.. option:: --help-commands [<file>] + 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>]`` +.. option:: --help-module <mod> [<file>] + 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>]`` +.. option:: --help-module-list [<file>] + 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>]`` +.. option:: --help-modules [<file>] + 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>]`` +.. option:: --help-policy <cmp> [<file>] + 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>]`` +.. option:: --help-policy-list [<file>] + 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>]`` +.. option:: --help-policies [<file>] + 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>]`` +.. option:: --help-property <prop> [<file>] + 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>]`` +.. option:: --help-property-list [<file>] + 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>]`` +.. option:: --help-properties [<file>] + 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>]`` +.. option:: --help-variable <var> [<file>] + 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>]`` +.. option:: --help-variable-list [<file>] + 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>]`` +.. option:: --help-variables [<file>] + Print cmake-variables manual and exit. The :manual:`cmake-variables(7)` manual is printed in a |