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>] -B <path-to-build> [-S <path-to-source>]
11          cmake-gui [<options>] <path-to-source | path-to-existing-build>
12          cmake-gui [<options>] --browse-manual [<filename>]
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 [<filename>]
40              Open  the  CMake  reference  manual in a browser and immediately
41              exit. If <filename> is specified, open that file within the ref‐
42              erence manual instead of index.html.
43
44       -version [<file>], --version [<file>], /V [<file>]
45              Show  program  name/version  banner  and  exit.   The  output is
46              printed to a named <file> if given.
47
48       -h, -H, --help, -help, -usage, /?
49              Print usage information and exit.
50
51              Usage describes the basic command line  interface  and  its  op‐
52              tions.
53
54       --help-full [<file>]
55              Print all help manuals and exit.
56
57              All  manuals  are  printed in a human-readable text format.  The
58              output is printed to a named <file> if given.
59
60       --help-manual <man> [<file>]
61              Print one help manual and exit.
62
63              The specified manual is printed in a human-readable text format.
64              The output is printed to a named <file> if given.
65
66       --help-manual-list [<file>]
67              List help manuals available and exit.
68
69              The  list contains all manuals for which help may be obtained by
70              using the --help-manual option followed by a manual  name.   The
71              output is printed to a named <file> if given.
72
73       --help-command <cmd> [<file>]
74              Print help for one command and exit.
75
76              The cmake-commands(7) manual entry for <cmd> is printed in a hu‐
77              man-readable text format.  The output  is  printed  to  a  named
78              <file> if given.
79
80       --help-command-list [<file>]
81              List commands with help available and exit.
82
83              The list contains all commands for which help may be obtained by
84              using the --help-command option followed by a command name.  The
85              output is printed to a named <file> if given.
86
87       --help-commands [<file>]
88              Print cmake-commands manual and exit.
89
90              The cmake-commands(7) manual is printed in a human-readable text
91              format.  The output is printed to a named <file> if given.
92
93       --help-module <mod> [<file>]
94              Print help for one module and exit.
95
96              The cmake-modules(7) manual entry for <mod> is printed in a  hu‐
97              man-readable  text  format.   The  output  is printed to a named
98              <file> if given.
99
100       --help-module-list [<file>]
101              List modules with help available and exit.
102
103              The list contains all modules for which help may be obtained  by
104              using  the  --help-module option followed by a module name.  The
105              output is printed to a named <file> if given.
106
107       --help-modules [<file>]
108              Print cmake-modules manual and exit.
109
110              The cmake-modules(7) manual is printed in a human-readable  text
111              format.  The output is printed to a named <file> if given.
112
113       --help-policy <cmp> [<file>]
114              Print help for one policy and exit.
115
116              The cmake-policies(7) manual entry for <cmp> is printed in a hu‐
117              man-readable text format.  The output  is  printed  to  a  named
118              <file> if given.
119
120       --help-policy-list [<file>]
121              List policies with help available and exit.
122
123              The list contains all policies for which help may be obtained by
124              using the --help-policy option followed by a policy  name.   The
125              output is printed to a named <file> if given.
126
127       --help-policies [<file>]
128              Print cmake-policies manual and exit.
129
130              The cmake-policies(7) manual is printed in a human-readable text
131              format.  The output is printed to a named <file> if given.
132
133       --help-property <prop> [<file>]
134              Print help for one property and exit.
135
136              The cmake-properties(7) manual entries for <prop> are printed in
137              a  human-readable text format.  The output is printed to a named
138              <file> if given.
139
140       --help-property-list [<file>]
141              List properties with help available and exit.
142
143              The list contains all properties for which help may be  obtained
144              by using the --help-property option followed by a property name.
145              The output is printed to a named <file> if given.
146
147       --help-properties [<file>]
148              Print cmake-properties manual and exit.
149
150              The cmake-properties(7) manual is printed  in  a  human-readable
151              text format.  The output is printed to a named <file> if given.
152
153       --help-variable <var> [<file>]
154              Print help for one variable and exit.
155
156              The  cmake-variables(7)  manual  entry for <var> is printed in a
157              human-readable text format.  The output is printed  to  a  named
158              <file> if given.
159
160       --help-variable-list [<file>]
161              List variables with help available and exit.
162
163              The  list  contains all variables for which help may be obtained
164              by using the --help-variable option followed by a variable name.
165              The output is printed to a named <file> if given.
166
167       --help-variables [<file>]
168              Print cmake-variables manual and exit.
169
170              The  cmake-variables(7)  manual  is  printed in a human-readable
171              text format.  The output is printed to a named <file> if given.
172

COPYRIGHT

193       2000-2023 Kitware, Inc. and Contributors
194
195
196
197
1983.27.7                           Oct 07, 2023                     CMAKE-GUI(1)

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

SEE ALSO

COPYRIGHT