cmake/man/man1/cmake-gui.1

.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "CMAKE-GUI" "1" "Jan 23, 2025" "3.31.5" "CMake"
.SH NAME
cmake-gui \- CMake GUI Command-Line Reference
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
cmake\-gui [<options>]
cmake\-gui [<options>] \-B <path\-to\-build> [\-S <path\-to\-source>]
cmake\-gui [<options>] <path\-to\-source | path\-to\-existing\-build>
cmake\-gui [<options>] \-\-browse\-manual [<filename>]
.ft P
.fi
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
The \fBcmake\-gui\fP executable is the CMake GUI.  Project configuration
settings may be specified interactively.  Brief instructions are
provided at the bottom of the window when the program is running.
.sp
CMake is a cross\-platform build system generator.  Projects specify
their build process with platform\-independent CMake listfiles included
in each directory of a source tree with the name \fBCMakeLists.txt\fP\&.
Users build a project by using CMake to generate a build system for a
native tool on their platform.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-S <path\-to\-source>
Path to root directory of the CMake project to build.
.UNINDENT
.INDENT 0.0
.TP
.B \-B <path\-to\-build>
Path to directory which CMake will use as the root of build directory.
.sp
If the directory doesn\(aqt already exist CMake will make it.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-preset=<preset\-name>
Name of the preset to use from the project\(aqs
\X'tty: link #manual:cmake-presets(7)'\fI\%presets\fP\X'tty: link' files, if it has them.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-browse\-manual [<filename>]
Open the CMake reference manual in a browser and immediately exit. If
\fB<filename>\fP is specified, open that file within the reference manual
instead of \fBindex.html\fP\&.
.UNINDENT
.INDENT 0.0
.TP
.B \-version [<file>], \-\-version [<file>], /V [<file>]
Show program name/version banner and exit.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-h, \-H, \-\-help, \-help, \-usage, /?
Print usage information and exit.
.sp
Usage describes the basic command line interface and its options.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help <keyword> [<file>]
Print help for one CMake keyword.
.sp
\fB<keyword>\fP can be a property, variable, command, policy, generator
or module.
.sp
The relevant manual entry for \fB<keyword>\fP is
printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.sp
Changed in version 3.28: Prior to CMake 3.28, this option supported command names only.

.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-full [<file>]
Print all help manuals and exit.
.sp
All manuals are printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-manual <man> [<file>]
Print one help manual and exit.
.sp
The specified manual is printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-manual\-list [<file>]
List help manuals available and exit.
.sp
The list contains all manuals for which help may be obtained by
using the \fB\-\-help\-manual\fP option followed by a manual name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-command <cmd> [<file>]
Print help for one command and exit.
.sp
The \X'tty: link #manual:cmake-commands(7)'\fI\%cmake\-commands(7)\fP\X'tty: link' manual entry for \fB<cmd>\fP is
printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-command\-list [<file>]
List commands with help available and exit.
.sp
The list contains all commands for which help may be obtained by
using the \fB\-\-help\-command\fP option followed by a command name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-commands [<file>]
Print cmake\-commands manual and exit.
.sp
The \X'tty: link #manual:cmake-commands(7)'\fI\%cmake\-commands(7)\fP\X'tty: link' manual is printed in a
human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-module <mod> [<file>]
Print help for one module and exit.
.sp
The \X'tty: link #manual:cmake-modules(7)'\fI\%cmake\-modules(7)\fP\X'tty: link' manual entry for \fB<mod>\fP is printed
in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-module\-list [<file>]
List modules with help available and exit.
.sp
The list contains all modules for which help may be obtained by
using the \fB\-\-help\-module\fP option followed by a module name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-modules [<file>]
Print cmake\-modules manual and exit.
.sp
The \X'tty: link #manual:cmake-modules(7)'\fI\%cmake\-modules(7)\fP\X'tty: link' manual is printed in a human\-readable
text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-policy <cmp> [<file>]
Print help for one policy and exit.
.sp
The \X'tty: link #manual:cmake-policies(7)'\fI\%cmake\-policies(7)\fP\X'tty: link' manual entry for \fB<cmp>\fP is
printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-policy\-list [<file>]
List policies with help available and exit.
.sp
The list contains all policies for which help may be obtained by
using the \fB\-\-help\-policy\fP option followed by a policy name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-policies [<file>]
Print cmake\-policies manual and exit.
.sp
The \X'tty: link #manual:cmake-policies(7)'\fI\%cmake\-policies(7)\fP\X'tty: link' manual is printed in a
human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-property <prop> [<file>]
Print help for one property and exit.
.sp
The \X'tty: link #manual:cmake-properties(7)'\fI\%cmake\-properties(7)\fP\X'tty: link' manual entries for \fB<prop>\fP are
printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-property\-list [<file>]
List properties with help available and exit.
.sp
The list contains all properties for which help may be obtained by
using the \fB\-\-help\-property\fP option followed by a property name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-properties [<file>]
Print cmake\-properties manual and exit.
.sp
The \X'tty: link #manual:cmake-properties(7)'\fI\%cmake\-properties(7)\fP\X'tty: link' manual is printed in a
human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-variable <var> [<file>]
Print help for one variable and exit.
.sp
The \X'tty: link #manual:cmake-variables(7)'\fI\%cmake\-variables(7)\fP\X'tty: link' manual entry for \fB<var>\fP is
printed in a human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-variable\-list [<file>]
List variables with help available and exit.
.sp
The list contains all variables for which help may be obtained by
using the \fB\-\-help\-variable\fP option followed by a variable name.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-help\-variables [<file>]
Print cmake\-variables manual and exit.
.sp
The \X'tty: link #manual:cmake-variables(7)'\fI\%cmake\-variables(7)\fP\X'tty: link' manual is printed in a
human\-readable text format.
The output is printed to a named \fB<file>\fP if given.
.UNINDENT
.SH SEE ALSO
.sp
The following resources are available to get help using CMake:
.INDENT 0.0
.TP
.B Home Page
\X'tty: link https://cmake.org'\fI\%https://cmake.org\fP\X'tty: link'
.sp
The primary starting point for learning about CMake.
.TP
.B Online Documentation and Community Resources
\X'tty: link https://cmake.org/documentation'\fI\%https://cmake.org/documentation\fP\X'tty: link'
.sp
Links to available documentation and community resources may be
found on this web page.
.TP
.B Discourse Forum
\X'tty: link https://discourse.cmake.org'\fI\%https://discourse.cmake.org\fP\X'tty: link'
.sp
The Discourse Forum hosts discussion and questions about CMake.
.UNINDENT
.SH COPYRIGHT
2000-2024 Kitware, Inc. and Contributors
.\" Generated by docutils manpage writer.
.