summaryrefslogtreecommitdiffstats
path: root/Help/manual/OPTIONS_HELP.txt
blob: baaab0f4d7bcc94a25487be7f86197099d50c55d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
.. |file| replace:: The help is printed to a named <f>ile if given.

* ``--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.

  If a file is specified, the version is written into it.
  |file|

* ``--help-manual <man> [<f>]``: Print one help manual and exit.

  The specified manual is printed in a human-readable text format.
  |file|

* ``--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|

* ``--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|

* ``--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|

* ``--help-commands [<f>]``: 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>]``: 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>]``: 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>]``: 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>]``: 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>]``: 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>]``: 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>]``: 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>]``: 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>]``: 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>]``: 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>]``: 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>]``: Print cmake-variables manual and exit.

  The :manual:`cmake-variables(7)` manual is printed in a
  human-readable text format.
  |file|