Help/manual/OPTIONS_HELP.txt

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