Help/manual/OPTIONS_HELP.txt

   1 .. |file| replace:: The help is printed to a named <f>ile if given.
   2
   3 ``--help,-help,-usage,-h,-H,/?``
   4  Print usage information and exit.
   5
   6  Usage describes the basic command line interface and its options.
   7
   8 ``--version,-version,/V [<f>]``
   9  Show program name/version banner and exit.
  10
  11  If a file is specified, the version is written into it.
  12  |file|
  13
  14 ``--help-full [<f>]``
  15  Print all help manuals and exit.
  16
  17  All manuals are printed in a human-readable text format.
  18  |file|
  19
  20 ``--help-manual <man> [<f>]``
  21  Print one help manual and exit.
  22
  23  The specified manual is printed in a human-readable text format.
  24  |file|
  25
  26 ``--help-manual-list [<f>]``
  27  List help manuals available and exit.
  28
  29  The list contains all manuals for which help may be obtained by
  30  using the ``--help-manual`` option followed by a manual name.
  31  |file|
  32
  33 ``--help-command <cmd> [<f>]``
  34  Print help for one command and exit.
  35
  36  The :manual:`cmake-commands(7)` manual entry for ``<cmd>`` is
  37  printed in a human-readable text format.
  38  |file|
  39
  40 ``--help-command-list [<f>]``
  41  List commands with help available and exit.
  42
  43  The list contains all commands for which help may be obtained by
  44  using the ``--help-command`` option followed by a command name.
  45  |file|
  46
  47 ``--help-commands [<f>]``
  48  Print cmake-commands manual and exit.
  49
  50  The :manual:`cmake-commands(7)` manual is printed in a
  51  human-readable text format.
  52  |file|
  53
  54 ``--help-module <mod> [<f>]``
  55  Print help for one module and exit.
  56
  57  The :manual:`cmake-modules(7)` manual entry for ``<mod>`` is printed
  58  in a human-readable text format.
  59  |file|
  60
  61 ``--help-module-list [<f>]``
  62  List modules with help available and exit.
  63
  64  The list contains all modules for which help may be obtained by
  65  using the ``--help-module`` option followed by a module name.
  66  |file|
  67
  68 ``--help-modules [<f>]``
  69  Print cmake-modules manual and exit.
  70
  71  The :manual:`cmake-modules(7)` manual is printed in a human-readable
  72  text format.
  73  |file|
  74
  75 ``--help-policy <cmp> [<f>]``
  76  Print help for one policy and exit.
  77
  78  The :manual:`cmake-policies(7)` manual entry for ``<cmp>`` is
  79  printed in a human-readable text format.
  80  |file|
  81
  82 ``--help-policy-list [<f>]``
  83  List policies with help available and exit.
  84
  85  The list contains all policies for which help may be obtained by
  86  using the ``--help-policy`` option followed by a policy name.
  87  |file|
  88
  89 ``--help-policies [<f>]``
  90  Print cmake-policies manual and exit.
  91
  92  The :manual:`cmake-policies(7)` manual is printed in a
  93  human-readable text format.
  94  |file|
  95
  96 ``--help-property <prop> [<f>]``
  97  Print help for one property and exit.
  98
  99  The :manual:`cmake-properties(7)` manual entries for ``<prop>`` are
 100  printed in a human-readable text format.
 101  |file|
 102
 103 ``--help-property-list [<f>]``
 104  List properties with help available and exit.
 105
 106  The list contains all properties for which help may be obtained by
 107  using the ``--help-property`` option followed by a property name.
 108  |file|
 109
 110 ``--help-properties [<f>]``
 111  Print cmake-properties manual and exit.
 112
 113  The :manual:`cmake-properties(7)` manual is printed in a
 114  human-readable text format.
 115  |file|
 116
 117 ``--help-variable <var> [<f>]``
 118  Print help for one variable and exit.
 119
 120  The :manual:`cmake-variables(7)` manual entry for ``<var>`` is
 121  printed in a human-readable text format.
 122  |file|
 123
 124 ``--help-variable-list [<f>]``
 125  List variables with help available and exit.
 126
 127  The list contains all variables for which help may be obtained by
 128  using the ``--help-variable`` option followed by a variable name.
 129  |file|
 130
 131 ``--help-variables [<f>]``
 132  Print cmake-variables manual and exit.
 133
 134  The :manual:`cmake-variables(7)` manual is printed in a
 135  human-readable text format.
 136  |file|