cmake-gui(1)

1CMAKE-GUI(1)                         CMake                        CMAKE-GUI(1)
2
3
4

NAME

6       cmake-gui - CMake GUI Command-Line Reference
7

SYNOPSIS

9          cmake-gui [<options>]
10          cmake-gui [<options>] {<path-to-source> | <path-to-existing-build>}
11          cmake-gui [<options>] -S <path-to-source> -B <path-to-build>
12          cmake-gui [<options>] --browse-manual
13

DESCRIPTION

15       The  cmake-gui executable is the CMake GUI.  Project configuration set‐
16       tings may be specified interactively.  Brief instructions are  provided
17       at the bottom of the window when the program is running.
18
19       CMake  is  a  cross-platform  build system generator.  Projects specify
20       their build process with platform-independent CMake listfiles  included
21       in each directory of a source tree with the name CMakeLists.txt.  Users
22       build a project by using CMake to generate a build system for a  native
23       tool on their platform.
24

OPTIONS

26       -S <path-to-source>
27              Path to root directory of the CMake project to build.
28
29       -B <path-to-build>
30              Path  to directory which CMake will use as the root of build di‐
31              rectory.
32
33              If the directory doesn't already exist CMake will make it.
34
35       --preset=<preset-name>
36              Name of the preset to use from the project's presets  files,  if
37              it has them.
38
39       --browse-manual
40              Open  the  CMake  reference  manual in a browser and immediately
41              exit.
42
43       --help,-help,-usage,-h,-H,/?
44              Print usage information and exit.
45
46              Usage describes the basic command line  interface  and  its  op‐
47              tions.
48
49       --version,-version,/V [<f>]
50              Show program name/version banner and exit.
51
52              If  a  file  is  specified, the version is written into it.  The
53              help is printed to a named <f>ile if given.
54
55       --help-full [<f>]
56              Print all help manuals and exit.
57
58              All manuals are printed in a human-readable  text  format.   The
59              help is printed to a named <f>ile if given.
60
61       --help-manual <man> [<f>]
62              Print one help manual and exit.
63
64              The specified manual is printed in a human-readable text format.
65              The help is printed to a named <f>ile if given.
66
67       --help-manual-list [<f>]
68              List help manuals available and exit.
69
70              The list contains all manuals for which help may be obtained  by
71              using  the  --help-manual option followed by a manual name.  The
72              help is printed to a named <f>ile if given.
73
74       --help-command <cmd> [<f>]
75              Print help for one command and exit.
76
77              The cmake-commands(7) manual entry for <cmd> is printed in a hu‐
78              man-readable text format.  The help is printed to a named <f>ile
79              if given.
80
81       --help-command-list [<f>]
82              List commands with help available and exit.
83
84              The list contains all commands for which help may be obtained by
85              using the --help-command option followed by a command name.  The
86              help is printed to a named <f>ile if given.
87
88       --help-commands [<f>]
89              Print cmake-commands manual and exit.
90
91              The cmake-commands(7) manual is printed in a human-readable text
92              format.  The help is printed to a named <f>ile if given.
93
94       --help-module <mod> [<f>]
95              Print help for one module and exit.
96
97              The  cmake-modules(7) manual entry for <mod> is printed in a hu‐
98              man-readable text format.  The help is printed to a named <f>ile
99              if given.
100
101       --help-module-list [<f>]
102              List modules with help available and exit.
103
104              The  list contains all modules for which help may be obtained by
105              using the --help-module option followed by a module  name.   The
106              help is printed to a named <f>ile if given.
107
108       --help-modules [<f>]
109              Print cmake-modules manual and exit.
110
111              The  cmake-modules(7) manual is printed in a human-readable text
112              format.  The help is printed to a named <f>ile if given.
113
114       --help-policy <cmp> [<f>]
115              Print help for one policy and exit.
116
117              The cmake-policies(7) manual entry for <cmp> is printed in a hu‐
118              man-readable text format.  The help is printed to a named <f>ile
119              if given.
120
121       --help-policy-list [<f>]
122              List policies with help available and exit.
123
124              The list contains all policies for which help may be obtained by
125              using  the  --help-policy option followed by a policy name.  The
126              help is printed to a named <f>ile if given.
127
128       --help-policies [<f>]
129              Print cmake-policies manual and exit.
130
131              The cmake-policies(7) manual is printed in a human-readable text
132              format.  The help is printed to a named <f>ile if given.
133
134       --help-property <prop> [<f>]
135              Print help for one property and exit.
136
137              The cmake-properties(7) manual entries for <prop> are printed in
138              a human-readable text format.  The help is printed  to  a  named
139              <f>ile if given.
140
141       --help-property-list [<f>]
142              List properties with help available and exit.
143
144              The  list contains all properties for which help may be obtained
145              by using the --help-property option followed by a property name.
146              The help is printed to a named <f>ile if given.
147
148       --help-properties [<f>]
149              Print cmake-properties manual and exit.
150
151              The  cmake-properties(7)  manual  is printed in a human-readable
152              text format.  The help is printed to a named <f>ile if given.
153
154       --help-variable <var> [<f>]
155              Print help for one variable and exit.
156
157              The cmake-variables(7) manual entry for <var> is  printed  in  a
158              human-readable  text  format.   The  help  is printed to a named
159              <f>ile if given.
160
161       --help-variable-list [<f>]
162              List variables with help available and exit.
163
164              The list contains all variables for which help may  be  obtained
165              by using the --help-variable option followed by a variable name.
166              The help is printed to a named <f>ile if given.
167
168       --help-variables [<f>]
169              Print cmake-variables manual and exit.
170
171              The cmake-variables(7) manual is  printed  in  a  human-readable
172              text format.  The help is printed to a named <f>ile if given.
173

COPYRIGHT

194       2000-2021 Kitware, Inc. and Contributors
195
196
197
198
1993.22.0                           Dec 02, 2021                     CMAKE-GUI(1)

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

SEE ALSO

COPYRIGHT