diff options
Diffstat (limited to 'Help/manual/OPTIONS_HELP.txt')
-rw-r--r-- | Help/manual/OPTIONS_HELP.txt | 163 |
1 files changed, 91 insertions, 72 deletions
diff --git a/Help/manual/OPTIONS_HELP.txt b/Help/manual/OPTIONS_HELP.txt index baaab0f..631dfef 100644 --- a/Help/manual/OPTIONS_HELP.txt +++ b/Help/manual/OPTIONS_HELP.txt @@ -1,111 +1,130 @@ .. |file| replace:: The help is printed to a named <f>ile if given. -* ``--help,-help,-usage,-h,-H,/?``: Print usage information and exit. +``--help,-help,-usage,-h,-H,/?`` + Print usage information and exit. - Usage describes the basic command line interface and its options. + Usage describes the basic command line interface and its options. -* ``--version,-version,/V [<f>]``: Show program name/version banner and exit. +``--version,-version,/V [<f>]`` + Show program name/version banner and exit. - If a file is specified, the version is written into it. - |file| + If a file is specified, the version is written into it. + |file| -* ``--help-manual <man> [<f>]``: Print one help manual and exit. +``--help-manual <man> [<f>]`` + Print one help manual and exit. - The specified manual is printed in a human-readable text format. - |file| + The specified manual is printed in a human-readable text format. + |file| -* ``--help-manual-list [<f>]``: List help manuals available and exit. +``--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| + 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. +``--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| + 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. +``--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| + 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. +``--help-commands [<f>]`` + Print cmake-commands manual and exit. - The :manual:`cmake-commands(7)` manual is printed in a - human-readable text format. - |file| + 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. +``--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| + 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. +``--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| + 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. +``--help-modules [<f>]`` + Print cmake-modules manual and exit. - The :manual:`cmake-modules(7)` manual is printed in a human-readable - text format. - |file| + 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. +``--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| + 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. +``--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| + 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. +``--help-policies [<f>]`` + Print cmake-policies manual and exit. - The :manual:`cmake-policies(7)` manual is printed in a - human-readable text format. - |file| + 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. +``--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| + 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. +``--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| + 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. +``--help-properties [<f>]`` + Print cmake-properties manual and exit. - The :manual:`cmake-properties(7)` manual is printed in a - human-readable text format. - |file| + 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. +``--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| + 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. +``--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| + 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. +``--help-variables [<f>]`` + Print cmake-variables manual and exit. - The :manual:`cmake-variables(7)` manual is printed in a - human-readable text format. - |file| + The :manual:`cmake-variables(7)` manual is printed in a + human-readable text format. + |file| |