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

DESCRIPTION

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

OPTIONS

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

SEE ALSO

166       The following resources are available to get help using CMake:
167
168       Home Page
169              https://cmake.org
170
171              The primary starting point for learning about CMake.
172
173       Online Documentation and Community Resources
174              https://cmake.org/documentation
175
176              Links  to available documentation and community resources may be
177              found on this web page.
178
179       Mailing List
180              https://cmake.org/mailing-lists
181
182              For help and discussion about using cmake,  a  mailing  list  is
183              provided  at  cmake@cmake.org.  The list is member-post-only but
184              one may sign up on the CMake web page.  Please  first  read  the
185              full documentation at https://cmake.org before posting questions
186              to the list.
187
189       2000-2019 Kitware, Inc. and Contributors
190
191
192
193
1943.14.5                           Jun 01, 2019                     CMAKE-GUI(1)
Impressum