1CMAKE-GUI(1) CMake CMAKE-GUI(1)
2
6 cmake-gui - CMake GUI Command-Line Reference
7
9 cmake-gui [<options>]
10 cmake-gui [<options>] (<path-to-source> | <path-to-existing-build>)
11
13 The “cmake-gui” executable is the CMake GUI. Project configuration
14 settings may be specified interactively. Brief instructions are pro‐
15 vided at the bottom of the window when the program is running.
16 CMake is a cross-platform build system generator. Projects specify
18 their build process with platform-independent CMake listfiles included
19 in each directory of a source tree with the name CMakeLists.txt. Users
20 build a project by using CMake to generate a build system for a native
21 tool on their platform.
22
24 --help,-help,-usage,-h,-H,/?
25 Print usage information and exit.
26 Usage describes the basic command line interface and its
28 options.
29 --version,-version,/V [<f>]
31 Show program name/version banner and exit.
32 If a file is specified, the version is written into it. The
34 help is printed to a named <f>ile if given.
35 --help-full [<f>]
37 Print all help manuals and exit.
38 All manuals are printed in a human-readable text format. The
40 help is printed to a named <f>ile if given.
41 --help-manual <man> [<f>]
43 Print one help manual and exit.
44 The specified manual is printed in a human-readable text format.
46 The help is printed to a named <f>ile if given.
47 --help-manual-list [<f>]
49 List help manuals available and exit.
50 The list contains all manuals for which help may be obtained by
52 using the --help-manual option followed by a manual name. The
53 help is printed to a named <f>ile if given.
54 --help-command <cmd> [<f>]
56 Print help for one command and exit.
57 The cmake-commands(7) manual entry for <cmd> is printed in a
59 human-readable text format. The help is printed to a named
60 <f>ile if given.
61 --help-command-list [<f>]
63 List commands with help available and exit.
64 The list contains all commands for which help may be obtained by
66 using the --help-command option followed by a command name. The
67 help is printed to a named <f>ile if given.
68 --help-commands [<f>]
70 Print cmake-commands manual and exit.
71 The cmake-commands(7) manual is printed in a human-readable text
73 format. The help is printed to a named <f>ile if given.
74 --help-module <mod> [<f>]
76 Print help for one module and exit.
77 The cmake-modules(7) manual entry for <mod> is printed in a
79 human-readable text format. The help is printed to a named
80 <f>ile if given.
81 --help-module-list [<f>]
83 List modules with help available and exit.
84 The list contains all modules for which help may be obtained by
86 using the --help-module option followed by a module name. The
87 help is printed to a named <f>ile if given.
88 --help-modules [<f>]
90 Print cmake-modules manual and exit.
91 The cmake-modules(7) manual is printed in a human-readable text
93 format. The help is printed to a named <f>ile if given.
94 --help-policy <cmp> [<f>]
96 Print help for one policy and exit.
97 The cmake-policies(7) manual entry for <cmp> is printed in a
99 human-readable text format. The help is printed to a named
100 <f>ile if given.
101 --help-policy-list [<f>]
103 List policies with help available and exit.
104 The list contains all policies for which help may be obtained by
106 using the --help-policy option followed by a policy name. The
107 help is printed to a named <f>ile if given.
108 --help-policies [<f>]
110 Print cmake-policies manual and exit.
111 The cmake-policies(7) manual is printed in a human-readable text
113 format. The help is printed to a named <f>ile if given.
114 --help-property <prop> [<f>]
116 Print help for one property and exit.
117 The cmake-properties(7) manual entries for <prop> are printed in
119 a human-readable text format. The help is printed to a named
120 <f>ile if given.
121 --help-property-list [<f>]
123 List properties with help available and exit.
124 The list contains all properties for which help may be obtained
126 by using the --help-property option followed by a property name.
127 The help is printed to a named <f>ile if given.
128 --help-properties [<f>]
130 Print cmake-properties manual and exit.
131 The cmake-properties(7) manual is printed in a human-readable
133 text format. The help is printed to a named <f>ile if given.
134 --help-variable <var> [<f>]
136 Print help for one variable and exit.
137 The cmake-variables(7) manual entry for <var> is printed in a
139 human-readable text format. The help is printed to a named
140 <f>ile if given.
141 --help-variable-list [<f>]
143 List variables with help available and exit.
144 The list contains all variables for which help may be obtained
146 by using the --help-variable option followed by a variable name.
147 The help is printed to a named <f>ile if given.
148 --help-variables [<f>]
150 Print cmake-variables manual and exit.
151 The cmake-variables(7) manual is printed in a human-readable
153 text format. The help is printed to a named <f>ile if given.
154
156 The following resources are available to get help using CMake:
157 Home Page
159 https://cmake.org
160 The primary starting point for learning about CMake.
162 Frequently Asked Questions
164 https://cmake.org/Wiki/CMake_FAQ
165 A Wiki is provided containing answers to frequently asked ques‐
167 tions.
168 Online Documentation
170 https://cmake.org/documentation
171 Links to available documentation may be found on this web page.
173 Mailing List
175 https://cmake.org/mailing-lists
176 For help and discussion about using cmake, a mailing list is
178 provided at cmake@cmake.org. The list is member-post-only but
179 one may sign up on the CMake web page. Please first read the
180 full documentation at https://cmake.org before posting questions
181 to the list.
182
184 2000-2018 Kitware, Inc. and Contributors
1853.11.4 May 13, 2019 CMAKE-GUI(1)