Add files using upload-large-folder tool

cmake/man/man1/ccmake.1

@@ -0,0 +1,476 @@
+.\" 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 "CCMAKE" "1" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+ccmake \- CMake Curses Dialog Command-Line Reference
+.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+ccmake [<options>] \-B <path\-to\-build> [\-S <path\-to\-source>]
+ccmake [<options>] <path\-to\-source | path\-to\-existing\-build>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH DESCRIPTION
+.sp
+The \fBccmake\fP executable is the CMake curses interface.  Project
+configuration settings may be specified interactively through this
+GUI.  Brief instructions are provided at the bottom of the terminal
+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 \-C <initial\-cache>
+Pre\-load a script to populate the cache.
+.sp
+When CMake is first run in an empty build tree, it creates a
+\fBCMakeCache.txt\fP file and populates it with customizable settings for
+the project.  This option may be used to specify a file from which
+to load cache entries before the first pass through the project\(aqs
+CMake listfiles.  The loaded entries take priority over the
+project\(aqs default values.  The given file should be a CMake script
+containing \X'tty: link #command:set'\fI\%set()\fP\X'tty: link' commands that use the \fBCACHE\fP option, not a
+cache\-format file.
+.sp
+References to \X'tty: link #variable:CMAKE_SOURCE_DIR'\fI\%CMAKE_SOURCE_DIR\fP\X'tty: link' and \X'tty: link #variable:CMAKE_BINARY_DIR'\fI\%CMAKE_BINARY_DIR\fP\X'tty: link'
+within the script evaluate to the top\-level source and build tree.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-D <var>:<type>=<value>, \-D <var>=<value>
+Create or update a CMake \fBCACHE\fP entry.
+.sp
+When CMake is first run in an empty build tree, it creates a
+\fBCMakeCache.txt\fP file and populates it with customizable settings for
+the project.  This option may be used to specify a setting that
+takes priority over the project\(aqs default value.  The option may be
+repeated for as many \fBCACHE\fP entries as desired.
+.sp
+If the \fB:<type>\fP portion is given it must be one of the types
+specified by the \X'tty: link #command:set'\fI\%set()\fP\X'tty: link' command documentation for its
+\fBCACHE\fP signature.
+If the \fB:<type>\fP portion is omitted the entry will be created
+with no type if it does not exist with a type already.  If a
+command in the project sets the type to \fBPATH\fP or \fBFILEPATH\fP
+then the \fB<value>\fP will be converted to an absolute path.
+.sp
+This option may also be given as a single argument:
+\fB\-D<var>:<type>=<value>\fP or \fB\-D<var>=<value>\fP\&.
+.sp
+It\(aqs important to note that the order of \fB\-C\fP and \fB\-D\fP arguments is
+significant. They will be carried out in the order they are listed, with the
+last argument taking precedence over the previous ones. For example, if you
+specify \fB\-DCMAKE_BUILD_TYPE=Debug\fP, followed by a \fB\-C\fP argument with a
+file that calls:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_BUILD_TYPE \(dqRelease\(dq CACHE STRING \(dq\(dq FORCE)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+then the \fB\-C\fP argument will take precedence, and \fBCMAKE_BUILD_TYPE\fP will
+be set to \fBRelease\fP\&. However, if the \fB\-D\fP argument comes after the \fB\-C\fP
+argument, it will be set to \fBDebug\fP\&.
+.sp
+If a \fBset(... CACHE ...)\fP call in the \fB\-C\fP file does not use \fBFORCE\fP,
+and a \fB\-D\fP argument sets the same variable, the \fB\-D\fP argument will take
+precedence regardless of order because of the nature of non\-\fBFORCE\fP
+\fBset(... CACHE ...)\fP calls.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-U <globbing_expr>
+Remove matching entries from CMake \fBCACHE\fP\&.
+.sp
+This option may be used to remove one or more variables from the
+\fBCMakeCache.txt\fP file, globbing expressions using \fB*\fP and \fB?\fP are
+supported.  The option may be repeated for as many \fBCACHE\fP entries as
+desired.
+.sp
+Use with care, you can make your \fBCMakeCache.txt\fP non\-working.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-G <generator\-name>
+Specify a build system generator.
+.sp
+CMake may support multiple native build systems on certain
+platforms.  A generator is responsible for generating a particular
+build system.  Possible generator names are specified in the
+\X'tty: link #manual:cmake-generators(7)'\fI\%cmake\-generators(7)\fP\X'tty: link' manual.
+.sp
+If not specified, CMake checks the \X'tty: link #envvar:CMAKE_GENERATOR'\fI\%CMAKE_GENERATOR\fP\X'tty: link' environment
+variable and otherwise falls back to a builtin default selection.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-T <toolset\-spec>
+Toolset specification for the generator, if supported.
+.sp
+Some CMake generators support a toolset specification to tell
+the native build system how to choose a compiler.  See the
+\X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' variable for details.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-A <platform\-name>
+Specify platform name if supported by generator.
+.sp
+Some CMake generators support a platform name to be given to the
+native build system to choose a compiler or SDK.  See the
+\X'tty: link #variable:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link' variable for details.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-toolchain <path\-to\-file>
+Added in version 3.21.
+
+.sp
+Specify the cross compiling toolchain file, equivalent to setting
+\X'tty: link #variable:CMAKE_TOOLCHAIN_FILE'\fI\%CMAKE_TOOLCHAIN_FILE\fP\X'tty: link' variable. Relative paths are interpreted as
+relative to the build directory, and if not found, relative to the source
+directory.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-install\-prefix <directory>
+Added in version 3.21.
+
+.sp
+Specify the installation directory, used by the
+\X'tty: link #variable:CMAKE_INSTALL_PREFIX'\fI\%CMAKE_INSTALL_PREFIX\fP\X'tty: link' variable. Must be an absolute path.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-Wno\-dev
+Suppress developer warnings.
+.sp
+Suppress warnings that are meant for the author of the
+\fBCMakeLists.txt\fP files. By default this will also turn off
+deprecation warnings.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-Wdev
+Enable developer warnings.
+.sp
+Enable warnings that are meant for the author of the \fBCMakeLists.txt\fP
+files. By default this will also turn on deprecation warnings.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-Wdeprecated
+Enable deprecated functionality warnings.
+.sp
+Enable warnings for usage of deprecated functionality, that are meant
+for the author of the \fBCMakeLists.txt\fP files.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-Wno\-deprecated
+Suppress deprecated functionality warnings.
+.sp
+Suppress warnings for usage of deprecated functionality, that are meant
+for the author of the \fBCMakeLists.txt\fP files.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-Werror=<what>
+Treat CMake warnings as errors. \fB<what>\fP must be one of the following:
+.INDENT 7.0
+.TP
+.B \fBdev\fP
+Make developer warnings errors.
+.sp
+Make warnings that are meant for the author of the \fBCMakeLists.txt\fP files
+errors. By default this will also turn on deprecated warnings as errors.
+.TP
+.B \fBdeprecated\fP
+Make deprecated macro and function warnings errors.
+.sp
+Make warnings for usage of deprecated macros and functions, that are meant
+for the author of the \fBCMakeLists.txt\fP files, errors.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-Wno\-error=<what>
+Do not treat CMake warnings as errors. \fB<what>\fP must be one of the following:
+.INDENT 7.0
+.TP
+.B \fBdev\fP
+Make warnings that are meant for the author of the \fBCMakeLists.txt\fP files not
+errors. By default this will also turn off deprecated warnings as errors.
+.TP
+.B \fBdeprecated\fP
+Make warnings for usage of deprecated macros and functions, that are meant
+for the author of the \fBCMakeLists.txt\fP files, not errors.
+.UNINDENT
+.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.
+.

cmake/man/man1/cmake-gui.1

@@ -0,0 +1,296 @@
+.\" 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 10, 2025" "3.31.4" "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.
+.

cmake/man/man1/cpack.1

@@ -0,0 +1,380 @@
+.\" 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 "CPACK" "1" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cpack \- CPack Command-Line Reference
+.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+cpack [<options>]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH DESCRIPTION
+.sp
+The \fBcpack\fP executable is the CMake packaging program.  It generates
+installers and source packages in a variety of formats.
+.sp
+For each installer or package format, \fBcpack\fP has a specific backend,
+called \(dqgenerator\(dq. A generator is responsible for generating the required
+inputs and invoking the specific package creation tools. These installer
+or package generators are not to be confused with the makefile generators
+of the \X'tty: link #manual:cmake(1)'\fI\%cmake\fP\X'tty: link' command.
+.sp
+All supported generators are specified in the \X'tty: link #manual:cpack-generators(7)'\fI\%cpack\-generators\fP\X'tty: link' manual.  The command \fBcpack \-\-help\fP prints a
+list of generators supported for the target platform.  Which of them are
+to be used can be selected through the \X'tty: link #variable:CPACK_GENERATOR'\fI\%CPACK_GENERATOR\fP\X'tty: link' variable
+or through the command\-line option \fI\%\-G\fP\&.
+.sp
+The \fBcpack\fP program is steered by a configuration file written in the
+\X'tty: link #manual:cmake-language(7)'\fI\%CMake language\fP\X'tty: link'\&. Unless chosen differently
+through the command\-line option \fI\%\-\-config\fP, the
+file \fBCPackConfig.cmake\fP in the current directory is used.
+.sp
+In the standard CMake workflow, the file \fBCPackConfig.cmake\fP is generated
+by the \X'tty: link #manual:cmake(1)'\fI\%cmake\fP\X'tty: link' executable, provided the \X'tty: link #module:CPack'\fI\%CPack\fP\X'tty: link'
+module is included by the project\(aqs \fBCMakeLists.txt\fP file.
+.SH OPTIONS
+.INDENT 0.0
+.TP
+.B \-G <generators>
+\fB<generators>\fP is a \X'tty: link #cmake-language-lists'\fI\%semicolon\-separated list\fP\X'tty: link'
+of generator names.  \fBcpack\fP will iterate through this list and produce
+package(s) in that generator\(aqs format according to the details provided in
+the \fBCPackConfig.cmake\fP configuration file.  If this option is not given,
+the \X'tty: link #variable:CPACK_GENERATOR'\fI\%CPACK_GENERATOR\fP\X'tty: link' variable determines the default set of
+generators that will be used.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-C <configs>
+Specify the project configuration(s) to be packaged (e.g. \fBDebug\fP,
+\fBRelease\fP, etc.), where \fB<configs>\fP is a
+\X'tty: link #cmake-language-lists'\fI\%semicolon\-separated list\fP\X'tty: link'\&.
+When the CMake project uses a multi\-configuration
+generator such as Xcode or Visual Studio, this option is needed to tell
+\fBcpack\fP which built executables to include in the package.
+The user is responsible for ensuring that the configuration(s) listed
+have already been built before invoking \fBcpack\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-D <var>=<value>
+Set a CPack variable.  This will override any value set for \fB<var>\fP in the
+input file read by \fBcpack\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-config <configFile>
+Specify the configuration file read by \fBcpack\fP to provide the packaging
+details.  By default, \fBCPackConfig.cmake\fP in the current directory will
+be used.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-V, \-\-verbose
+Run \fBcpack\fP with verbose output.  This can be used to show more details
+from the package generation tools and is suitable for project developers.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-debug
+Run \fBcpack\fP with debug output.  This option is intended mainly for the
+developers of \fBcpack\fP itself and is not normally needed by project
+developers.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-trace
+Put the underlying cmake scripts in trace mode.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-trace\-expand
+Put the underlying cmake scripts in expanded trace mode.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-P <packageName>
+Override/define the value of the \X'tty: link #variable:CPACK_PACKAGE_NAME'\fI\%CPACK_PACKAGE_NAME\fP\X'tty: link' variable used
+for packaging.  Any value set for this variable in the \fBCPackConfig.cmake\fP
+file will then be ignored.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-R <packageVersion>
+Override/define the value of the \X'tty: link #variable:CPACK_PACKAGE_VERSION'\fI\%CPACK_PACKAGE_VERSION\fP\X'tty: link'
+variable used for packaging.  It will override a value set in the
+\fBCPackConfig.cmake\fP file or one automatically computed from
+\X'tty: link #variable:CPACK_PACKAGE_VERSION_MAJOR'\fI\%CPACK_PACKAGE_VERSION_MAJOR\fP\X'tty: link',
+\X'tty: link #variable:CPACK_PACKAGE_VERSION_MINOR'\fI\%CPACK_PACKAGE_VERSION_MINOR\fP\X'tty: link' and
+\X'tty: link #variable:CPACK_PACKAGE_VERSION_PATCH'\fI\%CPACK_PACKAGE_VERSION_PATCH\fP\X'tty: link'\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-B <packageDirectory>
+Override/define \X'tty: link #variable:CPACK_PACKAGE_DIRECTORY'\fI\%CPACK_PACKAGE_DIRECTORY\fP\X'tty: link', which controls the
+directory where CPack will perform its packaging work.  The resultant
+package(s) will be created at this location by default and a
+\fB_CPack_Packages\fP subdirectory will also be created below this directory to
+use as a working area during package creation.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-vendor <vendorName>
+Override/define \X'tty: link #variable:CPACK_PACKAGE_VENDOR'\fI\%CPACK_PACKAGE_VENDOR\fP\X'tty: link'\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-preset <presetName>
+Use a preset from \X'tty: link #manual:cmake-presets(7)'\fI\%cmake\-presets(7)\fP\X'tty: link'\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-list\-presets
+List presets from \X'tty: link #manual:cmake-presets(7)'\fI\%cmake\-presets(7)\fP\X'tty: link'\&.
+.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.
+.

cmake/man/man1/ctest.1

@@ -0,0 +1,2609 @@
+.\" 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 "CTEST" "1" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+ctest \- CTest Command-Line Reference
+.SS Contents
+.INDENT 0.0
+.IP \(bu 2
+\fI\%ctest(1)\fP
+.INDENT 2.0
+.IP \(bu 2
+\fI\%Synopsis\fP
+.IP \(bu 2
+\fI\%Description\fP
+.IP \(bu 2
+\fI\%Run Tests\fP
+.IP \(bu 2
+\fI\%View Help\fP
+.IP \(bu 2
+\fI\%Label Matching\fP
+.IP \(bu 2
+\fI\%Label and Subproject Summary\fP
+.IP \(bu 2
+\fI\%Build and Test Mode\fP
+.IP \(bu 2
+\fI\%Dashboard Client\fP
+.INDENT 2.0
+.IP \(bu 2
+\fI\%Dashboard Client Steps\fP
+.IP \(bu 2
+\fI\%Dashboard Client Modes\fP
+.IP \(bu 2
+\fI\%Dashboard Client via CTest Command\-Line\fP
+.IP \(bu 2
+\fI\%Dashboard Client via CTest Script\fP
+.UNINDENT
+.IP \(bu 2
+\fI\%Dashboard Client Configuration\fP
+.INDENT 2.0
+.IP \(bu 2
+\fI\%CTest Start Step\fP
+.IP \(bu 2
+\fI\%CTest Update Step\fP
+.IP \(bu 2
+\fI\%CTest Configure Step\fP
+.IP \(bu 2
+\fI\%CTest Build Step\fP
+.IP \(bu 2
+\fI\%CTest Test Step\fP
+.IP \(bu 2
+\fI\%CTest Coverage Step\fP
+.IP \(bu 2
+\fI\%CTest MemCheck Step\fP
+.IP \(bu 2
+\fI\%CTest Submit Step\fP
+.UNINDENT
+.IP \(bu 2
+\fI\%Show as JSON Object Model\fP
+.IP \(bu 2
+\fI\%Resource Allocation\fP
+.INDENT 2.0
+.IP \(bu 2
+\fI\%Resource Specification File\fP
+.IP \(bu 2
+\fI\%RESOURCE_GROUPS Property\fP
+.IP \(bu 2
+\fI\%Environment Variables\fP
+.IP \(bu 2
+\fI\%Dynamically\-Generated Resource Specification File\fP
+.UNINDENT
+.IP \(bu 2
+\fI\%Job Server Integration\fP
+.IP \(bu 2
+\fI\%See Also\fP
+.UNINDENT
+.UNINDENT
+.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+\fI\%Run Tests\fP
+ ctest [<options>] [\-\-test\-dir <path\-to\-build>]
+
+\fI\%Build and Test Mode\fP
+ ctest \-\-build\-and\-test <path\-to\-source> <path\-to\-build>
+       \-\-build\-generator <generator> [<options>...]
+      [\-\-build\-options <opts>...]
+      [\-\-test\-command <command> [<args>...]]
+
+\fI\%Dashboard Client\fP
+ ctest \-D <dashboard>         [\-\- <dashboard\-options>...]
+ ctest \-M <model> \-T <action> [\-\- <dashboard\-options>...]
+ ctest \-S <script>            [\-\- <dashboard\-options>...]
+ ctest \-SP <script>           [\-\- <dashboard\-options>...]
+
+\fI\%View Help\fP
+ ctest \-\-help[\-<topic>]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH DESCRIPTION
+.sp
+The \fBctest\fP executable is the CMake test driver program.
+CMake\-generated build trees created for projects that use the
+\X'tty: link #command:enable_testing'\fI\%enable_testing()\fP\X'tty: link' and \X'tty: link #command:add_test'\fI\%add_test()\fP\X'tty: link' commands have testing support.
+This program will run the tests and report results.
+.SH RUN TESTS
+.INDENT 0.0
+.TP
+.B \-\-preset <preset>, \-\-preset=<preset>
+Use a test preset to specify test options. The project binary directory
+is inferred from the \fBconfigurePreset\fP key. The current working directory
+must contain CMake preset files.
+See \X'tty: link #manual:cmake-presets(7)'\fI\%preset\fP\X'tty: link' for more details.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-list\-presets
+Lists the available test presets. The current working directory must contain
+CMake preset files.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-C <cfg>, \-\-build\-config <cfg>
+Choose configuration to test.
+.sp
+Some CMake\-generated build trees can have multiple build
+configurations in the same tree.  This option can be used to specify
+which one should be tested.  Example configurations are \fBDebug\fP and
+\fBRelease\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-progress
+Enable short progress output from tests.
+.sp
+When the output of \fBctest\fP is being sent directly to a terminal, the
+progress through the set of tests is reported by updating the same line
+rather than printing start and end messages for each test on new lines.
+This can significantly reduce the verbosity of the test output.
+Test completion messages are still output on their own line for failed
+tests and the final test summary will also still be logged.
+.sp
+This option can also be enabled by setting the environment variable
+\X'tty: link #envvar:CTEST_PROGRESS_OUTPUT'\fI\%CTEST_PROGRESS_OUTPUT\fP\X'tty: link'\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-V, \-\-verbose
+Enable verbose output from tests.
+.sp
+Test output is normally suppressed and only summary information is
+displayed.  This option will show all test output.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-VV, \-\-extra\-verbose
+Enable more verbose output from tests.
+.sp
+Test output is normally suppressed and only summary information is
+displayed.  This option will show even more test output.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-debug
+Displaying more verbose internals of CTest.
+.sp
+This feature will result in a large number of output that is mostly
+useful for debugging dashboard problems.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-output\-on\-failure
+Output anything outputted by the test program if the test should fail.
+This option can also be enabled by setting the
+\X'tty: link #envvar:CTEST_OUTPUT_ON_FAILURE'\fI\%CTEST_OUTPUT_ON_FAILURE\fP\X'tty: link' environment variable
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-stop\-on\-failure
+Stop running the tests when the first failure happens.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-F
+Enable failover.
+.sp
+This option allows CTest to resume a test set execution that was
+previously interrupted.  If no interruption occurred, the \fB\-F\fP option
+will have no effect.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-j [<level>], \-\-parallel [<level>]
+Run tests in parallel, optionally limited to a given level of parallelism.
+.sp
+Added in version 3.29: The \fB<level>\fP may be omitted, or \fB0\fP, in which case:
+.INDENT 7.0
+.IP \(bu 2
+Under \fI\%Job Server Integration\fP, parallelism is limited by
+available job tokens.
+.IP \(bu 2
+Otherwise, if the value is omitted, parallelism is limited
+by the number of processors, or 2, whichever is larger.
+.IP \(bu 2
+Otherwise, if the value is \fB0\fP, parallelism is unbounded.
+.UNINDENT
+
+.sp
+This option may instead be specified by the \X'tty: link #envvar:CTEST_PARALLEL_LEVEL'\fI\%CTEST_PARALLEL_LEVEL\fP\X'tty: link'
+environment variable.
+.sp
+This option can be used with the \X'tty: link #prop_test:PROCESSORS'\fI\%PROCESSORS\fP\X'tty: link' test property.
+See the \fI\%Label and Subproject Summary\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-resource\-spec\-file <file>
+Run CTest with \fI\%resource allocation\fP enabled,
+using the
+\fI\%resource specification file\fP
+specified in \fB<file>\fP\&.
+.sp
+When \fBctest\fP is run as a \fI\%Dashboard Client\fP this sets the
+\fBResourceSpecFile\fP option of the \fI\%CTest Test Step\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-test\-load <level>
+While running tests in parallel (e.g. with \fI\%\-j\fP), try
+not to start tests when they may cause the CPU load to pass above a given
+threshold.
+.sp
+When \fBctest\fP is run as a \fI\%Dashboard Client\fP this sets the
+\fBTestLoad\fP option of the \fI\%CTest Test Step\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-Q, \-\-quiet
+Make CTest quiet.
+.sp
+This option will suppress all the output.  The output log file will
+still be generated if the \fI\%\-\-output\-log\fP is
+specified.  Options such as \fI\%\-\-verbose\fP,
+\fI\%\-\-extra\-verbose\fP, and
+\fI\%\-\-debug\fP are ignored
+if \fB\-\-quiet\fP is specified.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-O <file>, \-\-output\-log <file>
+Output to log file.
+.sp
+This option tells CTest to write all its output to a \fB<file>\fP log file.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-output\-junit <file>
+Added in version 3.21.
+
+.sp
+Write test results in JUnit format.
+.sp
+This option tells CTest to write test results to \fB<file>\fP in JUnit XML
+format. If \fB<file>\fP already exists, it will be overwritten. If using the
+\fI\%\-S\fP option to run a dashboard script, use the
+\fBOUTPUT_JUNIT\fP keyword with the \X'tty: link #command:ctest_test'\fI\%ctest_test()\fP\X'tty: link' command instead.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-N, \-\-show\-only[=<format>]
+Disable actual execution of tests.
+.sp
+This option tells CTest to list the tests that would be run but not
+actually run them.  Useful in conjunction with the \fI\%\-R\fP
+and \fI\%\-E\fP options.
+.sp
+Added in version 3.14: The \fB\-\-show\-only\fP option accepts a \fB<format>\fP value.
+
+.sp
+\fB<format>\fP can be one of the following values.
+.INDENT 7.0
+.INDENT 3.5
+.INDENT 0.0
+.TP
+.B \fBhuman\fP
+Human\-friendly output.  This is not guaranteed to be stable.
+This is the default.
+.TP
+.B \fBjson\-v1\fP
+Dump the test information in JSON format.
+See \fI\%Show as JSON Object Model\fP\&.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-L <regex>, \-\-label\-regex <regex>
+Run tests with labels matching regular expression as described under
+\X'tty: link #regex-specification'\fI\%string(REGEX)\fP\X'tty: link'\&.
+.sp
+This option tells CTest to run only the tests whose labels match the
+given regular expression.  When more than one \fB\-L\fP option is given,
+a test will only be run if each regular expression matches at least one
+of the test\(aqs labels (i.e. the multiple \fB\-L\fP labels form an \fBAND\fP
+relationship).  See \fI\%Label Matching\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-R <regex>, \-\-tests\-regex <regex>
+Run tests matching regular expression.
+.sp
+This option tells CTest to run only the tests whose names match the
+given regular expression.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-E <regex>, \-\-exclude\-regex <regex>
+Exclude tests matching regular expression.
+.sp
+This option tells CTest to NOT run the tests whose names match the
+given regular expression.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-LE <regex>, \-\-label\-exclude <regex>
+Exclude tests with labels matching regular expression.
+.sp
+This option tells CTest to NOT run the tests whose labels match the
+given regular expression.  When more than one \fB\-LE\fP option is given,
+a test will only be excluded if each regular expression matches at least one
+of the test\(aqs labels (i.e. the multiple \fB\-LE\fP labels form an \fBAND\fP
+relationship).  See \fI\%Label Matching\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-tests\-from\-file <filename>
+Added in version 3.29.
+
+.sp
+Run tests listed in the given file.
+.sp
+This option tells CTest to run tests that are listed in the given file.
+The file must contain one exact test name per line.
+Lines that do not exactly match any test names are ignored.
+This option can be combined with the other options like
+\fB\-R\fP, \fB\-E\fP, \fB\-L\fP or \fB\-LE\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-exclude\-from\-file <filename>
+Added in version 3.29.
+
+.sp
+Exclude tests listed in the given file.
+.sp
+This option tells CTest to NOT run tests that are listed in the given file.
+The file must contain one exact test name per line.
+Lines that do not exactly match any test names are ignored.
+This option can be combined with the other options like
+\fB\-R\fP, \fB\-E\fP, \fB\-L\fP or \fB\-LE\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-FA <regex>, \-\-fixture\-exclude\-any <regex>
+Exclude fixtures matching \fB<regex>\fP from automatically adding any tests to
+the test set.
+.sp
+If a test in the set of tests to be executed requires a particular fixture,
+that fixture\(aqs setup and cleanup tests would normally be added to the test set
+automatically. This option prevents adding setup or cleanup tests for fixtures
+matching the \fB<regex>\fP\&. Note that all other fixture behavior is retained,
+including test dependencies and skipping tests that have fixture setup tests
+that fail.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-FS <regex>, \-\-fixture\-exclude\-setup <regex>
+Same as \fI\%\-FA\fP except only matching setup tests are
+excluded.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-FC <regex>, \-\-fixture\-exclude\-cleanup <regex>
+Same as \fI\%\-FA\fP except only matching cleanup tests are
+excluded.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-I [Start,End,Stride,test#,test#|Test file], \-\-tests\-information
+Run a specific number of tests by number.
+.sp
+This option causes CTest to run tests starting at number \fBStart\fP,
+ending at number \fBEnd\fP, and incrementing by \fBStride\fP\&.  Any additional
+numbers after \fBStride\fP are considered individual test numbers.  \fBStart\fP,
+\fBEnd\fP, or \fBStride\fP can be empty.  Optionally a file can be given that
+contains the same syntax as the command line.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-U, \-\-union
+Take the Union of \fI\%\-I\fP and \fI\%\-R\fP\&.
+.sp
+When both \fI\%\-R\fP and \fI\%\-I\fP are specified
+by default the intersection of tests are run.  By specifying \fB\-U\fP the union
+of tests is run instead.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-rerun\-failed
+Run only the tests that failed previously.
+.sp
+This option tells CTest to perform only the tests that failed during
+its previous run.  When this option is specified, CTest ignores all
+other options intended to modify the list of tests to run (
+\fI\%\-L\fP, \fI\%\-R\fP, \fI\%\-E\fP,
+\fI\%\-LE\fP, \fI\%\-I\fP, etc).  In the event that
+CTest runs and no tests fail, subsequent calls to CTest with the
+\fB\-\-rerun\-failed\fP option will run the set of tests that most recently
+failed (if any).
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-repeat <mode>:<n>
+Run tests repeatedly based on the given \fB<mode>\fP up to \fB<n>\fP times.
+The modes are:
+.INDENT 7.0
+.TP
+.B \fBuntil\-fail\fP
+Require each test to run \fB<n>\fP times without failing in order to pass.
+This is useful in finding sporadic failures in test cases.
+.TP
+.B \fBuntil\-pass\fP
+Allow each test to run up to \fB<n>\fP times in order to pass.
+Repeats tests if they fail for any reason.
+This is useful in tolerating sporadic failures in test cases.
+.TP
+.B \fBafter\-timeout\fP
+Allow each test to run up to \fB<n>\fP times in order to pass.
+Repeats tests only if they timeout.
+This is useful in tolerating sporadic timeouts in test cases
+on busy machines.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-repeat\-until\-fail <n>
+Equivalent to \fI\%\-\-repeat until\-fail:<n>\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-max\-width <width>
+Set the max width for a test name to output.
+.sp
+Set the maximum width for each test name to show in the output.
+This allows the user to widen the output to avoid clipping the test
+name which can be very annoying.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-interactive\-debug\-mode [0|1]
+Set the interactive mode to \fB0\fP or \fB1\fP\&.
+.sp
+This option causes CTest to run tests in either an interactive mode
+or a non\-interactive mode.  In dashboard mode (\fBExperimental\fP, \fBNightly\fP,
+\fBContinuous\fP), the default is non\-interactive.  In non\-interactive mode,
+the environment variable \X'tty: link #envvar:DASHBOARD_TEST_FROM_CTEST'\fI\%DASHBOARD_TEST_FROM_CTEST\fP\X'tty: link' is set.
+.sp
+Prior to CMake 3.11, interactive mode on Windows allowed system debug
+popup windows to appear.  Now, due to CTest\(aqs use of \fBlibuv\fP to launch
+test processes, all system debug popup windows are always blocked.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-no\-label\-summary
+Disable timing summary information for labels.
+.sp
+This option tells CTest not to print summary information for each
+label associated with the tests run.  If there are no labels on the
+tests, nothing extra is printed.
+.sp
+See \fI\%Label and Subproject Summary\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-no\-subproject\-summary
+Disable timing summary information for subprojects.
+.sp
+This option tells CTest not to print summary information for each
+subproject associated with the tests run.  If there are no subprojects on the
+tests, nothing extra is printed.
+.sp
+See \fI\%Label and Subproject Summary\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-test\-dir <dir>
+Added in version 3.20.
+
+.sp
+Specify the directory in which to look for tests, typically a CMake project
+build directory. If not specified, the current directory is used.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-test\-output\-size\-passed <size>
+Added in version 3.4.
+
+.sp
+Limit the output for passed tests to \fB<size>\fP bytes.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-test\-output\-size\-failed <size>
+Added in version 3.4.
+
+.sp
+Limit the output for failed tests to \fB<size>\fP bytes.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-test\-output\-truncation <mode>
+Added in version 3.24.
+
+.sp
+Truncate \fBtail\fP (default), \fBmiddle\fP or \fBhead\fP of test output once
+maximum output size is reached.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-overwrite
+Overwrite CTest configuration option.
+.sp
+By default CTest uses configuration options from configuration file.
+This option will overwrite the configuration option.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-force\-new\-ctest\-process
+Run child CTest instances as new processes.
+.sp
+By default CTest will run child CTest instances within the same
+process.  If this behavior is not desired, this argument will
+enforce new processes for child CTest processes.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-schedule\-random
+Use a random order for scheduling tests.
+.sp
+This option will run the tests in a random order.  It is commonly
+used to detect implicit dependencies in a test suite.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-submit\-index
+Legacy option for old Dart2 dashboard server feature.
+Do not use.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-timeout <seconds>
+Set the default test timeout.
+.sp
+This option effectively sets a timeout on all tests that do not
+already have a timeout set on them via the \X'tty: link #prop_test:TIMEOUT'\fI\%TIMEOUT\fP\X'tty: link'
+property.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-stop\-time <time>
+Set a time at which all tests should stop running.
+.sp
+Set a real time of day at which all tests should timeout.  Example:
+\fB7:00:00 \-0400\fP\&.  Any time format understood by the curl date parser
+is accepted.  Local time is assumed if no timezone is specified.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-print\-labels
+Print all available test labels.
+.sp
+This option will not run any tests, it will simply print the list of
+all labels associated with the test set.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-no\-tests=<action>
+Regard no tests found either as error (when \fB<action>\fP is set to
+\fBerror\fP) or ignore it (when \fB<action>\fP is set to \fBignore\fP).
+.sp
+If no tests were found, the default behavior of CTest is to always log an
+error message but to return an error code in script mode only.  This option
+unifies the behavior of CTest by either returning an error code if no tests
+were found or by ignoring it.
+.sp
+Added in version 3.26.
+
+.sp
+This option can also be set by setting the \X'tty: link #envvar:CTEST_NO_TESTS_ACTION'\fI\%CTEST_NO_TESTS_ACTION\fP\X'tty: link'
+environment variable.
+.UNINDENT
+.SH VIEW HELP
+.sp
+To print version details or selected pages from the CMake documentation,
+use one of the following options:
+.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 LABEL MATCHING
+.sp
+Tests may have labels attached to them. Tests may be included
+or excluded from a test run by filtering on the labels.
+Each individual filter is a regular expression applied to
+the labels attached to a test.
+.sp
+When \fI\%\-L\fP is used, in order for a test to be included in a
+test run, each regular expression must match at least one
+label.  Using more than one \fI\%\-L\fP option means \(dqmatch \fBall\fP
+of these\(dq.
+.sp
+The \fI\%\-LE\fP option works just like \fI\%\-L\fP,
+but excludes tests rather than including them. A test is excluded if each
+regular expression matches at least one label.
+.sp
+If a test has no labels attached to it, then \fI\%\-L\fP will never
+include that test, and \fI\%\-LE\fP will never exclude that test.
+As an example of tests with labels, consider five tests,
+with the following labels:
+.INDENT 0.0
+.IP \(bu 2
+\fItest1\fP has labels \fItuesday\fP and \fIproduction\fP
+.IP \(bu 2
+\fItest2\fP has labels \fItuesday\fP and \fItest\fP
+.IP \(bu 2
+\fItest3\fP has labels \fIwednesday\fP and \fIproduction\fP
+.IP \(bu 2
+\fItest4\fP has label \fIwednesday\fP
+.IP \(bu 2
+\fItest5\fP has labels \fIfriday\fP and \fItest\fP
+.UNINDENT
+.sp
+Running \fBctest\fP with \fB\-L tuesday \-L test\fP will select \fItest2\fP, which has
+both labels. Running CTest with \fB\-L test\fP will select \fItest2\fP and
+\fItest5\fP, because both of them have a label that matches that regular
+expression.
+.sp
+Because the matching works with regular expressions, take note that
+running CTest with \fB\-L es\fP will match all five tests.
+To select the \fItuesday\fP and \fIwednesday\fP tests together, use a single
+regular expression that matches either of them, like \fB\-L \(dqtue|wed\(dq\fP\&.
+.SH LABEL AND SUBPROJECT SUMMARY
+.sp
+CTest prints timing summary information for each \fBLABEL\fP and subproject
+associated with the tests run. The label time summary will not include labels
+that are mapped to subprojects.
+.sp
+Added in version 3.22: Labels added dynamically during test execution are also reported in the
+timing summary.  See \X'tty: link #additional-labels'\fI\%Additional Labels\fP\X'tty: link'\&.
+
+.sp
+When the \X'tty: link #prop_test:PROCESSORS'\fI\%PROCESSORS\fP\X'tty: link' test property is set, CTest will display a
+weighted test timing result in label and subproject summaries. The time is
+reported with \fIsec*proc\fP instead of just \fIsec\fP\&.
+.sp
+The weighted time summary reported for each label or subproject \fBj\fP
+is computed as:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+Weighted Time Summary for Label/Subproject j =
+    sum(raw_test_time[j,i] * num_processors[j,i], i=1...num_tests[j])
+
+for labels/subprojects j=1...total
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+where:
+.INDENT 0.0
+.IP \(bu 2
+\fBraw_test_time[j,i]\fP: Wall\-clock time for the \fBi\fP test
+for the \fBj\fP label or subproject
+.IP \(bu 2
+\fBnum_processors[j,i]\fP: Value of the CTest \X'tty: link #prop_test:PROCESSORS'\fI\%PROCESSORS\fP\X'tty: link' property
+for the \fBi\fP test for the \fBj\fP label or subproject
+.IP \(bu 2
+\fBnum_tests[j]\fP: Number of tests associated with the \fBj\fP label or subproject
+.IP \(bu 2
+\fBtotal\fP: Total number of labels or subprojects that have at least one test run
+.UNINDENT
+.sp
+Therefore, the weighted time summary for each label or subproject represents
+the amount of time that CTest gave to run the tests for each label or
+subproject and gives a good representation of the total expense of the tests
+for each label or subproject when compared to other labels or subprojects.
+.sp
+For example, if \fBSubprojectA\fP showed \fB100 sec*proc\fP and \fBSubprojectB\fP showed
+\fB10 sec*proc\fP, then CTest allocated approximately 10 times the CPU/core time
+to run the tests for \fBSubprojectA\fP than for \fBSubprojectB\fP (e.g. so if effort
+is going to be expended to reduce the cost of the test suite for the whole
+project, then reducing the cost of the test suite for \fBSubprojectA\fP would
+likely have a larger impact than effort to reduce the cost of the test suite
+for \fBSubprojectB\fP).
+.SH BUILD AND TEST MODE
+.sp
+CTest provides a command\-line signature to configure (i.e. run cmake on),
+build, and/or execute a test:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+ctest \-\-build\-and\-test <path\-to\-source> <path\-to\-build>
+      \-\-build\-generator <generator>
+      [<options>...]
+      [\-\-build\-options <opts>...]
+      [\-\-test\-command <command> [<args>...]]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The configure and test steps are optional. The arguments to this command line
+are the source and binary directories.  The \fB\-\-build\-generator\fP option \fImust\fP
+be provided to use \fB\-\-build\-and\-test\fP\&.  If \fB\-\-test\-command\fP is specified
+then that will be run after the build is complete.  Other options that affect
+this mode include:
+.INDENT 0.0
+.TP
+.B \-\-build\-and\-test
+Switch into the build and test mode.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-target
+Specify a specific target to build.  The option can be given multiple times
+with different targets, in which case each target is built in turn.
+A clean will be done before building each target unless the
+\fI\%\-\-build\-noclean\fP option is given.
+.sp
+If no \fB\-\-build\-target\fP is specified, the \fBall\fP target is built.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-nocmake
+Run the build without running cmake first.
+.sp
+Skip the cmake step.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-run\-dir
+Specify directory to run programs from.
+.sp
+Directory where programs will be after it has been compiled.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-two\-config
+Run CMake twice.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-exe\-dir
+Specify the directory for the executable.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-generator
+Specify the generator to use. See the \X'tty: link #manual:cmake-generators(7)'\fI\%cmake\-generators(7)\fP\X'tty: link' manual.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-generator\-platform
+Specify the generator\-specific platform.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-generator\-toolset
+Specify the generator\-specific toolset.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-project
+Specify the name of the project to build.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-makeprogram
+Specify the explicit make program to be used by CMake when configuring and
+building the project. Only applicable for Make and Ninja based generators.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-noclean
+Skip the make clean step.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-config\-sample
+A sample executable to use to determine the configuration that
+should be used.  e.g.  \fBDebug\fP, \fBRelease\fP etc.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-build\-options
+Additional options for configuring the build (i.e. for CMake, not for
+the build tool).  Note that if this is specified, the \fB\-\-build\-options\fP
+keyword and its arguments must be the last option given on the command
+line, with the possible exception of \fB\-\-test\-command\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-test\-command
+The command to run as the test step with the
+\fI\%\-\-build\-and\-test\fP option.
+All arguments following this keyword will be assumed to be part of the
+test command line, so it must be the last option given.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-test\-timeout
+The time limit in seconds
+.UNINDENT
+.SH DASHBOARD CLIENT
+.sp
+CTest can operate as a client for the \X'tty: link https://www.cdash.org'\fI\%CDash\fP\X'tty: link' software quality dashboard
+application.  As a dashboard client, CTest performs a sequence of steps
+to configure, build, and test software, and then submits the results to
+a \X'tty: link https://www.cdash.org'\fI\%CDash\fP\X'tty: link' server. The command\-line signature used to submit to \X'tty: link https://www.cdash.org'\fI\%CDash\fP\X'tty: link' is:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+ctest \-D <dashboard>         [\-\- <dashboard\-options>...]
+ctest \-M <model> \-T <action> [\-\- <dashboard\-options>...]
+ctest \-S <script>            [\-\- <dashboard\-options>...]
+ctest \-SP <script>           [\-\- <dashboard\-options>...]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Options for Dashboard Client include:
+.INDENT 0.0
+.TP
+.B \-D <dashboard>, \-\-dashboard <dashboard>
+Execute dashboard test.
+.sp
+This option tells CTest to act as a CDash client and perform a
+dashboard test.  All tests are \fB<Mode><Test>\fP, where \fB<Mode>\fP can be
+\fBExperimental\fP, \fBNightly\fP, and \fBContinuous\fP, and \fB<Test>\fP can be
+\fBStart\fP, \fBUpdate\fP, \fBConfigure\fP, \fBBuild\fP, \fBTest\fP,
+\fBCoverage\fP, and \fBSubmit\fP\&.
+.sp
+If \fB<dashboard>\fP is not one of the recognized \fB<Mode><Test>\fP values,
+this will be treated as a variable definition instead (see the
+\fI\%dashboard\-options\fP further below).
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-M <model>, \-\-test\-model <model>
+Sets the model for a dashboard.
+.sp
+This option tells CTest to act as a CDash client where the \fB<model>\fP
+can be \fBExperimental\fP, \fBNightly\fP, and \fBContinuous\fP\&.
+Combining \fB\-M\fP and \fI\%\-T\fP is similar to
+\fI\%\-D\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-T <action>, \-\-test\-action <action>
+Sets the dashboard action to perform.
+.sp
+This option tells CTest to act as a CDash client and perform some
+action such as \fBstart\fP, \fBbuild\fP, \fBtest\fP etc. See
+\fI\%Dashboard Client Steps\fP for the full list of actions.
+Combining \fI\%\-M\fP and \fB\-T\fP is similar to
+\fI\%\-D\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-S <script>, \-\-script <script>
+Execute a dashboard for a configuration.
+.sp
+This option tells CTest to load in a configuration script which sets
+a number of parameters such as the binary and source directories.
+Then CTest will do what is required to create and run a dashboard.
+This option basically sets up a dashboard and then runs \fI\%ctest \-D\fP
+with the appropriate options.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-SP <script>, \-\-script\-new\-process <script>
+Execute a dashboard for a configuration.
+.sp
+This option does the same operations as \fI\%\-S\fP but it
+will do them in a separate process.  This is primarily useful in cases
+where the script may modify the environment and you do not want the modified
+environment to impact other \fI\%\-S\fP scripts.
+.UNINDENT
+.sp
+The available \fB<dashboard\-options>\fP are the following:
+.INDENT 0.0
+.TP
+.B \-D <var>:<type>=<value>
+Define a variable for script mode.
+.sp
+Pass in variable values on the command line.  Use in conjunction
+with \fI\%\-S\fP to pass variable values to a dashboard script.
+Parsing \fB\-D\fP arguments as variable values is only attempted if the value
+following \fB\-D\fP does not match any of the known dashboard types.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-group <group>
+Specify what group you\(aqd like to submit results to
+.sp
+Submit dashboard to specified group instead of default one.  By
+default, the dashboard is submitted to Nightly, Experimental, or
+Continuous group, but by specifying this option, the group can be
+arbitrary.
+.sp
+This replaces the deprecated option \fB\-\-track\fP\&.
+Despite the name change its behavior is unchanged.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-A <file>, \-\-add\-notes <file>
+Add a notes file with submission.
+.sp
+This option tells CTest to include a notes file when submitting
+dashboard.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-tomorrow\-tag
+\fBNightly\fP or \fBExperimental\fP starts with next day tag.
+.sp
+This is useful if the build will not finish in one day.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-extra\-submit <file>[;<file>]
+Submit extra files to the dashboard.
+.sp
+This option will submit extra files to the dashboard.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-http\-header <header>
+Added in version 3.29.
+
+.sp
+Append HTTP header when submitting to the dashboard.
+.sp
+This option will cause CTest to append the specified header
+when submitting to the dashboard.
+This option may be specified more than once.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-http1.0
+Submit using \fIHTTP 1.0\fP\&.
+.sp
+This option will force CTest to use \fIHTTP 1.0\fP to submit files to the
+dashboard, instead of \fIHTTP 1.1\fP\&.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \-\-no\-compress\-output
+Do not compress test output when submitting.
+.sp
+This flag will turn off automatic compression of test output.  Use
+this to maintain compatibility with an older version of CDash which
+doesn\(aqt support compressed test output.
+.UNINDENT
+.SS Dashboard Client Steps
+.sp
+CTest defines an ordered list of testing steps of which some or all may
+be run as a dashboard client:
+.INDENT 0.0
+.TP
+.B \fBStart\fP
+Start a new dashboard submission to be composed of results recorded
+by the following steps.
+See the \fI\%CTest Start Step\fP section below.
+.TP
+.B \fBUpdate\fP
+Update the source tree from its version control repository.
+Record the old and new versions and the list of updated source files.
+See the \fI\%CTest Update Step\fP section below.
+.TP
+.B \fBConfigure\fP
+Configure the software by running a command in the build tree.
+Record the configuration output log.
+See the \fI\%CTest Configure Step\fP section below.
+.TP
+.B \fBBuild\fP
+Build the software by running a command in the build tree.
+Record the build output log and detect warnings and errors.
+See the \fI\%CTest Build Step\fP section below.
+.TP
+.B \fBTest\fP
+Test the software by loading a \fBCTestTestfile.cmake\fP
+from the build tree and executing the defined tests.
+Record the output and result of each test.
+See the \fI\%CTest Test Step\fP section below.
+.TP
+.B \fBCoverage\fP
+Compute coverage of the source code by running a coverage
+analysis tool and recording its output.
+See the \fI\%CTest Coverage Step\fP section below.
+.TP
+.B \fBMemCheck\fP
+Run the software test suite through a memory check tool.
+Record the test output, results, and issues reported by the tool.
+See the \fI\%CTest MemCheck Step\fP section below.
+.TP
+.B \fBSubmit\fP
+Submit results recorded from other testing steps to the
+software quality dashboard server.
+See the \fI\%CTest Submit Step\fP section below.
+.UNINDENT
+.SS Dashboard Client Modes
+.sp
+CTest defines three modes of operation as a dashboard client:
+.INDENT 0.0
+.TP
+.B \fBNightly\fP
+This mode is intended to be invoked once per day, typically at night.
+It enables the \fBStart\fP, \fBUpdate\fP, \fBConfigure\fP, \fBBuild\fP, \fBTest\fP,
+\fBCoverage\fP, and \fBSubmit\fP steps by default.  Selected steps run even
+if the \fBUpdate\fP step reports no changes to the source tree.
+.TP
+.B \fBContinuous\fP
+This mode is intended to be invoked repeatedly throughout the day.
+It enables the \fBStart\fP, \fBUpdate\fP, \fBConfigure\fP, \fBBuild\fP, \fBTest\fP,
+\fBCoverage\fP, and \fBSubmit\fP steps by default, but exits after the
+\fBUpdate\fP step if it reports no changes to the source tree.
+.TP
+.B \fBExperimental\fP
+This mode is intended to be invoked by a developer to test local changes.
+It enables the \fBStart\fP, \fBConfigure\fP, \fBBuild\fP, \fBTest\fP, \fBCoverage\fP,
+and \fBSubmit\fP steps by default.
+.UNINDENT
+.SS Dashboard Client via CTest Command\-Line
+.sp
+CTest can perform testing on an already\-generated build tree.
+Run the \fBctest\fP command with the current working directory set
+to the build tree and use one of these signatures:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+ctest \-D <mode>[<step>]
+ctest \-M <mode> [\-T <step>]...
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \fB<mode>\fP must be one of the above \fI\%Dashboard Client Modes\fP,
+and each \fB<step>\fP must be one of the above \fI\%Dashboard Client Steps\fP\&.
+.sp
+CTest reads the \fI\%Dashboard Client Configuration\fP settings from
+a file in the build tree called either \fBCTestConfiguration.ini\fP
+or \fBDartConfiguration.tcl\fP (the names are historical).  The format
+of the file is:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# Lines starting in \(aq#\(aq are comments.
+# Other non\-blank lines are key\-value pairs.
+<setting>: <value>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+where \fB<setting>\fP is the setting name and \fB<value>\fP is the
+setting value.
+.sp
+In build trees generated by CMake, this configuration file is
+generated by the \X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module if included by the project.
+The module uses variables to obtain a value for each setting
+as documented with the settings below.
+.SS Dashboard Client via CTest Script
+.sp
+CTest can perform testing driven by a \X'tty: link #manual:cmake-language(7)'\fI\%cmake\-language(7)\fP\X'tty: link'
+script that creates and maintains the source and build tree as
+well as performing the testing steps.  Run the \fBctest\fP command
+with the current working directory set outside of any build tree
+and use one of these signatures:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+ctest \-S <script>
+ctest \-SP <script>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \fB<script>\fP file must call \X'tty: link #ctest-commands'\fI\%CTest Commands\fP\X'tty: link' commands
+to run testing steps explicitly as documented below.  The commands
+obtain \fI\%Dashboard Client Configuration\fP settings from their
+arguments or from variables set in the script.
+.SH DASHBOARD CLIENT CONFIGURATION
+.sp
+The \fI\%Dashboard Client Steps\fP may be configured by named
+settings as documented in the following sections.
+.SS CTest Start Step
+.sp
+Start a new dashboard submission to be composed of results recorded
+by the following steps.
+.sp
+In a \fI\%CTest Script\fP, the \X'tty: link #command:ctest_start'\fI\%ctest_start()\fP\X'tty: link' command runs this step.
+Arguments to the command may specify some of the step settings.
+The command first runs the command\-line specified by the
+\fBCTEST_CHECKOUT_COMMAND\fP variable, if set, to initialize the source
+directory.
+.sp
+Configuration settings include:
+.INDENT 0.0
+.TP
+.B \fBBuildDirectory\fP
+The full path to the project build tree.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_BINARY_DIRECTORY'\fI\%CTEST_BINARY_DIRECTORY\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \X'tty: link #variable:PROJECT_BINARY_DIR'\fI\%PROJECT_BINARY_DIR\fP\X'tty: link'
+.UNINDENT
+.TP
+.B \fBSourceDirectory\fP
+The full path to the project source tree.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_SOURCE_DIRECTORY'\fI\%CTEST_SOURCE_DIRECTORY\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \X'tty: link #variable:PROJECT_SOURCE_DIR'\fI\%PROJECT_SOURCE_DIR\fP\X'tty: link'
+.UNINDENT
+.UNINDENT
+.SS CTest Update Step
+.sp
+In a \fI\%CTest Script\fP, the \X'tty: link #command:ctest_update'\fI\%ctest_update()\fP\X'tty: link' command runs this step.
+Arguments to the command may specify some of the step settings.
+.sp
+Configuration settings to specify the version control tool include:
+.INDENT 0.0
+.TP
+.B \fBBZRCommand\fP
+\fBbzr\fP command\-line tool to use if source tree is managed by Bazaar.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_BZR_COMMAND'\fI\%CTEST_BZR_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: none
+.UNINDENT
+.TP
+.B \fBBZRUpdateOptions\fP
+Command\-line options to the \fBBZRCommand\fP when updating the source.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_BZR_UPDATE_OPTIONS'\fI\%CTEST_BZR_UPDATE_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: none
+.UNINDENT
+.TP
+.B \fBCVSCommand\fP
+\fBcvs\fP command\-line tool to use if source tree is managed by CVS.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_CVS_COMMAND'\fI\%CTEST_CVS_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCVSCOMMAND\fP
+.UNINDENT
+.TP
+.B \fBCVSUpdateOptions\fP
+Command\-line options to the \fBCVSCommand\fP when updating the source.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_CVS_UPDATE_OPTIONS'\fI\%CTEST_CVS_UPDATE_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCVS_UPDATE_OPTIONS\fP
+.UNINDENT
+.TP
+.B \fBGITCommand\fP
+\fBgit\fP command\-line tool to use if source tree is managed by Git.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_GIT_COMMAND'\fI\%CTEST_GIT_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBGITCOMMAND\fP
+.UNINDENT
+.sp
+The source tree is updated by \fBgit fetch\fP followed by
+\fBgit reset \-\-hard\fP to the \fBFETCH_HEAD\fP\&.  The result is the same
+as \fBgit pull\fP except that any local modifications are overwritten.
+Use \fBGITUpdateCustom\fP to specify a different approach.
+.TP
+.B \fBGITInitSubmodules\fP
+If set, CTest will update the repository\(aqs submodules before updating.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_GIT_INIT_SUBMODULES'\fI\%CTEST_GIT_INIT_SUBMODULES\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_GIT_INIT_SUBMODULES\fP
+.UNINDENT
+.TP
+.B \fBGITUpdateCustom\fP
+Specify a custom command line (as a semicolon\-separated list) to run
+in the source tree (Git work tree) to update it instead of running
+the \fBGITCommand\fP\&.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_GIT_UPDATE_CUSTOM'\fI\%CTEST_GIT_UPDATE_CUSTOM\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_GIT_UPDATE_CUSTOM\fP
+.UNINDENT
+.TP
+.B \fBGITUpdateOptions\fP
+Command\-line options to the \fBGITCommand\fP when updating the source.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_GIT_UPDATE_OPTIONS'\fI\%CTEST_GIT_UPDATE_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBGIT_UPDATE_OPTIONS\fP
+.UNINDENT
+.TP
+.B \fBHGCommand\fP
+\fBhg\fP command\-line tool to use if source tree is managed by Mercurial.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_HG_COMMAND'\fI\%CTEST_HG_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: none
+.UNINDENT
+.TP
+.B \fBHGUpdateOptions\fP
+Command\-line options to the \fBHGCommand\fP when updating the source.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_HG_UPDATE_OPTIONS'\fI\%CTEST_HG_UPDATE_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: none
+.UNINDENT
+.TP
+.B \fBP4Client\fP
+Value of the \fB\-c\fP option to the \fBP4Command\fP\&.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_P4_CLIENT'\fI\%CTEST_P4_CLIENT\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_P4_CLIENT\fP
+.UNINDENT
+.TP
+.B \fBP4Command\fP
+\fBp4\fP command\-line tool to use if source tree is managed by Perforce.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_P4_COMMAND'\fI\%CTEST_P4_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBP4COMMAND\fP
+.UNINDENT
+.TP
+.B \fBP4Options\fP
+Command\-line options to the \fBP4Command\fP for all invocations.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_P4_OPTIONS'\fI\%CTEST_P4_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_P4_OPTIONS\fP
+.UNINDENT
+.TP
+.B \fBP4UpdateCustom\fP
+Specify a custom command line (as a semicolon\-separated list) to run
+in the source tree (Perforce tree) to update it instead of running
+the \fBP4Command\fP\&.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_P4_UPDATE_CUSTOM\fP
+.UNINDENT
+.TP
+.B \fBP4UpdateOptions\fP
+Command\-line options to the \fBP4Command\fP when updating the source.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_P4_UPDATE_OPTIONS'\fI\%CTEST_P4_UPDATE_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_P4_UPDATE_OPTIONS\fP
+.UNINDENT
+.TP
+.B \fBSVNCommand\fP
+\fBsvn\fP command\-line tool to use if source tree is managed by Subversion.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_SVN_COMMAND'\fI\%CTEST_SVN_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBSVNCOMMAND\fP
+.UNINDENT
+.TP
+.B \fBSVNOptions\fP
+Command\-line options to the \fBSVNCommand\fP for all invocations.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_SVN_OPTIONS'\fI\%CTEST_SVN_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_SVN_OPTIONS\fP
+.UNINDENT
+.TP
+.B \fBSVNUpdateOptions\fP
+Command\-line options to the \fBSVNCommand\fP when updating the source.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_SVN_UPDATE_OPTIONS'\fI\%CTEST_SVN_UPDATE_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBSVN_UPDATE_OPTIONS\fP
+.UNINDENT
+.TP
+.B \fBUpdateCommand\fP
+Specify the version\-control command\-line tool to use without
+detecting the VCS that manages the source tree.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_UPDATE_COMMAND'\fI\%CTEST_UPDATE_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fB<VCS>COMMAND\fP
+when \fBUPDATE_TYPE\fP is \fB<vcs>\fP, else \fBUPDATE_COMMAND\fP
+.UNINDENT
+.TP
+.B \fBUpdateOptions\fP
+Command\-line options to the \fBUpdateCommand\fP\&.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_UPDATE_OPTIONS'\fI\%CTEST_UPDATE_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fB<VCS>_UPDATE_OPTIONS\fP
+when \fBUPDATE_TYPE\fP is \fB<vcs>\fP, else \fBUPDATE_OPTIONS\fP
+.UNINDENT
+.TP
+.B \fBUpdateType\fP
+Specify the version\-control system that manages the source
+tree if it cannot be detected automatically.
+The value may be \fBbzr\fP, \fBcvs\fP, \fBgit\fP, \fBhg\fP,
+\fBp4\fP, or \fBsvn\fP\&.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none, detected from source tree
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBUPDATE_TYPE\fP if set,
+else \fBCTEST_UPDATE_TYPE\fP
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \fBUpdateVersionOnly\fP
+Specify that you want the version control update command to only
+discover the current version that is checked out, and not to update
+to a different version.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_UPDATE_VERSION_ONLY'\fI\%CTEST_UPDATE_VERSION_ONLY\fP\X'tty: link'
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B \fBUpdateVersionOverride\fP
+Specify the current version of your source tree.
+.sp
+When this variable is set to a non\-empty string, CTest will report the value
+you specified rather than using the update command to discover the current
+version that is checked out. Use of this variable supersedes
+\fBUpdateVersionOnly\fP\&. Like \fBUpdateVersionOnly\fP, using this variable tells
+CTest not to update the source tree to a different version.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_UPDATE_VERSION_OVERRIDE'\fI\%CTEST_UPDATE_VERSION_OVERRIDE\fP\X'tty: link'
+.UNINDENT
+.UNINDENT
+.sp
+Additional configuration settings include:
+.INDENT 0.0
+.TP
+.B \fBNightlyStartTime\fP
+In the \fBNightly\fP dashboard mode, specify the \(dqnightly start time\(dq.
+With centralized version control systems (\fBcvs\fP and \fBsvn\fP),
+the \fBUpdate\fP step checks out the version of the software as of
+this time so that multiple clients choose a common version to test.
+This is not well\-defined in distributed version\-control systems so
+the setting is ignored.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_NIGHTLY_START_TIME'\fI\%CTEST_NIGHTLY_START_TIME\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBNIGHTLY_START_TIME\fP if set,
+else \fBCTEST_NIGHTLY_START_TIME\fP
+.UNINDENT
+.UNINDENT
+.SS CTest Configure Step
+.sp
+In a \fI\%CTest Script\fP, the \X'tty: link #command:ctest_configure'\fI\%ctest_configure()\fP\X'tty: link' command runs this step.
+Arguments to the command may specify some of the step settings.
+.sp
+Configuration settings include:
+.INDENT 0.0
+.TP
+.B \fBConfigureCommand\fP
+Command\-line to launch the software configuration process.
+It will be executed in the location specified by the
+\fBBuildDirectory\fP setting.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_CONFIGURE_COMMAND'\fI\%CTEST_CONFIGURE_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \X'tty: link #variable:CMAKE_COMMAND'\fI\%CMAKE_COMMAND\fP\X'tty: link'
+followed by \X'tty: link #variable:PROJECT_SOURCE_DIR'\fI\%PROJECT_SOURCE_DIR\fP\X'tty: link'
+.UNINDENT
+.TP
+.B \fBLabelsForSubprojects\fP
+Specify a semicolon\-separated list of labels that will be treated as
+subprojects. This mapping will be passed on to CDash when configure, test or
+build results are submitted.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_LABELS_FOR_SUBPROJECTS'\fI\%CTEST_LABELS_FOR_SUBPROJECTS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_LABELS_FOR_SUBPROJECTS\fP
+.UNINDENT
+.sp
+See \fI\%Label and Subproject Summary\fP\&.
+.UNINDENT
+.SS CTest Build Step
+.sp
+In a \fI\%CTest Script\fP, the \X'tty: link #command:ctest_build'\fI\%ctest_build()\fP\X'tty: link' command runs this step.
+Arguments to the command may specify some of the step settings.
+.sp
+Configuration settings include:
+.INDENT 0.0
+.TP
+.B \fBDefaultCTestConfigurationType\fP
+When the build system to be launched allows build\-time selection
+of the configuration (e.g. \fBDebug\fP, \fBRelease\fP), this specifies
+the default configuration to be built when no \fI\%\-C\fP
+option is given to the \fBctest\fP command.  The value will be substituted
+into the value of \fBMakeCommand\fP to replace the literal string
+\fB${CTEST_CONFIGURATION_TYPE}\fP if it appears.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_CONFIGURATION_TYPE'\fI\%CTEST_CONFIGURATION_TYPE\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBDEFAULT_CTEST_CONFIGURATION_TYPE\fP,
+initialized by the \X'tty: link #envvar:CMAKE_CONFIG_TYPE'\fI\%CMAKE_CONFIG_TYPE\fP\X'tty: link' environment variable
+.UNINDENT
+.TP
+.B \fBLabelsForSubprojects\fP
+Specify a semicolon\-separated list of labels that will be treated as
+subprojects. This mapping will be passed on to CDash when configure, test or
+build results are submitted.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_LABELS_FOR_SUBPROJECTS'\fI\%CTEST_LABELS_FOR_SUBPROJECTS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_LABELS_FOR_SUBPROJECTS\fP
+.UNINDENT
+.sp
+See \fI\%Label and Subproject Summary\fP\&.
+.TP
+.B \fBMakeCommand\fP
+Command\-line to launch the software build process.
+It will be executed in the location specified by the
+\fBBuildDirectory\fP setting.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_BUILD_COMMAND'\fI\%CTEST_BUILD_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBMAKECOMMAND\fP,
+initialized by the \X'tty: link #command:build_command'\fI\%build_command()\fP\X'tty: link' command
+.UNINDENT
+.TP
+.B \fBUseLaunchers\fP
+For build trees generated by CMake using one of the
+\X'tty: link #makefile-generators'\fI\%Makefile Generators\fP\X'tty: link' or the \X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link'
+generator, specify whether the
+\fBCTEST_USE_LAUNCHERS\fP feature is enabled by the
+\X'tty: link #module:CTestUseLaunchers'\fI\%CTestUseLaunchers\fP\X'tty: link' module (also included by the
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module).  When enabled, the generated build
+system wraps each invocation of the compiler, linker, or
+custom command line with a \(dqlauncher\(dq that communicates
+with CTest via environment variables and files to report
+granular build warning and error information.  Otherwise,
+CTest must \(dqscrape\(dq the build output log for diagnostics.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_USE_LAUNCHERS'\fI\%CTEST_USE_LAUNCHERS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_USE_LAUNCHERS\fP
+.UNINDENT
+.UNINDENT
+.SS CTest Test Step
+.sp
+In a \fI\%CTest Script\fP, the \X'tty: link #command:ctest_test'\fI\%ctest_test()\fP\X'tty: link' command runs this step.
+Arguments to the command may specify some of the step settings.
+.sp
+Configuration settings include:
+.INDENT 0.0
+.TP
+.B \fBResourceSpecFile\fP
+Specify a
+\fI\%resource specification file\fP\&.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_RESOURCE_SPEC_FILE'\fI\%CTEST_RESOURCE_SPEC_FILE\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_RESOURCE_SPEC_FILE\fP
+.UNINDENT
+.sp
+See \fI\%Resource Allocation\fP for more information.
+.TP
+.B \fBLabelsForSubprojects\fP
+Specify a semicolon\-separated list of labels that will be treated as
+subprojects. This mapping will be passed on to CDash when configure, test or
+build results are submitted.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_LABELS_FOR_SUBPROJECTS'\fI\%CTEST_LABELS_FOR_SUBPROJECTS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_LABELS_FOR_SUBPROJECTS\fP
+.UNINDENT
+.sp
+See \fI\%Label and Subproject Summary\fP\&.
+.TP
+.B \fBTestLoad\fP
+While running tests in parallel (e.g. with \fI\%\-j\fP),
+try not to start tests when they may cause the CPU load to pass above
+a given threshold.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_TEST_LOAD'\fI\%CTEST_TEST_LOAD\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_TEST_LOAD\fP
+.UNINDENT
+.TP
+.B \fBTimeOut\fP
+The default timeout for each test if not specified by the
+\X'tty: link #prop_test:TIMEOUT'\fI\%TIMEOUT\fP\X'tty: link' test property or the
+\fI\%\-\-timeout\fP flag.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_TEST_TIMEOUT'\fI\%CTEST_TEST_TIMEOUT\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBDART_TESTING_TIMEOUT\fP
+.UNINDENT
+.UNINDENT
+.sp
+To report extra test values to CDash, see \X'tty: link #additional-test-measurements'\fI\%Additional Test Measurements\fP\X'tty: link'\&.
+.SS CTest Coverage Step
+.sp
+In a \fI\%CTest Script\fP, the \X'tty: link #command:ctest_coverage'\fI\%ctest_coverage()\fP\X'tty: link' command runs this step.
+Arguments to the command may specify some of the step settings.
+.sp
+Configuration settings include:
+.INDENT 0.0
+.TP
+.B \fBCoverageCommand\fP
+Command\-line tool to perform software coverage analysis.
+It will be executed in the location specified by the
+\fBBuildDirectory\fP setting.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_COVERAGE_COMMAND'\fI\%CTEST_COVERAGE_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCOVERAGE_COMMAND\fP
+.UNINDENT
+.TP
+.B \fBCoverageExtraFlags\fP
+Specify command\-line options to the \fBCoverageCommand\fP tool.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_COVERAGE_EXTRA_FLAGS'\fI\%CTEST_COVERAGE_EXTRA_FLAGS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCOVERAGE_EXTRA_FLAGS\fP
+.UNINDENT
+.sp
+These options are the first arguments passed to \fBCoverageCommand\fP\&.
+.UNINDENT
+.SS CTest MemCheck Step
+.sp
+In a \fI\%CTest Script\fP, the \X'tty: link #command:ctest_memcheck'\fI\%ctest_memcheck()\fP\X'tty: link' command runs this step.
+Arguments to the command may specify some of the step settings.
+.sp
+Configuration settings include:
+.INDENT 0.0
+.TP
+.B \fBMemoryCheckCommand\fP
+Command\-line tool to perform dynamic analysis.  Test command lines
+will be launched through this tool.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_MEMORYCHECK_COMMAND'\fI\%CTEST_MEMORYCHECK_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBMEMORYCHECK_COMMAND\fP
+.UNINDENT
+.TP
+.B \fBMemoryCheckCommandOptions\fP
+Specify command\-line options to the \fBMemoryCheckCommand\fP tool.
+They will be placed prior to the test command line.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_MEMORYCHECK_COMMAND_OPTIONS'\fI\%CTEST_MEMORYCHECK_COMMAND_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBMEMORYCHECK_COMMAND_OPTIONS\fP
+.UNINDENT
+.TP
+.B \fBMemoryCheckType\fP
+Specify the type of memory checking to perform.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_MEMORYCHECK_TYPE'\fI\%CTEST_MEMORYCHECK_TYPE\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBMEMORYCHECK_TYPE\fP
+.UNINDENT
+.TP
+.B \fBMemoryCheckSanitizerOptions\fP
+Specify options to sanitizers when running with a sanitize\-enabled build.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_MEMORYCHECK_SANITIZER_OPTIONS'\fI\%CTEST_MEMORYCHECK_SANITIZER_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBMEMORYCHECK_SANITIZER_OPTIONS\fP
+.UNINDENT
+.TP
+.B \fBMemoryCheckSuppressionFile\fP
+Specify a file containing suppression rules for the
+\fBMemoryCheckCommand\fP tool.  It will be passed with options
+appropriate to the tool.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_MEMORYCHECK_SUPPRESSIONS_FILE'\fI\%CTEST_MEMORYCHECK_SUPPRESSIONS_FILE\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBMEMORYCHECK_SUPPRESSIONS_FILE\fP
+.UNINDENT
+.UNINDENT
+.sp
+Additional configuration settings include:
+.INDENT 0.0
+.TP
+.B \fBBoundsCheckerCommand\fP
+Specify a \fBMemoryCheckCommand\fP that is known to be command\-line
+compatible with Bounds Checker.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: none
+.UNINDENT
+.TP
+.B \fBPurifyCommand\fP
+Specify a \fBMemoryCheckCommand\fP that is known to be command\-line
+compatible with Purify.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBPURIFYCOMMAND\fP
+.UNINDENT
+.TP
+.B \fBValgrindCommand\fP
+Specify a \fBMemoryCheckCommand\fP that is known to be command\-line
+compatible with Valgrind.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBVALGRIND_COMMAND\fP
+.UNINDENT
+.TP
+.B \fBValgrindCommandOptions\fP
+Specify command\-line options to the \fBValgrindCommand\fP tool.
+They will be placed prior to the test command line.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBVALGRIND_COMMAND_OPTIONS\fP
+.UNINDENT
+.TP
+.B \fBDrMemoryCommand\fP
+Specify a \fBMemoryCheckCommand\fP that is known to be a command\-line
+compatible with DrMemory.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBDRMEMORY_COMMAND\fP
+.UNINDENT
+.TP
+.B \fBDrMemoryCommandOptions\fP
+Specify command\-line options to the \fBDrMemoryCommand\fP tool.
+They will be placed prior to the test command line.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBDRMEMORY_COMMAND_OPTIONS\fP
+.UNINDENT
+.TP
+.B \fBCudaSanitizerCommand\fP
+Specify a \fBMemoryCheckCommand\fP that is known to be a command\-line
+compatible with cuda\-memcheck or compute\-sanitizer.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCUDA_SANITIZER_COMMAND\fP
+.UNINDENT
+.TP
+.B \fBCudaSanitizerCommandOptions\fP
+Specify command\-line options to the \fBCudaSanitizerCommand\fP tool.
+They will be placed prior to the test command line.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCUDA_SANITIZER_COMMAND_OPTIONS\fP
+.UNINDENT
+.UNINDENT
+.SS CTest Submit Step
+.sp
+In a \fI\%CTest Script\fP, the \X'tty: link #command:ctest_submit'\fI\%ctest_submit()\fP\X'tty: link' command runs this step.
+Arguments to the command may specify some of the step settings.
+.sp
+Configuration settings include:
+.INDENT 0.0
+.TP
+.B \fBBuildName\fP
+Describe the dashboard client platform with a short string.
+(Operating system, compiler, etc.)
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_BUILD_NAME'\fI\%CTEST_BUILD_NAME\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBBUILDNAME\fP
+.UNINDENT
+.TP
+.B \fBCDashVersion\fP
+Legacy option.  Not used.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none, detected from server
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_CDASH_VERSION\fP
+.UNINDENT
+.TP
+.B \fBCTestSubmitRetryCount\fP
+Specify a number of attempts to retry submission on network failure.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none,
+use the \X'tty: link #command:ctest_submit'\fI\%ctest_submit()\fP\X'tty: link' \fBRETRY_COUNT\fP option.
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_SUBMIT_RETRY_COUNT\fP
+.UNINDENT
+.TP
+.B \fBCTestSubmitRetryDelay\fP
+Specify a delay before retrying submission on network failure.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: none,
+use the \X'tty: link #command:ctest_submit'\fI\%ctest_submit()\fP\X'tty: link' \fBRETRY_DELAY\fP option.
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_SUBMIT_RETRY_DELAY\fP
+.UNINDENT
+.TP
+.B \fBCurlOptions\fP
+Deprecated since version 3.30: Use \fBTLSVerify\fP instead.
+
+.sp
+Specify a semicolon\-separated list of options to control the
+Curl library that CTest uses internally to connect to the
+server.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_CURL_OPTIONS'\fI\%CTEST_CURL_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_CURL_OPTIONS\fP
+.UNINDENT
+.sp
+Possible options are:
+.INDENT 7.0
+.TP
+.B \fBCURLOPT_SSL_VERIFYPEER_OFF\fP
+Disable the \fBCURLOPT_SSL_VERIFYPEER\fP curl option.
+.TP
+.B \fBCURLOPT_SSL_VERIFYHOST_OFF\fP
+Disable the \fBCURLOPT_SSL_VERIFYHOST\fP curl option.
+.UNINDENT
+.TP
+.B \fBDropLocation\fP
+Legacy option.  When \fBSubmitURL\fP is not set, it is constructed from
+\fBDropMethod\fP, \fBDropSiteUser\fP, \fBDropSitePassword\fP, \fBDropSite\fP, and
+\fBDropLocation\fP\&.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_DROP_LOCATION'\fI\%CTEST_DROP_LOCATION\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBDROP_LOCATION\fP if set,
+else \fBCTEST_DROP_LOCATION\fP
+.UNINDENT
+.TP
+.B \fBDropMethod\fP
+Legacy option.  When \fBSubmitURL\fP is not set, it is constructed from
+\fBDropMethod\fP, \fBDropSiteUser\fP, \fBDropSitePassword\fP, \fBDropSite\fP, and
+\fBDropLocation\fP\&.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_DROP_METHOD'\fI\%CTEST_DROP_METHOD\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBDROP_METHOD\fP if set,
+else \fBCTEST_DROP_METHOD\fP
+.UNINDENT
+.TP
+.B \fBDropSite\fP
+Legacy option.  When \fBSubmitURL\fP is not set, it is constructed from
+\fBDropMethod\fP, \fBDropSiteUser\fP, \fBDropSitePassword\fP, \fBDropSite\fP, and
+\fBDropLocation\fP\&.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_DROP_SITE'\fI\%CTEST_DROP_SITE\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBDROP_SITE\fP if set,
+else \fBCTEST_DROP_SITE\fP
+.UNINDENT
+.TP
+.B \fBDropSitePassword\fP
+Legacy option.  When \fBSubmitURL\fP is not set, it is constructed from
+\fBDropMethod\fP, \fBDropSiteUser\fP, \fBDropSitePassword\fP, \fBDropSite\fP, and
+\fBDropLocation\fP\&.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_DROP_SITE_PASSWORD'\fI\%CTEST_DROP_SITE_PASSWORD\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBDROP_SITE_PASSWORD\fP if set,
+else \fBCTEST_DROP_SITE_PASWORD\fP
+.UNINDENT
+.TP
+.B \fBDropSiteUser\fP
+Legacy option.  When \fBSubmitURL\fP is not set, it is constructed from
+\fBDropMethod\fP, \fBDropSiteUser\fP, \fBDropSitePassword\fP, \fBDropSite\fP, and
+\fBDropLocation\fP\&.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_DROP_SITE_USER'\fI\%CTEST_DROP_SITE_USER\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBDROP_SITE_USER\fP if set,
+else \fBCTEST_DROP_SITE_USER\fP
+.UNINDENT
+.TP
+.B \fBIsCDash\fP
+Legacy option.  Not used.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_DROP_SITE_CDASH'\fI\%CTEST_DROP_SITE_CDASH\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_DROP_SITE_CDASH\fP
+.UNINDENT
+.TP
+.B \fBScpCommand\fP
+Legacy option.  Not used.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_SCP_COMMAND'\fI\%CTEST_SCP_COMMAND\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBSCPCOMMAND\fP
+.UNINDENT
+.TP
+.B \fBSite\fP
+Describe the dashboard client host site with a short string.
+(Hostname, domain, etc.)
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_SITE'\fI\%CTEST_SITE\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBSITE\fP,
+initialized by the \X'tty: link #command:site_name'\fI\%site_name()\fP\X'tty: link' command
+.UNINDENT
+.TP
+.B \fBSubmitURL\fP
+The \fBhttp\fP or \fBhttps\fP URL of the dashboard server to send the submission
+to.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_SUBMIT_URL'\fI\%CTEST_SUBMIT_URL\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBSUBMIT_URL\fP if set,
+else \fBCTEST_SUBMIT_URL\fP
+.UNINDENT
+.TP
+.B \fBSubmitInactivityTimeout\fP
+The time to wait for the submission after which it is canceled
+if not completed. Specify a zero value to disable timeout.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_SUBMIT_INACTIVITY_TIMEOUT'\fI\%CTEST_SUBMIT_INACTIVITY_TIMEOUT\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_SUBMIT_INACTIVITY_TIMEOUT\fP
+.UNINDENT
+.TP
+.B \fBTLSVersion\fP
+Added in version 3.30.
+
+.sp
+Specify a minimum TLS version allowed when submitting to a dashboard
+via \fBhttps://\fP URLs.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_TLS_VERSION'\fI\%CTEST_TLS_VERSION\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_TLS_VERSION\fP
+.UNINDENT
+.sp
+Changed in version 3.31: The default is TLS 1.2.
+Previously, no minimum version was enforced by default.
+
+.TP
+.B \fBTLSVerify\fP
+Added in version 3.30.
+
+.sp
+Specify a boolean value indicating whether to verify the server
+certificate when submitting to a dashboard via \fBhttps://\fP URLs.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_TLS_VERIFY'\fI\%CTEST_TLS_VERIFY\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBCTEST_TLS_VERIFY\fP
+.UNINDENT
+.sp
+Changed in version 3.31: The default is on.  Previously, the default was off.
+Users may set the \X'tty: link #envvar:CMAKE_TLS_VERIFY'\fI\%CMAKE_TLS_VERIFY\fP\X'tty: link' environment
+variable to \fB0\fP to restore the old default.
+
+.TP
+.B \fBTriggerSite\fP
+Legacy option.  Not used.
+.INDENT 7.0
+.IP \(bu 2
+\fI\%CTest Script\fP variable: \X'tty: link #variable:CTEST_TRIGGER_SITE'\fI\%CTEST_TRIGGER_SITE\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #module:CTest'\fI\%CTest\fP\X'tty: link' module variable: \fBTRIGGER_SITE\fP if set,
+else \fBCTEST_TRIGGER_SITE\fP
+.UNINDENT
+.UNINDENT
+.SH SHOW AS JSON OBJECT MODEL
+.sp
+Added in version 3.14.
+
+.sp
+When the \fB\-\-show\-only=json\-v1\fP command line option is given, the test
+information is output in JSON format.  Version 1.0 of the JSON object
+model is defined as follows:
+.INDENT 0.0
+.TP
+.B \fBkind\fP
+The string \(dqctestInfo\(dq.
+.TP
+.B \fBversion\fP
+A JSON object specifying the version components.  Its members are
+.INDENT 7.0
+.TP
+.B \fBmajor\fP
+A non\-negative integer specifying the major version component.
+.TP
+.B \fBminor\fP
+A non\-negative integer specifying the minor version component.
+.UNINDENT
+.TP
+.B \fBbacktraceGraph\fP
+JSON object representing backtrace information with the
+following members:
+.INDENT 7.0
+.TP
+.B \fBcommands\fP
+List of command names.
+.TP
+.B \fBfiles\fP
+List of file names.
+.TP
+.B \fBnodes\fP
+List of node JSON objects with members:
+.INDENT 7.0
+.TP
+.B \fBcommand\fP
+Index into the \fBcommands\fP member of the \fBbacktraceGraph\fP\&.
+.TP
+.B \fBfile\fP
+Index into the \fBfiles\fP member of the \fBbacktraceGraph\fP\&.
+.TP
+.B \fBline\fP
+Line number in the file where the backtrace was added.
+.TP
+.B \fBparent\fP
+Index into the \fBnodes\fP member of the \fBbacktraceGraph\fP
+representing the parent in the graph.
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBtests\fP
+A JSON array listing information about each test.  Each entry
+is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBname\fP
+Test name.
+.TP
+.B \fBconfig\fP
+Configuration that the test can run on.
+Empty string means any config.
+.TP
+.B \fBcommand\fP
+List where the first element is the test command and the
+remaining elements are the command arguments.
+.TP
+.B \fBbacktrace\fP
+Index into the \fBnodes\fP member of the \fBbacktraceGraph\fP\&.
+.TP
+.B \fBproperties\fP
+Test properties.
+Can contain keys for each of the supported test properties.
+.UNINDENT
+.UNINDENT
+.SH RESOURCE ALLOCATION
+.sp
+CTest provides a mechanism for tests to specify the resources that they need
+in a fine\-grained way, and for users to specify the resources available on
+the running machine. This allows CTest to internally keep track of which
+resources are in use and which are free, scheduling tests in a way that
+prevents them from trying to claim resources that are not available.
+.sp
+When the resource allocation feature is used, CTest will not oversubscribe
+resources. For example, if a resource has 8 slots, CTest will not run tests
+that collectively use more than 8 slots at a time. This has the effect of
+limiting how many tests can run at any given time, even if a high \fB\-j\fP
+argument is used, if those tests all use some slots from the same resource.
+In addition, it means that a single test that uses more of a resource than is
+available on a machine will not run at all (and will be reported as
+\fBNot Run\fP).
+.sp
+A common use case for this feature is for tests that require the use of a GPU.
+Multiple tests can simultaneously allocate memory from a GPU, but if too many
+tests try to do this at once, some of them will fail to allocate, resulting in
+a failed test, even though the test would have succeeded if it had the memory
+it needed. By using the resource allocation feature, each test can specify how
+much memory it requires from a GPU, allowing CTest to schedule tests in a way
+that running several of these tests at once does not exhaust the GPU\(aqs memory
+pool.
+.sp
+Please note that CTest has no concept of what a GPU is or how much memory it
+has. It does not have any way of communicating with a GPU to retrieve this
+information or perform any memory management, although the project can define
+a test that provides details about the test machine (see
+\fI\%Dynamically\-Generated Resource Specification File\fP).
+.sp
+CTest keeps track of a list of abstract resource types, each of which has a
+certain number of slots available for tests to use. Each test specifies the
+number of slots that it requires from a certain resource, and CTest then
+schedules them in a way that prevents the total number of slots in use from
+exceeding the listed capacity. When a test is executed, and slots from a
+resource are allocated to that test, tests may assume that they have exclusive
+use of those slots for the duration of the test\(aqs process.
+.sp
+The CTest resource allocation feature consists of at least two inputs:
+.INDENT 0.0
+.IP \(bu 2
+The \fI\%resource specification file\fP,
+described below, which describes the resources available on the system.
+.IP \(bu 2
+The \X'tty: link #prop_test:RESOURCE_GROUPS'\fI\%RESOURCE_GROUPS\fP\X'tty: link' property of tests, which describes the
+resources required by the test.
+.UNINDENT
+.sp
+When CTest runs a test, the resources allocated to that test are passed in the
+form of a set of
+\fI\%environment variables\fP as
+described below. Using this information to decide which resource to connect to
+is left to the test writer.
+.sp
+The \fBRESOURCE_GROUPS\fP property tells CTest what resources a test expects
+to use grouped in a way meaningful to the test.  The test itself must read
+the \fI\%environment variables\fP to
+determine which resources have been allocated to each group.  For example,
+each group may correspond to a process the test will spawn when executed.
+.sp
+Note that even if a test specifies a \fBRESOURCE_GROUPS\fP property, it is still
+possible for that to test to run without any resource allocation (and without
+the corresponding
+\fI\%environment variables\fP)
+if the user does not pass a resource specification file. Passing this file,
+either through the \fB\-\-resource\-spec\-file\fP command\-line argument or the
+\fBRESOURCE_SPEC_FILE\fP argument to \X'tty: link #command:ctest_test'\fI\%ctest_test()\fP\X'tty: link', is what activates the
+resource allocation feature. Tests should check the
+\fBCTEST_RESOURCE_GROUP_COUNT\fP environment variable to find out whether or not
+resource allocation is activated. This variable will always (and only) be
+defined if resource allocation is activated. If resource allocation is not
+activated, then the \fBCTEST_RESOURCE_GROUP_COUNT\fP variable will not exist,
+even if it exists for the parent \fBctest\fP process. If a test absolutely must
+have resource allocation, then it can return a failing exit code or use the
+\X'tty: link #prop_test:SKIP_RETURN_CODE'\fI\%SKIP_RETURN_CODE\fP\X'tty: link' or \X'tty: link #prop_test:SKIP_REGULAR_EXPRESSION'\fI\%SKIP_REGULAR_EXPRESSION\fP\X'tty: link'
+properties to indicate a skipped test.
+.SS Resource Specification File
+.sp
+The resource specification file is a JSON file which is passed to CTest in one
+of a number of ways. It can be specified on the command line with the
+\fI\%ctest \-\-resource\-spec\-file\fP option, it can be given using the
+\fBRESOURCE_SPEC_FILE\fP argument of \X'tty: link #command:ctest_test'\fI\%ctest_test()\fP\X'tty: link', or it can be
+generated dynamically as part of test execution (see
+\fI\%Dynamically\-Generated Resource Specification File\fP).
+.sp
+If a dashboard script is used and \fBRESOURCE_SPEC_FILE\fP is not specified, the
+value of \X'tty: link #variable:CTEST_RESOURCE_SPEC_FILE'\fI\%CTEST_RESOURCE_SPEC_FILE\fP\X'tty: link' in the dashboard script is used
+instead.  If \fI\%\-\-resource\-spec\-file\fP,
+\fBRESOURCE_SPEC_FILE\fP, and \X'tty: link #variable:CTEST_RESOURCE_SPEC_FILE'\fI\%CTEST_RESOURCE_SPEC_FILE\fP\X'tty: link' in the
+dashboard script are not specified, the value of
+\X'tty: link #variable:CTEST_RESOURCE_SPEC_FILE'\fI\%CTEST_RESOURCE_SPEC_FILE\fP\X'tty: link' in the CMake build is used instead.
+If none of these are specified, no resource spec file is used.
+.sp
+The resource specification file must be a JSON object. All examples in this
+document assume the following resource specification file:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  \(dqversion\(dq: {
+    \(dqmajor\(dq: 1,
+    \(dqminor\(dq: 0
+  },
+  \(dqlocal\(dq: [
+    {
+      \(dqgpus\(dq: [
+        {
+          \(dqid\(dq: \(dq0\(dq,
+          \(dqslots\(dq: 2
+        },
+        {
+          \(dqid\(dq: \(dq1\(dq,
+          \(dqslots\(dq: 4
+        },
+        {
+          \(dqid\(dq: \(dq2\(dq,
+          \(dqslots\(dq: 2
+        },
+        {
+          \(dqid\(dq: \(dq3\(dq
+        }
+      ],
+      \(dqcrypto_chips\(dq: [
+        {
+          \(dqid\(dq: \(dqcard0\(dq,
+          \(dqslots\(dq: 4
+        }
+      ]
+    }
+  ]
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The members are:
+.INDENT 0.0
+.TP
+.B \fBversion\fP
+An object containing a \fBmajor\fP integer field and a \fBminor\fP integer field.
+Currently, the only supported version is major \fB1\fP, minor \fB0\fP\&. Any other
+value is an error.
+.TP
+.B \fBlocal\fP
+A JSON array of resource sets present on the system.  Currently, this array
+is restricted to being of size 1.
+.sp
+Each array element is a JSON object with members whose names are equal to the
+desired resource types, such as \fBgpus\fP\&. These names must start with a
+lowercase letter or an underscore, and subsequent characters can be a
+lowercase letter, a digit, or an underscore. Uppercase letters are not
+allowed, because certain platforms have case\-insensitive environment
+variables. See the \fI\%Environment Variables\fP section below for
+more information. It is recommended that the resource type name be the plural
+of a noun, such as \fBgpus\fP or \fBcrypto_chips\fP (and not \fBgpu\fP or
+\fBcrypto_chip\fP\&.)
+.sp
+Please note that the names \fBgpus\fP and \fBcrypto_chips\fP are just examples,
+and CTest does not interpret them in any way. You are free to make up any
+resource type you want to meet your own requirements.
+.sp
+The value for each resource type is a JSON array consisting of JSON objects,
+each of which describe a specific instance of the specified resource. These
+objects have the following members:
+.INDENT 7.0
+.TP
+.B \fBid\fP
+A string consisting of an identifier for the resource. Each character in
+the identifier can be a lowercase letter, a digit, or an underscore.
+Uppercase letters are not allowed.
+.sp
+Identifiers must be unique within a resource type. However, they do not
+have to be unique across resource types. For example, it is valid to have a
+\fBgpus\fP resource named \fB0\fP and a \fBcrypto_chips\fP resource named \fB0\fP,
+but not two \fBgpus\fP resources both named \fB0\fP\&.
+.sp
+Please note that the IDs \fB0\fP, \fB1\fP, \fB2\fP, \fB3\fP, and \fBcard0\fP are just
+examples, and CTest does not interpret them in any way. You are free to
+make up any IDs you want to meet your own requirements.
+.TP
+.B \fBslots\fP
+An optional unsigned number specifying the number of slots available on the
+resource. For example, this could be megabytes of RAM on a GPU, or
+cryptography units available on a cryptography chip. If \fBslots\fP is not
+specified, a default value of \fB1\fP is assumed.
+.UNINDENT
+.UNINDENT
+.sp
+In the example file above, there are four GPUs with ID\(aqs 0 through 3. GPU 0 has
+2 slots, GPU 1 has 4, GPU 2 has 2, and GPU 3 has a default of 1 slot. There is
+also one cryptography chip with 4 slots.
+.SS \fBRESOURCE_GROUPS\fP Property
+.sp
+See \X'tty: link #prop_test:RESOURCE_GROUPS'\fI\%RESOURCE_GROUPS\fP\X'tty: link' for a description of this property.
+.SS Environment Variables
+.sp
+Once CTest has decided which resources to allocate to a test, it passes this
+information to the test executable as a series of environment variables. For
+each example below, we will assume that the test in question has a
+\X'tty: link #prop_test:RESOURCE_GROUPS'\fI\%RESOURCE_GROUPS\fP\X'tty: link' property of
+\fB2,gpus:2;gpus:4,gpus:1,crypto_chips:2\fP\&.
+.sp
+The following variables are passed to the test process:
+.INDENT 0.0
+.TP
+.B CTEST_RESOURCE_GROUP_COUNT
+The total number of groups specified by the \X'tty: link #prop_test:RESOURCE_GROUPS'\fI\%RESOURCE_GROUPS\fP\X'tty: link'
+property. For example:
+.INDENT 7.0
+.IP \(bu 2
+\fBCTEST_RESOURCE_GROUP_COUNT=3\fP
+.UNINDENT
+.sp
+This variable will only be defined if \fI\%ctest(1)\fP has been given a
+\fB\-\-resource\-spec\-file\fP, or if \X'tty: link #command:ctest_test'\fI\%ctest_test()\fP\X'tty: link' has been given a
+\fBRESOURCE_SPEC_FILE\fP\&. If no resource specification file has been given,
+this variable will not be defined.
+.UNINDENT
+.INDENT 0.0
+.TP
+.B CTEST_RESOURCE_GROUP_<num>
+The list of resource types allocated to each group, with each item
+separated by a comma. \fB<num>\fP is a number from zero to
+\fBCTEST_RESOURCE_GROUP_COUNT\fP minus one. \fBCTEST_RESOURCE_GROUP_<num>\fP
+is defined for each \fB<num>\fP in this range. For example:
+.INDENT 7.0
+.IP \(bu 2
+\fBCTEST_RESOURCE_GROUP_0=gpus\fP
+.IP \(bu 2
+\fBCTEST_RESOURCE_GROUP_1=gpus\fP
+.IP \(bu 2
+\fBCTEST_RESOURCE_GROUP_2=crypto_chips,gpus\fP
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.TP
+.B CTEST_RESOURCE_GROUP_<num>_<resource\-type>
+The list of resource IDs and number of slots from each ID allocated to each
+group for a given resource type. This variable consists of a series of
+pairs, each pair separated by a semicolon, and with the two items in the pair
+separated by a comma. The first item in each pair is \fBid:\fP followed by the
+ID of a resource of type \fB<resource\-type>\fP, and the second item is
+\fBslots:\fP followed by the number of slots from that resource allocated to
+the given group. For example:
+.INDENT 7.0
+.IP \(bu 2
+\fBCTEST_RESOURCE_GROUP_0_GPUS=id:0,slots:2\fP
+.IP \(bu 2
+\fBCTEST_RESOURCE_GROUP_1_GPUS=id:2,slots:2\fP
+.IP \(bu 2
+\fBCTEST_RESOURCE_GROUP_2_GPUS=id:1,slots:4;id:3,slots:1\fP
+.IP \(bu 2
+\fBCTEST_RESOURCE_GROUP_2_CRYPTO_CHIPS=id:card0,slots:2\fP
+.UNINDENT
+.sp
+In this example, group 0 gets 2 slots from GPU \fB0\fP, group 1 gets 2 slots
+from GPU \fB2\fP, and group 2 gets 4 slots from GPU \fB1\fP, 1 slot from GPU
+\fB3\fP, and 2 slots from cryptography chip \fBcard0\fP\&.
+.sp
+\fB<num>\fP is a number from zero to \fBCTEST_RESOURCE_GROUP_COUNT\fP minus one.
+\fB<resource\-type>\fP is the name of a resource type, converted to uppercase.
+\fBCTEST_RESOURCE_GROUP_<num>_<resource\-type>\fP is defined for the product
+of each \fB<num>\fP in the range listed above and each resource type listed in
+\fBCTEST_RESOURCE_GROUP_<num>\fP\&.
+.sp
+Because some platforms have case\-insensitive names for environment variables,
+the names of resource types may not clash in a case\-insensitive environment.
+Because of this, for the sake of simplicity, all resource types must be
+listed in all lowercase in the
+\fI\%resource specification file\fP and
+in the \X'tty: link #prop_test:RESOURCE_GROUPS'\fI\%RESOURCE_GROUPS\fP\X'tty: link' property, and they are converted to all
+uppercase in the \fBCTEST_RESOURCE_GROUP_<num>_<resource\-type>\fP environment
+variable.
+.UNINDENT
+.SS Dynamically\-Generated Resource Specification File
+.sp
+Added in version 3.28.
+
+.sp
+A project may optionally specify a single test which will be used to
+dynamically generate the resource specification file that CTest will use for
+scheduling tests that use resources. The test that generates the file must
+have the \X'tty: link #prop_test:GENERATED_RESOURCE_SPEC_FILE'\fI\%GENERATED_RESOURCE_SPEC_FILE\fP\X'tty: link' property set, and must have
+exactly one fixture in its \X'tty: link #prop_test:FIXTURES_SETUP'\fI\%FIXTURES_SETUP\fP\X'tty: link' property. This fixture
+is considered by CTest to have special meaning: it\(aqs the fixture that generates
+the resource spec file. The fixture may have any name. If such a fixture
+exists, all tests that have \X'tty: link #prop_test:RESOURCE_GROUPS'\fI\%RESOURCE_GROUPS\fP\X'tty: link' set must have the
+fixture in their \X'tty: link #prop_test:FIXTURES_REQUIRED'\fI\%FIXTURES_REQUIRED\fP\X'tty: link', and a resource spec file may
+not be specified with the \fB\-\-resource\-spec\-file\fP argument or the
+\X'tty: link #variable:CTEST_RESOURCE_SPEC_FILE'\fI\%CTEST_RESOURCE_SPEC_FILE\fP\X'tty: link' variable.
+.SH JOB SERVER INTEGRATION
+.sp
+Added in version 3.29.
+
+.sp
+On POSIX systems, when running under the context of a \X'tty: link https://www.gnu.org/software/make/manual/html_node/Job-Slots.html'\fI\%Job Server\fP\X'tty: link',
+CTest shares its job slots.  This is independent of the \X'tty: link #prop_test:PROCESSORS'\fI\%PROCESSORS\fP\X'tty: link'
+test property, which still counts against CTest\(aqs \fI\%\-j\fP
+parallel level.  CTest acquires exactly one token from the job server before
+running each test, and returns it when the test finishes.
+.sp
+For example, consider the \fBMakefile\fP:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+test:
+	+ctest \-j 8
+
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+When invoked via \fBmake \-j 2 test\fP, \fBctest\fP connects to the job server,
+acquires a token for each test, and runs at most 2 tests concurrently.
+.sp
+On Windows systems, job server integration is not yet implemented.
+.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.
+.

cmake/man/man7/cmake-buildsystem.7

@@ -0,0 +1,1640 @@
+.\" 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-BUILDSYSTEM" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-buildsystem \- CMake Buildsystem Reference
+.SH INTRODUCTION
+.sp
+A CMake\-based buildsystem is organized as a set of high\-level logical
+targets.  Each target corresponds to an executable or library, or
+is a custom target containing custom commands.  Dependencies between the
+targets are expressed in the buildsystem to determine the build order
+and the rules for regeneration in response to change.
+.SH BINARY TARGETS
+.sp
+Executables and libraries are defined using the \X'tty: link #command:add_executable'\fI\%add_executable()\fP\X'tty: link'
+and \X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link' commands.  The resulting binary files have
+appropriate \X'tty: link #prop_tgt:PREFIX'\fI\%PREFIX\fP\X'tty: link', \X'tty: link #prop_tgt:SUFFIX'\fI\%SUFFIX\fP\X'tty: link' and extensions for the
+platform targeted. Dependencies between binary targets are expressed using
+the \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' command:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(archive archive.cpp zip.cpp lzma.cpp)
+add_executable(zipapp zipapp.cpp)
+target_link_libraries(zipapp archive)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\fBarchive\fP is defined as a \fBSTATIC\fP library \-\- an archive containing objects
+compiled from \fBarchive.cpp\fP, \fBzip.cpp\fP, and \fBlzma.cpp\fP\&.  \fBzipapp\fP
+is defined as an executable formed by compiling and linking \fBzipapp.cpp\fP\&.
+When linking the \fBzipapp\fP executable, the \fBarchive\fP static library is
+linked in.
+.SS Binary Executables
+.sp
+The \X'tty: link #command:add_executable'\fI\%add_executable()\fP\X'tty: link' command defines an executable target:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_executable(mytool mytool.cpp)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Commands such as \X'tty: link #command:add_custom_command'\fI\%add_custom_command()\fP\X'tty: link', which generates rules to be
+run at build time can transparently use an \X'tty: link #prop_tgt:TYPE'\fI\%EXECUTABLE\fP\X'tty: link'
+target as a \fBCOMMAND\fP executable.  The buildsystem rules will ensure that
+the executable is built before attempting to run the command.
+.SS Binary Library Types
+.SS Normal Libraries
+.sp
+By default, the \X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link' command defines a \fBSTATIC\fP library,
+unless a type is specified.  A type may be specified when using the command:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(archive SHARED archive.cpp zip.cpp lzma.cpp)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(archive STATIC archive.cpp zip.cpp lzma.cpp)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \X'tty: link #variable:BUILD_SHARED_LIBS'\fI\%BUILD_SHARED_LIBS\fP\X'tty: link' variable may be enabled to change the
+behavior of \X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link' to build shared libraries by default.
+.sp
+In the context of the buildsystem definition as a whole, it is largely
+irrelevant whether particular libraries are \fBSHARED\fP or \fBSTATIC\fP \-\-
+the commands, dependency specifications and other APIs work similarly
+regardless of the library type.  The \fBMODULE\fP library type is
+dissimilar in that it is generally not linked to \-\- it is not used in
+the right\-hand\-side of the \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' command.
+It is a type which is loaded as a plugin using runtime techniques.
+If the library does not export any unmanaged symbols (e.g. Windows
+resource DLL, C++/CLI DLL), it is required that the library not be a
+\fBSHARED\fP library because CMake expects \fBSHARED\fP libraries to export
+at least one symbol.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(archive MODULE 7z.cpp)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Apple Frameworks
+.sp
+A \fBSHARED\fP library may be marked with the \X'tty: link #prop_tgt:FRAMEWORK'\fI\%FRAMEWORK\fP\X'tty: link'
+target property to create an macOS or iOS Framework Bundle.
+A library with the \fBFRAMEWORK\fP target property should also set the
+\X'tty: link #prop_tgt:FRAMEWORK_VERSION'\fI\%FRAMEWORK_VERSION\fP\X'tty: link' target property.  This property is typically
+set to the value of \(dqA\(dq by macOS conventions.
+The \fBMACOSX_FRAMEWORK_IDENTIFIER\fP sets the \fBCFBundleIdentifier\fP key
+and it uniquely identifies the bundle.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(MyFramework SHARED MyFramework.cpp)
+set_target_properties(MyFramework PROPERTIES
+  FRAMEWORK TRUE
+  FRAMEWORK_VERSION A # Version \(dqA\(dq is macOS convention
+  MACOSX_FRAMEWORK_IDENTIFIER org.cmake.MyFramework
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Object Libraries
+.sp
+The \fBOBJECT\fP library type defines a non\-archival collection of object files
+resulting from compiling the given source files.  The object files collection
+may be used as source inputs to other targets by using the syntax
+\X'tty: link #genex:TARGET_OBJECTS'\fI\%$<TARGET_OBJECTS:name>\fP\X'tty: link'\&.  This is a
+\X'tty: link #manual:cmake-generator-expressions(7)'\fI\%generator expression\fP\X'tty: link' that can be
+used to supply the \fBOBJECT\fP library content to other targets:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(archive OBJECT archive.cpp zip.cpp lzma.cpp)
+
+add_library(archiveExtras STATIC $<TARGET_OBJECTS:archive> extras.cpp)
+
+add_executable(test_exe $<TARGET_OBJECTS:archive> test.cpp)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The link (or archiving) step of those other targets will use the object
+files collection in addition to those from their own sources.
+.sp
+Alternatively, object libraries may be linked into other targets:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(archive OBJECT archive.cpp zip.cpp lzma.cpp)
+
+add_library(archiveExtras STATIC extras.cpp)
+target_link_libraries(archiveExtras PUBLIC archive)
+
+add_executable(test_exe test.cpp)
+target_link_libraries(test_exe archive)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The link (or archiving) step of those other targets will use the object
+files from \fBOBJECT\fP libraries that are \fIdirectly\fP linked.  Additionally,
+usage requirements of the \fBOBJECT\fP libraries will be honored when compiling
+sources in those other targets.  Furthermore, those usage requirements
+will propagate transitively to dependents of those other targets.
+.sp
+Object libraries may not be used as the \fBTARGET\fP in a use of the
+\X'tty: link #command:add_custom_command'\fI\%add_custom_command(TARGET)\fP\X'tty: link' command signature.  However,
+the list of objects can be used by \X'tty: link #command:add_custom_command'\fI\%add_custom_command(OUTPUT)\fP\X'tty: link'
+or \X'tty: link #generate'\fI\%file(GENERATE)\fP\X'tty: link' by using \fB$<TARGET_OBJECTS:objlib>\fP\&.
+.SH BUILD SPECIFICATION AND USAGE REQUIREMENTS
+.sp
+Targets build according to their own
+\fI\%build specification\fP in combination with
+\fI\%usage requirements\fP propagated from their
+link dependencies.  Both may be specified using target\-specific
+\fI\%commands\fP\&.
+.sp
+For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(archive SHARED archive.cpp zip.cpp)
+
+if (LZMA_FOUND)
+  # Add a source implementing support for lzma.
+  target_sources(archive PRIVATE lzma.cpp)
+
+  # Compile the \(aqarchive\(aq library sources with \(aq\-DBUILDING_WITH_LZMA\(aq.
+  target_compile_definitions(archive PRIVATE BUILDING_WITH_LZMA)
+endif()
+
+target_compile_definitions(archive INTERFACE USING_ARCHIVE_LIB)
+
+add_executable(consumer consumer.cpp)
+
+# Link \(aqconsumer\(aq to \(aqarchive\(aq.  This also consumes its usage requirements,
+# so \(aqconsumer.cpp\(aq is compiled with \(aq\-DUSING_ARCHIVE_LIB\(aq.
+target_link_libraries(consumer archive)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Target Commands
+.sp
+Target\-specific commands populate the
+\fI\%build specification\fP of \fI\%Binary Targets\fP and
+\fI\%usage requirements\fP of \fI\%Binary Targets\fP,
+\fI\%Interface Libraries\fP, and \fI\%Imported Targets\fP\&.
+.sp
+Invocations must specify scope keywords, each affecting the visibility
+of arguments following it.  The scopes are:
+.INDENT 0.0
+.TP
+.B \fBPUBLIC\fP
+Populates both properties for \fI\%building\fP
+and properties for \fI\%using\fP a target.
+.TP
+.B \fBPRIVATE\fP
+Populates only properties for \fI\%building\fP
+a target.
+.TP
+.B \fBINTERFACE\fP
+Populates only properties for \fI\%using\fP
+a target.
+.UNINDENT
+.sp
+The commands are:
+.INDENT 0.0
+.TP
+.B \X'tty: link #command:target_compile_definitions'\fI\%target_compile_definitions()\fP\X'tty: link'
+Populates the \X'tty: link #prop_tgt:COMPILE_DEFINITIONS'\fI\%COMPILE_DEFINITIONS\fP\X'tty: link' build specification and
+\X'tty: link #prop_tgt:INTERFACE_COMPILE_DEFINITIONS'\fI\%INTERFACE_COMPILE_DEFINITIONS\fP\X'tty: link' usage requirement properties.
+.sp
+For example, the call
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+target_compile_definitions(archive
+  PRIVATE   BUILDING_WITH_LZMA
+  INTERFACE USING_ARCHIVE_LIB
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+appends \fBBUILDING_WITH_LZMA\fP to the target\(aqs \fBCOMPILE_DEFINITIONS\fP
+property and appends \fBUSING_ARCHIVE_LIB\fP to the target\(aqs
+\fBINTERFACE_COMPILE_DEFINITIONS\fP property.
+.TP
+.B \X'tty: link #command:target_compile_options'\fI\%target_compile_options()\fP\X'tty: link'
+Populates the \X'tty: link #prop_tgt:COMPILE_OPTIONS'\fI\%COMPILE_OPTIONS\fP\X'tty: link' build specification and
+\X'tty: link #prop_tgt:INTERFACE_COMPILE_OPTIONS'\fI\%INTERFACE_COMPILE_OPTIONS\fP\X'tty: link' usage requirement properties.
+.TP
+.B \X'tty: link #command:target_compile_features'\fI\%target_compile_features()\fP\X'tty: link'
+Added in version 3.1.
+
+.sp
+Populates the \X'tty: link #prop_tgt:COMPILE_FEATURES'\fI\%COMPILE_FEATURES\fP\X'tty: link' build specification and
+\X'tty: link #prop_tgt:INTERFACE_COMPILE_FEATURES'\fI\%INTERFACE_COMPILE_FEATURES\fP\X'tty: link' usage requirement properties.
+.TP
+.B \X'tty: link #command:target_include_directories'\fI\%target_include_directories()\fP\X'tty: link'
+Populates the \X'tty: link #prop_tgt:INCLUDE_DIRECTORIES'\fI\%INCLUDE_DIRECTORIES\fP\X'tty: link' build specification
+and \X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link' usage requirement
+properties.  With the \fBSYSTEM\fP option, it also populates the
+\X'tty: link #prop_tgt:INTERFACE_SYSTEM_INCLUDE_DIRECTORIES'\fI\%INTERFACE_SYSTEM_INCLUDE_DIRECTORIES\fP\X'tty: link' usage requirement.
+.sp
+For convenience, the \X'tty: link #variable:CMAKE_INCLUDE_CURRENT_DIR'\fI\%CMAKE_INCLUDE_CURRENT_DIR\fP\X'tty: link' variable
+may be enabled to add the source directory and corresponding build
+directory as \fBINCLUDE_DIRECTORIES\fP on all targets.  Similarly,
+the \X'tty: link #variable:CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE'\fI\%CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE\fP\X'tty: link' variable may
+be enabled to add them as \fBINTERFACE_INCLUDE_DIRECTORIES\fP on all
+targets.
+.TP
+.B \X'tty: link #command:target_sources'\fI\%target_sources()\fP\X'tty: link'
+Added in version 3.1.
+
+.sp
+Populates the \X'tty: link #prop_tgt:SOURCES'\fI\%SOURCES\fP\X'tty: link' build specification and
+\X'tty: link #prop_tgt:INTERFACE_SOURCES'\fI\%INTERFACE_SOURCES\fP\X'tty: link' usage requirement properties.
+.sp
+It also supports specifying \X'tty: link #file-sets'\fI\%File Sets\fP\X'tty: link', which can add C++ module
+sources and headers not listed in the \fBSOURCES\fP and \fBINTERFACE_SOURCES\fP
+properties.  File sets may also populate the \X'tty: link #prop_tgt:INCLUDE_DIRECTORIES'\fI\%INCLUDE_DIRECTORIES\fP\X'tty: link'
+build specification and \X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link' usage
+requirement properties with the include directories containing the headers.
+.TP
+.B \X'tty: link #command:target_precompile_headers'\fI\%target_precompile_headers()\fP\X'tty: link'
+Added in version 3.16.
+
+.sp
+Populates the \X'tty: link #prop_tgt:PRECOMPILE_HEADERS'\fI\%PRECOMPILE_HEADERS\fP\X'tty: link' build specification and
+\X'tty: link #prop_tgt:INTERFACE_PRECOMPILE_HEADERS'\fI\%INTERFACE_PRECOMPILE_HEADERS\fP\X'tty: link' usage requirement properties.
+.TP
+.B \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link'
+Populates the \X'tty: link #prop_tgt:LINK_LIBRARIES'\fI\%LINK_LIBRARIES\fP\X'tty: link' build specification
+and \X'tty: link #prop_tgt:INTERFACE_LINK_LIBRARIES'\fI\%INTERFACE_LINK_LIBRARIES\fP\X'tty: link' usage requirement properties.
+.sp
+This is the primary mechanism by which link dependencies and their
+\fI\%usage requirements\fP are transitively
+propagated to affect compilation and linking of a target.
+.TP
+.B \X'tty: link #command:target_link_directories'\fI\%target_link_directories()\fP\X'tty: link'
+Added in version 3.13.
+
+.sp
+Populates the \X'tty: link #prop_tgt:LINK_DIRECTORIES'\fI\%LINK_DIRECTORIES\fP\X'tty: link' build specification and
+\X'tty: link #prop_tgt:INTERFACE_LINK_DIRECTORIES'\fI\%INTERFACE_LINK_DIRECTORIES\fP\X'tty: link' usage requirement properties.
+.TP
+.B \X'tty: link #command:target_link_options'\fI\%target_link_options()\fP\X'tty: link'
+Added in version 3.13.
+
+.sp
+Populates the \X'tty: link #prop_tgt:LINK_OPTIONS'\fI\%LINK_OPTIONS\fP\X'tty: link' build specification and
+\X'tty: link #prop_tgt:INTERFACE_LINK_OPTIONS'\fI\%INTERFACE_LINK_OPTIONS\fP\X'tty: link' usage requirement properties.
+.UNINDENT
+.SS Target Build Specification
+.sp
+The build specification of \fI\%Binary Targets\fP is represented by target
+properties.  For each of the following \fI\%compile\fP
+and \fI\%link\fP properties, compilation and linking
+of the target is affected both by its own value and by the corresponding
+\fI\%usage requirement\fP property, named with
+an \fBINTERFACE_\fP prefix, collected from the transitive closure of link
+dependencies.
+.SS Target Compile Properties
+.sp
+These represent the \fI\%build specification\fP
+for compiling a target.
+.INDENT 0.0
+.TP
+.B \X'tty: link #prop_tgt:COMPILE_DEFINITIONS'\fI\%COMPILE_DEFINITIONS\fP\X'tty: link'
+List of compile definitions for compiling sources in the target.
+These are passed to the compiler with \fB\-D\fP flags, or equivalent,
+in an unspecified order.
+.sp
+The \X'tty: link #prop_tgt:DEFINE_SYMBOL'\fI\%DEFINE_SYMBOL\fP\X'tty: link' target property is also used
+as a compile definition as a special convenience case for
+\fBSHARED\fP and \fBMODULE\fP library targets.
+.TP
+.B \X'tty: link #prop_tgt:COMPILE_OPTIONS'\fI\%COMPILE_OPTIONS\fP\X'tty: link'
+List of compile options for compiling sources in the target.
+These are passed to the compiler as flags, in the order of appearance.
+.sp
+Compile options are automatically escaped for the shell.
+.sp
+Some compile options are best specified via dedicated settings,
+such as the \X'tty: link #prop_tgt:POSITION_INDEPENDENT_CODE'\fI\%POSITION_INDEPENDENT_CODE\fP\X'tty: link' target property.
+.TP
+.B \X'tty: link #prop_tgt:COMPILE_FEATURES'\fI\%COMPILE_FEATURES\fP\X'tty: link'
+Added in version 3.1.
+
+.sp
+List of \X'tty: link #manual:cmake-compile-features(7)'\fI\%compile features\fP\X'tty: link' needed
+for compiling sources in the target.  Typically these ensure the
+target\(aqs sources are compiled using a sufficient language standard level.
+.TP
+.B \X'tty: link #prop_tgt:INCLUDE_DIRECTORIES'\fI\%INCLUDE_DIRECTORIES\fP\X'tty: link'
+List of include directories for compiling sources in the target.
+These are passed to the compiler with \fB\-I\fP or \fB\-isystem\fP flags,
+or equivalent, in the order of appearance.
+.sp
+For convenience, the \X'tty: link #variable:CMAKE_INCLUDE_CURRENT_DIR'\fI\%CMAKE_INCLUDE_CURRENT_DIR\fP\X'tty: link' variable
+may be enabled to add the source directory and corresponding build
+directory as \fBINCLUDE_DIRECTORIES\fP on all targets.
+.TP
+.B \X'tty: link #prop_tgt:SOURCES'\fI\%SOURCES\fP\X'tty: link'
+List of source files associated with the target.  This includes sources
+specified when the target was created by the \X'tty: link #command:add_executable'\fI\%add_executable()\fP\X'tty: link',
+\X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link', or \X'tty: link #command:add_custom_target'\fI\%add_custom_target()\fP\X'tty: link' command.
+It also includes sources added by the \X'tty: link #command:target_sources'\fI\%target_sources()\fP\X'tty: link' command,
+but does not include \X'tty: link #file-sets'\fI\%File Sets\fP\X'tty: link'\&.
+.TP
+.B \X'tty: link #prop_tgt:PRECOMPILE_HEADERS'\fI\%PRECOMPILE_HEADERS\fP\X'tty: link'
+Added in version 3.16.
+
+.sp
+List of header files to precompile and include when compiling
+sources in the target.
+.TP
+.B \X'tty: link #prop_tgt:AUTOMOC_MACRO_NAMES'\fI\%AUTOMOC_MACRO_NAMES\fP\X'tty: link'
+Added in version 3.10.
+
+.sp
+List of macro names used by \X'tty: link #prop_tgt:AUTOMOC'\fI\%AUTOMOC\fP\X'tty: link' to determine if a
+C++ source in the target needs to be processed by \fBmoc\fP\&.
+.TP
+.B \X'tty: link #prop_tgt:AUTOUIC_OPTIONS'\fI\%AUTOUIC_OPTIONS\fP\X'tty: link'
+Added in version 3.0.
+
+.sp
+List of options used by \X'tty: link #prop_tgt:AUTOUIC'\fI\%AUTOUIC\fP\X'tty: link' when invoking \fBuic\fP
+for the target.
+.UNINDENT
+.SS Target Link Properties
+.sp
+These represent the \fI\%build specification\fP
+for linking a target.
+.INDENT 0.0
+.TP
+.B \X'tty: link #prop_tgt:LINK_LIBRARIES'\fI\%LINK_LIBRARIES\fP\X'tty: link'
+List of link libraries for linking the target, if it is an executable,
+shared library, or module library.  Entries for \fI\%Normal Libraries\fP are
+passed to the linker either via paths to their link artifacts, or
+with \fB\-l\fP flags or equivalent.  Entries for \fI\%Object Libraries\fP are
+passed to the linker via paths to their object files.
+.sp
+Additionally, for compiling and linking the target itself,
+\fI\%usage requirements\fP are propagated from
+\fBLINK_LIBRARIES\fP entries naming \fI\%Normal Libraries\fP,
+\fI\%Interface Libraries\fP, \fI\%Object Libraries\fP, and \fI\%Imported Targets\fP,
+collected over the transitive closure of their
+\X'tty: link #prop_tgt:INTERFACE_LINK_LIBRARIES'\fI\%INTERFACE_LINK_LIBRARIES\fP\X'tty: link' properties.
+.TP
+.B \X'tty: link #prop_tgt:LINK_DIRECTORIES'\fI\%LINK_DIRECTORIES\fP\X'tty: link'
+Added in version 3.13.
+
+.sp
+List of link directories for linking the target, if it is an executable,
+shared library, or module library.  The directories are passed to the
+linker with \fB\-L\fP flags, or equivalent.
+.TP
+.B \X'tty: link #prop_tgt:LINK_OPTIONS'\fI\%LINK_OPTIONS\fP\X'tty: link'
+Added in version 3.13.
+
+.sp
+List of link options for linking the target, if it is an executable,
+shared library, or module library.  The options are passed to the
+linker as flags, in the order of appearance.
+.sp
+Link options are automatically escaped for the shell.
+.TP
+.B \X'tty: link #prop_tgt:LINK_DEPENDS'\fI\%LINK_DEPENDS\fP\X'tty: link'
+List of files on which linking the target depends, if it is an executable,
+shared library, or module library.  For example, linker scripts specified
+via \X'tty: link #prop_tgt:LINK_OPTIONS'\fI\%LINK_OPTIONS\fP\X'tty: link' may be listed here such that changing them
+causes binaries to be linked again.
+.UNINDENT
+.SS Target Usage Requirements
+.sp
+The \fIusage requirements\fP of a target are settings that propagate to consumers,
+which link to the target via \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link', in order to
+correctly compile and link with it.  They are represented by transitive
+\fI\%compile\fP and
+\fI\%link\fP properties.
+.sp
+Note that usage requirements are not designed as a way to make downstreams
+use particular \X'tty: link #prop_tgt:COMPILE_OPTIONS'\fI\%COMPILE_OPTIONS\fP\X'tty: link', \X'tty: link #prop_tgt:COMPILE_DEFINITIONS'\fI\%COMPILE_DEFINITIONS\fP\X'tty: link',
+etc. for convenience only.  The contents of the properties must be
+\fBrequirements\fP, not merely recommendations.
+.sp
+See the \X'tty: link #creating-relocatable-packages'\fI\%Creating Relocatable Packages\fP\X'tty: link' section of the
+\X'tty: link #manual:cmake-packages(7)'\fI\%cmake\-packages(7)\fP\X'tty: link' manual for discussion of additional care
+that must be taken when specifying usage requirements while creating
+packages for redistribution.
+.sp
+The usage requirements of a target can transitively propagate to the dependents.
+The \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' command has \fBPRIVATE\fP,
+\fBINTERFACE\fP and \fBPUBLIC\fP keywords to control the propagation.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(archive archive.cpp)
+target_compile_definitions(archive INTERFACE USING_ARCHIVE_LIB)
+
+add_library(serialization serialization.cpp)
+target_compile_definitions(serialization INTERFACE USING_SERIALIZATION_LIB)
+
+add_library(archiveExtras extras.cpp)
+target_link_libraries(archiveExtras PUBLIC archive)
+target_link_libraries(archiveExtras PRIVATE serialization)
+# archiveExtras is compiled with \-DUSING_ARCHIVE_LIB
+# and \-DUSING_SERIALIZATION_LIB
+
+add_executable(consumer consumer.cpp)
+# consumer is compiled with \-DUSING_ARCHIVE_LIB
+target_link_libraries(consumer archiveExtras)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Because the \fBarchive\fP is a \fBPUBLIC\fP dependency of \fBarchiveExtras\fP, the
+usage requirements of it are propagated to \fBconsumer\fP too.
+.sp
+Because
+\fBserialization\fP is a \fBPRIVATE\fP dependency of \fBarchiveExtras\fP, the usage
+requirements of it are not propagated to \fBconsumer\fP\&.
+.sp
+Generally, a dependency should be specified in a use of
+\X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' with the \fBPRIVATE\fP keyword if it is used by
+only the implementation of a library, and not in the header files.  If a
+dependency is additionally used in the header files of a library (e.g. for
+class inheritance), then it should be specified as a \fBPUBLIC\fP dependency.
+A dependency which is not used by the implementation of a library, but only by
+its headers should be specified as an \fBINTERFACE\fP dependency.  The
+\X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' command may be invoked with multiple uses of
+each keyword:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+target_link_libraries(archiveExtras
+  PUBLIC archive
+  PRIVATE serialization
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Usage requirements are propagated by reading the \fBINTERFACE_\fP variants
+of target properties from dependencies and appending the values to the
+non\-\fBINTERFACE_\fP variants of the operand.  For example, the
+\X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link' of dependencies is read and
+appended to the \X'tty: link #prop_tgt:INCLUDE_DIRECTORIES'\fI\%INCLUDE_DIRECTORIES\fP\X'tty: link' of the operand.  In cases
+where order is relevant and maintained, and the order resulting from the
+\X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' calls does not allow correct compilation,
+use of an appropriate command to set the property directly may update the
+order.
+.sp
+For example, if the linked libraries for a target must be specified
+in the order \fBlib1\fP \fBlib2\fP \fBlib3\fP , but the include directories must
+be specified in the order \fBlib3\fP \fBlib1\fP \fBlib2\fP:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+target_link_libraries(myExe lib1 lib2 lib3)
+target_include_directories(myExe
+  PRIVATE $<TARGET_PROPERTY:lib3,INTERFACE_INCLUDE_DIRECTORIES>)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Note that care must be taken when specifying usage requirements for targets
+which will be exported for installation using the \X'tty: link #export'\fI\%install(EXPORT)\fP\X'tty: link'
+command.  See \X'tty: link #creating-packages'\fI\%Creating Packages\fP\X'tty: link' for more.
+.SS Transitive Compile Properties
+.sp
+These represent \fI\%usage requirements\fP for
+compiling consumers.
+.INDENT 0.0
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_COMPILE_DEFINITIONS'\fI\%INTERFACE_COMPILE_DEFINITIONS\fP\X'tty: link'
+List of compile definitions for compiling sources in the target\(aqs consumers.
+Typically these are used by the target\(aqs header files.
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_COMPILE_OPTIONS'\fI\%INTERFACE_COMPILE_OPTIONS\fP\X'tty: link'
+List of compile options for compiling sources in the target\(aqs consumers.
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_COMPILE_FEATURES'\fI\%INTERFACE_COMPILE_FEATURES\fP\X'tty: link'
+Added in version 3.1.
+
+.sp
+List of \X'tty: link #manual:cmake-compile-features(7)'\fI\%compile features\fP\X'tty: link' needed
+for compiling sources in the target\(aqs consumers.  Typically these
+ensure the target\(aqs header files are processed when compiling consumers
+using a sufficient language standard level.
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link'
+List of include directories for compiling sources in the target\(aqs consumers.
+Typically these are the locations of the target\(aqs header files.
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_SYSTEM_INCLUDE_DIRECTORIES'\fI\%INTERFACE_SYSTEM_INCLUDE_DIRECTORIES\fP\X'tty: link'
+List of directories that, when specified as include directories, e.g., by
+\X'tty: link #prop_tgt:INCLUDE_DIRECTORIES'\fI\%INCLUDE_DIRECTORIES\fP\X'tty: link' or \X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link',
+should be treated as \(dqsystem\(dq include directories when compiling sources
+in the target\(aqs consumers.
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_SOURCES'\fI\%INTERFACE_SOURCES\fP\X'tty: link'
+List of source files to associate with the target\(aqs consumers.
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_PRECOMPILE_HEADERS'\fI\%INTERFACE_PRECOMPILE_HEADERS\fP\X'tty: link'
+Added in version 3.16.
+
+.sp
+List of header files to precompile and include when compiling
+sources in the target\(aqs consumers.
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_AUTOMOC_MACRO_NAMES'\fI\%INTERFACE_AUTOMOC_MACRO_NAMES\fP\X'tty: link'
+Added in version 3.27.
+
+.sp
+List of macro names used by \X'tty: link #prop_tgt:AUTOMOC'\fI\%AUTOMOC\fP\X'tty: link' to determine if a
+C++ source in the target\(aqs consumers needs to be processed by \fBmoc\fP\&.
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_AUTOUIC_OPTIONS'\fI\%INTERFACE_AUTOUIC_OPTIONS\fP\X'tty: link'
+Added in version 3.0.
+
+.sp
+List of options used by \X'tty: link #prop_tgt:AUTOUIC'\fI\%AUTOUIC\fP\X'tty: link' when invoking \fBuic\fP
+for the target\(aqs consumers.
+.UNINDENT
+.SS Transitive Link Properties
+.sp
+These represent \fI\%usage requirements\fP for
+linking consumers.
+.INDENT 0.0
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_LINK_LIBRARIES'\fI\%INTERFACE_LINK_LIBRARIES\fP\X'tty: link'
+List of link libraries for linking the target\(aqs consumers, for
+those that are executables, shared libraries, or module libraries.
+These are the transitive dependencies of the target.
+.sp
+Additionally, for compiling and linking the target\(aqs consumers,
+\fI\%usage requirements\fP are collected from
+the transitive closure of \fBINTERFACE_LINK_LIBRARIES\fP entries naming
+\fI\%Normal Libraries\fP, \fI\%Interface Libraries\fP, \fI\%Object Libraries\fP,
+and \fI\%Imported Targets\fP,
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_LINK_DIRECTORIES'\fI\%INTERFACE_LINK_DIRECTORIES\fP\X'tty: link'
+Added in version 3.13.
+
+.sp
+List of link directories for linking the target\(aqs consumers, for
+those that are executables, shared libraries, or module libraries.
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_LINK_OPTIONS'\fI\%INTERFACE_LINK_OPTIONS\fP\X'tty: link'
+Added in version 3.13.
+
+.sp
+List of link options for linking the target\(aqs consumers, for
+those that are executables, shared libraries, or module libraries.
+.TP
+.B \X'tty: link #prop_tgt:INTERFACE_LINK_DEPENDS'\fI\%INTERFACE_LINK_DEPENDS\fP\X'tty: link'
+Added in version 3.13.
+
+.sp
+List of files on which linking the target\(aqs consumers depends, for
+those that are executables, shared libraries, or module libraries.
+.UNINDENT
+.SS Custom Transitive Properties
+.sp
+Added in version 3.30.
+
+.sp
+The \X'tty: link #genex:TARGET_PROPERTY'\fI\%TARGET_PROPERTY\fP\X'tty: link' generator expression evaluates the above
+\fI\%build specification\fP and
+\fI\%usage requirement\fP properties
+as builtin transitive properties.  It also supports custom transitive
+properties defined by the \X'tty: link #prop_tgt:TRANSITIVE_COMPILE_PROPERTIES'\fI\%TRANSITIVE_COMPILE_PROPERTIES\fP\X'tty: link'
+and \X'tty: link #prop_tgt:TRANSITIVE_LINK_PROPERTIES'\fI\%TRANSITIVE_LINK_PROPERTIES\fP\X'tty: link' properties on the target
+and its link dependencies.
+.sp
+For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(example INTERFACE)
+set_target_properties(example PROPERTIES
+  TRANSITIVE_COMPILE_PROPERTIES \(dqCUSTOM_C\(dq
+  TRANSITIVE_LINK_PROPERTIES    \(dqCUSTOM_L\(dq
+
+  INTERFACE_CUSTOM_C \(dqEXAMPLE_CUSTOM_C\(dq
+  INTERFACE_CUSTOM_L \(dqEXAMPLE_CUSTOM_L\(dq
+  )
+
+add_library(mylib STATIC mylib.c)
+target_link_libraries(mylib PRIVATE example)
+set_target_properties(mylib PROPERTIES
+  CUSTOM_C           \(dqMYLIB_PRIVATE_CUSTOM_C\(dq
+  CUSTOM_L           \(dqMYLIB_PRIVATE_CUSTOM_L\(dq
+  INTERFACE_CUSTOM_C \(dqMYLIB_IFACE_CUSTOM_C\(dq
+  INTERFACE_CUSTOM_L \(dqMYLIB_IFACE_CUSTOM_L\(dq
+  )
+
+add_executable(myexe myexe.c)
+target_link_libraries(myexe PRIVATE mylib)
+set_target_properties(myexe PROPERTIES
+  CUSTOM_C \(dqMYEXE_CUSTOM_C\(dq
+  CUSTOM_L \(dqMYEXE_CUSTOM_L\(dq
+  )
+
+add_custom_target(print ALL VERBATIM
+  COMMAND ${CMAKE_COMMAND} \-E echo
+    # Prints \(dqMYLIB_PRIVATE_CUSTOM_C;EXAMPLE_CUSTOM_C\(dq
+    \(dq$<TARGET_PROPERTY:mylib,CUSTOM_C>\(dq
+
+    # Prints \(dqMYLIB_PRIVATE_CUSTOM_L;EXAMPLE_CUSTOM_L\(dq
+    \(dq$<TARGET_PROPERTY:mylib,CUSTOM_L>\(dq
+
+    # Prints \(dqMYEXE_CUSTOM_C\(dq
+    \(dq$<TARGET_PROPERTY:myexe,CUSTOM_C>\(dq
+
+    # Prints \(dqMYEXE_CUSTOM_L;MYLIB_IFACE_CUSTOM_L;EXAMPLE_CUSTOM_L\(dq
+    \(dq$<TARGET_PROPERTY:myexe,CUSTOM_L>\(dq
+  )
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Compatible Interface Properties
+.sp
+Some target properties are required to be compatible between a target and
+the interface of each dependency.  For example, the
+\X'tty: link #prop_tgt:POSITION_INDEPENDENT_CODE'\fI\%POSITION_INDEPENDENT_CODE\fP\X'tty: link' target property may specify a
+boolean value of whether a target should be compiled as
+position\-independent\-code, which has platform\-specific consequences.
+A target may also specify the usage requirement
+\X'tty: link #prop_tgt:INTERFACE_POSITION_INDEPENDENT_CODE'\fI\%INTERFACE_POSITION_INDEPENDENT_CODE\fP\X'tty: link' to communicate that
+consumers must be compiled as position\-independent\-code.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_executable(exe1 exe1.cpp)
+set_property(TARGET exe1 PROPERTY POSITION_INDEPENDENT_CODE ON)
+
+add_library(lib1 SHARED lib1.cpp)
+set_property(TARGET lib1 PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE ON)
+
+add_executable(exe2 exe2.cpp)
+target_link_libraries(exe2 lib1)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Here, both \fBexe1\fP and \fBexe2\fP will be compiled as position\-independent\-code.
+\fBlib1\fP will also be compiled as position\-independent\-code because that is the
+default setting for \fBSHARED\fP libraries.  If dependencies have conflicting,
+non\-compatible requirements \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' issues a diagnostic:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(lib1 SHARED lib1.cpp)
+set_property(TARGET lib1 PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE ON)
+
+add_library(lib2 SHARED lib2.cpp)
+set_property(TARGET lib2 PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE OFF)
+
+add_executable(exe1 exe1.cpp)
+target_link_libraries(exe1 lib1)
+set_property(TARGET exe1 PROPERTY POSITION_INDEPENDENT_CODE OFF)
+
+add_executable(exe2 exe2.cpp)
+target_link_libraries(exe2 lib1 lib2)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \fBlib1\fP requirement \fBINTERFACE_POSITION_INDEPENDENT_CODE\fP is not
+\(dqcompatible\(dq with the \X'tty: link #prop_tgt:POSITION_INDEPENDENT_CODE'\fI\%POSITION_INDEPENDENT_CODE\fP\X'tty: link' property of
+the \fBexe1\fP target.  The library requires that consumers are built as
+position\-independent\-code, while the executable specifies to not built as
+position\-independent\-code, so a diagnostic is issued.
+.sp
+The \fBlib1\fP and \fBlib2\fP requirements are not \(dqcompatible\(dq.  One of them
+requires that consumers are built as position\-independent\-code, while
+the other requires that consumers are not built as position\-independent\-code.
+Because \fBexe2\fP links to both and they are in conflict, a CMake error message
+is issued:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+CMake Error: The INTERFACE_POSITION_INDEPENDENT_CODE property of \(dqlib2\(dq does
+not agree with the value of POSITION_INDEPENDENT_CODE already determined
+for \(dqexe2\(dq.
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+To be \(dqcompatible\(dq, the \X'tty: link #prop_tgt:POSITION_INDEPENDENT_CODE'\fI\%POSITION_INDEPENDENT_CODE\fP\X'tty: link' property,
+if set must be either the same, in a boolean sense, as the
+\X'tty: link #prop_tgt:INTERFACE_POSITION_INDEPENDENT_CODE'\fI\%INTERFACE_POSITION_INDEPENDENT_CODE\fP\X'tty: link' property of all transitively
+specified dependencies on which that property is set.
+.sp
+This property of \(dqcompatible interface requirement\(dq may be extended to other
+properties by specifying the property in the content of the
+\X'tty: link #prop_tgt:COMPATIBLE_INTERFACE_BOOL'\fI\%COMPATIBLE_INTERFACE_BOOL\fP\X'tty: link' target property.  Each specified property
+must be compatible between the consuming target and the corresponding property
+with an \fBINTERFACE_\fP prefix from each dependency:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(lib1Version2 SHARED lib1_v2.cpp)
+set_property(TARGET lib1Version2 PROPERTY INTERFACE_CUSTOM_PROP ON)
+set_property(TARGET lib1Version2 APPEND PROPERTY
+  COMPATIBLE_INTERFACE_BOOL CUSTOM_PROP
+)
+
+add_library(lib1Version3 SHARED lib1_v3.cpp)
+set_property(TARGET lib1Version3 PROPERTY INTERFACE_CUSTOM_PROP OFF)
+
+add_executable(exe1 exe1.cpp)
+target_link_libraries(exe1 lib1Version2) # CUSTOM_PROP will be ON
+
+add_executable(exe2 exe2.cpp)
+target_link_libraries(exe2 lib1Version2 lib1Version3) # Diagnostic
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Non\-boolean properties may also participate in \(dqcompatible interface\(dq
+computations.  Properties specified in the
+\X'tty: link #prop_tgt:COMPATIBLE_INTERFACE_STRING'\fI\%COMPATIBLE_INTERFACE_STRING\fP\X'tty: link'
+property must be either unspecified or compare to the same string among
+all transitively specified dependencies. This can be useful to ensure
+that multiple incompatible versions of a library are not linked together
+through transitive requirements of a target:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(lib1Version2 SHARED lib1_v2.cpp)
+set_property(TARGET lib1Version2 PROPERTY INTERFACE_LIB_VERSION 2)
+set_property(TARGET lib1Version2 APPEND PROPERTY
+  COMPATIBLE_INTERFACE_STRING LIB_VERSION
+)
+
+add_library(lib1Version3 SHARED lib1_v3.cpp)
+set_property(TARGET lib1Version3 PROPERTY INTERFACE_LIB_VERSION 3)
+
+add_executable(exe1 exe1.cpp)
+target_link_libraries(exe1 lib1Version2) # LIB_VERSION will be \(dq2\(dq
+
+add_executable(exe2 exe2.cpp)
+target_link_libraries(exe2 lib1Version2 lib1Version3) # Diagnostic
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \X'tty: link #prop_tgt:COMPATIBLE_INTERFACE_NUMBER_MAX'\fI\%COMPATIBLE_INTERFACE_NUMBER_MAX\fP\X'tty: link' target property specifies
+that content will be evaluated numerically and the maximum number among all
+specified will be calculated:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(lib1Version2 SHARED lib1_v2.cpp)
+set_property(TARGET lib1Version2 PROPERTY INTERFACE_CONTAINER_SIZE_REQUIRED 200)
+set_property(TARGET lib1Version2 APPEND PROPERTY
+  COMPATIBLE_INTERFACE_NUMBER_MAX CONTAINER_SIZE_REQUIRED
+)
+
+add_library(lib1Version3 SHARED lib1_v3.cpp)
+set_property(TARGET lib1Version3 PROPERTY INTERFACE_CONTAINER_SIZE_REQUIRED 1000)
+
+add_executable(exe1 exe1.cpp)
+# CONTAINER_SIZE_REQUIRED will be \(dq200\(dq
+target_link_libraries(exe1 lib1Version2)
+
+add_executable(exe2 exe2.cpp)
+# CONTAINER_SIZE_REQUIRED will be \(dq1000\(dq
+target_link_libraries(exe2 lib1Version2 lib1Version3)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Similarly, the \X'tty: link #prop_tgt:COMPATIBLE_INTERFACE_NUMBER_MIN'\fI\%COMPATIBLE_INTERFACE_NUMBER_MIN\fP\X'tty: link' may be used to
+calculate the numeric minimum value for a property from dependencies.
+.sp
+Each calculated \(dqcompatible\(dq property value may be read in the consumer at
+generate\-time using generator expressions.
+.sp
+Note that for each dependee, the set of properties specified in each
+compatible interface property must not intersect with the set specified in
+any of the other properties.
+.SS Property Origin Debugging
+.sp
+Because build specifications can be determined by dependencies, the lack of
+locality of code which creates a target and code which is responsible for
+setting build specifications may make the code more difficult to reason about.
+\X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' provides a debugging facility to print the origin of the
+contents of properties which may be determined by dependencies.  The properties
+which can be debugged are listed in the
+\X'tty: link #variable:CMAKE_DEBUG_TARGET_PROPERTIES'\fI\%CMAKE_DEBUG_TARGET_PROPERTIES\fP\X'tty: link' variable documentation:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_DEBUG_TARGET_PROPERTIES
+  INCLUDE_DIRECTORIES
+  COMPILE_DEFINITIONS
+  POSITION_INDEPENDENT_CODE
+  CONTAINER_SIZE_REQUIRED
+  LIB_VERSION
+)
+add_executable(exe1 exe1.cpp)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In the case of properties listed in \X'tty: link #prop_tgt:COMPATIBLE_INTERFACE_BOOL'\fI\%COMPATIBLE_INTERFACE_BOOL\fP\X'tty: link' or
+\X'tty: link #prop_tgt:COMPATIBLE_INTERFACE_STRING'\fI\%COMPATIBLE_INTERFACE_STRING\fP\X'tty: link', the debug output shows which target
+was responsible for setting the property, and which other dependencies also
+defined the property.  In the case of
+\X'tty: link #prop_tgt:COMPATIBLE_INTERFACE_NUMBER_MAX'\fI\%COMPATIBLE_INTERFACE_NUMBER_MAX\fP\X'tty: link' and
+\X'tty: link #prop_tgt:COMPATIBLE_INTERFACE_NUMBER_MIN'\fI\%COMPATIBLE_INTERFACE_NUMBER_MIN\fP\X'tty: link', the debug output shows the
+value of the property from each dependency, and whether the value determines
+the new extreme.
+.SS Build Specification with Generator Expressions
+.sp
+Build specifications may use
+\X'tty: link #manual:cmake-generator-expressions(7)'\fI\%generator expressions\fP\X'tty: link' containing
+content which may be conditional or known only at generate\-time.  For example,
+the calculated \(dqcompatible\(dq value of a property may be read with the
+\fBTARGET_PROPERTY\fP expression:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(lib1Version2 SHARED lib1_v2.cpp)
+set_property(TARGET lib1Version2 PROPERTY
+  INTERFACE_CONTAINER_SIZE_REQUIRED 200)
+set_property(TARGET lib1Version2 APPEND PROPERTY
+  COMPATIBLE_INTERFACE_NUMBER_MAX CONTAINER_SIZE_REQUIRED
+)
+
+add_executable(exe1 exe1.cpp)
+target_link_libraries(exe1 lib1Version2)
+target_compile_definitions(exe1 PRIVATE
+    CONTAINER_SIZE=$<TARGET_PROPERTY:CONTAINER_SIZE_REQUIRED>
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In this case, the \fBexe1\fP source files will be compiled with
+\fB\-DCONTAINER_SIZE=200\fP\&.
+.sp
+The unary \fBTARGET_PROPERTY\fP generator expression and the \fBTARGET_POLICY\fP
+generator expression are evaluated with the consuming target context.  This
+means that a usage requirement specification may be evaluated differently based
+on the consumer:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(lib1 lib1.cpp)
+target_compile_definitions(lib1 INTERFACE
+  $<$<STREQUAL:$<TARGET_PROPERTY:TYPE>,EXECUTABLE>:LIB1_WITH_EXE>
+  $<$<STREQUAL:$<TARGET_PROPERTY:TYPE>,SHARED_LIBRARY>:LIB1_WITH_SHARED_LIB>
+  $<$<TARGET_POLICY:CMP0041>:CONSUMER_CMP0041_NEW>
+)
+
+add_executable(exe1 exe1.cpp)
+target_link_libraries(exe1 lib1)
+
+cmake_policy(SET CMP0041 NEW)
+
+add_library(shared_lib shared_lib.cpp)
+target_link_libraries(shared_lib lib1)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \fBexe1\fP executable will be compiled with \fB\-DLIB1_WITH_EXE\fP, while the
+\fBshared_lib\fP shared library will be compiled with \fB\-DLIB1_WITH_SHARED_LIB\fP
+and \fB\-DCONSUMER_CMP0041_NEW\fP, because policy \X'tty: link #policy:CMP0041'\fI\%CMP0041\fP\X'tty: link' is
+\fBNEW\fP at the point where the \fBshared_lib\fP target is created.
+.sp
+The \fBBUILD_INTERFACE\fP expression wraps requirements which are only used when
+consumed from a target in the same buildsystem, or when consumed from a target
+exported to the build directory using the \X'tty: link #command:export'\fI\%export()\fP\X'tty: link' command.  The
+\fBINSTALL_INTERFACE\fP expression wraps requirements which are only used when
+consumed from a target which has been installed and exported with the
+\X'tty: link #export'\fI\%install(EXPORT)\fP\X'tty: link' command:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(ClimbingStats climbingstats.cpp)
+target_compile_definitions(ClimbingStats INTERFACE
+  $<BUILD_INTERFACE:ClimbingStats_FROM_BUILD_LOCATION>
+  $<INSTALL_INTERFACE:ClimbingStats_FROM_INSTALLED_LOCATION>
+)
+install(TARGETS ClimbingStats EXPORT libExport ${InstallArgs})
+install(EXPORT libExport NAMESPACE Upstream::
+        DESTINATION lib/cmake/ClimbingStats)
+export(EXPORT libExport NAMESPACE Upstream::)
+
+add_executable(exe1 exe1.cpp)
+target_link_libraries(exe1 ClimbingStats)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In this case, the \fBexe1\fP executable will be compiled with
+\fB\-DClimbingStats_FROM_BUILD_LOCATION\fP\&.  The exporting commands generate
+\X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets with either the \fBINSTALL_INTERFACE\fP or the
+\fBBUILD_INTERFACE\fP omitted, and the \fB*_INTERFACE\fP marker stripped away.
+A separate project consuming the \fBClimbingStats\fP package would contain:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_package(ClimbingStats REQUIRED)
+
+add_executable(Downstream main.cpp)
+target_link_libraries(Downstream Upstream::ClimbingStats)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Depending on whether the \fBClimbingStats\fP package was used from the build
+location or the install location, the \fBDownstream\fP target would be compiled
+with either \fB\-DClimbingStats_FROM_BUILD_LOCATION\fP or
+\fB\-DClimbingStats_FROM_INSTALL_LOCATION\fP\&.  For more about packages and
+exporting see the \X'tty: link #manual:cmake-packages(7)'\fI\%cmake\-packages(7)\fP\X'tty: link' manual.
+.SS Include Directories and Usage Requirements
+.sp
+Include directories require some special consideration when specified as usage
+requirements and when used with generator expressions.  The
+\X'tty: link #command:target_include_directories'\fI\%target_include_directories()\fP\X'tty: link' command accepts both relative and
+absolute include directories:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(lib1 lib1.cpp)
+target_include_directories(lib1 PRIVATE
+  /absolute/path
+  relative/path
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Relative paths are interpreted relative to the source directory where the
+command appears.  Relative paths are not allowed in the
+\X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link' of \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets.
+.sp
+In cases where a non\-trivial generator expression is used, the
+\fBINSTALL_PREFIX\fP expression may be used within the argument of an
+\fBINSTALL_INTERFACE\fP expression.  It is a replacement marker which
+expands to the installation prefix when imported by a consuming project.
+.sp
+Include directories usage requirements commonly differ between the build\-tree
+and the install\-tree.  The \fBBUILD_INTERFACE\fP and \fBINSTALL_INTERFACE\fP
+generator expressions can be used to describe separate usage requirements
+based on the usage location.  Relative paths are allowed within the
+\fBINSTALL_INTERFACE\fP expression and are interpreted relative to the
+installation prefix.  For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(ClimbingStats climbingstats.cpp)
+target_include_directories(ClimbingStats INTERFACE
+  $<BUILD_INTERFACE:${CMAKE_CURRENT_BINARY_DIR}/generated>
+  $<INSTALL_INTERFACE:/absolute/path>
+  $<INSTALL_INTERFACE:relative/path>
+  $<INSTALL_INTERFACE:$<INSTALL_PREFIX>/$<CONFIG>/generated>
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Two convenience APIs are provided relating to include directories usage
+requirements.  The \X'tty: link #variable:CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE'\fI\%CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE\fP\X'tty: link' variable
+may be enabled, with an equivalent effect to:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set_property(TARGET tgt APPEND PROPERTY INTERFACE_INCLUDE_DIRECTORIES
+  $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR};${CMAKE_CURRENT_BINARY_DIR}>
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+for each target affected.  The convenience for installed targets is
+an \fBINCLUDES DESTINATION\fP component with the \X'tty: link #targets'\fI\%install(TARGETS)\fP\X'tty: link'
+command:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+install(TARGETS foo bar bat EXPORT tgts ${dest_args}
+  INCLUDES DESTINATION include
+)
+install(EXPORT tgts ${other_args})
+install(FILES ${headers} DESTINATION include)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This is equivalent to appending \fB${CMAKE_INSTALL_PREFIX}/include\fP to the
+\X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link' of each of the installed
+\X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets when generated by \X'tty: link #export'\fI\%install(EXPORT)\fP\X'tty: link'\&.
+.sp
+When the \X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link' of an
+\fI\%imported target\fP is consumed, the entries in the
+property may be treated as system include directories.  The effects of that
+are toolchain\-dependent, but one common effect is to omit compiler warnings
+for headers found in those directories.  The \X'tty: link #prop_tgt:SYSTEM'\fI\%SYSTEM\fP\X'tty: link' property of
+the installed target determines this behavior (see the
+\X'tty: link #prop_tgt:EXPORT_NO_SYSTEM'\fI\%EXPORT_NO_SYSTEM\fP\X'tty: link' property for how to modify the installed value
+for a target).  It is also possible to change how consumers interpret the
+system behavior of consumed imported targets by setting the
+\X'tty: link #prop_tgt:NO_SYSTEM_FROM_IMPORTED'\fI\%NO_SYSTEM_FROM_IMPORTED\fP\X'tty: link' target property on the \fIconsumer\fP\&.
+.sp
+If a binary target is linked transitively to a macOS \X'tty: link #prop_tgt:FRAMEWORK'\fI\%FRAMEWORK\fP\X'tty: link', the
+\fBHeaders\fP directory of the framework is also treated as a usage requirement.
+This has the same effect as passing the framework directory as an include
+directory.
+.SS Link Libraries and Generator Expressions
+.sp
+Like build specifications, \X'tty: link #prop_tgt:LINK_LIBRARIES'\fI\%link libraries\fP\X'tty: link' may be
+specified with generator expression conditions.  However, as consumption of
+usage requirements is based on collection from linked dependencies, there is
+an additional limitation that the link dependencies must form a \(dqdirected
+acyclic graph\(dq.  That is, if linking to a target is dependent on the value of
+a target property, that target property may not be dependent on the linked
+dependencies:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(lib1 lib1.cpp)
+add_library(lib2 lib2.cpp)
+target_link_libraries(lib1 PUBLIC
+  $<$<TARGET_PROPERTY:POSITION_INDEPENDENT_CODE>:lib2>
+)
+add_library(lib3 lib3.cpp)
+set_property(TARGET lib3 PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE ON)
+
+add_executable(exe1 exe1.cpp)
+target_link_libraries(exe1 lib1 lib3)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+As the value of the \X'tty: link #prop_tgt:POSITION_INDEPENDENT_CODE'\fI\%POSITION_INDEPENDENT_CODE\fP\X'tty: link' property of
+the \fBexe1\fP target is dependent on the linked libraries (\fBlib3\fP), and the
+edge of linking \fBexe1\fP is determined by the same
+\X'tty: link #prop_tgt:POSITION_INDEPENDENT_CODE'\fI\%POSITION_INDEPENDENT_CODE\fP\X'tty: link' property, the dependency graph above
+contains a cycle.  \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' issues an error message.
+.SS Output Artifacts
+.sp
+The buildsystem targets created by the \X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link' and
+\X'tty: link #command:add_executable'\fI\%add_executable()\fP\X'tty: link' commands create rules to create binary outputs.
+The exact output location of the binaries can only be determined at
+generate\-time because it can depend on the build\-configuration and the
+link\-language of linked dependencies etc.  \fBTARGET_FILE\fP,
+\fBTARGET_LINKER_FILE\fP and related expressions can be used to access the
+name and location of generated binaries.  These expressions do not work
+for \fBOBJECT\fP libraries however, as there is no single file generated
+by such libraries which is relevant to the expressions.
+.sp
+There are three kinds of output artifacts that may be build by targets
+as detailed in the following sections.  Their classification differs
+between DLL platforms and non\-DLL platforms.  All Windows\-based
+systems including Cygwin are DLL platforms.
+.SS Runtime Output Artifacts
+.sp
+A \fIruntime\fP output artifact of a buildsystem target may be:
+.INDENT 0.0
+.IP \(bu 2
+The executable file (e.g. \fB\&.exe\fP) of an executable target
+created by the \X'tty: link #command:add_executable'\fI\%add_executable()\fP\X'tty: link' command.
+.IP \(bu 2
+On DLL platforms: the executable file (e.g. \fB\&.dll\fP) of a shared
+library target created by the \X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link' command
+with the \fBSHARED\fP option.
+.UNINDENT
+.sp
+The \X'tty: link #prop_tgt:RUNTIME_OUTPUT_DIRECTORY'\fI\%RUNTIME_OUTPUT_DIRECTORY\fP\X'tty: link' and \X'tty: link #prop_tgt:RUNTIME_OUTPUT_NAME'\fI\%RUNTIME_OUTPUT_NAME\fP\X'tty: link'
+target properties may be used to control runtime output artifact locations
+and names in the build tree.
+.SS Library Output Artifacts
+.sp
+A \fIlibrary\fP output artifact of a buildsystem target may be:
+.INDENT 0.0
+.IP \(bu 2
+The loadable module file (e.g. \fB\&.dll\fP or \fB\&.so\fP) of a module
+library target created by the \X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link' command
+with the \fBMODULE\fP option.
+.IP \(bu 2
+On non\-DLL platforms: the shared library file (e.g. \fB\&.so\fP or \fB\&.dylib\fP)
+of a shared library target created by the \X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link'
+command with the \fBSHARED\fP option.
+.UNINDENT
+.sp
+The \X'tty: link #prop_tgt:LIBRARY_OUTPUT_DIRECTORY'\fI\%LIBRARY_OUTPUT_DIRECTORY\fP\X'tty: link' and \X'tty: link #prop_tgt:LIBRARY_OUTPUT_NAME'\fI\%LIBRARY_OUTPUT_NAME\fP\X'tty: link'
+target properties may be used to control library output artifact locations
+and names in the build tree.
+.SS Archive Output Artifacts
+.sp
+An \fIarchive\fP output artifact of a buildsystem target may be:
+.INDENT 0.0
+.IP \(bu 2
+The static library file (e.g. \fB\&.lib\fP or \fB\&.a\fP) of a static
+library target created by the \X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link' command
+with the \fBSTATIC\fP option.
+.IP \(bu 2
+On DLL platforms: the import library file (e.g. \fB\&.lib\fP) of a shared
+library target created by the \X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link' command
+with the \fBSHARED\fP option.  This file is only guaranteed to exist if
+the library exports at least one unmanaged symbol.
+.IP \(bu 2
+On DLL platforms: the import library file (e.g. \fB\&.lib\fP) of an
+executable target created by the \X'tty: link #command:add_executable'\fI\%add_executable()\fP\X'tty: link' command
+when its \X'tty: link #prop_tgt:ENABLE_EXPORTS'\fI\%ENABLE_EXPORTS\fP\X'tty: link' target property is set.
+.IP \(bu 2
+On AIX: the linker import file (e.g. \fB\&.imp\fP) of an executable target
+created by the \X'tty: link #command:add_executable'\fI\%add_executable()\fP\X'tty: link' command when its
+\X'tty: link #prop_tgt:ENABLE_EXPORTS'\fI\%ENABLE_EXPORTS\fP\X'tty: link' target property is set.
+.IP \(bu 2
+On macOS: the linker import file (e.g. \fB\&.tbd\fP) of a shared library target
+created by the \X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link' command with the \fBSHARED\fP option and
+when its \X'tty: link #prop_tgt:ENABLE_EXPORTS'\fI\%ENABLE_EXPORTS\fP\X'tty: link' target property is set.
+.UNINDENT
+.sp
+The \X'tty: link #prop_tgt:ARCHIVE_OUTPUT_DIRECTORY'\fI\%ARCHIVE_OUTPUT_DIRECTORY\fP\X'tty: link' and \X'tty: link #prop_tgt:ARCHIVE_OUTPUT_NAME'\fI\%ARCHIVE_OUTPUT_NAME\fP\X'tty: link'
+target properties may be used to control archive output artifact locations
+and names in the build tree.
+.SS Directory\-Scoped Commands
+.sp
+The \X'tty: link #command:target_include_directories'\fI\%target_include_directories()\fP\X'tty: link',
+\X'tty: link #command:target_compile_definitions'\fI\%target_compile_definitions()\fP\X'tty: link' and
+\X'tty: link #command:target_compile_options'\fI\%target_compile_options()\fP\X'tty: link' commands have an effect on only one
+target at a time.  The commands \X'tty: link #command:add_compile_definitions'\fI\%add_compile_definitions()\fP\X'tty: link',
+\X'tty: link #command:add_compile_options'\fI\%add_compile_options()\fP\X'tty: link' and \X'tty: link #command:include_directories'\fI\%include_directories()\fP\X'tty: link' have
+a similar function, but operate at directory scope instead of target
+scope for convenience.
+.SH BUILD CONFIGURATIONS
+.sp
+Configurations determine specifications for a certain type of build, such
+as \fBRelease\fP or \fBDebug\fP\&.  The way this is specified depends on the type
+of \X'tty: link #manual:cmake-generators(7)'\fI\%generator\fP\X'tty: link' being used.  For single
+configuration generators like  \X'tty: link #makefile-generators'\fI\%Makefile Generators\fP\X'tty: link' and
+\X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link', the configuration is specified at configure time by the
+\X'tty: link #variable:CMAKE_BUILD_TYPE'\fI\%CMAKE_BUILD_TYPE\fP\X'tty: link' variable. For multi\-configuration generators
+like \X'tty: link #visual-studio-generators'\fI\%Visual Studio\fP\X'tty: link', \X'tty: link #generator:Xcode'\fI\%Xcode\fP\X'tty: link', and
+\X'tty: link #generator:Ninja Multi-Config'\fI\%Ninja Multi\-Config\fP\X'tty: link', the configuration is chosen by the user at
+build time and \X'tty: link #variable:CMAKE_BUILD_TYPE'\fI\%CMAKE_BUILD_TYPE\fP\X'tty: link' is ignored.  In the
+multi\-configuration case, the set of \fIavailable\fP configurations is specified
+at configure time by the \X'tty: link #variable:CMAKE_CONFIGURATION_TYPES'\fI\%CMAKE_CONFIGURATION_TYPES\fP\X'tty: link' variable,
+but the actual configuration used cannot be known until the build stage.
+This difference is often misunderstood, leading to problematic code like the
+following:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# WARNING: This is wrong for multi\-config generators because they don\(aqt use
+#          and typically don\(aqt even set CMAKE_BUILD_TYPE
+string(TOLOWER ${CMAKE_BUILD_TYPE} build_type)
+if (build_type STREQUAL debug)
+  target_compile_definitions(exe1 PRIVATE DEBUG_BUILD)
+endif()
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\X'tty: link #manual:cmake-generator-expressions(7)'\fI\%Generator expressions\fP\X'tty: link' should be
+used instead to handle configuration\-specific logic correctly, regardless of
+the generator used.  For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# Works correctly for both single and multi\-config generators
+target_compile_definitions(exe1 PRIVATE
+  $<$<CONFIG:Debug>:DEBUG_BUILD>
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In the presence of \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets, the content of
+\X'tty: link #prop_tgt:MAP_IMPORTED_CONFIG_<CONFIG>'\fI\%MAP_IMPORTED_CONFIG_DEBUG\fP\X'tty: link' is also
+accounted for by the above \X'tty: link #genex:CONFIG'\fI\%$<CONFIG:Debug>\fP\X'tty: link' expression.
+.SS Case Sensitivity
+.sp
+\X'tty: link #variable:CMAKE_BUILD_TYPE'\fI\%CMAKE_BUILD_TYPE\fP\X'tty: link' and \X'tty: link #variable:CMAKE_CONFIGURATION_TYPES'\fI\%CMAKE_CONFIGURATION_TYPES\fP\X'tty: link' are
+just like other variables in that any string comparisons made with their
+values will be case\-sensitive.  The \X'tty: link #genex:CONFIG'\fI\%$<CONFIG>\fP\X'tty: link' generator expression also
+preserves the casing of the configuration as set by the user or CMake defaults.
+For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# NOTE: Don\(aqt use these patterns, they are for illustration purposes only.
+
+set(CMAKE_BUILD_TYPE Debug)
+if(CMAKE_BUILD_TYPE STREQUAL DEBUG)
+  # ... will never get here, \(dqDebug\(dq != \(dqDEBUG\(dq
+endif()
+add_custom_target(print_config ALL
+  # Prints \(dqConfig is Debug\(dq in this single\-config case
+  COMMAND ${CMAKE_COMMAND} \-E echo \(dqConfig is $<CONFIG>\(dq
+  VERBATIM
+)
+
+set(CMAKE_CONFIGURATION_TYPES Debug Release)
+if(DEBUG IN_LIST CMAKE_CONFIGURATION_TYPES)
+  # ... will never get here, \(dqDebug\(dq != \(dqDEBUG\(dq
+endif()
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In contrast, CMake treats the configuration type case\-insensitively when
+using it internally in places that modify behavior based on the configuration.
+For example, the \X'tty: link #genex:CONFIG'\fI\%$<CONFIG:Debug>\fP\X'tty: link' generator expression will evaluate to 1
+for a configuration of not only \fBDebug\fP, but also \fBDEBUG\fP, \fBdebug\fP or
+even \fBDeBuG\fP\&.  Therefore, you can specify configuration types in
+\X'tty: link #variable:CMAKE_BUILD_TYPE'\fI\%CMAKE_BUILD_TYPE\fP\X'tty: link' and \X'tty: link #variable:CMAKE_CONFIGURATION_TYPES'\fI\%CMAKE_CONFIGURATION_TYPES\fP\X'tty: link' with
+any mixture of upper and lowercase, although there are strong conventions
+(see the next section).  If you must test the value in string comparisons,
+always convert the value to upper or lowercase first and adjust the test
+accordingly.
+.SS Default And Custom Configurations
+.sp
+By default, CMake defines a number of standard configurations:
+.INDENT 0.0
+.IP \(bu 2
+\fBDebug\fP
+.IP \(bu 2
+\fBRelease\fP
+.IP \(bu 2
+\fBRelWithDebInfo\fP
+.IP \(bu 2
+\fBMinSizeRel\fP
+.UNINDENT
+.sp
+In multi\-config generators, the \X'tty: link #variable:CMAKE_CONFIGURATION_TYPES'\fI\%CMAKE_CONFIGURATION_TYPES\fP\X'tty: link' variable
+will be populated with (potentially a subset of) the above list by default,
+unless overridden by the project or user.  The actual configuration used is
+selected by the user at build time.
+.sp
+For single\-config generators, the configuration is specified with the
+\X'tty: link #variable:CMAKE_BUILD_TYPE'\fI\%CMAKE_BUILD_TYPE\fP\X'tty: link' variable at configure time and cannot be changed
+at build time.  The default value will often be none of the above standard
+configurations and will instead be an empty string.  A common misunderstanding
+is that this is the same as \fBDebug\fP, but that is not the case.  Users should
+always explicitly specify the build type instead to avoid this common problem.
+.sp
+The above standard configuration types provide reasonable behavior on most
+platforms, but they can be extended to provide other types.  Each configuration
+defines a set of compiler and linker flag variables for the language in use.
+These variables follow the convention \X'tty: link #variable:CMAKE_<LANG>_FLAGS_<CONFIG>'\fI\%CMAKE_<LANG>_FLAGS_<CONFIG>\fP\X'tty: link',
+where \fB<CONFIG>\fP is always the uppercase configuration name.  When defining
+a custom configuration type, make sure these variables are set appropriately,
+typically as cache variables.
+.SH PSEUDO TARGETS
+.sp
+Some target types do not represent outputs of the buildsystem, but only inputs
+such as external dependencies, aliases or other non\-build artifacts.  Pseudo
+targets are not represented in the generated buildsystem.
+.SS Imported Targets
+.sp
+An \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' target represents a pre\-existing dependency.  Usually
+such targets are defined by an upstream package and should be treated as
+immutable. After declaring an \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' target one can adjust its
+target properties by using the customary commands such as
+\X'tty: link #command:target_compile_definitions'\fI\%target_compile_definitions()\fP\X'tty: link', \X'tty: link #command:target_include_directories'\fI\%target_include_directories()\fP\X'tty: link',
+\X'tty: link #command:target_compile_options'\fI\%target_compile_options()\fP\X'tty: link' or \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' just like
+with any other regular target.
+.sp
+\X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets may have the same usage requirement properties
+populated as binary targets, such as
+\X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link',
+\X'tty: link #prop_tgt:INTERFACE_COMPILE_DEFINITIONS'\fI\%INTERFACE_COMPILE_DEFINITIONS\fP\X'tty: link',
+\X'tty: link #prop_tgt:INTERFACE_COMPILE_OPTIONS'\fI\%INTERFACE_COMPILE_OPTIONS\fP\X'tty: link',
+\X'tty: link #prop_tgt:INTERFACE_LINK_LIBRARIES'\fI\%INTERFACE_LINK_LIBRARIES\fP\X'tty: link', and
+\X'tty: link #prop_tgt:INTERFACE_POSITION_INDEPENDENT_CODE'\fI\%INTERFACE_POSITION_INDEPENDENT_CODE\fP\X'tty: link'\&.
+.sp
+The \X'tty: link #prop_tgt:LOCATION'\fI\%LOCATION\fP\X'tty: link' may also be read from an IMPORTED target, though there
+is rarely reason to do so.  Commands such as \X'tty: link #command:add_custom_command'\fI\%add_custom_command()\fP\X'tty: link' can
+transparently use an \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' \X'tty: link #prop_tgt:TYPE'\fI\%EXECUTABLE\fP\X'tty: link' target
+as a \fBCOMMAND\fP executable.
+.sp
+The scope of the definition of an \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' target is the directory
+where it was defined.  It may be accessed and used from subdirectories, but
+not from parent directories or sibling directories.  The scope is similar to
+the scope of a cmake variable.
+.sp
+It is also possible to define a \fBGLOBAL\fP \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' target which is
+accessible globally in the buildsystem.
+.sp
+See the \X'tty: link #manual:cmake-packages(7)'\fI\%cmake\-packages(7)\fP\X'tty: link' manual for more on creating packages
+with \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets.
+.SS Alias Targets
+.sp
+An \fBALIAS\fP target is a name which may be used interchangeably with
+a binary target name in read\-only contexts.  A primary use\-case for \fBALIAS\fP
+targets is for example or unit test executables accompanying a library, which
+may be part of the same buildsystem or built separately based on user
+configuration.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(lib1 lib1.cpp)
+install(TARGETS lib1 EXPORT lib1Export ${dest_args})
+install(EXPORT lib1Export NAMESPACE Upstream:: ${other_args})
+
+add_library(Upstream::lib1 ALIAS lib1)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In another directory, we can link unconditionally to the \fBUpstream::lib1\fP
+target, which may be an \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' target from a package, or an
+\fBALIAS\fP target if built as part of the same buildsystem.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+if (NOT TARGET Upstream::lib1)
+  find_package(lib1 REQUIRED)
+endif()
+add_executable(exe1 exe1.cpp)
+target_link_libraries(exe1 Upstream::lib1)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\fBALIAS\fP targets are not mutable, installable or exportable.  They are
+entirely local to the buildsystem description.  A name can be tested for
+whether it is an \fBALIAS\fP name by reading the \X'tty: link #prop_tgt:ALIASED_TARGET'\fI\%ALIASED_TARGET\fP\X'tty: link'
+property from it:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+get_target_property(_aliased Upstream::lib1 ALIASED_TARGET)
+if(_aliased)
+  message(STATUS \(dqThe name Upstream::lib1 is an ALIAS for ${_aliased}.\(dq)
+endif()
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Interface Libraries
+.sp
+An \fBINTERFACE\fP library target does not compile sources and does not
+produce a library artifact on disk, so it has no \X'tty: link #prop_tgt:LOCATION'\fI\%LOCATION\fP\X'tty: link'\&.
+.sp
+It may specify usage requirements such as
+\X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link',
+\X'tty: link #prop_tgt:INTERFACE_COMPILE_DEFINITIONS'\fI\%INTERFACE_COMPILE_DEFINITIONS\fP\X'tty: link',
+\X'tty: link #prop_tgt:INTERFACE_COMPILE_OPTIONS'\fI\%INTERFACE_COMPILE_OPTIONS\fP\X'tty: link',
+\X'tty: link #prop_tgt:INTERFACE_LINK_LIBRARIES'\fI\%INTERFACE_LINK_LIBRARIES\fP\X'tty: link',
+\X'tty: link #prop_tgt:INTERFACE_SOURCES'\fI\%INTERFACE_SOURCES\fP\X'tty: link',
+and \X'tty: link #prop_tgt:INTERFACE_POSITION_INDEPENDENT_CODE'\fI\%INTERFACE_POSITION_INDEPENDENT_CODE\fP\X'tty: link'\&.
+Only the \fBINTERFACE\fP modes of the \X'tty: link #command:target_include_directories'\fI\%target_include_directories()\fP\X'tty: link',
+\X'tty: link #command:target_compile_definitions'\fI\%target_compile_definitions()\fP\X'tty: link', \X'tty: link #command:target_compile_options'\fI\%target_compile_options()\fP\X'tty: link',
+\X'tty: link #command:target_sources'\fI\%target_sources()\fP\X'tty: link', and \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' commands
+may be used with \fBINTERFACE\fP libraries.
+.sp
+Since CMake 3.19, an \fBINTERFACE\fP library target may optionally contain
+source files.  An interface library that contains source files will be
+included as a build target in the generated buildsystem.  It does not
+compile sources, but may contain custom commands to generate other sources.
+Additionally, IDEs will show the source files as part of the target for
+interactive reading and editing.
+.sp
+A primary use\-case for \fBINTERFACE\fP libraries is header\-only libraries.
+Since CMake 3.23, header files may be associated with a library by adding
+them to a header set using the \X'tty: link #command:target_sources'\fI\%target_sources()\fP\X'tty: link' command:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(Eigen INTERFACE)
+
+target_sources(Eigen PUBLIC
+  FILE_SET HEADERS
+    BASE_DIRS src
+    FILES src/eigen.h src/vector.h src/matrix.h
+)
+
+add_executable(exe1 exe1.cpp)
+target_link_libraries(exe1 Eigen)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+When we specify the \fBFILE_SET\fP here, the \fBBASE_DIRS\fP we define automatically
+become include directories in the usage requirements for the target \fBEigen\fP\&.
+The usage requirements from the target are consumed and used when compiling, but
+have no effect on linking.
+.sp
+Another use\-case is to employ an entirely target\-focussed design for usage
+requirements:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(pic_on INTERFACE)
+set_property(TARGET pic_on PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE ON)
+add_library(pic_off INTERFACE)
+set_property(TARGET pic_off PROPERTY INTERFACE_POSITION_INDEPENDENT_CODE OFF)
+
+add_library(enable_rtti INTERFACE)
+target_compile_options(enable_rtti INTERFACE
+  $<$<OR:$<COMPILER_ID:GNU>,$<COMPILER_ID:Clang>>:\-rtti>
+)
+
+add_executable(exe1 exe1.cpp)
+target_link_libraries(exe1 pic_on enable_rtti)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This way, the build specification of \fBexe1\fP is expressed entirely as linked
+targets, and the complexity of compiler\-specific flags is encapsulated in an
+\fBINTERFACE\fP library target.
+.sp
+\fBINTERFACE\fP libraries may be installed and exported. We can install the
+default header set along with the target:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(Eigen INTERFACE)
+
+target_sources(Eigen INTERFACE
+  FILE_SET HEADERS
+    BASE_DIRS src
+    FILES src/eigen.h src/vector.h src/matrix.h
+)
+
+install(TARGETS Eigen EXPORT eigenExport
+  FILE_SET HEADERS DESTINATION include/Eigen)
+install(EXPORT eigenExport NAMESPACE Upstream::
+  DESTINATION lib/cmake/Eigen
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Here, the headers defined in the header set are installed to \fBinclude/Eigen\fP\&.
+The install destination automatically becomes an include directory that is a
+usage requirement for consumers.
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-compile-features.7

@@ -0,0 +1,395 @@
+.\" 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-COMPILE-FEATURES" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-compile-features \- CMake Compile Features Reference
+.SH INTRODUCTION
+.sp
+Project source code may depend on, or be conditional on, the availability
+of certain features of the compiler.  There are three use\-cases which arise:
+\fI\%Compile Feature Requirements\fP, \fI\%Optional Compile Features\fP
+and \fI\%Conditional Compilation Options\fP\&.
+.sp
+While features are typically specified in programming language standards,
+CMake provides a primary user interface based on granular handling of
+the features, not the language standard that introduced the feature.
+.sp
+The \X'tty: link #prop_gbl:CMAKE_C_KNOWN_FEATURES'\fI\%CMAKE_C_KNOWN_FEATURES\fP\X'tty: link', \X'tty: link #prop_gbl:CMAKE_CUDA_KNOWN_FEATURES'\fI\%CMAKE_CUDA_KNOWN_FEATURES\fP\X'tty: link',
+and \X'tty: link #prop_gbl:CMAKE_CXX_KNOWN_FEATURES'\fI\%CMAKE_CXX_KNOWN_FEATURES\fP\X'tty: link' global properties contain all the
+features known to CMake, regardless of compiler support for the feature.
+The \X'tty: link #variable:CMAKE_C_COMPILE_FEATURES'\fI\%CMAKE_C_COMPILE_FEATURES\fP\X'tty: link', \X'tty: link #variable:CMAKE_CUDA_COMPILE_FEATURES'\fI\%CMAKE_CUDA_COMPILE_FEATURES\fP\X'tty: link'
+, and \X'tty: link #variable:CMAKE_CXX_COMPILE_FEATURES'\fI\%CMAKE_CXX_COMPILE_FEATURES\fP\X'tty: link' variables contain all features
+CMake knows are known to the compiler, regardless of language standard
+or compile flags needed to use them.
+.sp
+Features known to CMake are named mostly following the same convention
+as the Clang feature test macros.  There are some exceptions, such as
+CMake using \fBcxx_final\fP and \fBcxx_override\fP instead of the single
+\fBcxx_override_control\fP used by Clang.
+.sp
+Note that there are no separate compile features properties or variables for
+the \fBOBJC\fP or \fBOBJCXX\fP languages.  These are based off \fBC\fP or \fBC++\fP
+respectively, so the properties and variables for their corresponding base
+language should be used instead.
+.SH COMPILE FEATURE REQUIREMENTS
+.sp
+Compile feature requirements may be specified with the
+\X'tty: link #command:target_compile_features'\fI\%target_compile_features()\fP\X'tty: link' command.  For example, if a target must
+be compiled with compiler support for the
+\X'tty: link #prop_gbl:CMAKE_CXX_KNOWN_FEATURES'\fI\%cxx_constexpr\fP\X'tty: link' feature:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(mylib requires_constexpr.cpp)
+target_compile_features(mylib PRIVATE cxx_constexpr)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In processing the requirement for the \fBcxx_constexpr\fP feature,
+\X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' will ensure that the in\-use C++ compiler is capable
+of the feature, and will add any necessary flags such as \fB\-std=gnu++11\fP
+to the compile lines of C++ files in the \fBmylib\fP target.  A
+\fBFATAL_ERROR\fP is issued if the compiler is not capable of the
+feature.
+.sp
+The exact compile flags and language standard are deliberately not part
+of the user interface for this use\-case.  CMake will compute the
+appropriate compile flags to use by considering the features specified
+for each target.
+.sp
+Such compile flags are added even if the compiler supports the
+particular feature without the flag. For example, the GNU compiler
+supports variadic templates (with a warning) even if \fB\-std=gnu++98\fP is
+used.  CMake adds the \fB\-std=gnu++11\fP flag if \fBcxx_variadic_templates\fP
+is specified as a requirement.
+.sp
+In the above example, \fBmylib\fP requires \fBcxx_constexpr\fP when it
+is built itself, but consumers of \fBmylib\fP are not required to use a
+compiler which supports \fBcxx_constexpr\fP\&.  If the interface of
+\fBmylib\fP does require the \fBcxx_constexpr\fP feature (or any other
+known feature), that may be specified with the \fBPUBLIC\fP or
+\fBINTERFACE\fP signatures of \X'tty: link #command:target_compile_features'\fI\%target_compile_features()\fP\X'tty: link':
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(mylib requires_constexpr.cpp)
+# cxx_constexpr is a usage\-requirement
+target_compile_features(mylib PUBLIC cxx_constexpr)
+
+# main.cpp will be compiled with \-std=gnu++11 on GNU for cxx_constexpr.
+add_executable(myexe main.cpp)
+target_link_libraries(myexe mylib)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Feature requirements are evaluated transitively by consuming the link
+implementation.  See \X'tty: link #manual:cmake-buildsystem(7)'\fI\%cmake\-buildsystem(7)\fP\X'tty: link' for more on
+transitive behavior of build properties and usage requirements.
+.SS Requiring Language Standards
+.sp
+In projects that use a large number of commonly available features from
+a particular language standard (e.g. C++ 11) one may specify a
+meta\-feature (e.g. \fBcxx_std_11\fP) that requires use of a compiler mode
+that is at minimum aware of that standard, but could be greater.
+This is simpler than specifying all the features individually, but does
+not guarantee the existence of any particular feature.
+Diagnosis of use of unsupported features will be delayed until compile time.
+.sp
+For example, if C++ 11 features are used extensively in a project\(aqs
+header files, then clients must use a compiler mode that is no less
+than C++ 11.  This can be requested with the code:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+target_compile_features(mylib PUBLIC cxx_std_11)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In this example, CMake will ensure the compiler is invoked in a mode
+of at\-least C++ 11 (or C++ 14, C++ 17, ...), adding flags such as
+\fB\-std=gnu++11\fP if necessary.  This applies to sources within \fBmylib\fP
+as well as any dependents (that may include headers from \fBmylib\fP).
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+If the compiler\(aqs default standard level is at least that
+of the requested feature, CMake may omit the \fB\-std=\fP flag.
+The flag may still be added if the compiler\(aqs default extensions mode
+does not match the \X'tty: link #prop_tgt:<LANG>_EXTENSIONS'\fI\%<LANG>_EXTENSIONS\fP\X'tty: link' target property,
+or if the \X'tty: link #prop_tgt:<LANG>_STANDARD'\fI\%<LANG>_STANDARD\fP\X'tty: link' target property is set.
+.UNINDENT
+.UNINDENT
+.SS Availability of Compiler Extensions
+.sp
+The \X'tty: link #prop_tgt:<LANG>_EXTENSIONS'\fI\%<LANG>_EXTENSIONS\fP\X'tty: link' target property defaults to the compiler\(aqs
+default (see \X'tty: link #variable:CMAKE_<LANG>_EXTENSIONS_DEFAULT'\fI\%CMAKE_<LANG>_EXTENSIONS_DEFAULT\fP\X'tty: link'). Note that because
+most compilers enable extensions by default, this may expose portability bugs
+in user code or in the headers of third\-party dependencies.
+.sp
+\X'tty: link #prop_tgt:<LANG>_EXTENSIONS'\fI\%<LANG>_EXTENSIONS\fP\X'tty: link' used to default to \fBON\fP\&. See \X'tty: link #policy:CMP0128'\fI\%CMP0128\fP\X'tty: link'\&.
+.SH OPTIONAL COMPILE FEATURES
+.sp
+Compile features may be preferred if available, without creating a hard
+requirement.   This can be achieved by \fInot\fP specifying features with
+\X'tty: link #command:target_compile_features'\fI\%target_compile_features()\fP\X'tty: link' and instead checking the compiler
+capabilities with preprocessor conditions in project code.
+.sp
+In this use\-case, the project may wish to establish a particular language
+standard if available from the compiler, and use preprocessor conditions
+to detect the features actually available.  A language standard may be
+established by \fI\%Requiring Language Standards\fP using
+\X'tty: link #command:target_compile_features'\fI\%target_compile_features()\fP\X'tty: link' with meta\-features like \fBcxx_std_11\fP,
+or by setting the \X'tty: link #prop_tgt:CXX_STANDARD'\fI\%CXX_STANDARD\fP\X'tty: link' target property or
+\X'tty: link #variable:CMAKE_CXX_STANDARD'\fI\%CMAKE_CXX_STANDARD\fP\X'tty: link' variable.
+.sp
+See also policy \X'tty: link #policy:CMP0120'\fI\%CMP0120\fP\X'tty: link' and legacy documentation on
+\X'tty: link #wcdh-example-usage'\fI\%Example Usage\fP\X'tty: link' of the deprecated
+\X'tty: link #module:WriteCompilerDetectionHeader'\fI\%WriteCompilerDetectionHeader\fP\X'tty: link' module.
+.SH CONDITIONAL COMPILATION OPTIONS
+.sp
+Libraries may provide entirely different header files depending on
+requested compiler features.
+.sp
+For example, a header at \fBwith_variadics/interface.h\fP may contain:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+template<int I, int... Is>
+struct Interface;
+
+template<int I>
+struct Interface<I>
+{
+  static int accumulate()
+  {
+    return I;
+  }
+};
+
+template<int I, int... Is>
+struct Interface
+{
+  static int accumulate()
+  {
+    return I + Interface<Is...>::accumulate();
+  }
+};
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+while a header at \fBno_variadics/interface.h\fP may contain:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+template<int I1, int I2 = 0, int I3 = 0, int I4 = 0>
+struct Interface
+{
+  static int accumulate() { return I1 + I2 + I3 + I4; }
+};
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+It may be possible to write an abstraction \fBinterface.h\fP header
+containing something like:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+#ifdef HAVE_CXX_VARIADIC_TEMPLATES
+#include \(dqwith_variadics/interface.h\(dq
+#else
+#include \(dqno_variadics/interface.h\(dq
+#endif
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+However this could be unmaintainable if there are many files to
+abstract. What is needed is to use alternative include directories
+depending on the compiler capabilities.
+.sp
+CMake provides a \fBCOMPILE_FEATURES\fP
+\X'tty: link #manual:cmake-generator-expressions(7)'\fI\%generator expression\fP\X'tty: link' to implement
+such conditions.  This may be used with the build\-property commands such as
+\X'tty: link #command:target_include_directories'\fI\%target_include_directories()\fP\X'tty: link' and \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link'
+to set the appropriate \X'tty: link #manual:cmake-buildsystem(7)'\fI\%buildsystem\fP\X'tty: link'
+properties:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(foo INTERFACE)
+set(with_variadics ${CMAKE_CURRENT_SOURCE_DIR}/with_variadics)
+set(no_variadics ${CMAKE_CURRENT_SOURCE_DIR}/no_variadics)
+target_include_directories(foo
+  INTERFACE
+    \(dq$<$<COMPILE_FEATURES:cxx_variadic_templates>:${with_variadics}>\(dq
+    \(dq$<$<NOT:$<COMPILE_FEATURES:cxx_variadic_templates>>:${no_variadics}>\(dq
+  )
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Consuming code then simply links to the \fBfoo\fP target as usual and uses
+the feature\-appropriate include directory
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_executable(consumer_with consumer_with.cpp)
+target_link_libraries(consumer_with foo)
+set_property(TARGET consumer_with CXX_STANDARD 11)
+
+add_executable(consumer_no consumer_no.cpp)
+target_link_libraries(consumer_no foo)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH SUPPORTED COMPILERS
+.sp
+CMake is currently aware of the \X'tty: link #prop_tgt:CXX_STANDARD'\fI\%C++ standards\fP\X'tty: link'
+and \X'tty: link #prop_gbl:CMAKE_CXX_KNOWN_FEATURES'\fI\%compile features\fP\X'tty: link' available from
+the following \X'tty: link #variable:CMAKE_<LANG>_COMPILER_ID'\fI\%compiler ids\fP\X'tty: link' as of the
+versions specified for each:
+.INDENT 0.0
+.IP \(bu 2
+\fBAppleClang\fP: Apple Clang for Xcode versions 4.4+.
+.IP \(bu 2
+\fBClang\fP: Clang compiler versions 2.9+.
+.IP \(bu 2
+\fBGNU\fP: GNU compiler versions 4.4+.
+.IP \(bu 2
+\fBMSVC\fP: Microsoft Visual Studio versions 2010+.
+.IP \(bu 2
+\fBSunPro\fP: Oracle SolarisStudio versions 12.4+.
+.IP \(bu 2
+\fBIntel\fP: Intel compiler versions 12.1+.
+.UNINDENT
+.sp
+CMake is currently aware of the \X'tty: link #prop_tgt:C_STANDARD'\fI\%C standards\fP\X'tty: link'
+and \X'tty: link #prop_gbl:CMAKE_C_KNOWN_FEATURES'\fI\%compile features\fP\X'tty: link' available from
+the following \X'tty: link #variable:CMAKE_<LANG>_COMPILER_ID'\fI\%compiler ids\fP\X'tty: link' as of the
+versions specified for each:
+.INDENT 0.0
+.IP \(bu 2
+all compilers and versions listed above for C++.
+.IP \(bu 2
+\fBGNU\fP: GNU compiler versions 3.4+
+.UNINDENT
+.sp
+CMake is currently aware of the \X'tty: link #prop_tgt:CXX_STANDARD'\fI\%C++ standards\fP\X'tty: link' and
+their associated meta\-features (e.g. \fBcxx_std_11\fP) available from the
+following \X'tty: link #variable:CMAKE_<LANG>_COMPILER_ID'\fI\%compiler ids\fP\X'tty: link' as of the
+versions specified for each:
+.INDENT 0.0
+.IP \(bu 2
+\fBCray\fP: Cray Compiler Environment version 8.1+.
+.IP \(bu 2
+\fBFujitsu\fP: Fujitsu HPC compiler 4.0+.
+.IP \(bu 2
+\fBPGI\fP: PGI version 12.10+.
+.IP \(bu 2
+\fBNVHPC\fP: NVIDIA HPC compilers version 11.0+.
+.IP \(bu 2
+\fBTI\fP: Texas Instruments compiler.
+.IP \(bu 2
+\fBTIClang\fP: Texas Instruments Clang\-based compilers.
+.IP \(bu 2
+\fBXL\fP: IBM XL version 10.1+.
+.UNINDENT
+.sp
+CMake is currently aware of the \X'tty: link #prop_tgt:C_STANDARD'\fI\%C standards\fP\X'tty: link' and
+their associated meta\-features (e.g. \fBc_std_99\fP) available from the
+following \X'tty: link #variable:CMAKE_<LANG>_COMPILER_ID'\fI\%compiler ids\fP\X'tty: link' as of the
+versions specified for each:
+.INDENT 0.0
+.IP \(bu 2
+all compilers and versions listed above with only meta\-features for C++.
+.UNINDENT
+.sp
+CMake is currently aware of the \X'tty: link #prop_tgt:CUDA_STANDARD'\fI\%CUDA standards\fP\X'tty: link' and
+their associated meta\-features (e.g. \fBcuda_std_11\fP) available from the
+following \X'tty: link #variable:CMAKE_<LANG>_COMPILER_ID'\fI\%compiler ids\fP\X'tty: link' as of the
+versions specified for each:
+.INDENT 0.0
+.IP \(bu 2
+\fBClang\fP: Clang compiler 5.0+.
+.IP \(bu 2
+\fBNVIDIA\fP: NVIDIA nvcc compiler 7.5+.
+.UNINDENT
+.SH LANGUAGE STANDARD FLAGS
+.sp
+In order to satisfy requirements specified by the
+\X'tty: link #command:target_compile_features'\fI\%target_compile_features()\fP\X'tty: link' command or the
+\X'tty: link #variable:CMAKE_<LANG>_STANDARD'\fI\%CMAKE_<LANG>_STANDARD\fP\X'tty: link' variable, CMake may pass a
+language standard flag to the compiler, such as \fB\-std=c++11\fP\&.
+.sp
+For \X'tty: link #visual-studio-generators'\fI\%Visual Studio Generators\fP\X'tty: link', CMake cannot precisely control
+the placement of the language standard flag on the compiler command line.
+For \X'tty: link #ninja-generators'\fI\%Ninja Generators\fP\X'tty: link', \X'tty: link #makefile-generators'\fI\%Makefile Generators\fP\X'tty: link', and
+\X'tty: link #generator:Xcode'\fI\%Xcode\fP\X'tty: link', CMake places the language standard flag just after
+the language\-wide flags from \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_<LANG>_FLAGS\fP\X'tty: link'
+and \X'tty: link #variable:CMAKE_<LANG>_FLAGS_<CONFIG>'\fI\%CMAKE_<LANG>_FLAGS_<CONFIG>\fP\X'tty: link'\&.
+.sp
+Changed in version 3.26: The language standard flag is placed before flags specified by other
+abstractions such as the \X'tty: link #command:target_compile_options'\fI\%target_compile_options()\fP\X'tty: link' command.
+Prior to CMake 3.26, the language standard flag was placed after them.
+
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-configure-log.7

@@ -0,0 +1,386 @@
+.\" 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-CONFIGURE-LOG" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-configure-log \- CMake Configure Log
+.sp
+Added in version 3.26.
+
+.SH INTRODUCTION
+.sp
+CMake writes a running log, known as the \fIconfigure log\fP,
+of certain events that occur during the Configure step.
+The configure log does \fInot\fP contain a log of all output, errors,
+or messages printed while configuring a project.  It is a log of
+detailed information about specific events, such as toolchain inspection
+by \X'tty: link #command:try_compile'\fI\%try_compile()\fP\X'tty: link', meant for use in debugging the configuration
+of a build tree.
+.sp
+For human use, this version of CMake writes the configure log to the file:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+${CMAKE_BINARY_DIR}/CMakeFiles/CMakeConfigureLog.yaml
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+However, the \fIlocation and name of the log file may change\fP in future
+versions of CMake.  Tools that read the configure log should get its
+location using a \X'tty: link #file-api-configurelog'\fI\%configureLog\fP\X'tty: link' query to
+the \X'tty: link #manual:cmake-file-api(7)'\fI\%cmake\-file\-api(7)\fP\X'tty: link'\&.
+See the \fI\%Log Versioning\fP section below for details.
+.SH LOG STRUCTURE
+.sp
+The configure log is designed to be both machine\- and human\-readable.
+.sp
+The log file is a YAML document stream containing zero or more YAML
+documents separated by document markers.  Each document begins
+with a \fB\-\-\-\fP document marker line, contains a single YAML mapping
+that logs events from one CMake \(dqconfigure\(dq step, and, if the configure
+step finished normally, ends with a \fB\&...\fP document marker line:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+\-\-\-
+events:
+  \-
+    kind: \(dqtry_compile\-v1\(dq
+    # (other fields omitted)
+  \-
+    kind: \(dqtry_compile\-v1\(dq
+    # (other fields omitted)
+\&...
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+A new document is appended to the log every time CMake configures
+the build tree and logs new events.
+.sp
+The keys of each document root mapping are:
+.INDENT 0.0
+.TP
+.B \fBevents\fP
+A YAML block sequence of nodes corresponding to events logged during
+one CMake \(dqconfigure\(dq step.  Each event is a YAML node containing one
+of the \fI\%Event Kinds\fP documented below.
+.UNINDENT
+.SS Log Versioning
+.sp
+Each of the \fI\%Event Kinds\fP is versioned independently.  The set of
+keys an event\(aqs log entry provides is specific to its major version.
+When an event is logged, the latest version of its event kind that is
+known to the running version of CMake is always written to the log.
+.sp
+Tools reading the configure log must ignore event kinds and versions
+they do not understand:
+.INDENT 0.0
+.IP \(bu 2
+A future version of CMake may introduce a new event kind or version.
+.IP \(bu 2
+If an existing build tree is re\-configured with a different version of
+CMake, the log may contain different versions of the same event kind.
+.IP \(bu 2
+If \X'tty: link #manual:cmake-file-api(7)'\fI\%cmake\-file\-api(7)\fP\X'tty: link' queries request one or more
+\X'tty: link #file-api-configurelog'\fI\%configureLog\fP\X'tty: link' object versions,
+the log may contain multiple entries for the same event, each
+with a different version of its event kind.
+.UNINDENT
+.sp
+IDEs should write a \X'tty: link #manual:cmake-file-api(7)'\fI\%cmake\-file\-api(7)\fP\X'tty: link' query requesting a
+specific \X'tty: link #file-api-configurelog'\fI\%configureLog\fP\X'tty: link' object version,
+before running CMake, and then read the configure log only as described
+by the file\-api reply.
+.SS Text Block Encoding
+.sp
+In order to make the log human\-readable, text blocks are always
+represented using YAML literal block scalars (\fB|\fP).
+Since literal block scalars do not support escaping, backslashes
+and non\-printable characters are encoded at the application layer:
+.INDENT 0.0
+.IP \(bu 2
+\fB\e\e\fP encodes a backslash.
+.IP \(bu 2
+\fB\exXX\fP encodes a byte using two hexadecimal digits, \fBXX\fP\&.
+.UNINDENT
+.SH EVENT KINDS
+.sp
+Every event kind is represented by a YAML mapping of the form:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+kind: \(dq<kind>\-v<major>\(dq
+backtrace:
+  \- \(dq<file>:<line> (<function>)\(dq
+checks:
+  \- \(dqChecking for something\(dq
+#...event\-specific keys...
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The keys common to all events are:
+.INDENT 0.0
+.TP
+.B \fBkind\fP
+A string identifying the event kind and major version.
+.TP
+.B \fBbacktrace\fP
+A YAML block sequence reporting the call stack of CMake source
+locations at which the event occurred, from most\-recent to
+least\-recent.  Each node is a string specifying one location
+formatted as \fB<file>:<line> (<function>)\fP\&.
+.TP
+.B \fBchecks\fP
+An optional key that is present when the event occurred with
+at least one pending \X'tty: link #command:message'\fI\%message(CHECK_START)\fP\X'tty: link'\&.  Its value
+is a YAML block sequence reporting the stack of pending checks,
+from most\-recent to least\-recent.  Each node is a string containing
+a pending check message.
+.UNINDENT
+.sp
+Additional mapping keys are specific to each (versioned) event kind,
+described below.
+.SS Event Kind \fBmessage\fP
+.sp
+The \X'tty: link #command:message'\fI\%message(CONFIGURE_LOG)\fP\X'tty: link' command logs \fBmessage\fP events.
+.sp
+There is only one \fBmessage\fP event major version, version 1.
+.SS \fBmessage\-v1\fP Event
+.sp
+A \fBmessage\-v1\fP event is a YAML mapping:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+kind: \(dqmessage\-v1\(dq
+backtrace:
+  \- \(dqCMakeLists.txt:123 (message)\(dq
+checks:
+  \- \(dqChecking for something\(dq
+message: |
+  # ...
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The keys specific to \fBmessage\-v1\fP mappings are:
+.INDENT 0.0
+.TP
+.B \fBmessage\fP
+A YAML literal block scalar containing the message text,
+represented using our \fI\%Text Block Encoding\fP\&.
+.UNINDENT
+.SS Event Kind \fBtry_compile\fP
+.sp
+The \X'tty: link #command:try_compile'\fI\%try_compile()\fP\X'tty: link' command logs \fBtry_compile\fP events.
+.sp
+There is only one \fBtry_compile\fP event major version, version 1.
+.SS \fBtry_compile\-v1\fP Event
+.sp
+A \fBtry_compile\-v1\fP event is a YAML mapping:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+kind: \(dqtry_compile\-v1\(dq
+backtrace:
+  \- \(dqCMakeLists.txt:123 (try_compile)\(dq
+checks:
+  \- \(dqChecking for something\(dq
+description: \(dqExplicit LOG_DESCRIPTION\(dq
+directories:
+  source: \(dq/path/to/.../TryCompile\-01234\(dq
+  binary: \(dq/path/to/.../TryCompile\-01234\(dq
+cmakeVariables:
+  SOME_VARIABLE: \(dqSome Value\(dq
+buildResult:
+  variable: \(dqCOMPILE_RESULT\(dq
+  cached: true
+  stdout: |
+    # ...
+  exitCode: 0
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The keys specific to \fBtry_compile\-v1\fP mappings are:
+.INDENT 0.0
+.TP
+.B \fBdescription\fP
+An optional key that is present when the \fBLOG_DESCRIPTION <text>\fP option
+was used.  Its value is a string containing the description \fB<text>\fP\&.
+.TP
+.B \fBdirectories\fP
+A mapping describing the directories associated with the
+compilation attempt.  It has the following keys:
+.INDENT 7.0
+.TP
+.B \fBsource\fP
+String specifying the source directory of the
+\X'tty: link #command:try_compile'\fI\%try_compile()\fP\X'tty: link' project.
+.TP
+.B \fBbinary\fP
+String specifying the binary directory of the
+\X'tty: link #command:try_compile'\fI\%try_compile()\fP\X'tty: link' project.
+For non\-project invocations, this is often the same as
+the source directory.
+.UNINDENT
+.TP
+.B \fBcmakeVariables\fP
+An optional key that is present when CMake propagates variables
+into the test project, either automatically or due to the
+\X'tty: link #variable:CMAKE_TRY_COMPILE_PLATFORM_VARIABLES'\fI\%CMAKE_TRY_COMPILE_PLATFORM_VARIABLES\fP\X'tty: link' variable.
+Its value is a mapping from variable names to their values.
+.TP
+.B \fBbuildResult\fP
+A mapping describing the result of compiling the test code.
+It has the following keys:
+.INDENT 7.0
+.TP
+.B \fBvariable\fP
+A string specifying the name of the CMake variable
+storing the result of trying to build the test project.
+.TP
+.B \fBcached\fP
+A boolean indicating whether the above result \fBvariable\fP
+is stored in the CMake cache.
+.TP
+.B \fBstdout\fP
+A YAML literal block scalar containing the output from building
+the test project, represented using our \fI\%Text Block Encoding\fP\&.
+This contains build output from both stdout and stderr.
+.TP
+.B \fBexitCode\fP
+An integer specifying the build tool exit code from trying
+to build the test project.
+.UNINDENT
+.UNINDENT
+.SS Event Kind \fBtry_run\fP
+.sp
+The \X'tty: link #command:try_run'\fI\%try_run()\fP\X'tty: link' command logs \fBtry_run\fP events.
+.sp
+There is only one \fBtry_run\fP event major version, version 1.
+.SS \fBtry_run\-v1\fP Event
+.sp
+A \fBtry_run\-v1\fP event is a YAML mapping:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+kind: \(dqtry_run\-v1\(dq
+backtrace:
+  \- \(dqCMakeLists.txt:456 (try_run)\(dq
+checks:
+  \- \(dqChecking for something\(dq
+description: \(dqExplicit LOG_DESCRIPTION\(dq
+directories:
+  source: \(dq/path/to/.../TryCompile\-56789\(dq
+  binary: \(dq/path/to/.../TryCompile\-56789\(dq
+buildResult:
+  variable: \(dqCOMPILE_RESULT\(dq
+  cached: true
+  stdout: |
+    # ...
+  exitCode: 0
+runResult:
+  variable: \(dqRUN_RESULT\(dq
+  cached: true
+  stdout: |
+    # ...
+  stderr: |
+    # ...
+  exitCode: 0
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The keys specific to \fBtry_run\-v1\fP mappings include those
+documented by the \fI\%try_compile\-v1 event\fP, plus:
+.INDENT 0.0
+.TP
+.B \fBrunResult\fP
+A mapping describing the result of running the test code.
+It has the following keys:
+.INDENT 7.0
+.TP
+.B \fBvariable\fP
+A string specifying the name of the CMake variable
+storing the result of trying to run the test executable.
+.TP
+.B \fBcached\fP
+A boolean indicating whether the above result \fBvariable\fP
+is stored in the CMake cache.
+.TP
+.B \fBstdout\fP
+An optional key that is present when the test project built successfully.
+Its value is a YAML literal block scalar containing output from running
+the test executable, represented using our \fI\%Text Block Encoding\fP\&.
+.sp
+If \fBRUN_OUTPUT_VARIABLE\fP was used, stdout and stderr are captured
+together, so this will contain both.  Otherwise, this will contain
+only the stdout output.
+.TP
+.B \fBstderr\fP
+An optional key that is present when the test project built successfully
+and the \fBRUN_OUTPUT_VARIABLE\fP option was not used.
+Its value is a YAML literal block scalar containing output from running
+the test executable, represented using our \fI\%Text Block Encoding\fP\&.
+.sp
+If \fBRUN_OUTPUT_VARIABLE\fP was used, stdout and stderr are captured
+together in the \fBstdout\fP key, and this key will not be present.
+Otherwise, this will contain the stderr output.
+.TP
+.B \fBexitCode\fP
+An optional key that is present when the test project built successfully.
+Its value is an integer specifying the exit code, or a string containing
+an error message, from trying to run the test executable.
+.UNINDENT
+.UNINDENT
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-cxxmodules.7

@@ -0,0 +1,194 @@
+.\" 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-CXXMODULES" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-cxxmodules \- CMake C++ Modules Support Reference
+.sp
+Added in version 3.28.
+
+.sp
+C++ 20 introduced the concept of \(dqmodules\(dq to the language.  The design
+requires build systems to order compilations among each other to satisfy
+\fBimport\fP statements reliably.  CMake\(aqs implementation asks the compiler
+to scan source files for module dependencies during the build, collates
+scanning results to infer ordering constraints, and tells the build tool
+how to dynamically update the build graph.
+.SH COMPILATION STRATEGY
+.sp
+With C++ modules, compiling a set of C++ sources is no longer embarrassingly
+parallel. That is, any given source may first require the compilation of
+another source file first in order to provide a \(dqCMI\(dq (compiled module
+interface) or \(dqBMI\(dq (binary module interface) that C++ compilers use to
+satisfy \fBimport\fP statements in other sources. With headers, sources could
+share their declarations so that any consumers could compile independently.
+With modules, declarations are now generated into these BMI files by the
+compiler during compilation based on the contents of the source file and its
+\fBexport\fP statements.
+.sp
+The order necessary for compilation requires build\-time resolution of the
+ordering because the order is controlled by the contents of the sources. This
+means that the ordering needs extracted from the source during the build to
+avoid regenerating the build graph via a configure and generate phase for
+every source change to get a correct build.
+.sp
+The general strategy is to use a \(dqscanner\(dq to extract the ordering dependency
+information and update the build graph with new edges between existing edges
+by taking the per\-source scan results (represented by \X'tty: link https://www.open-std.org/jtc1/sc22/wg21/docs/papers/2022/p1689r5.html'\fI\%P1689R5\fP\X'tty: link' files) and
+\(dqcollating\(dq the dependencies within a target and to modules produced by
+targets visible to the target. The primary task is to generate \(dqmodule map\(dq
+files to pass to each compile rule with the paths to the BMIs needed to
+satisfy \fBimport\fP statements. The collator also has tasks to use the
+build\-time information to fill out information including \fBinstall\fP rules for
+the module interface units, their BMIs, and properties for any exported
+targets with C++ modules.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+CMake is focusing on correct builds before looking at performance
+improvements. There are known tactics within the chosen strategy which may
+offer build performance improvements. However, they are being deferred
+until we have a working model against which to compare them. It is also
+important to note that a tactic useful in one situation (e.g., clean
+builds) may not be performant in a different situation (e.g., incremental
+builds). Finding a balance and offering controls to select the tactics is
+future work.
+.UNINDENT
+.UNINDENT
+.SH SCANNING CONTROL
+.sp
+Whether or not sources get scanned for C++ module usage is dependent on the
+following queries. The first query that provides a yes/no answer is used.
+.INDENT 0.0
+.IP \(bu 2
+If the source file belongs to a file set of type \fBCXX_MODULES\fP, it will
+be scanned.
+.IP \(bu 2
+If the target does not use at least C++ 20, it will not be scanned.
+.IP \(bu 2
+If the source file is not the language \fBCXX\fP, it will not be scanned.
+.IP \(bu 2
+If the \X'tty: link #prop_sf:CXX_SCAN_FOR_MODULES'\fI\%CXX_SCAN_FOR_MODULES\fP\X'tty: link' source file property is set, its
+value will be used.
+.IP \(bu 2
+If the \X'tty: link #prop_tgt:CXX_SCAN_FOR_MODULES'\fI\%CXX_SCAN_FOR_MODULES\fP\X'tty: link' target property is set, its value
+will be used.  Set the \X'tty: link #variable:CMAKE_CXX_SCAN_FOR_MODULES'\fI\%CMAKE_CXX_SCAN_FOR_MODULES\fP\X'tty: link' variable
+to initialize this property on all targets as they are created.
+.IP \(bu 2
+Otherwise, the source file will be scanned if the compiler and generator
+support scanning.  See policy \X'tty: link #policy:CMP0155'\fI\%CMP0155\fP\X'tty: link'\&.
+.UNINDENT
+.sp
+Note that any scanned source will be excluded from any unity build (see
+\X'tty: link #prop_tgt:UNITY_BUILD'\fI\%UNITY_BUILD\fP\X'tty: link') because module\-related statements can only happen at
+one place within a C++ translation unit.
+.SH COMPILER SUPPORT
+.sp
+Compilers which CMake natively supports module dependency scanning include:
+.INDENT 0.0
+.IP \(bu 2
+MSVC toolset 14.34 and newer (provided with Visual Studio 17.4 and newer)
+.IP \(bu 2
+LLVM/Clang 16.0 and newer
+.IP \(bu 2
+GCC 14 (for the in\-development branch, after 2023\-09\-20) and newer
+.UNINDENT
+.SH IMPORT STD SUPPORT
+.sp
+Support for \fBimport std\fP is limited to the following toolchain and standard
+library combinations:
+.INDENT 0.0
+.IP \(bu 2
+Clang 18.1.2 and newer with \fB\-stdlib=libc++\fP
+.IP \(bu 2
+MSVC toolset 14.36 and newer (provided with Visual Studio 17.6 Preview 2 and
+newer)
+.UNINDENT
+.sp
+The \X'tty: link #variable:CMAKE_CXX_COMPILER_IMPORT_STD'\fI\%CMAKE_CXX_COMPILER_IMPORT_STD\fP\X'tty: link' variable may be used to detect
+support for a standard level with the active C++ toolchain.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+This support is provided only when experimental support for
+\fBimport std;\fP has been enabled by the
+\fBCMAKE_EXPERIMENTAL_CXX_IMPORT_STD\fP gate.
+.UNINDENT
+.UNINDENT
+.SH GENERATOR SUPPORT
+.sp
+The list of generators which support scanning sources for C++ modules include:
+.INDENT 0.0
+.IP \(bu 2
+\X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #generator:Ninja Multi-Config'\fI\%Ninja Multi\-Config\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #generator:Visual Studio 17 2022'\fI\%Visual Studio 17 2022\fP\X'tty: link'
+.UNINDENT
+.SS Limitations
+.sp
+There are a number of known limitations of the current C++ module support in
+CMake.  This does not document known limitations or bugs in compilers as these
+can change over time.
+.sp
+For all generators:
+.INDENT 0.0
+.IP \(bu 2
+Header units are not supported.
+.IP \(bu 2
+No builtin support for \fBimport std;\fP or other compiler\-provided modules.
+.UNINDENT
+.sp
+For the Ninja Generators:
+.INDENT 0.0
+.IP \(bu 2
+\fBninja\fP 1.11 or newer is required.
+.UNINDENT
+.sp
+For the \X'tty: link #visual-studio-generators'\fI\%Visual Studio Generators\fP\X'tty: link':
+.INDENT 0.0
+.IP \(bu 2
+Only Visual Studio 2022 and MSVC toolsets 14.34 (Visual Studio
+17.4) and newer.
+.IP \(bu 2
+No support for exporting or installing BMI or module information.
+.IP \(bu 2
+No support for compiling BMIs from \fBIMPORTED\fP targets with C++ modules
+(including \fBimport std\fP).
+.IP \(bu 2
+No diagnosis of using modules provided by \fBPRIVATE\fP sources from
+\fBPUBLIC\fP module sources.
+.UNINDENT
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-developer.7

@@ -0,0 +1,676 @@
+.\" 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-DEVELOPER" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-developer \- CMake Developer Reference
+.SH INTRODUCTION
+.sp
+This manual is intended for reference by developers working with
+\X'tty: link #manual:cmake-language(7)'\fI\%cmake\-language(7)\fP\X'tty: link' code, whether writing their own modules,
+authoring their own build systems, or working on CMake itself.
+.sp
+See \X'tty: link https://cmake.org/get-involved/'\fI\%https://cmake.org/get\-involved/\fP\X'tty: link' to get involved in development of
+CMake upstream.  It includes links to contribution instructions, which
+in turn link to developer guides for CMake itself.
+.SH ACCESSING WINDOWS REGISTRY
+.sp
+CMake offers some facilities to access the registry on \fBWindows\fP platforms.
+.SS Query Windows Registry
+.sp
+Added in version 3.24.
+
+.sp
+The \X'tty: link #command:cmake_host_system_information'\fI\%cmake_host_system_information()\fP\X'tty: link' command offers the possibility to
+query the registry on the local computer. See
+\X'tty: link #query-windows-registry'\fI\%cmake_host_system(QUERY_WINDOWS_REGISTRY)\fP\X'tty: link' for
+more information.
+.SS Find Using Windows Registry
+.sp
+Changed in version 3.24.
+
+.sp
+Options \fBHINTS\fP and \fBPATHS\fP of \X'tty: link #command:find_file'\fI\%find_file()\fP\X'tty: link',
+\X'tty: link #command:find_library'\fI\%find_library()\fP\X'tty: link', \X'tty: link #command:find_path'\fI\%find_path()\fP\X'tty: link', \X'tty: link #command:find_program'\fI\%find_program()\fP\X'tty: link', and
+\X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' commands offer the possibility, on \fBWindows\fP
+platform, to query the registry.
+.sp
+The formal syntax, as specified using
+\X'tty: link https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form'\fI\%BNF\fP\X'tty: link' notation with
+the regular extensions, for registry query is the following:
+.sp
+.nf
+\fBregistry_query \fP ::=  \(aq[\(aq \fI\%sep_definition\fP? \fI\%root_key\fP
+                         ((\fI\%key_separator\fP \fI\%sub_key\fP)? (\fI\%value_separator\fP \fI\%value_name\fP_)?)? \(aq]\(aq
+\fBsep_definition \fP ::=  \(aq{\(aq \fI\%value_separator\fP \(aq}\(aq
+\fBroot_key       \fP ::=  \(aqHKLM\(aq | \(aqHKEY_LOCAL_MACHINE\(aq | \(aqHKCU\(aq | \(aqHKEY_CURRENT_USER\(aq |
+                     \(aqHKCR\(aq | \(aqHKEY_CLASSES_ROOT\(aq | \(aqHKCC\(aq | \(aqHKEY_CURRENT_CONFIG\(aq |
+                     \(aqHKU\(aq | \(aqHKEY_USERS\(aq
+\fBsub_key        \fP ::=  \fI\%element\fP (\fI\%key_separator\fP \fI\%element\fP)*
+\fBkey_separator  \fP ::=  \(aq/\(aq | \(aq\e\e\(aq
+\fBvalue_separator\fP ::=  \fI\%element\fP | \(aq;\(aq
+\fBvalue_name     \fP ::=  \fI\%element\fP | \(aq(default)\(aq
+\fBelement        \fP ::=  \fI\%character\fP\e+
+\fBcharacter      \fP ::=  <any character except \fI\%key_separator\fP and \fI\%value_separator\fP>
+
+.fi
+.sp
+The \fI\%sep_definition\fP optional item offers the possibility to specify
+the string used to separate the \fI\%sub_key\fP from the \fI\%value_name\fP
+item. If not specified, the character \fB;\fP is used. Multiple
+\fI\%registry_query\fP items can be specified as part of a path.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# example using default separator
+find_file(... PATHS \(dq/root/[HKLM/Stuff;InstallDir]/lib[HKLM\e\e\e\eStuff;Architecture]\(dq)
+
+# example using different specified separators
+find_library(... HINTS \(dq/root/[{|}HKCU/Stuff|InstallDir]/lib[{@@}HKCU\e\e\e\eStuff@@Architecture]\(dq)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+If the \fI\%value_name\fP item is not specified or has the special name
+\fB(default)\fP, the content of the default value, if any, will be returned. The
+supported types for the \fI\%value_name\fP are:
+.INDENT 0.0
+.IP \(bu 2
+\fBREG_SZ\fP\&.
+.IP \(bu 2
+\fBREG_EXPAND_SZ\fP\&. The returned data is expanded.
+.IP \(bu 2
+\fBREG_DWORD\fP\&.
+.IP \(bu 2
+\fBREG_QWORD\fP\&.
+.UNINDENT
+.sp
+When the registry query failed, typically because the key does not exist or
+the data type is not supported, the string \fB/REGISTRY\-NOTFOUND\fP is substituted
+to the \fB[]\fP query expression.
+.SH FIND MODULES
+.sp
+A \(dqfind module\(dq is a \fBFind<PackageName>.cmake\fP file to be loaded by the
+\X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command when invoked for \fB<PackageName>\fP\&.
+.sp
+The primary task of a find module is to determine whether a package is
+available, set the \fB<PackageName>_FOUND\fP variable to reflect this and
+provide any variables, macros and imported targets required to use the
+package.  A find module is useful in cases where an upstream library does
+not provide a \X'tty: link #config-file-packages'\fI\%config file package\fP\X'tty: link'\&.
+.sp
+The traditional approach is to use variables for everything, including
+libraries and executables: see the \fI\%Standard Variable Names\fP section
+below.  This is what most of the existing find modules provided by CMake
+do.
+.sp
+The more modern approach is to behave as much like
+\X'tty: link #config-file-packages'\fI\%config file packages\fP\X'tty: link' files as possible, by
+providing \X'tty: link #imported-targets'\fI\%imported target\fP\X'tty: link'\&.  This has the advantage
+of propagating \X'tty: link #target-usage-requirements'\fI\%usage requirements\fP\X'tty: link'
+to consumers.
+.sp
+In either case (or even when providing both variables and imported
+targets), find modules should provide backwards compatibility with old
+versions that had the same name.
+.sp
+A FindFoo.cmake module will typically be loaded by the command:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_package(Foo [major[.minor[.patch[.tweak]]]]
+             [EXACT] [QUIET] [REQUIRED]
+             [[COMPONENTS] [components...]]
+             [OPTIONAL_COMPONENTS components...]
+             [NO_POLICY_SCOPE])
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+See the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' documentation for details on what
+variables are set for the find module.  Most of these are dealt with by
+using \X'tty: link #module:FindPackageHandleStandardArgs'\fI\%FindPackageHandleStandardArgs\fP\X'tty: link'\&.
+.sp
+Briefly, the module should only locate versions of the package
+compatible with the requested version, as described by the
+\fBFoo_FIND_VERSION\fP family of variables.  If \fBFoo_FIND_QUIETLY\fP is
+set to true, it should avoid printing messages, including anything
+complaining about the package not being found.  If \fBFoo_FIND_REQUIRED\fP
+is set to true, the module should issue a \fBFATAL_ERROR\fP if the package
+cannot be found.  If neither are set to true, it should print a
+non\-fatal message if it cannot find the package.
+.sp
+Packages that find multiple semi\-independent parts (like bundles of
+libraries) should search for the components listed in
+\fBFoo_FIND_COMPONENTS\fP if it is set , and only set \fBFoo_FOUND\fP to
+true if for each searched\-for component \fB<c>\fP that was not found,
+\fBFoo_FIND_REQUIRED_<c>\fP is not set to true.  The \fBHANDLE_COMPONENTS\fP
+argument of \fBfind_package_handle_standard_args()\fP can be used to
+implement this.
+.sp
+If \fBFoo_FIND_COMPONENTS\fP is not set, which modules are searched for
+and required is up to the find module, but should be documented.
+.sp
+For internal implementation, it is a generally accepted convention that
+variables starting with underscore are for temporary use only.
+.SS Standard Variable Names
+.sp
+For a \fBFindXxx.cmake\fP module that takes the approach of setting
+variables (either instead of or in addition to creating imported
+targets), the following variable names should be used to keep things
+consistent between Find modules.  Note that all variables start with
+\fBXxx_\fP, which (unless otherwise noted) must match exactly the name
+of the \fBFindXxx.cmake\fP file, including upper/lowercase.
+This prefix on the variable names ensures that they do not conflict with
+variables of other Find modules.  The same pattern should also be followed
+for any macros, functions and imported targets defined by the Find module.
+.INDENT 0.0
+.TP
+.B \fBXxx_INCLUDE_DIRS\fP
+The final set of include directories listed in one variable for use by
+client code. This should not be a cache entry (note that this also means
+this variable should not be used as the result variable of a
+\X'tty: link #command:find_path'\fI\%find_path()\fP\X'tty: link' command \- see \fBXxx_INCLUDE_DIR\fP below for that).
+.TP
+.B \fBXxx_LIBRARIES\fP
+The libraries to use with the module.  These may be CMake targets, full
+absolute paths to a library binary or the name of a library that the
+linker must find in its search path.  This should not be a cache entry
+(note that this also means this variable should not be used as the
+result variable of a \X'tty: link #command:find_library'\fI\%find_library()\fP\X'tty: link' command \- see
+\fBXxx_LIBRARY\fP below for that).
+.TP
+.B \fBXxx_DEFINITIONS\fP
+The compile definitions to use when compiling code that uses the module.
+This really shouldn\(aqt include options such as \fB\-DHAS_JPEG\fP that a client
+source\-code file uses to decide whether to \fB#include <jpeg.h>\fP
+.TP
+.B \fBXxx_EXECUTABLE\fP
+The full absolute path to an executable.  In this case, \fBXxx\fP might not
+be the name of the module, it might be the name of the tool (usually
+converted to all uppercase), assuming that tool has such a well\-known name
+that it is unlikely that another tool with the same name exists.  It would
+be appropriate to use this as the result variable of a
+\X'tty: link #command:find_program'\fI\%find_program()\fP\X'tty: link' command.
+.TP
+.B \fBXxx_YYY_EXECUTABLE\fP
+Similar to \fBXxx_EXECUTABLE\fP except here the \fBXxx\fP is always the module
+name and \fBYYY\fP is the tool name (again, usually fully uppercase).
+Prefer this form if the tool name is not very widely known or has the
+potential  to clash with another tool.  For greater consistency, also
+prefer this form if the module provides more than one executable.
+.TP
+.B \fBXxx_LIBRARY_DIRS\fP
+Optionally, the final set of library directories listed in one
+variable for use by client code. This should not be a cache entry.
+.TP
+.B \fBXxx_ROOT_DIR\fP
+Where to find the base directory of the module.
+.TP
+.B \fBXxx_VERSION_VV\fP
+Variables of this form specify whether the \fBXxx\fP module being provided
+is version \fBVV\fP of the module.  There should not be more than one
+variable of this form set to true for a given module.  For example, a
+module \fBBarry\fP might have evolved over many years and gone through a
+number of different major versions.  Version 3 of the \fBBarry\fP module
+might set the variable \fBBarry_VERSION_3\fP to true, whereas an older
+version of the module might set \fBBarry_VERSION_2\fP to true instead.
+It would be an error for both \fBBarry_VERSION_3\fP and \fBBarry_VERSION_2\fP
+to both be set to true.
+.TP
+.B \fBXxx_WRAP_YY\fP
+When a variable of this form is set to false, it indicates that the
+relevant wrapping command should not be used.  The wrapping command
+depends on the module, it may be implied by the module name or it might
+be specified by the \fBYY\fP part of the variable.
+.TP
+.B \fBXxx_Yy_FOUND\fP
+For variables of this form, \fBYy\fP is the name of a component for the
+module.  It should match exactly one of the valid component names that
+may be passed to the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command for the module.
+If a variable of this form is set to false, it means that the \fBYy\fP
+component of module \fBXxx\fP was not found or is not available.
+Variables of this form would typically be used for optional components
+so that the caller can check whether an optional component is available.
+.TP
+.B \fBXxx_FOUND\fP
+When the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command returns to the caller, this
+variable will be set to true if the module was deemed to have been found
+successfully.
+.TP
+.B \fBXxx_NOT_FOUND_MESSAGE\fP
+Should be set by config\-files in the case that it has set
+\fBXxx_FOUND\fP to FALSE.  The contained message will be printed by the
+\X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command and by
+\X'tty: link #command:find_package_handle_standard_args'\fI\%find_package_handle_standard_args()\fP\X'tty: link' to inform the user about the
+problem.  Use this instead of calling \X'tty: link #command:message'\fI\%message()\fP\X'tty: link' directly to
+report a reason for failing to find the module or package.
+.TP
+.B \fBXxx_RUNTIME_LIBRARY_DIRS\fP
+Optionally, the runtime library search path for use when running an
+executable linked to shared libraries.  The list should be used by
+user code to create the \fBPATH\fP on windows or \fBLD_LIBRARY_PATH\fP on
+UNIX.  This should not be a cache entry.
+.TP
+.B \fBXxx_VERSION\fP
+The full version string of the package found, if any.  Note that many
+existing modules provide \fBXxx_VERSION_STRING\fP instead.
+.TP
+.B \fBXxx_VERSION_MAJOR\fP
+The major version of the package found, if any.
+.TP
+.B \fBXxx_VERSION_MINOR\fP
+The minor version of the package found, if any.
+.TP
+.B \fBXxx_VERSION_PATCH\fP
+The patch version of the package found, if any.
+.UNINDENT
+.sp
+The following names should not usually be used in \fBCMakeLists.txt\fP files.
+They are intended for use by Find modules to specify and cache the locations
+of specific files or directories.  Users are typically able to set and edit
+these variables to control the behavior of Find modules (like entering the
+path to a library manually):
+.INDENT 0.0
+.TP
+.B \fBXxx_LIBRARY\fP
+The path of the library.  Use this form only when the module provides a
+single library.  It is appropriate to use this as the result variable
+in a \X'tty: link #command:find_library'\fI\%find_library()\fP\X'tty: link' command.
+.TP
+.B \fBXxx_Yy_LIBRARY\fP
+The path of library \fBYy\fP provided by the module \fBXxx\fP\&.  Use this form
+when the module provides more than one library or where other modules may
+also provide a library of the same name. It is also appropriate to use
+this form as the result variable in a \X'tty: link #command:find_library'\fI\%find_library()\fP\X'tty: link' command.
+.TP
+.B \fBXxx_INCLUDE_DIR\fP
+When the module provides only a single library, this variable can be used
+to specify where to find headers for using the library (or more accurately,
+the path that consumers of the library should add to their header search
+path).  It would be appropriate to use this as the result variable in a
+\X'tty: link #command:find_path'\fI\%find_path()\fP\X'tty: link' command.
+.TP
+.B \fBXxx_Yy_INCLUDE_DIR\fP
+If the module provides more than one library or where other modules may
+also provide a library of the same name, this form is recommended for
+specifying where to find headers for using library \fBYy\fP provided by
+the module.  Again, it would be appropriate to use this as the result
+variable in a \X'tty: link #command:find_path'\fI\%find_path()\fP\X'tty: link' command.
+.UNINDENT
+.sp
+To prevent users being overwhelmed with settings to configure, try to
+keep as many options as possible out of the cache, leaving at least one
+option which can be used to disable use of the module, or locate a
+not\-found library (e.g. \fBXxx_ROOT_DIR\fP).  For the same reason, mark
+most cache options as advanced.  For packages which provide both debug
+and release binaries, it is common to create cache variables with a
+\fB_LIBRARY_<CONFIG>\fP suffix, such as \fBFoo_LIBRARY_RELEASE\fP and
+\fBFoo_LIBRARY_DEBUG\fP\&.  The \X'tty: link #module:SelectLibraryConfigurations'\fI\%SelectLibraryConfigurations\fP\X'tty: link' module
+can be helpful for such cases.
+.sp
+While these are the standard variable names, you should provide
+backwards compatibility for any old names that were actually in use.
+Make sure you comment them as deprecated, so that no\-one starts using
+them.
+.SS A Sample Find Module
+.sp
+We will describe how to create a simple find module for a library \fBFoo\fP\&.
+.sp
+The top of the module should begin with a license notice, followed by
+a blank line, and then followed by a \X'tty: link #bracket-comment'\fI\%Bracket Comment\fP\X'tty: link'\&.  The comment
+should begin with \fB\&.rst:\fP to indicate that the rest of its content is
+reStructuredText\-format documentation.  For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# Distributed under the OSI\-approved BSD 3\-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+#[=======================================================================[.rst:
+FindFoo
+\-\-\-\-\-\-\-
+
+Finds the Foo library.
+
+Imported Targets
+^^^^^^^^^^^^^^^^
+
+This module provides the following imported targets, if found:
+
+\(ga\(gaFoo::Foo\(ga\(ga
+  The Foo library
+
+Result Variables
+^^^^^^^^^^^^^^^^
+
+This will define the following variables:
+
+\(ga\(gaFoo_FOUND\(ga\(ga
+  True if the system has the Foo library.
+\(ga\(gaFoo_VERSION\(ga\(ga
+  The version of the Foo library which was found.
+\(ga\(gaFoo_INCLUDE_DIRS\(ga\(ga
+  Include directories needed to use Foo.
+\(ga\(gaFoo_LIBRARIES\(ga\(ga
+  Libraries needed to link to Foo.
+
+Cache Variables
+^^^^^^^^^^^^^^^
+
+The following cache variables may also be set:
+
+\(ga\(gaFoo_INCLUDE_DIR\(ga\(ga
+  The directory containing \(ga\(gafoo.h\(ga\(ga.
+\(ga\(gaFoo_LIBRARY\(ga\(ga
+  The path to the Foo library.
+
+#]=======================================================================]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The module documentation consists of:
+.INDENT 0.0
+.IP \(bu 2
+An underlined heading specifying the module name.
+.IP \(bu 2
+A simple description of what the module finds.
+More description may be required for some packages.  If there are
+caveats or other details users of the module should be aware of,
+specify them here.
+.IP \(bu 2
+A section listing imported targets provided by the module, if any.
+.IP \(bu 2
+A section listing result variables provided by the module.
+.IP \(bu 2
+Optionally a section listing cache variables used by the module, if any.
+.UNINDENT
+.sp
+If the package provides any macros or functions, they should be listed in
+an additional section, but can be documented by additional \fB\&.rst:\fP
+comment blocks immediately above where those macros or functions are defined.
+.sp
+The find module implementation may begin below the documentation block.
+Now the actual libraries and so on have to be found.  The code here will
+obviously vary from module to module (dealing with that, after all, is the
+point of find modules), but there tends to be a common pattern for libraries.
+.sp
+First, we try to use \fBpkg\-config\fP to find the library.  Note that we
+cannot rely on this, as it may not be available, but it provides a good
+starting point.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_package(PkgConfig)
+if(PKG_CONFIG_FOUND)
+  pkg_check_modules(PC_Foo QUIET Foo)
+endif()
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This should define some variables starting \fBPC_Foo_\fP that contain the
+information from the \fBFoo.pc\fP file.
+.sp
+Now we need to find the libraries and include files; we use the
+information from \fBpkg\-config\fP to provide hints to CMake about where to
+look.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_path(Foo_INCLUDE_DIR
+  NAMES foo.h
+  PATHS ${PC_Foo_INCLUDE_DIRS}
+  PATH_SUFFIXES Foo
+)
+find_library(Foo_LIBRARY
+  NAMES foo
+  PATHS ${PC_Foo_LIBRARY_DIRS}
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Alternatively, if the library is available with multiple configurations, you can
+use \X'tty: link #module:SelectLibraryConfigurations'\fI\%SelectLibraryConfigurations\fP\X'tty: link' to automatically set the
+\fBFoo_LIBRARY\fP variable instead:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_library(Foo_LIBRARY_RELEASE
+  NAMES foo
+  PATHS ${PC_Foo_LIBRARY_DIRS}/Release
+)
+find_library(Foo_LIBRARY_DEBUG
+  NAMES foo
+  PATHS ${PC_Foo_LIBRARY_DIRS}/Debug
+)
+
+include(SelectLibraryConfigurations)
+select_library_configurations(Foo)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+If you have a good way of getting the version (from a header file, for
+example), you can use that information to set \fBFoo_VERSION\fP (although
+note that find modules have traditionally used \fBFoo_VERSION_STRING\fP,
+so you may want to set both).  Otherwise, attempt to use the information
+from \fBpkg\-config\fP
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(Foo_VERSION ${PC_Foo_VERSION})
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Now we can use \X'tty: link #module:FindPackageHandleStandardArgs'\fI\%FindPackageHandleStandardArgs\fP\X'tty: link' to do most of the
+rest of the work for us
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+include(FindPackageHandleStandardArgs)
+find_package_handle_standard_args(Foo
+  FOUND_VAR Foo_FOUND
+  REQUIRED_VARS
+    Foo_LIBRARY
+    Foo_INCLUDE_DIR
+  VERSION_VAR Foo_VERSION
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This will check that the \fBREQUIRED_VARS\fP contain values (that do not
+end in \fB\-NOTFOUND\fP) and set \fBFoo_FOUND\fP appropriately.  It will also
+cache those values.  If \fBFoo_VERSION\fP is set, and a required version
+was passed to \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link', it will check the requested version
+against the one in \fBFoo_VERSION\fP\&.  It will also print messages as
+appropriate; note that if the package was found, it will print the
+contents of the first required variable to indicate where it was found.
+.sp
+At this point, we have to provide a way for users of the find module to
+link to the library or libraries that were found.  There are two
+approaches, as discussed in the \fI\%Find Modules\fP section above.  The
+traditional variable approach looks like
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+if(Foo_FOUND)
+  set(Foo_LIBRARIES ${Foo_LIBRARY})
+  set(Foo_INCLUDE_DIRS ${Foo_INCLUDE_DIR})
+  set(Foo_DEFINITIONS ${PC_Foo_CFLAGS_OTHER})
+endif()
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+If more than one library was found, all of them should be included in
+these variables (see the \fI\%Standard Variable Names\fP section for more
+information).
+.sp
+When providing imported targets, these should be namespaced (hence the
+\fBFoo::\fP prefix); CMake will recognize that values passed to
+\X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' that contain \fB::\fP in their name are
+supposed to be imported targets (rather than just library names), and
+will produce appropriate diagnostic messages if that target does not
+exist (see policy \X'tty: link #policy:CMP0028'\fI\%CMP0028\fP\X'tty: link').
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+if(Foo_FOUND AND NOT TARGET Foo::Foo)
+  add_library(Foo::Foo UNKNOWN IMPORTED)
+  set_target_properties(Foo::Foo PROPERTIES
+    IMPORTED_LOCATION \(dq${Foo_LIBRARY}\(dq
+    INTERFACE_COMPILE_OPTIONS \(dq${PC_Foo_CFLAGS_OTHER}\(dq
+    INTERFACE_INCLUDE_DIRECTORIES \(dq${Foo_INCLUDE_DIR}\(dq
+  )
+endif()
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+One thing to note about this is that the \fBINTERFACE_INCLUDE_DIRECTORIES\fP and
+similar properties should only contain information about the target itself, and
+not any of its dependencies.  Instead, those dependencies should also be
+targets, and CMake should be told that they are dependencies of this target.
+CMake will then combine all the necessary information automatically.
+.sp
+The type of the \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' target created in the
+\X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link' command can always be specified as \fBUNKNOWN\fP
+type.  This simplifies the code in cases where static or shared variants may
+be found, and CMake will determine the type by inspecting the files.
+.sp
+If the library is available with multiple configurations, the
+\X'tty: link #prop_tgt:IMPORTED_CONFIGURATIONS'\fI\%IMPORTED_CONFIGURATIONS\fP\X'tty: link' target property should also be
+populated:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+if(Foo_FOUND)
+  if (NOT TARGET Foo::Foo)
+    add_library(Foo::Foo UNKNOWN IMPORTED)
+  endif()
+  if (Foo_LIBRARY_RELEASE)
+    set_property(TARGET Foo::Foo APPEND PROPERTY
+      IMPORTED_CONFIGURATIONS RELEASE
+    )
+    set_target_properties(Foo::Foo PROPERTIES
+      IMPORTED_LOCATION_RELEASE \(dq${Foo_LIBRARY_RELEASE}\(dq
+    )
+  endif()
+  if (Foo_LIBRARY_DEBUG)
+    set_property(TARGET Foo::Foo APPEND PROPERTY
+      IMPORTED_CONFIGURATIONS DEBUG
+    )
+    set_target_properties(Foo::Foo PROPERTIES
+      IMPORTED_LOCATION_DEBUG \(dq${Foo_LIBRARY_DEBUG}\(dq
+    )
+  endif()
+  set_target_properties(Foo::Foo PROPERTIES
+    INTERFACE_COMPILE_OPTIONS \(dq${PC_Foo_CFLAGS_OTHER}\(dq
+    INTERFACE_INCLUDE_DIRECTORIES \(dq${Foo_INCLUDE_DIR}\(dq
+  )
+endif()
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \fBRELEASE\fP variant should be listed first in the property
+so that the variant is chosen if the user uses a configuration which is
+not an exact match for any listed \fBIMPORTED_CONFIGURATIONS\fP\&.
+.sp
+Most of the cache variables should be hidden in the \fBccmake\fP interface unless
+the user explicitly asks to edit them.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+mark_as_advanced(
+  Foo_INCLUDE_DIR
+  Foo_LIBRARY
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+If this module replaces an older version, you should set compatibility variables
+to cause the least disruption possible.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# compatibility variables
+set(Foo_VERSION_STRING ${Foo_VERSION})
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-env-variables.7

@@ -0,0 +1,1443 @@
+.\" 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-ENV-VARIABLES" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-env-variables \- CMake Environment Variables Reference
+.sp
+This page lists environment variables that have special
+meaning to CMake.
+.sp
+For general information on environment variables, see the
+\X'tty: link #cmake-language-environment-variables'\fI\%Environment Variables\fP\X'tty: link'
+section in the cmake\-language manual.
+.SH ENVIRONMENT VARIABLES THAT CHANGE BEHAVIOR
+.SS CMAKE_APPBUNDLE_PATH
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBCMAKE_APPBUNDLE_PATH\fP environment variable may be set to a list of
+directories to be searched for macOS application bundles
+by the \X'tty: link #command:find_program'\fI\%find_program()\fP\X'tty: link' and \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' commands.
+.sp
+This variable may hold a single directory or a list of directories separated
+by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment
+variable convention on those platforms).
+.sp
+See also the \X'tty: link #variable:CMAKE_APPBUNDLE_PATH'\fI\%CMAKE_APPBUNDLE_PATH\fP\X'tty: link' CMake variable.
+.SS CMAKE_FRAMEWORK_PATH
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBCMAKE_FRAMEWORK_PATH\fP environment variable may be set to a list of
+directories to be searched for macOS frameworks by the \X'tty: link #command:find_library'\fI\%find_library()\fP\X'tty: link',
+\X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link', \X'tty: link #command:find_path'\fI\%find_path()\fP\X'tty: link' and \X'tty: link #command:find_file'\fI\%find_file()\fP\X'tty: link' commands.
+.sp
+This variable may hold a single directory or a list of directories separated
+by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment
+variable convention on those platforms).
+.sp
+See also the \X'tty: link #variable:CMAKE_FRAMEWORK_PATH'\fI\%CMAKE_FRAMEWORK_PATH\fP\X'tty: link' CMake variable.
+.SS CMAKE_INCLUDE_PATH
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBCMAKE_INCLUDE_PATH\fP environment variable may be set to a list of
+directories to be searched by the \X'tty: link #command:find_file'\fI\%find_file()\fP\X'tty: link' and \X'tty: link #command:find_path'\fI\%find_path()\fP\X'tty: link' commands.
+.sp
+This variable may hold a single directory or a list of directories separated
+by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment
+variable convention on those platforms).
+.sp
+See also the \X'tty: link #variable:CMAKE_INCLUDE_PATH'\fI\%CMAKE_INCLUDE_PATH\fP\X'tty: link' CMake variable.
+.SS CMAKE_LIBRARY_PATH
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBCMAKE_LIBRARY_PATH\fP environment variable may be set to a list of
+directories to be searched by the \X'tty: link #command:find_library'\fI\%find_library()\fP\X'tty: link' command.
+.sp
+This variable may hold a single directory or a list of directories separated
+by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment
+variable convention on those platforms).
+.sp
+See also the \X'tty: link #variable:CMAKE_LIBRARY_PATH'\fI\%CMAKE_LIBRARY_PATH\fP\X'tty: link' CMake variable.
+.SS CMAKE_MAXIMUM_RECURSION_DEPTH
+.sp
+Added in version 3.27.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Maximum recursion depth for CMake scripts.  This environment variable is
+used if the \X'tty: link #variable:CMAKE_MAXIMUM_RECURSION_DEPTH'\fI\%CMAKE_MAXIMUM_RECURSION_DEPTH\fP\X'tty: link' variable is not set.
+See that variable\(aqs documentation for details.
+.SS CMAKE_PREFIX_PATH
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBCMAKE_PREFIX_PATH\fP environment variable may be set to a list of
+directories specifying installation \fIprefixes\fP to be searched by the
+\X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link', \X'tty: link #command:find_program'\fI\%find_program()\fP\X'tty: link', \X'tty: link #command:find_library'\fI\%find_library()\fP\X'tty: link',
+\X'tty: link #command:find_file'\fI\%find_file()\fP\X'tty: link', and \X'tty: link #command:find_path'\fI\%find_path()\fP\X'tty: link' commands.  Each command will
+add appropriate subdirectories (like \fBbin\fP, \fBlib\fP, or \fBinclude\fP)
+as specified in its own documentation.
+.sp
+This variable may hold a single prefix or a list of prefixes separated
+by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment
+variable convention on those platforms).
+.sp
+See also the \X'tty: link #variable:CMAKE_PREFIX_PATH'\fI\%CMAKE_PREFIX_PATH\fP\X'tty: link' CMake variable.
+.SS CMAKE_PROGRAM_PATH
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBCMAKE_PROGRAM_PATH\fP environment variable may be set to a list of
+directories to be searched by the \X'tty: link #command:find_program'\fI\%find_program()\fP\X'tty: link' command.
+.sp
+This variable may hold a single directory or a list of directories separated
+by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment
+variable convention on those platforms).
+.sp
+See also the \X'tty: link #variable:CMAKE_PROGRAM_PATH'\fI\%CMAKE_PROGRAM_PATH\fP\X'tty: link' CMake variable.
+.SS CMAKE_TLS_VERIFY
+.sp
+Added in version 3.30.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Specify the default value for the \X'tty: link #download'\fI\%file(DOWNLOAD)\fP\X'tty: link' and
+\X'tty: link #upload'\fI\%file(UPLOAD)\fP\X'tty: link' commands\(aq \fBTLS_VERIFY\fP option.
+This environment variable is used if the option is not given
+and the \X'tty: link #variable:CMAKE_TLS_VERIFY'\fI\%CMAKE_TLS_VERIFY\fP\X'tty: link' cmake variable is not set.
+.sp
+This variable is also used by the \X'tty: link #module:ExternalProject'\fI\%ExternalProject\fP\X'tty: link' and
+\X'tty: link #module:FetchContent'\fI\%FetchContent\fP\X'tty: link' modules for internal calls to
+\X'tty: link #download'\fI\%file(DOWNLOAD)\fP\X'tty: link' and \fBgit clone\fP\&.
+.SS CMAKE_TLS_VERSION
+.sp
+Added in version 3.30.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Specify the default value for the \X'tty: link #download'\fI\%file(DOWNLOAD)\fP\X'tty: link' and
+\X'tty: link #upload'\fI\%file(UPLOAD)\fP\X'tty: link' commands\(aq \fBTLS_VERSION\fP option.
+This environment variable is used if the option is not given
+and the \X'tty: link #variable:CMAKE_TLS_VERSION'\fI\%CMAKE_TLS_VERSION\fP\X'tty: link' cmake variable is not set.
+See that variable for allowed values.
+.sp
+This variable is also used by the \X'tty: link #module:ExternalProject'\fI\%ExternalProject\fP\X'tty: link' and
+\X'tty: link #module:FetchContent'\fI\%FetchContent\fP\X'tty: link' modules for internal calls to
+\X'tty: link #download'\fI\%file(DOWNLOAD)\fP\X'tty: link' and \fBgit clone\fP\&.
+.SS SSL_CERT_DIR
+.sp
+Added in version 3.25.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Specify default directory containing CA certificates.  It overrides
+the default CA directory used.
+.SS SSL_CERT_FILE
+.sp
+Added in version 3.25.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Specify the file name containing CA certificates.  It overrides the
+default, os\-specific CA file used.
+.SH ENVIRONMENT VARIABLES THAT CONTROL THE BUILD
+.SS ADSP_ROOT
+.sp
+Added in version 3.24.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBADSP_ROOT\fP environment variable specifies a default value
+for the \X'tty: link #variable:CMAKE_ADSP_ROOT'\fI\%CMAKE_ADSP_ROOT\fP\X'tty: link' variable when there is no explicit
+configuration given on the first run while creating a new build tree.
+.SS CMAKE_APPLE_SILICON_PROCESSOR
+.sp
+Added in version 3.19.2.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+On Apple Silicon hosts running macOS, set this environment variable to tell
+CMake what architecture to use for \X'tty: link #variable:CMAKE_HOST_SYSTEM_PROCESSOR'\fI\%CMAKE_HOST_SYSTEM_PROCESSOR\fP\X'tty: link'\&.
+The value must be either \fBarm64\fP or \fBx86_64\fP\&.
+.sp
+The \X'tty: link #variable:CMAKE_APPLE_SILICON_PROCESSOR'\fI\%CMAKE_APPLE_SILICON_PROCESSOR\fP\X'tty: link' normal variable, if set,
+overrides this environment variable.
+.SS CMAKE_BUILD_PARALLEL_LEVEL
+.sp
+Added in version 3.12.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Specifies the maximum number of concurrent processes to use when building
+using the \fBcmake \-\-build\fP command line
+\X'tty: link #build-tool-mode'\fI\%Build Tool Mode\fP\X'tty: link'\&.
+For example, if \fBCMAKE_BUILD_PARALLEL_LEVEL\fP is set to 8, the
+underlying build tool will execute up to 8 jobs concurrently as if
+\fBcmake \-\-build\fP were invoked with the
+\X'tty: link #cmdoption-cmake-build-j'\fI\%\-\-parallel 8\fP\X'tty: link' option.
+.sp
+If this variable is defined empty the native build tool\(aqs default number is
+used.
+.SS CMAKE_BUILD_TYPE
+.sp
+Added in version 3.22.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBCMAKE_BUILD_TYPE\fP environment variable specifies a default value
+for the \X'tty: link #variable:CMAKE_BUILD_TYPE'\fI\%CMAKE_BUILD_TYPE\fP\X'tty: link' variable when there is no explicit
+configuration given on the first run while creating a new build tree.
+.SS CMAKE_COLOR_DIAGNOSTICS
+.sp
+Added in version 3.24.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Specifies a default value for the \X'tty: link #variable:CMAKE_COLOR_DIAGNOSTICS'\fI\%CMAKE_COLOR_DIAGNOSTICS\fP\X'tty: link' variable
+when there is no explicit value given on the first run.
+.SS CMAKE_CONFIG_DIR
+.sp
+Added in version 3.31.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Specify a CMake user\-wide configuration directory for
+\X'tty: link #manual:cmake-file-api(7)'\fI\%cmake\-file\-api(7)\fP\X'tty: link' queries.
+.sp
+If this environment variable is not set, the default user\-wide
+configuration directory is platform\-specific:
+.INDENT 0.0
+.IP \(bu 2
+Windows: \fB%LOCALAPPDATA%\eCMake\fP
+.IP \(bu 2
+macOS: \fB$XDG_CONFIG_HOME/CMake\fP if set, otherwise
+\fB$HOME/Library/Application Support/CMake\fP
+.IP \(bu 2
+Linux/Other: \fB$XDG_CONFIG_HOME/cmake\fP if set, otherwise
+\fB$HOME/.config/cmake\fP
+.UNINDENT
+.SS CMAKE_CONFIG_TYPE
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The default build configuration for \X'tty: link #build-tool-mode'\fI\%Build a Project\fP\X'tty: link' and
+\fBctest\fP build handler when there is no explicit configuration given.
+.SS CMAKE_CONFIGURATION_TYPES
+.sp
+Added in version 3.22.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBCMAKE_CONFIGURATION_TYPES\fP environment variable specifies a
+default value for the \X'tty: link #variable:CMAKE_CONFIGURATION_TYPES'\fI\%CMAKE_CONFIGURATION_TYPES\fP\X'tty: link' variable
+when there is no explicit configuration given on the first run while
+creating a new build tree.
+.SS CMAKE_CROSSCOMPILING_EMULATOR
+.sp
+Added in version 3.28.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The default value for \X'tty: link #variable:CMAKE_CROSSCOMPILING_EMULATOR'\fI\%CMAKE_CROSSCOMPILING_EMULATOR\fP\X'tty: link' when there
+is no explicit configuration given on the first run while creating a new
+build tree.  On later runs in an existing build tree the value persists in
+the cache as \X'tty: link #variable:CMAKE_CROSSCOMPILING_EMULATOR'\fI\%CMAKE_CROSSCOMPILING_EMULATOR\fP\X'tty: link'\&.
+.SS CMAKE_EXPORT_BUILD_DATABASE
+.sp
+Added in version 3.31.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The default value for \X'tty: link #variable:CMAKE_EXPORT_BUILD_DATABASE'\fI\%CMAKE_EXPORT_BUILD_DATABASE\fP\X'tty: link' when there is no
+explicit configuration given on the first run while creating a new build tree.
+On later runs in an existing build tree the value persists in the cache as
+\X'tty: link #variable:CMAKE_EXPORT_BUILD_DATABASE'\fI\%CMAKE_EXPORT_BUILD_DATABASE\fP\X'tty: link'\&.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+This variable is meaningful only when experimental support for build
+databases has been enabled by the
+\fBCMAKE_EXPERIMENTAL_EXPORT_BUILD_DATABASE\fP gate.
+.UNINDENT
+.UNINDENT
+.SS CMAKE_EXPORT_COMPILE_COMMANDS
+.sp
+Added in version 3.17.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The default value for \X'tty: link #variable:CMAKE_EXPORT_COMPILE_COMMANDS'\fI\%CMAKE_EXPORT_COMPILE_COMMANDS\fP\X'tty: link' when there
+is no explicit configuration given on the first run while creating a new
+build tree.  On later runs in an existing build tree the value persists in
+the cache as \X'tty: link #variable:CMAKE_EXPORT_COMPILE_COMMANDS'\fI\%CMAKE_EXPORT_COMPILE_COMMANDS\fP\X'tty: link'\&.
+.SS CMAKE_GENERATOR
+.sp
+Added in version 3.15.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Specifies the CMake default generator to use when no generator is supplied
+with \X'tty: link #cmdoption-cmake-G'\fI\%\-G\fP\X'tty: link'\&. If the provided value doesn\(aqt name a generator
+known by CMake, the internal default is used.  Either way the resulting
+generator selection is stored in the \X'tty: link #variable:CMAKE_GENERATOR'\fI\%CMAKE_GENERATOR\fP\X'tty: link' variable.
+.sp
+Some generators may be additionally configured using the environment
+variables:
+.INDENT 0.0
+.IP \(bu 2
+\X'tty: link #envvar:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #envvar:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #envvar:CMAKE_GENERATOR_INSTANCE'\fI\%CMAKE_GENERATOR_INSTANCE\fP\X'tty: link'
+.UNINDENT
+.SS CMAKE_GENERATOR_INSTANCE
+.sp
+Added in version 3.15.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Default value for \X'tty: link #variable:CMAKE_GENERATOR_INSTANCE'\fI\%CMAKE_GENERATOR_INSTANCE\fP\X'tty: link' if no Cache entry is
+present. This value is only applied if \X'tty: link #envvar:CMAKE_GENERATOR'\fI\%CMAKE_GENERATOR\fP\X'tty: link' is set.
+.SS CMAKE_GENERATOR_PLATFORM
+.sp
+Added in version 3.15.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Default value for \X'tty: link #variable:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link' if no Cache entry
+is present and no value is specified by \X'tty: link #cmdoption-cmake-A'\fI\%cmake \-A\fP\X'tty: link' option.
+This value is only applied if \X'tty: link #envvar:CMAKE_GENERATOR'\fI\%CMAKE_GENERATOR\fP\X'tty: link' is set.
+.SS CMAKE_GENERATOR_TOOLSET
+.sp
+Added in version 3.15.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Default value for \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' if no Cache entry
+is present and no value is specified by \X'tty: link #cmdoption-cmake-T'\fI\%cmake \-T\fP\X'tty: link' option.
+This value is only applied if \X'tty: link #envvar:CMAKE_GENERATOR'\fI\%CMAKE_GENERATOR\fP\X'tty: link' is set.
+.SS CMAKE_INSTALL_MODE
+.sp
+Added in version 3.22.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBCMAKE_INSTALL_MODE\fP environment variable allows users to operate
+CMake in an alternate mode of \X'tty: link #install'\fI\%file(INSTALL)\fP\X'tty: link' and \X'tty: link #command:install'\fI\%install()\fP\X'tty: link'\&.
+.sp
+The default behavior for an installation is to copy a source file from a
+source directory into a destination directory. This environment variable
+however allows the user to override this behavior, causing CMake to create
+symbolic links instead.
+.SS Usage Scenarios
+.sp
+Installing symbolic links rather than copying files can help in the following
+ways:
+.INDENT 0.0
+.IP \(bu 2
+Conserving storage space because files do not have to be duplicated on disk.
+.IP \(bu 2
+Changes to the source of the symbolic link are seen at the install
+destination without having to re\-run the install step.
+.IP \(bu 2
+Editing through the link at the install destination will modify the source
+of the link. This may be useful when dealing with CMake project hierarchies,
+i.e. using \X'tty: link #module:ExternalProject'\fI\%ExternalProject\fP\X'tty: link' and consistent source navigation and
+refactoring is desired across projects.
+.UNINDENT
+.SS Allowed Values
+.sp
+The following values are allowed for \fBCMAKE_INSTALL_MODE\fP:
+.INDENT 0.0
+.TP
+.B \fBCOPY\fP, empty or unset
+Duplicate the file at its destination.  This is the default behavior.
+.TP
+.B \fBABS_SYMLINK\fP
+Create an \fIabsolute\fP symbolic link to the source file at the destination.
+Halt with an error if the link cannot be created.
+.TP
+.B \fBABS_SYMLINK_OR_COPY\fP
+Like \fBABS_SYMLINK\fP but fall back to silently copying if the symlink
+couldn\(aqt be created.
+.TP
+.B \fBREL_SYMLINK\fP
+Create a \fIrelative\fP symbolic link to the source file at the destination.
+Halt with an error if the link cannot be created.
+.TP
+.B \fBREL_SYMLINK_OR_COPY\fP
+Like \fBREL_SYMLINK\fP but fall back to silently copying if the symlink
+couldn\(aqt be created.
+.TP
+.B \fBSYMLINK\fP
+Try as if through \fBREL_SYMLINK\fP and fall back to \fBABS_SYMLINK\fP if the
+referenced file cannot be expressed using a relative path.
+Halt with an error if the link cannot be created.
+.TP
+.B \fBSYMLINK_OR_COPY\fP
+Like \fBSYMLINK\fP but fall back to silently copying if the symlink couldn\(aqt
+be created.
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+A symbolic link consists of a reference file path rather than contents of its
+own, hence there are two ways to express the relation, either by a \fIrelative\fP
+or an \fIabsolute\fP path.
+.UNINDENT
+.UNINDENT
+.SS When To Set The Environment Variable
+.sp
+For the environment variable to take effect, it must be set during the correct
+build phase(s).
+.INDENT 0.0
+.IP \(bu 2
+If the project calls \X'tty: link #install'\fI\%file(INSTALL)\fP\X'tty: link' directly, the environment
+variable must be set during the configuration phase.
+.IP \(bu 2
+In order to apply to \X'tty: link #command:install'\fI\%install()\fP\X'tty: link', the environment variable must be
+set during installation.  This could be during a build if using the
+\fBinstall\fP or \fBpackage\fP build targets, or separate from the build when
+invoking an install or running \X'tty: link #manual:cpack(1)'\fI\%cpack\fP\X'tty: link' from the command
+line.
+.IP \(bu 2
+When using \X'tty: link #module:ExternalProject'\fI\%ExternalProject\fP\X'tty: link', it might be required during the build
+phase, since the external project\(aqs own configure, build and install steps
+will execute during the main project\(aqs build phase.
+.UNINDENT
+.sp
+Given the above, it is recommended to set the environment variable consistently
+across all phases (configure, build and install).
+.SS Caveats
+.sp
+Use this environment variable with caution. The following highlights some
+points to be considered:
+.INDENT 0.0
+.IP \(bu 2
+\fBCMAKE_INSTALL_MODE\fP only affects files, not directories.
+.IP \(bu 2
+Symbolic links are not available on all platforms.
+.IP \(bu 2
+The way this environment variable interacts with the install step of
+\X'tty: link #module:ExternalProject'\fI\%ExternalProject\fP\X'tty: link' is more complex. For further details, see that
+module\(aqs documentation.
+.IP \(bu 2
+A symbolic link ties the destination to the source in a persistent way.
+Writing to either of the two affects both file system objects.
+This is in contrast to normal install behavior which only copies files as
+they were at the time the install was performed, with no enduring
+relationship between the source and destination of the install.
+.IP \(bu 2
+Combining \fBCMAKE_INSTALL_MODE\fP with \X'tty: link #prop_tgt:IOS_INSTALL_COMBINED'\fI\%IOS_INSTALL_COMBINED\fP\X'tty: link' is
+not supported.
+.IP \(bu 2
+Changing \fBCMAKE_INSTALL_MODE\fP from what it was on a previous run can lead
+to unexpected results.  Moving from a non\-symlinking mode to a symlinking
+mode will discard any previous file at the destination, but the reverse is
+not true.  Once a symlink exists at the destination, even if you switch to a
+non\-symlink mode, the symlink will continue to exist at the destination and
+will not be replaced by an actual file.
+.UNINDENT
+.SS CMAKE_INSTALL_PARALLEL_LEVEL
+.sp
+Added in version 3.31.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Specifies the default maximum number of concurrent processes to use when
+installing using \fBcmake \-\-install\fP\&.
+.sp
+This has no impact unless \X'tty: link #prop_gbl:INSTALL_PARALLEL'\fI\%INSTALL_PARALLEL\fP\X'tty: link' is enabled.
+.SS CMAKE_INSTALL_PREFIX
+.sp
+Added in version 3.29.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBCMAKE_INSTALL_PREFIX\fP environment variable specifies a custom default
+value for the \X'tty: link #variable:CMAKE_INSTALL_PREFIX'\fI\%CMAKE_INSTALL_PREFIX\fP\X'tty: link' variable in place of the
+default values specified by CMake itself. The value specified must be an
+absolute path to a directory.
+.SS CMAKE_<LANG>_COMPILER_LAUNCHER
+.sp
+Added in version 3.17.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Default compiler launcher to use for the specified language. Will only be used
+by CMake to initialize the variable on the first configuration. Afterwards, it
+is available through the cache setting of the variable of the same name. For
+any configuration run (including the first), the environment variable will be
+ignored if the \X'tty: link #variable:CMAKE_<LANG>_COMPILER_LAUNCHER'\fI\%CMAKE_<LANG>_COMPILER_LAUNCHER\fP\X'tty: link' variable is defined.
+.SS CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES_EXCLUDE
+.sp
+Added in version 3.27.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+A \X'tty: link #cmake-language-lists'\fI\%semicolon\-separated list\fP\X'tty: link' of directories
+to exclude from the \X'tty: link #variable:CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES'\fI\%CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES\fP\X'tty: link'
+variable when it is automatically detected from the \fB<LANG>\fP compiler.
+.sp
+This may be used to work around misconfigured compiler drivers that pass
+extraneous implicit link directories to their linker.
+.SS CMAKE_<LANG>_LINKER_LAUNCHER
+.sp
+Added in version 3.21.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Default launcher to use when linking a target of the specified language. Will
+only be used by CMake to initialize the variable on the first configuration.
+Afterwards, it is available through the cache setting of the variable of the
+same name. For any configuration run (including the first), the environment
+variable will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_LINKER_LAUNCHER'\fI\%CMAKE_<LANG>_LINKER_LAUNCHER\fP\X'tty: link'
+variable is defined.
+.SS CMAKE_MSVCIDE_RUN_PATH
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Extra PATH locations for custom commands when using
+\X'tty: link #visual-studio-generators'\fI\%Visual Studio Generators\fP\X'tty: link'\&.
+.sp
+The \fBCMAKE_MSVCIDE_RUN_PATH\fP environment variable sets the default value for
+the \X'tty: link #variable:CMAKE_MSVCIDE_RUN_PATH'\fI\%CMAKE_MSVCIDE_RUN_PATH\fP\X'tty: link' variable if not already explicitly set.
+.SS CMAKE_NO_VERBOSE
+.sp
+Added in version 3.14.
+
+.sp
+Disables verbose output from CMake when \X'tty: link #envvar:VERBOSE'\fI\%VERBOSE\fP\X'tty: link' environment variable
+is set.
+.sp
+Only your build tool of choice will still print verbose output when you start
+to actually build your project.
+.SS CMAKE_OSX_ARCHITECTURES
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Target specific architectures for macOS.
+.sp
+The \fBCMAKE_OSX_ARCHITECTURES\fP environment variable sets the default value for
+the \X'tty: link #variable:CMAKE_OSX_ARCHITECTURES'\fI\%CMAKE_OSX_ARCHITECTURES\fP\X'tty: link' variable. See
+\X'tty: link #prop_tgt:OSX_ARCHITECTURES'\fI\%OSX_ARCHITECTURES\fP\X'tty: link' for more information.
+.SS CMAKE_TEST_LAUNCHER
+.sp
+Added in version 3.29.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The default value for the \X'tty: link #variable:CMAKE_TEST_LAUNCHER'\fI\%CMAKE_TEST_LAUNCHER\fP\X'tty: link' variable when there
+is no explicit configuration given on the first run while creating a new
+build tree.  On later runs in an existing build tree the value persists in
+the cache as \X'tty: link #variable:CMAKE_TEST_LAUNCHER'\fI\%CMAKE_TEST_LAUNCHER\fP\X'tty: link'\&.
+.SS CMAKE_TOOLCHAIN_FILE
+.sp
+Added in version 3.21.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+The \fBCMAKE_TOOLCHAIN_FILE\fP environment variable specifies a default value
+for the \X'tty: link #variable:CMAKE_TOOLCHAIN_FILE'\fI\%CMAKE_TOOLCHAIN_FILE\fP\X'tty: link' variable when there is no explicit
+configuration given on the first run while creating a new build tree.
+On later runs in an existing build tree the value persists in the cache
+as \X'tty: link #variable:CMAKE_TOOLCHAIN_FILE'\fI\%CMAKE_TOOLCHAIN_FILE\fP\X'tty: link'\&.
+.SS DESTDIR
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+On UNIX one can use the \fBDESTDIR\fP mechanism in order to relocate the
+whole installation.  \fBDESTDIR\fP means DESTination DIRectory.  It is
+commonly used by packagers to install software in a staging directory.
+.sp
+For example, running
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+make DESTDIR=/package/stage install
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+will install the software using the installation prefix, e.g. \fB/usr/local\fP,
+prepended with the \fBDESTDIR\fP value which gives \fB/package/stage/usr/local\fP\&.
+The packaging tool may then construct the package from the content of the
+\fB/package/stage\fP directory.
+.sp
+See the \X'tty: link #variable:CMAKE_INSTALL_PREFIX'\fI\%CMAKE_INSTALL_PREFIX\fP\X'tty: link' variable to control the
+installation prefix when configuring a build tree.  Or, when using
+the \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' command\-line tool\(aqs \X'tty: link #cmdoption-cmake-install'\fI\%\-\-install\fP\X'tty: link'
+mode, one may specify a different prefix using the
+\X'tty: link #cmdoption-cmake--install-0'\fI\%\-\-prefix\fP\X'tty: link' option.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+\fBDESTDIR\fP may not be used on Windows because installation
+prefix usually contains a drive letter like in \fBC:/Program Files\fP
+which cannot be prepended with some other prefix.
+.UNINDENT
+.UNINDENT
+.SS LDFLAGS
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Will only be used by CMake on the first configuration to determine the default
+linker flags, after which the value for \fBLDFLAGS\fP is stored in the cache
+as \X'tty: link #variable:CMAKE_EXE_LINKER_FLAGS_INIT'\fI\%CMAKE_EXE_LINKER_FLAGS_INIT\fP\X'tty: link',
+\X'tty: link #variable:CMAKE_SHARED_LINKER_FLAGS_INIT'\fI\%CMAKE_SHARED_LINKER_FLAGS_INIT\fP\X'tty: link', and
+\X'tty: link #variable:CMAKE_MODULE_LINKER_FLAGS_INIT'\fI\%CMAKE_MODULE_LINKER_FLAGS_INIT\fP\X'tty: link'\&. For any configuration run
+(including the first), the environment variable will be ignored if the
+equivalent  \fBCMAKE_<TYPE>_LINKER_FLAGS_INIT\fP variable is defined.
+.SS MACOSX_DEPLOYMENT_TARGET
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Specify the minimum version of macOS on which the target binaries are
+to be deployed.
+.sp
+The \fBMACOSX_DEPLOYMENT_TARGET\fP environment variable sets the default value for
+the \X'tty: link #variable:CMAKE_OSX_DEPLOYMENT_TARGET'\fI\%CMAKE_OSX_DEPLOYMENT_TARGET\fP\X'tty: link' variable.
+.SS <PackageName>_ROOT
+.sp
+Added in version 3.12.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Calls to \X'tty: link #command:find_package'\fI\%find_package(<PackageName>)\fP\X'tty: link' will search in prefixes
+specified by the \fB<PackageName>_ROOT\fP environment variable, where
+\fB<PackageName>\fP is the (case\-preserved) name given to the
+\X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' call and \fB_ROOT\fP is literal.
+For example, \fBfind_package(Foo)\fP will search prefixes specified in the
+\fBFoo_ROOT\fP environment variable (if set).  See policy \X'tty: link #policy:CMP0074'\fI\%CMP0074\fP\X'tty: link'\&.
+.sp
+This variable may hold a single prefix or a list of prefixes separated
+by \fB:\fP on UNIX or \fB;\fP on Windows (the same as the \fBPATH\fP environment
+variable convention on those platforms).
+.sp
+See also the \X'tty: link #variable:<PackageName>_ROOT'\fI\%<PackageName>_ROOT\fP\X'tty: link' CMake variable.
+.INDENT 0.0
+.TP
+.B <PACKAGENAME>_ROOT
+Added in version 3.27.
+
+.sp
+Calls to \X'tty: link #command:find_package'\fI\%find_package(<PackageName>)\fP\X'tty: link' will also search in
+prefixes specified by the upper\-case \fB<PACKAGENAME>_ROOT\fP environment
+variable.  See policy \X'tty: link #policy:CMP0144'\fI\%CMP0144\fP\X'tty: link'\&.
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+Note that the \fB<PackageName>_ROOT\fP and \fB<PACKAGENAME>_ROOT\fP
+environment variables are distinct only on platforms that have
+case\-sensitive environments.
+.UNINDENT
+.UNINDENT
+.SS VERBOSE
+.sp
+Added in version 3.14.
+
+.sp
+Activates verbose output from CMake and your build tools of choice when
+you start to actually build your project.
+.sp
+Note that any given value is ignored. It\(aqs just checked for existence.
+.sp
+See also \X'tty: link #build-tool-mode'\fI\%Build Tool Mode\fP\X'tty: link' and
+\X'tty: link #envvar:CMAKE_NO_VERBOSE'\fI\%CMAKE_NO_VERBOSE\fP\X'tty: link' environment variable
+.SH ENVIRONMENT VARIABLES FOR LANGUAGES
+.SS ASM<DIALECT>
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling a specific dialect of assembly language
+files. \fBASM<DIALECT>\fP can be one of:
+.INDENT 0.0
+.IP \(bu 2
+\fBASM\fP
+.IP \(bu 2
+\fBASM_NASM\fP (Netwide Assembler)
+.IP \(bu 2
+\fBASM_MASM\fP (Microsoft Assembler)
+.IP \(bu 2
+\fBASM_MARMASM\fP (Microsoft ARM Assembler)
+.IP \(bu 2
+\fBASM\-ATT\fP (Assembler AT&T)
+.UNINDENT
+.sp
+Will only be used by CMake on the first configuration to determine
+\fBASM<DIALECT>\fP compiler, after which the value for \fBASM<DIALECT>\fP is stored
+in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_ASM<DIALECT>_COMPILER\fP\X'tty: link'\&. For subsequent
+configuration runs, the environment variable will be ignored in favor of
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_ASM<DIALECT>_COMPILER\fP\X'tty: link'\&.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+Options that are required to make the compiler work correctly can be included;
+they can not be changed.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ export ASM=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS ASM<DIALECT>FLAGS
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Add default compilation flags to be used when compiling a specific dialect
+of an assembly language.  \fBASM<DIALECT>FLAGS\fP can be one of:
+.INDENT 0.0
+.IP \(bu 2
+\fBASMFLAGS\fP
+.IP \(bu 2
+\fBASM_NASMFLAGS\fP
+.IP \(bu 2
+\fBASM_MASMFLAGS\fP
+.IP \(bu 2
+\fBASM_MARMASMFLAGS\fP
+.IP \(bu 2
+\fBASM\-ATTFLAGS\fP
+.UNINDENT
+.sp
+CMake uses this environment variable value, in combination with its own
+builtin default flags for the toolchain, to initialize and store the
+\X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_ASM<DIALECT>_FLAGS\fP\X'tty: link' cache entry.
+This occurs the first time a build tree is configured for language \fBASM<DIALECT>\fP\&.
+For any configuration run (including the first), the environment variable
+will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_ASM<DIALECT>_FLAGS\fP\X'tty: link' variable is already defined.
+.sp
+See also \X'tty: link #variable:CMAKE_<LANG>_FLAGS_INIT'\fI\%CMAKE_ASM<DIALECT>_FLAGS_INIT\fP\X'tty: link'\&.
+.SS CC
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling \fBC\fP language files. Will only be used by
+CMake on the first configuration to determine \fBC\fP compiler, after which the
+value for \fBCC\fP is stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_C_COMPILER\fP\X'tty: link'\&. For any configuration run
+(including the first), the environment variable will be ignored if the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_C_COMPILER\fP\X'tty: link' variable is defined.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+Options that are required to make the compiler work correctly can be included;
+they can not be changed.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ export CC=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS CFLAGS
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Add default compilation flags to be used when compiling \fBC\fP files.
+.sp
+CMake uses this environment variable value, in combination with its own
+builtin default flags for the toolchain, to initialize and store the
+\X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_C_FLAGS\fP\X'tty: link' cache entry.
+This occurs the first time a build tree is configured for language \fBC\fP\&.
+For any configuration run (including the first), the environment variable
+will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_C_FLAGS\fP\X'tty: link' variable is already defined.
+.sp
+See also \X'tty: link #variable:CMAKE_<LANG>_FLAGS_INIT'\fI\%CMAKE_C_FLAGS_INIT\fP\X'tty: link'\&.
+.SS CSFLAGS
+.sp
+Added in version 3.9.2.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Add default compilation flags to be used when compiling \fBCSharp\fP files.
+.sp
+CMake uses this environment variable value, in combination with its own
+builtin default flags for the toolchain, to initialize and store the
+\X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_CSharp_FLAGS\fP\X'tty: link' cache entry.
+This occurs the first time a build tree is configured for language \fBCSharp\fP\&.
+For any configuration run (including the first), the environment variable
+will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_CSharp_FLAGS\fP\X'tty: link' variable is already defined.
+.sp
+See also \X'tty: link #variable:CMAKE_<LANG>_FLAGS_INIT'\fI\%CMAKE_CSharp_FLAGS_INIT\fP\X'tty: link'\&.
+.SS CUDAARCHS
+.sp
+Added in version 3.20.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Value used to initialize \X'tty: link #variable:CMAKE_CUDA_ARCHITECTURES'\fI\%CMAKE_CUDA_ARCHITECTURES\fP\X'tty: link' on the first
+configuration. Subsequent runs will use the value stored in the cache.
+.sp
+This is a semicolon\-separated list of architectures as described in
+\X'tty: link #prop_tgt:CUDA_ARCHITECTURES'\fI\%CUDA_ARCHITECTURES\fP\X'tty: link'\&.
+.SS CUDACXX
+.sp
+Added in version 3.8.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling \fBCUDA\fP language files. Will only be used by
+CMake on the first configuration to determine \fBCUDA\fP compiler, after which the
+value for \fBCUDA\fP is stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_CUDA_COMPILER\fP\X'tty: link'\&. For any configuration
+run (including the first), the environment variable will be ignored if the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_CUDA_COMPILER\fP\X'tty: link' variable is defined.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+Options that are required to make the compiler work correctly can be included;
+they can not be changed.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ export CUDACXX=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS CUDAFLAGS
+.sp
+Added in version 3.8.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Add default compilation flags to be used when compiling \fBCUDA\fP files.
+.sp
+CMake uses this environment variable value, in combination with its own
+builtin default flags for the toolchain, to initialize and store the
+\X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_CUDA_FLAGS\fP\X'tty: link' cache entry.
+This occurs the first time a build tree is configured for language \fBCUDA\fP\&.
+For any configuration run (including the first), the environment variable
+will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_CUDA_FLAGS\fP\X'tty: link' variable is already defined.
+.sp
+See also \X'tty: link #variable:CMAKE_<LANG>_FLAGS_INIT'\fI\%CMAKE_CUDA_FLAGS_INIT\fP\X'tty: link'\&.
+.SS CUDAHOSTCXX
+.sp
+Added in version 3.8.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling host code when compiling \fBCUDA\fP
+language files. Will only be used by CMake on the first configuration to
+determine \fBCUDA\fP host compiler, after which the value for \fBCUDAHOSTCXX\fP is
+stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_HOST_COMPILER'\fI\%CMAKE_CUDA_HOST_COMPILER\fP\X'tty: link'\&.
+This environment variable is preferred over
+\X'tty: link #variable:CMAKE_<LANG>_HOST_COMPILER'\fI\%CMAKE_CUDA_HOST_COMPILER\fP\X'tty: link'\&.
+.sp
+This environment variable is primarily meant for use with projects that
+enable \fBCUDA\fP as a first\-class language.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+Ignored when using \X'tty: link #visual-studio-generators'\fI\%Visual Studio Generators\fP\X'tty: link'\&.
+.UNINDENT
+.UNINDENT
+.sp
+Added in version 3.13: The \X'tty: link #module:FindCUDA'\fI\%FindCUDA\fP\X'tty: link'
+module will use this variable to initialize its \fBCUDA_HOST_COMPILER\fP setting.
+
+.SS CXX
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling \fBCXX\fP language files. Will only be used by
+CMake on the first configuration to determine \fBCXX\fP compiler, after which the
+value for \fBCXX\fP is stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_CXX_COMPILER\fP\X'tty: link'\&. For any configuration
+run (including the first), the environment variable will be ignored if the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_CXX_COMPILER\fP\X'tty: link' variable is defined.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+Options that are required to make the compiler work correctly can be included;
+they can not be changed.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ export CXX=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS CXXFLAGS
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Add default compilation flags to be used when compiling \fBCXX\fP (C++) files.
+.sp
+CMake uses this environment variable value, in combination with its own
+builtin default flags for the toolchain, to initialize and store the
+\X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_CXX_FLAGS\fP\X'tty: link' cache entry.
+This occurs the first time a build tree is configured for language \fBCXX\fP\&.
+For any configuration run (including the first), the environment variable
+will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_CXX_FLAGS\fP\X'tty: link' variable is already defined.
+.sp
+See also \X'tty: link #variable:CMAKE_<LANG>_FLAGS_INIT'\fI\%CMAKE_CXX_FLAGS_INIT\fP\X'tty: link'\&.
+.SS FC
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling \fBFortran\fP language files. Will only be used
+by CMake on the first configuration to determine \fBFortran\fP compiler, after
+which the value for \fBFortran\fP is stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_Fortran_COMPILER\fP\X'tty: link'\&. For any
+configuration run (including the first), the environment variable will be
+ignored if the \X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_Fortran_COMPILER\fP\X'tty: link'
+variable is defined.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+Options that are required to make the compiler work correctly can be included;
+they can not be changed.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ export FC=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS FFLAGS
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Add default compilation flags to be used when compiling \fBFortran\fP files.
+.sp
+CMake uses this environment variable value, in combination with its own
+builtin default flags for the toolchain, to initialize and store the
+\X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_Fortran_FLAGS\fP\X'tty: link' cache entry.
+This occurs the first time a build tree is configured for language \fBFortran\fP\&.
+For any configuration run (including the first), the environment variable
+will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_Fortran_FLAGS\fP\X'tty: link' variable is already defined.
+.sp
+See also \X'tty: link #variable:CMAKE_<LANG>_FLAGS_INIT'\fI\%CMAKE_Fortran_FLAGS_INIT\fP\X'tty: link'\&.
+.SS HIPCXX
+.sp
+Added in version 3.21.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling \fBHIP\fP language files. Will only be used by
+CMake on the first configuration to determine \fBHIP\fP compiler, after which the
+value for \fBHIP\fP is stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_HIP_COMPILER\fP\X'tty: link'\&. For any configuration
+run (including the first), the environment variable will be ignored if the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_HIP_COMPILER\fP\X'tty: link' variable is defined.
+.SS HIPFLAGS
+.sp
+Added in version 3.21.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Add default compilation flags to be used when compiling \fBHIP\fP files.
+.sp
+CMake uses this environment variable value, in combination with its own
+builtin default flags for the toolchain, to initialize and store the
+\X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_HIP_FLAGS\fP\X'tty: link' cache entry.
+This occurs the first time a build tree is configured for language \fBHIP\fP\&.
+For any configuration run (including the first), the environment variable
+will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_HIP_FLAGS\fP\X'tty: link' variable is already defined.
+.sp
+See also \X'tty: link #variable:CMAKE_<LANG>_FLAGS_INIT'\fI\%CMAKE_HIP_FLAGS_INIT\fP\X'tty: link'\&.
+.SS HIPHOSTCXX
+.sp
+Added in version 3.28.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling host code when compiling \fBHIP\fP
+language files with the NVIDIA CUDA Compiler. Will only be used by CMake
+on the first configuration to determine \fBHIP\fP host compiler, after which
+the value for \fBHIPHOSTCXX\fP is stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_HOST_COMPILER'\fI\%CMAKE_HIP_HOST_COMPILER\fP\X'tty: link'\&.
+.sp
+This environment variable is primarily meant for use with projects that
+enable \fBHIP\fP as a first\-class language.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+Ignored when using \X'tty: link #visual-studio-generators'\fI\%Visual Studio Generators\fP\X'tty: link'\&.
+.UNINDENT
+.UNINDENT
+.SS ISPC
+.sp
+Added in version 3.19.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling \fBISPC\fP language files. Will only be used by
+CMake on the first configuration to determine \fBISPC\fP compiler, after which the
+value for \fBISPC\fP is stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_ISPC_COMPILER\fP\X'tty: link'\&. For any configuration
+run (including the first), the environment variable will be ignored if the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_ISPC_COMPILER\fP\X'tty: link' variable is defined.
+.SS ISPCFLAGS
+.sp
+Added in version 3.19.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Add default compilation flags to be used when compiling \fBISPC\fP files.
+.sp
+CMake uses this environment variable value, in combination with its own
+builtin default flags for the toolchain, to initialize and store the
+\X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_ISPC_FLAGS\fP\X'tty: link' cache entry.
+This occurs the first time a build tree is configured for language \fBISPC\fP\&.
+For any configuration run (including the first), the environment variable
+will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_ISPC_FLAGS\fP\X'tty: link' variable is already defined.
+.sp
+See also \X'tty: link #variable:CMAKE_<LANG>_FLAGS_INIT'\fI\%CMAKE_ISPC_FLAGS_INIT\fP\X'tty: link'\&.
+.SS OBJC
+.sp
+Added in version 3.16.7.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling \fBOBJC\fP language files. Will only be used
+by CMake on the first configuration to determine \fBOBJC\fP compiler, after
+which the value for \fBOBJC\fP is stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_OBJC_COMPILER\fP\X'tty: link'\&. For any configuration
+run (including the first), the environment variable will be ignored if the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_OBJC_COMPILER\fP\X'tty: link' variable is defined.
+.sp
+If \fBOBJC\fP is not defined, the \X'tty: link #envvar:CC'\fI\%CC\fP\X'tty: link' environment variable will
+be checked instead.
+.SS OBJCFLAGS
+.sp
+Added in version 3.16.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Add default compilation flags to be used when compiling \fBObjective C\fP files.
+.sp
+CMake uses this environment variable value, in combination with its own
+builtin default flags for the toolchain, to initialize and store the
+\X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_OBJC_FLAGS\fP\X'tty: link' cache entry.
+This occurs the first time a build tree is configured for language \fBOBJC\fP\&.
+For any configuration run (including the first), the environment variable
+will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_OBJC_FLAGS\fP\X'tty: link' variable is already defined.
+.sp
+See also \X'tty: link #variable:CMAKE_<LANG>_FLAGS_INIT'\fI\%CMAKE_OBJC_FLAGS_INIT\fP\X'tty: link'\&.
+.SS OBJCXX
+.sp
+Added in version 3.16.7.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling \fBOBJCXX\fP language files. Will only be used
+by CMake on the first configuration to determine \fBOBJCXX\fP compiler, after
+which the value for \fBOBJCXX\fP is stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_OBJCXX_COMPILER\fP\X'tty: link'\&. For any configuration
+run (including the first), the environment variable will be ignored if the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_OBJCXX_COMPILER\fP\X'tty: link' variable is defined.
+.sp
+If \fBOBJCXX\fP is not defined, the \X'tty: link #envvar:CXX'\fI\%CXX\fP\X'tty: link' environment variable will
+be checked instead.
+.SS OBJCXXFLAGS
+.sp
+Added in version 3.16.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Add default compilation flags to be used when compiling \fBObjective C++\fP (.mm) files.
+.sp
+CMake uses this environment variable value, in combination with its own
+builtin default flags for the toolchain, to initialize and store the
+\X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_OBJCXX_FLAGS\fP\X'tty: link' cache entry.
+This occurs the first time a build tree is configured for language \fBOBJCXX\fP\&.
+For any configuration run (including the first), the environment variable
+will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_OBJCXX_FLAGS\fP\X'tty: link' variable is already defined.
+.sp
+See also \X'tty: link #variable:CMAKE_<LANG>_FLAGS_INIT'\fI\%CMAKE_OBJCXX_FLAGS_INIT\fP\X'tty: link'\&.
+.SS RC
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling \fBresource\fP files. Will only be used by CMake
+on the first configuration to determine \fBresource\fP compiler, after which the
+value for \fBRC\fP is stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_RC_COMPILER\fP\X'tty: link'\&. For any configuration run
+(including the first), the environment variable will be ignored if the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_RC_COMPILER\fP\X'tty: link' variable is defined.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+Options that are required to make the compiler work correctly can be included;
+they can not be changed.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ export RC=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS RCFLAGS
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Add default compilation flags to be used when compiling \fBRC\fP (resource) files.
+.sp
+CMake uses this environment variable value, in combination with its own
+builtin default flags for the toolchain, to initialize and store the
+\X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_RC_FLAGS\fP\X'tty: link' cache entry.
+This occurs the first time a build tree is configured for language \fBRC\fP\&.
+For any configuration run (including the first), the environment variable
+will be ignored if the \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_RC_FLAGS\fP\X'tty: link' variable is already defined.
+.sp
+See also \X'tty: link #variable:CMAKE_<LANG>_FLAGS_INIT'\fI\%CMAKE_RC_FLAGS_INIT\fP\X'tty: link'\&.
+.SS SWIFTC
+.sp
+Added in version 3.15.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Preferred executable for compiling \fBSwift\fP language files. Will only be used by
+CMake on the first configuration to determine \fBSwift\fP compiler, after which the
+value for \fBSWIFTC\fP is stored in the cache as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_Swift_COMPILER\fP\X'tty: link'\&. For any configuration run
+(including the first), the environment variable will be ignored if the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_Swift_COMPILER\fP\X'tty: link' variable is defined.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+Options that are required to make the compiler work correctly can be included;
+they can not be changed.
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ export SWIFTC=\(dqcustom\-compiler \-\-arg1 \-\-arg2\(dq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH ENVIRONMENT VARIABLES FOR CTEST
+.SS CTEST_INTERACTIVE_DEBUG_MODE
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Environment variable that will exist and be set to \fB1\fP when a test executed
+by \X'tty: link #manual:ctest(1)'\fI\%ctest(1)\fP\X'tty: link' is run in interactive mode.
+.SS CTEST_NO_TESTS_ACTION
+.sp
+Added in version 3.26.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Environment variable that controls how \X'tty: link #manual:ctest(1)'\fI\%ctest\fP\X'tty: link' handles
+cases when there are no tests to run. Possible values are: \fBerror\fP,
+\fBignore\fP, empty or unset.
+.sp
+The \X'tty: link #cmdoption-ctest-no-tests'\fI\%\-\-no\-tests=<action>\fP\X'tty: link' option to
+\X'tty: link #manual:ctest(1)'\fI\%ctest\fP\X'tty: link' overrides this environment variable if both
+are given.
+.SS CTEST_OUTPUT_ON_FAILURE
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Boolean environment variable that controls if the output should be logged for
+failed tests. Set the value to \fB1\fP, \fBTrue\fP, or \fBON\fP to enable output on failure.
+See \X'tty: link #manual:ctest(1)'\fI\%ctest(1)\fP\X'tty: link' for more information on controlling output of failed
+tests.
+.SS CTEST_PARALLEL_LEVEL
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Specify the number of tests for CTest to run in parallel.
+For example, if \fBCTEST_PARALLEL_LEVEL\fP is set to 8, CTest will run
+up to 8 tests concurrently as if \fBctest\fP were invoked with the
+\X'tty: link #cmdoption-ctest-j'\fI\%\-\-parallel 8\fP\X'tty: link' option.
+.sp
+Changed in version 3.29: The value may be empty, or \fB0\fP, to let ctest use a default level of
+parallelism, or unbounded parallelism, respectively, as documented by
+the \X'tty: link #cmdoption-ctest-j'\fI\%ctest \-\-parallel\fP\X'tty: link' option.
+.sp
+On Windows, environment variables cannot be set to an empty string.
+CTest will interpret a whitespace\-only string as empty.
+.sp
+In CMake 3.28 and earlier, an empty or \fB0\fP value was equivalent to \fB1\fP\&.
+
+.sp
+See \X'tty: link #manual:ctest(1)'\fI\%ctest(1)\fP\X'tty: link' for more information on parallel test execution.
+.SS CTEST_PROGRESS_OUTPUT
+.sp
+Added in version 3.13.
+
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Boolean environment variable that affects how \X'tty: link #manual:ctest(1)'\fI\%ctest\fP\X'tty: link'
+command output reports overall progress.  When set to \fB1\fP, \fBTRUE\fP, \fBON\fP or anything
+else that evaluates to boolean true, progress is reported by repeatedly
+updating the same line.  This greatly reduces the overall verbosity, but is
+only supported when output is sent directly to a terminal.  If the environment
+variable is not set or has a value that evaluates to false, output is reported
+normally with each test having its own start and end lines logged to the
+output.
+.sp
+The \X'tty: link #cmdoption-ctest-progress'\fI\%\-\-progress\fP\X'tty: link' option to \X'tty: link #manual:ctest(1)'\fI\%ctest\fP\X'tty: link'
+overrides this environment variable if both are given.
+.SS CTEST_USE_LAUNCHERS_DEFAULT
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Initializes the \X'tty: link #variable:CTEST_USE_LAUNCHERS'\fI\%CTEST_USE_LAUNCHERS\fP\X'tty: link' variable if not already defined.
+.SS DASHBOARD_TEST_FROM_CTEST
+.sp
+This is a CMake \X'tty: link #cmake-language-environment-variables'\fI\%Environment Variable\fP\X'tty: link'\&. Its initial value is taken from
+the calling process environment.
+.sp
+Environment variable that will exist when a test executed by \X'tty: link #manual:ctest(1)'\fI\%ctest(1)\fP\X'tty: link'
+is run in non\-interactive mode.  The value will be equal to
+\X'tty: link #variable:CMAKE_VERSION'\fI\%CMAKE_VERSION\fP\X'tty: link'\&.
+.SH ENVIRONMENT VARIABLES FOR THE CMAKE CURSES INTERFACE
+.SS CCMAKE_COLORS
+.sp
+Added in version 3.18.
+
+.sp
+Determines what colors are used by the CMake curses interface,
+when run on a terminal that supports colors.
+The syntax follows the same conventions as \fBLS_COLORS\fP;
+that is, a list of key/value pairs separated by \fB:\fP\&.
+.sp
+Keys are a single letter corresponding to a CMake cache variable type:
+.INDENT 0.0
+.IP \(bu 2
+\fBs\fP: A \fBSTRING\fP\&.
+.IP \(bu 2
+\fBp\fP: A \fBFILEPATH\fP\&.
+.IP \(bu 2
+\fBc\fP: A value which has an associated list of choices.
+.IP \(bu 2
+\fBy\fP: A \fBBOOL\fP which has a true\-like value (e.g. \fBON\fP, \fBYES\fP).
+.IP \(bu 2
+\fBn\fP: A \fBBOOL\fP which has a false\-like value (e.g. \fBOFF\fP, \fBNO\fP).
+.UNINDENT
+.sp
+Values are an integer number that specifies what color to use.
+\fB0\fP is black (you probably don\(aqt want to use that).
+Others are determined by your terminal\(aqs color support.
+Most (color) terminals will support at least 8 or 16 colors.
+Some will support up to 256 colors. The colors will likely match
+\X'tty: link https://upload.wikimedia.org/wikipedia/commons/1/15/Xterm_256color_chart.svg'\fI\%this chart\fP\X'tty: link',
+although the first 16 colors may match the original
+\X'tty: link https://en.wikipedia.org/wiki/Color_Graphics_Adapter#Color_palette'\fI\%CGA color palette\fP\X'tty: link'\&.
+(Many modern terminal emulators also allow their color palette,
+at least for the first 16 colors, to be configured by the user.)
+.sp
+Note that fairly minimal checking is done for bad colors
+(although a value higher than what curses believes your terminal supports
+will be silently ignored) or bad syntax.
+.sp
+For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+CCMAKE_COLORS=\(aqs=39:p=220:c=207:n=196:y=46\(aq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-file-api.7

@@ -0,0 +1,1984 @@
+.\" 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-FILE-API" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-file-api \- CMake File-Based API
+.SH INTRODUCTION
+.sp
+CMake provides a file\-based API that clients may use to get semantic
+information about the buildsystems CMake generates.  Clients may use
+the API by writing query files to a specific location in a build tree
+to request zero or more \fI\%Object Kinds\fP\&.  When CMake generates the
+buildsystem in that build tree it will read the query files and write
+reply files for the client to read.
+.sp
+The file\-based API uses a \fB<build>/.cmake/api/\fP directory at the top
+of a build tree.  The API is versioned to support changes to the layout
+of files within the API directory.  API file layout versioning is
+orthogonal to the versioning of \fI\%Object Kinds\fP used in replies.
+This version of CMake supports only one API version, \fI\%API v1\fP\&.
+.sp
+Added in version 3.27: Projects may also submit queries for the current run using the
+\X'tty: link #command:cmake_file_api'\fI\%cmake_file_api()\fP\X'tty: link' command.
+
+.SH API V1
+.sp
+API v1 is housed in the \fB<build>/.cmake/api/v1/\fP directory.
+It has the following subdirectories:
+.INDENT 0.0
+.TP
+.B \fBquery/\fP
+Holds query files written by clients.
+These may be \fI\%v1 Shared Stateless Query Files\fP,
+\fI\%v1 Client Stateless Query Files\fP, or \fI\%v1 Client Stateful Query Files\fP\&.
+.TP
+.B \fBreply/\fP
+Holds reply files written by CMake whenever it runs to generate a build
+system.  These are indexed by a \fI\%v1 Reply Index File\fP file that may
+reference additional \fI\%v1 Reply Files\fP\&.  CMake owns all reply files.
+Clients must never remove them.
+.sp
+Clients may look for and read a reply index file at any time.
+Clients may optionally create the \fBreply/\fP directory at any time
+and monitor it for the appearance of a new reply index file.
+.UNINDENT
+.sp
+Added in version 3.31: Users can add query files to \fBapi/v1/query\fP inside the
+\X'tty: link #envvar:CMAKE_CONFIG_DIR'\fI\%CMAKE_CONFIG_DIR\fP\X'tty: link' to create user\-wide queries for all CMake projects.
+
+.SS v1 Shared Stateless Query Files
+.sp
+Shared stateless query files allow clients to share requests for
+major versions of the \fI\%Object Kinds\fP and get all requested versions
+recognized by the CMake that runs.
+.sp
+Clients may create shared requests by creating empty files in the
+\fBv1/query/\fP directory.  The form is:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<build>/.cmake/api/v1/query/<kind>\-v<major>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+where \fB<kind>\fP is one of the \fI\%Object Kinds\fP, \fB\-v\fP is literal,
+and \fB<major>\fP is the major version number.
+.sp
+Files of this form are stateless shared queries not owned by any specific
+client.  Once created they should not be removed without external client
+coordination or human intervention.
+.SS v1 Client Stateless Query Files
+.sp
+Client stateless query files allow clients to create owned requests for
+major versions of the \fI\%Object Kinds\fP and get all requested versions
+recognized by the CMake that runs.
+.sp
+Clients may create owned requests by creating empty files in
+client\-specific query subdirectories.  The form is:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<build>/.cmake/api/v1/query/client\-<client>/<kind>\-v<major>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+where \fBclient\-\fP is literal, \fB<client>\fP is a string uniquely
+identifying the client, \fB<kind>\fP is one of the \fI\%Object Kinds\fP,
+\fB\-v\fP is literal, and \fB<major>\fP is the major version number.
+Each client must choose a unique \fB<client>\fP identifier via its
+own means.
+.sp
+Files of this form are stateless queries owned by the client \fB<client>\fP\&.
+The owning client may remove them at any time.
+.SS v1 Client Stateful Query Files
+.sp
+Stateful query files allow clients to request a list of versions of
+each of the \fI\%Object Kinds\fP and get only the most recent version
+recognized by the CMake that runs.
+.sp
+Clients may create owned stateful queries by creating \fBquery.json\fP
+files in client\-specific query subdirectories.  The form is:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<build>/.cmake/api/v1/query/client\-<client>/query.json
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+where \fBclient\-\fP is literal, \fB<client>\fP is a string uniquely
+identifying the client, and \fBquery.json\fP is literal.  Each client
+must choose a unique \fB<client>\fP identifier via its own means.
+.sp
+\fBquery.json\fP files are stateful queries owned by the client \fB<client>\fP\&.
+The owning client may update or remove them at any time.  When a
+given client installation is updated it may then update the stateful
+query it writes to build trees to request newer object versions.
+This can be used to avoid asking CMake to generate multiple object
+versions unnecessarily.
+.sp
+A \fBquery.json\fP file must contain a JSON object:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  \(dqrequests\(dq: [
+    { \(dqkind\(dq: \(dq<kind>\(dq , \(dqversion\(dq: 1 },
+    { \(dqkind\(dq: \(dq<kind>\(dq , \(dqversion\(dq: { \(dqmajor\(dq: 1, \(dqminor\(dq: 2 } },
+    { \(dqkind\(dq: \(dq<kind>\(dq , \(dqversion\(dq: [2, 1] },
+    { \(dqkind\(dq: \(dq<kind>\(dq , \(dqversion\(dq: [2, { \(dqmajor\(dq: 1, \(dqminor\(dq: 2 }] },
+    { \(dqkind\(dq: \(dq<kind>\(dq , \(dqversion\(dq: 1, \(dqclient\(dq: {} },
+    { \(dqkind\(dq: \(dq...\(dq }
+  ],
+  \(dqclient\(dq: {}
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The members are:
+.INDENT 0.0
+.TP
+.B \fBrequests\fP
+A JSON array containing zero or more requests.  Each request is
+a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBkind\fP
+Specifies one of the \fI\%Object Kinds\fP to be included in the reply.
+.TP
+.B \fBversion\fP
+Indicates the version(s) of the object kind that the client
+understands.  Versions have major and minor components following
+semantic version conventions.  The value must be
+.INDENT 7.0
+.IP \(bu 2
+a JSON integer specifying a (non\-negative) major version number, or
+.IP \(bu 2
+a JSON object containing \fBmajor\fP and (optionally) \fBminor\fP
+members specifying non\-negative integer version components, or
+.IP \(bu 2
+a JSON array whose elements are each one of the above.
+.UNINDENT
+.TP
+.B \fBclient\fP
+Optional member reserved for use by the client.  This value is
+preserved in the reply written for the client in the
+\fI\%v1 Reply Index File\fP but is otherwise ignored.  Clients may use
+this to pass custom information with a request through to its reply.
+.UNINDENT
+.sp
+For each requested object kind CMake will choose the \fIfirst\fP version
+that it recognizes for that kind among those listed in the request.
+The response will use the selected \fImajor\fP version with the highest
+\fIminor\fP version known to the running CMake for that major version.
+Therefore clients should list all supported major versions in
+preferred order along with the minimal minor version required
+for each major version.
+.TP
+.B \fBclient\fP
+Optional member reserved for use by the client.  This value is
+preserved in the reply written for the client in the
+\fI\%v1 Reply Index File\fP but is otherwise ignored.  Clients may use
+this to pass custom information with a query through to its reply.
+.UNINDENT
+.sp
+Other \fBquery.json\fP top\-level members are reserved for future use.
+If present they are ignored for forward compatibility.
+.SS v1 Reply Index File
+.sp
+CMake writes an \fBindex\-*.json\fP file to the \fBv1/reply/\fP directory
+whenever it runs to generate a build system.  Clients must read the
+reply index file first and may read other \fI\%v1 Reply Files\fP only by
+following references.  The form of the reply index file name is:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<build>/.cmake/api/v1/reply/index\-<unspecified>.json
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+where \fBindex\-\fP is literal and \fB<unspecified>\fP is an unspecified
+name selected by CMake.  Whenever a new index file is generated it
+is given a new name and any old one is deleted.  During the short
+time between these steps there may be multiple index files present;
+the one with the largest name in lexicographic order is the current
+index file.
+.sp
+The reply index file contains a JSON object:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  \(dqcmake\(dq: {
+    \(dqversion\(dq: {
+      \(dqmajor\(dq: 3, \(dqminor\(dq: 14, \(dqpatch\(dq: 0, \(dqsuffix\(dq: \(dq\(dq,
+      \(dqstring\(dq: \(dq3.14.0\(dq, \(dqisDirty\(dq: false
+    },
+    \(dqpaths\(dq: {
+      \(dqcmake\(dq: \(dq/prefix/bin/cmake\(dq,
+      \(dqctest\(dq: \(dq/prefix/bin/ctest\(dq,
+      \(dqcpack\(dq: \(dq/prefix/bin/cpack\(dq,
+      \(dqroot\(dq: \(dq/prefix/share/cmake\-3.14\(dq
+    },
+    \(dqgenerator\(dq: {
+      \(dqmultiConfig\(dq: false,
+      \(dqname\(dq: \(dqUnix Makefiles\(dq
+    }
+  },
+  \(dqobjects\(dq: [
+    { \(dqkind\(dq: \(dq<kind>\(dq,
+      \(dqversion\(dq: { \(dqmajor\(dq: 1, \(dqminor\(dq: 0 },
+      \(dqjsonFile\(dq: \(dq<file>\(dq },
+    { \(dq...\(dq: \(dq...\(dq }
+  ],
+  \(dqreply\(dq: {
+    \(dq<kind>\-v<major>\(dq: { \(dqkind\(dq: \(dq<kind>\(dq,
+                         \(dqversion\(dq: { \(dqmajor\(dq: 1, \(dqminor\(dq: 0 },
+                         \(dqjsonFile\(dq: \(dq<file>\(dq },
+    \(dq<unknown>\(dq: { \(dqerror\(dq: \(dqunknown query file\(dq },
+    \(dq...\(dq: {},
+    \(dqclient\-<client>\(dq: {
+      \(dq<kind>\-v<major>\(dq: { \(dqkind\(dq: \(dq<kind>\(dq,
+                           \(dqversion\(dq: { \(dqmajor\(dq: 1, \(dqminor\(dq: 0 },
+                           \(dqjsonFile\(dq: \(dq<file>\(dq },
+      \(dq<unknown>\(dq: { \(dqerror\(dq: \(dqunknown query file\(dq },
+      \(dq...\(dq: {},
+      \(dqquery.json\(dq: {
+        \(dqrequests\(dq: [ {}, {}, {} ],
+        \(dqresponses\(dq: [
+          { \(dqkind\(dq: \(dq<kind>\(dq,
+            \(dqversion\(dq: { \(dqmajor\(dq: 1, \(dqminor\(dq: 0 },
+            \(dqjsonFile\(dq: \(dq<file>\(dq },
+          { \(dqerror\(dq: \(dqunknown query file\(dq },
+          { \(dq...\(dq: {} }
+        ],
+        \(dqclient\(dq: {}
+      }
+    }
+  }
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The members are:
+.INDENT 0.0
+.TP
+.B \fBcmake\fP
+A JSON object containing information about the instance of CMake that
+generated the reply.  It contains members:
+.INDENT 7.0
+.TP
+.B \fBversion\fP
+A JSON object specifying the version of CMake with members:
+.INDENT 7.0
+.TP
+.B \fBmajor\fP, \fBminor\fP, \fBpatch\fP
+Integer values specifying the major, minor, and patch version components.
+.TP
+.B \fBsuffix\fP
+A string specifying the version suffix, if any, e.g. \fBg0abc3\fP\&.
+.TP
+.B \fBstring\fP
+A string specifying the full version in the format
+\fB<major>.<minor>.<patch>[\-<suffix>]\fP\&.
+.TP
+.B \fBisDirty\fP
+A boolean indicating whether the version was built from a version
+controlled source tree with local modifications.
+.UNINDENT
+.TP
+.B \fBpaths\fP
+A JSON object specifying paths to things that come with CMake.
+It has members for \fBcmake\fP, \fBctest\fP, and \fBcpack\fP
+whose values are JSON strings specifying the absolute path to each tool,
+represented with forward slashes.  It also has a \fBroot\fP member for
+the absolute path to the directory containing CMake resources like the
+\fBModules/\fP directory (see \X'tty: link #variable:CMAKE_ROOT'\fI\%CMAKE_ROOT\fP\X'tty: link').
+.TP
+.B \fBgenerator\fP
+A JSON object describing the CMake generator used for the build.
+It has members:
+.INDENT 7.0
+.TP
+.B \fBmultiConfig\fP
+A boolean specifying whether the generator supports multiple output
+configurations.
+.TP
+.B \fBname\fP
+A string specifying the name of the generator.
+.TP
+.B \fBplatform\fP
+If the generator supports \X'tty: link #variable:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link',
+this is a string specifying the generator platform name.
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBobjects\fP
+A JSON array listing all versions of all \fI\%Object Kinds\fP generated
+as part of the reply.  Each array entry is a
+\fI\%v1 Reply File Reference\fP\&.
+.TP
+.B \fBreply\fP
+A JSON object mirroring the content of the \fBquery/\fP directory
+that CMake loaded to produce the reply.  The members are of the form
+.INDENT 7.0
+.TP
+.B \fB<kind>\-v<major>\fP
+A member of this form appears for each of the
+\fI\%v1 Shared Stateless Query Files\fP that CMake recognized as a
+request for object kind \fB<kind>\fP with major version \fB<major>\fP\&.
+The value is a \fI\%v1 Reply File Reference\fP to the corresponding
+reply file for that object kind and version.
+.TP
+.B \fB<unknown>\fP
+A member of this form appears for each of the
+\fI\%v1 Shared Stateless Query Files\fP that CMake did not recognize.
+The value is a JSON object with a single \fBerror\fP member
+containing a string with an error message indicating that the
+query file is unknown.
+.TP
+.B \fBclient\-<client>\fP
+A member of this form appears for each client\-owned directory
+holding \fI\%v1 Client Stateless Query Files\fP\&.
+The value is a JSON object mirroring the content of the
+\fBquery/client\-<client>/\fP directory.  The members are of the form:
+.INDENT 7.0
+.TP
+.B \fB<kind>\-v<major>\fP
+A member of this form appears for each of the
+\fI\%v1 Client Stateless Query Files\fP that CMake recognized as a
+request for object kind \fB<kind>\fP with major version \fB<major>\fP\&.
+The value is a \fI\%v1 Reply File Reference\fP to the corresponding
+reply file for that object kind and version.
+.TP
+.B \fB<unknown>\fP
+A member of this form appears for each of the
+\fI\%v1 Client Stateless Query Files\fP that CMake did not recognize.
+The value is a JSON object with a single \fBerror\fP member
+containing a string with an error message indicating that the
+query file is unknown.
+.TP
+.B \fBquery.json\fP
+This member appears for clients using
+\fI\%v1 Client Stateful Query Files\fP\&.
+If the \fBquery.json\fP file failed to read or parse as a JSON object,
+this member is a JSON object with a single \fBerror\fP member
+containing a string with an error message.  Otherwise, this member
+is a JSON object mirroring the content of the \fBquery.json\fP file.
+The members are:
+.INDENT 7.0
+.TP
+.B \fBclient\fP
+A copy of the \fBquery.json\fP file \fBclient\fP member, if it exists.
+.TP
+.B \fBrequests\fP
+A copy of the \fBquery.json\fP file \fBrequests\fP member, if it exists.
+.TP
+.B \fBresponses\fP
+If the \fBquery.json\fP file \fBrequests\fP member is missing or invalid,
+this member is a JSON object with a single \fBerror\fP member
+containing a string with an error message.  Otherwise, this member
+contains a JSON array with a response for each entry of the
+\fBrequests\fP array, in the same order.  Each response is
+.INDENT 7.0
+.IP \(bu 2
+a JSON object with a single \fBerror\fP member containing a string
+with an error message, or
+.IP \(bu 2
+a \fI\%v1 Reply File Reference\fP to the corresponding reply file for
+the requested object kind and selected version.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.sp
+After reading the reply index file, clients may read the other
+\fI\%v1 Reply Files\fP it references.
+.SS v1 Reply File Reference
+.sp
+The reply index file represents each reference to another reply file
+using a JSON object with members:
+.INDENT 0.0
+.TP
+.B \fBkind\fP
+A string specifying one of the \fI\%Object Kinds\fP\&.
+.TP
+.B \fBversion\fP
+A JSON object with members \fBmajor\fP and \fBminor\fP specifying
+integer version components of the object kind.
+.TP
+.B \fBjsonFile\fP
+A JSON string specifying a path relative to the reply index file
+to another JSON file containing the object.
+.UNINDENT
+.SS v1 Reply Files
+.sp
+Reply files containing specific \fI\%Object Kinds\fP are written by CMake.
+The names of these files are unspecified and must not be interpreted
+by clients.  Clients must first read the \fI\%v1 Reply Index File\fP and
+follow references to the names of the desired response objects.
+.sp
+Reply files (including the index file) will never be replaced by
+files of the same name but different content.  This allows a client
+to read the files concurrently with a running CMake that may generate
+a new reply.  However, after generating a new reply CMake will attempt
+to remove reply files from previous runs that it did not just write.
+If a client attempts to read a reply file referenced by the index but
+finds the file missing, that means a concurrent CMake has generated
+a new reply.  The client may simply start again by reading the new
+reply index file.
+.SH OBJECT KINDS
+.sp
+The CMake file\-based API reports semantic information about the build
+system using the following kinds of JSON objects.  Each kind of object
+is versioned independently using semantic versioning with major and
+minor components.  Every kind of object has the form:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  \(dqkind\(dq: \(dq<kind>\(dq,
+  \(dqversion\(dq: { \(dqmajor\(dq: 1, \(dqminor\(dq: 0 },
+  \(dq...\(dq: {}
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \fBkind\fP member is a string specifying the object kind name.
+The \fBversion\fP member is a JSON object with \fBmajor\fP and \fBminor\fP
+members specifying integer components of the object kind\(aqs version.
+Additional top\-level members are specific to each object kind.
+.SS Object Kind \(dqcodemodel\(dq
+.sp
+The \fBcodemodel\fP object kind describes the build system structure as
+modeled by CMake.
+.sp
+There is only one \fBcodemodel\fP object major version, version 2.
+Version 1 does not exist to avoid confusion with that from
+\X'tty: link #manual:cmake-server(7)'\fI\%cmake\-server(7)\fP\X'tty: link' mode.
+.SS \(dqcodemodel\(dq version 2
+.sp
+\fBcodemodel\fP object version 2 is a JSON object:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  \(dqkind\(dq: \(dqcodemodel\(dq,
+  \(dqversion\(dq: { \(dqmajor\(dq: 2, \(dqminor\(dq: 7 },
+  \(dqpaths\(dq: {
+    \(dqsource\(dq: \(dq/path/to/top\-level\-source\-dir\(dq,
+    \(dqbuild\(dq: \(dq/path/to/top\-level\-build\-dir\(dq
+  },
+  \(dqconfigurations\(dq: [
+    {
+      \(dqname\(dq: \(dqDebug\(dq,
+      \(dqdirectories\(dq: [
+        {
+          \(dqsource\(dq: \(dq.\(dq,
+          \(dqbuild\(dq: \(dq.\(dq,
+          \(dqchildIndexes\(dq: [ 1 ],
+          \(dqprojectIndex\(dq: 0,
+          \(dqtargetIndexes\(dq: [ 0 ],
+          \(dqhasInstallRule\(dq: true,
+          \(dqminimumCMakeVersion\(dq: {
+            \(dqstring\(dq: \(dq3.14\(dq
+          },
+          \(dqjsonFile\(dq: \(dq<file>\(dq
+        },
+        {
+          \(dqsource\(dq: \(dqsub\(dq,
+          \(dqbuild\(dq: \(dqsub\(dq,
+          \(dqparentIndex\(dq: 0,
+          \(dqprojectIndex\(dq: 0,
+          \(dqtargetIndexes\(dq: [ 1 ],
+          \(dqminimumCMakeVersion\(dq: {
+            \(dqstring\(dq: \(dq3.14\(dq
+          },
+          \(dqjsonFile\(dq: \(dq<file>\(dq
+        }
+      ],
+      \(dqprojects\(dq: [
+        {
+          \(dqname\(dq: \(dqMyProject\(dq,
+          \(dqdirectoryIndexes\(dq: [ 0, 1 ],
+          \(dqtargetIndexes\(dq: [ 0, 1 ]
+        }
+      ],
+      \(dqtargets\(dq: [
+        {
+          \(dqname\(dq: \(dqMyExecutable\(dq,
+          \(dqdirectoryIndex\(dq: 0,
+          \(dqprojectIndex\(dq: 0,
+          \(dqjsonFile\(dq: \(dq<file>\(dq
+        },
+        {
+          \(dqname\(dq: \(dqMyLibrary\(dq,
+          \(dqdirectoryIndex\(dq: 1,
+          \(dqprojectIndex\(dq: 0,
+          \(dqjsonFile\(dq: \(dq<file>\(dq
+        }
+      ]
+    }
+  ]
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The members specific to \fBcodemodel\fP objects are:
+.INDENT 0.0
+.TP
+.B \fBpaths\fP
+A JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBsource\fP
+A string specifying the absolute path to the top\-level source directory,
+represented with forward slashes.
+.TP
+.B \fBbuild\fP
+A string specifying the absolute path to the top\-level build directory,
+represented with forward slashes.
+.UNINDENT
+.TP
+.B \fBconfigurations\fP
+A JSON array of entries corresponding to available build configurations.
+On single\-configuration generators there is one entry for the value
+of the \X'tty: link #variable:CMAKE_BUILD_TYPE'\fI\%CMAKE_BUILD_TYPE\fP\X'tty: link' variable.  For multi\-configuration
+generators there is an entry for each configuration listed in the
+\X'tty: link #variable:CMAKE_CONFIGURATION_TYPES'\fI\%CMAKE_CONFIGURATION_TYPES\fP\X'tty: link' variable.
+Each entry is a JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBname\fP
+A string specifying the name of the configuration, e.g. \fBDebug\fP\&.
+.TP
+.B \fBdirectories\fP
+A JSON array of entries each corresponding to a build system directory
+whose source directory contains a \fBCMakeLists.txt\fP file.  The first
+entry corresponds to the top\-level directory.  Each entry is a
+JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBsource\fP
+A string specifying the path to the source directory, represented
+with forward slashes.  If the directory is inside the top\-level
+source directory then the path is specified relative to that
+directory (with \fB\&.\fP for the top\-level source directory itself).
+Otherwise the path is absolute.
+.TP
+.B \fBbuild\fP
+A string specifying the path to the build directory, represented
+with forward slashes.  If the directory is inside the top\-level
+build directory then the path is specified relative to that
+directory (with \fB\&.\fP for the top\-level build directory itself).
+Otherwise the path is absolute.
+.TP
+.B \fBparentIndex\fP
+Optional member that is present when the directory is not top\-level.
+The value is an unsigned integer 0\-based index of another entry in
+the main \fBdirectories\fP array that corresponds to the parent
+directory that added this directory as a subdirectory.
+.TP
+.B \fBchildIndexes\fP
+Optional member that is present when the directory has subdirectories.
+The value is a JSON array of entries corresponding to child directories
+created by the \X'tty: link #command:add_subdirectory'\fI\%add_subdirectory()\fP\X'tty: link' or \X'tty: link #command:subdirs'\fI\%subdirs()\fP\X'tty: link'
+command.  Each entry is an unsigned integer 0\-based index of another
+entry in the main \fBdirectories\fP array.
+.TP
+.B \fBprojectIndex\fP
+An unsigned integer 0\-based index into the main \fBprojects\fP array
+indicating the build system project to which the this directory belongs.
+.TP
+.B \fBtargetIndexes\fP
+Optional member that is present when the directory itself has targets,
+excluding those belonging to subdirectories.  The value is a JSON
+array of entries corresponding to the targets.  Each entry is an
+unsigned integer 0\-based index into the main \fBtargets\fP array.
+.TP
+.B \fBminimumCMakeVersion\fP
+Optional member present when a minimum required version of CMake is
+known for the directory.  This is the \fB<min>\fP version given to the
+most local call to the \X'tty: link #command:cmake_minimum_required'\fI\%cmake_minimum_required(VERSION)\fP\X'tty: link'
+command in the directory itself or one of its ancestors.
+The value is a JSON object with one member:
+.INDENT 7.0
+.TP
+.B \fBstring\fP
+A string specifying the minimum required version in the format:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<major>.<minor>[.<patch>[.<tweak>]][<suffix>]
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Each component is an unsigned integer and the suffix may be an
+arbitrary string.
+.UNINDENT
+.TP
+.B \fBhasInstallRule\fP
+Optional member that is present with boolean value \fBtrue\fP when
+the directory or one of its subdirectories contains any
+\X'tty: link #command:install'\fI\%install()\fP\X'tty: link' rules, i.e. whether a \fBmake install\fP
+or equivalent rule is available.
+.TP
+.B \fBjsonFile\fP
+A JSON string specifying a path relative to the codemodel file
+to another JSON file containing a
+\fI\%\(dqcodemodel\(dq version 2 \(dqdirectory\(dq object\fP\&.
+.sp
+This field was added in codemodel version 2.3.
+.UNINDENT
+.TP
+.B \fBprojects\fP
+A JSON array of entries corresponding to the top\-level project
+and sub\-projects defined in the build system.  Each (sub\-)project
+corresponds to a source directory whose \fBCMakeLists.txt\fP file
+calls the \X'tty: link #command:project'\fI\%project()\fP\X'tty: link' command with a project name different
+from its parent directory.  The first entry corresponds to the
+top\-level project.
+.sp
+Each entry is a JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBname\fP
+A string specifying the name given to the \X'tty: link #command:project'\fI\%project()\fP\X'tty: link' command.
+.TP
+.B \fBparentIndex\fP
+Optional member that is present when the project is not top\-level.
+The value is an unsigned integer 0\-based index of another entry in
+the main \fBprojects\fP array that corresponds to the parent project
+that added this project as a sub\-project.
+.TP
+.B \fBchildIndexes\fP
+Optional member that is present when the project has sub\-projects.
+The value is a JSON array of entries corresponding to the sub\-projects.
+Each entry is an unsigned integer 0\-based index of another
+entry in the main \fBprojects\fP array.
+.TP
+.B \fBdirectoryIndexes\fP
+A JSON array of entries corresponding to build system directories
+that are part of the project.  The first entry corresponds to the
+top\-level directory of the project.  Each entry is an unsigned
+integer 0\-based index into the main \fBdirectories\fP array.
+.TP
+.B \fBtargetIndexes\fP
+Optional member that is present when the project itself has targets,
+excluding those belonging to sub\-projects.  The value is a JSON
+array of entries corresponding to the targets.  Each entry is an
+unsigned integer 0\-based index into the main \fBtargets\fP array.
+.UNINDENT
+.TP
+.B \fBtargets\fP
+A JSON array of entries corresponding to the build system targets.
+Such targets are created by calls to \X'tty: link #command:add_executable'\fI\%add_executable()\fP\X'tty: link',
+\X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link', and \X'tty: link #command:add_custom_target'\fI\%add_custom_target()\fP\X'tty: link', excluding
+imported targets and interface libraries (which do not generate any
+build rules).  Each entry is a JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBname\fP
+A string specifying the target name.
+.TP
+.B \fBid\fP
+A string uniquely identifying the target.  This matches the \fBid\fP
+field in the file referenced by \fBjsonFile\fP\&.
+.TP
+.B \fBdirectoryIndex\fP
+An unsigned integer 0\-based index into the main \fBdirectories\fP array
+indicating the build system directory in which the target is defined.
+.TP
+.B \fBprojectIndex\fP
+An unsigned integer 0\-based index into the main \fBprojects\fP array
+indicating the build system project in which the target is defined.
+.TP
+.B \fBjsonFile\fP
+A JSON string specifying a path relative to the codemodel file
+to another JSON file containing a
+\fI\%\(dqcodemodel\(dq version 2 \(dqtarget\(dq object\fP\&.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS \(dqcodemodel\(dq version 2 \(dqdirectory\(dq object
+.sp
+A codemodel \(dqdirectory\(dq object is referenced by a \fI\%\(dqcodemodel\(dq version 2\fP
+object\(aqs \fBdirectories\fP array.  Each \(dqdirectory\(dq object is a JSON object
+with members:
+.INDENT 0.0
+.TP
+.B \fBpaths\fP
+A JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBsource\fP
+A string specifying the path to the source directory, represented
+with forward slashes.  If the directory is inside the top\-level
+source directory then the path is specified relative to that
+directory (with \fB\&.\fP for the top\-level source directory itself).
+Otherwise the path is absolute.
+.TP
+.B \fBbuild\fP
+A string specifying the path to the build directory, represented
+with forward slashes.  If the directory is inside the top\-level
+build directory then the path is specified relative to that
+directory (with \fB\&.\fP for the top\-level build directory itself).
+Otherwise the path is absolute.
+.UNINDENT
+.TP
+.B \fBinstallers\fP
+A JSON array of entries corresponding to \X'tty: link #command:install'\fI\%install()\fP\X'tty: link' rules.
+Each entry is a JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBcomponent\fP
+A string specifying the component selected by the corresponding
+\X'tty: link #command:install'\fI\%install()\fP\X'tty: link' command invocation.
+.TP
+.B \fBdestination\fP
+Optional member that is present for specific \fBtype\fP values below.
+The value is a string specifying the install destination path.
+The path may be absolute or relative to the install prefix.
+.TP
+.B \fBpaths\fP
+Optional member that is present for specific \fBtype\fP values below.
+The value is a JSON array of entries corresponding to the paths
+(files or directories) to be installed.  Each entry is one of:
+.INDENT 7.0
+.IP \(bu 2
+A string specifying the path from which a file or directory
+is to be installed.  The portion of the path not preceded by
+a \fB/\fP also specifies the path (name) to which the file
+or directory is to be installed under the destination.
+.IP \(bu 2
+A JSON object with members:
+.INDENT 2.0
+.TP
+.B \fBfrom\fP
+A string specifying the path from which a file or directory
+is to be installed.
+.TP
+.B \fBto\fP
+A string specifying the path to which the file or directory
+is to be installed under the destination.
+.UNINDENT
+.UNINDENT
+.sp
+In both cases the paths are represented with forward slashes.  If
+the \(dqfrom\(dq path is inside the top\-level directory documented by the
+corresponding \fBtype\fP value, then the path is specified relative
+to that directory.  Otherwise the path is absolute.
+.TP
+.B \fBtype\fP
+A string specifying the type of installation rule.  The value is one
+of the following, with some variants providing additional members:
+.INDENT 7.0
+.TP
+.B \fBfile\fP
+An \X'tty: link #files'\fI\%install(FILES)\fP\X'tty: link' or \X'tty: link #programs'\fI\%install(PROGRAMS)\fP\X'tty: link' call.
+The \fBdestination\fP and \fBpaths\fP members are populated, with paths
+under the top\-level \fIsource\fP directory expressed relative to it.
+The \fBisOptional\fP member may exist.
+This type has no additional members.
+.TP
+.B \fBdirectory\fP
+An \X'tty: link #directory'\fI\%install(DIRECTORY)\fP\X'tty: link' call.
+The \fBdestination\fP and \fBpaths\fP members are populated, with paths
+under the top\-level \fIsource\fP directory expressed relative to it.
+The \fBisOptional\fP member may exist.
+This type has no additional members.
+.TP
+.B \fBtarget\fP
+An \X'tty: link #targets'\fI\%install(TARGETS)\fP\X'tty: link' call.
+The \fBdestination\fP and \fBpaths\fP members are populated, with paths
+under the top\-level \fIbuild\fP directory expressed relative to it.
+The \fBisOptional\fP member may exist.
+This type has additional members \fBtargetId\fP, \fBtargetIndex\fP,
+\fBtargetIsImportLibrary\fP, and \fBtargetInstallNamelink\fP\&.
+.TP
+.B \fBexport\fP
+An \X'tty: link #export'\fI\%install(EXPORT)\fP\X'tty: link' call.
+The \fBdestination\fP and \fBpaths\fP members are populated, with paths
+under the top\-level \fIbuild\fP directory expressed relative to it.
+The \fBpaths\fP entries refer to files generated automatically by
+CMake for installation, and their actual values are considered
+private implementation details.
+This type has additional members \fBexportName\fP and \fBexportTargets\fP\&.
+.TP
+.B \fBscript\fP
+An \X'tty: link #script'\fI\%install(SCRIPT)\fP\X'tty: link' call.
+This type has additional member \fBscriptFile\fP\&.
+.TP
+.B \fBcode\fP
+An \X'tty: link #code'\fI\%install(CODE)\fP\X'tty: link' call.
+This type has no additional members.
+.TP
+.B \fBimportedRuntimeArtifacts\fP
+An \X'tty: link #imported-runtime-artifacts'\fI\%install(IMPORTED_RUNTIME_ARTIFACTS)\fP\X'tty: link' call.
+The \fBdestination\fP member is populated. The \fBisOptional\fP member may
+exist. This type has no additional members.
+.TP
+.B \fBruntimeDependencySet\fP
+An \X'tty: link #runtime-dependency-set'\fI\%install(RUNTIME_DEPENDENCY_SET)\fP\X'tty: link' call or an
+\X'tty: link #targets'\fI\%install(TARGETS)\fP\X'tty: link' call with \fBRUNTIME_DEPENDENCIES\fP\&. The
+\fBdestination\fP member is populated. This type has additional members
+\fBruntimeDependencySetName\fP and \fBruntimeDependencySetType\fP\&.
+.TP
+.B \fBfileSet\fP
+An \X'tty: link #targets'\fI\%install(TARGETS)\fP\X'tty: link' call with \fBFILE_SET\fP\&.
+The \fBdestination\fP and \fBpaths\fP members are populated.
+The \fBisOptional\fP member may exist.
+This type has additional members \fBfileSetName\fP, \fBfileSetType\fP,
+\fBfileSetDirectories\fP, and \fBfileSetTarget\fP\&.
+.sp
+This type was added in codemodel version 2.4.
+.UNINDENT
+.TP
+.B \fBisExcludeFromAll\fP
+Optional member that is present with boolean value \fBtrue\fP when
+\X'tty: link #command:install'\fI\%install()\fP\X'tty: link' is called with the \fBEXCLUDE_FROM_ALL\fP option.
+.TP
+.B \fBisForAllComponents\fP
+Optional member that is present with boolean value \fBtrue\fP when
+\X'tty: link #command:install'\fI\%install(SCRIPT|CODE)\fP\X'tty: link' is called with the
+\fBALL_COMPONENTS\fP option.
+.TP
+.B \fBisOptional\fP
+Optional member that is present with boolean value \fBtrue\fP when
+\X'tty: link #command:install'\fI\%install()\fP\X'tty: link' is called with the \fBOPTIONAL\fP option.
+This is allowed when \fBtype\fP is \fBfile\fP, \fBdirectory\fP, or \fBtarget\fP\&.
+.TP
+.B \fBtargetId\fP
+Optional member that is present when \fBtype\fP is \fBtarget\fP\&.
+The value is a string uniquely identifying the target to be installed.
+This matches the \fBid\fP member of the target in the main
+\(dqcodemodel\(dq object\(aqs \fBtargets\fP array.
+.TP
+.B \fBtargetIndex\fP
+Optional member that is present when \fBtype\fP is \fBtarget\fP\&.
+The value is an unsigned integer 0\-based index into the main \(dqcodemodel\(dq
+object\(aqs \fBtargets\fP array for the target to be installed.
+.TP
+.B \fBtargetIsImportLibrary\fP
+Optional member that is present when \fBtype\fP is \fBtarget\fP and
+the installer is for a Windows DLL import library file or for an
+AIX linker import file.  If present, it has boolean value \fBtrue\fP\&.
+.TP
+.B \fBtargetInstallNamelink\fP
+Optional member that is present when \fBtype\fP is \fBtarget\fP and
+the installer corresponds to a target that may use symbolic links
+to implement the \X'tty: link #prop_tgt:VERSION'\fI\%VERSION\fP\X'tty: link' and \X'tty: link #prop_tgt:SOVERSION'\fI\%SOVERSION\fP\X'tty: link'
+target properties.
+The value is a string indicating how the installer is supposed to
+handle the symlinks: \fBskip\fP means the installer should skip the
+symlinks and install only the real file, and \fBonly\fP means the
+installer should install only the symlinks and not the real file.
+In all cases the \fBpaths\fP member lists what it actually installs.
+.TP
+.B \fBexportName\fP
+Optional member that is present when \fBtype\fP is \fBexport\fP\&.
+The value is a string specifying the name of the export.
+.TP
+.B \fBexportTargets\fP
+Optional member that is present when \fBtype\fP is \fBexport\fP\&.
+The value is a JSON array of entries corresponding to the targets
+included in the export.  Each entry is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBid\fP
+A string uniquely identifying the target.  This matches
+the \fBid\fP member of the target in the main \(dqcodemodel\(dq
+object\(aqs \fBtargets\fP array.
+.TP
+.B \fBindex\fP
+An unsigned integer 0\-based index into the main \(dqcodemodel\(dq
+object\(aqs \fBtargets\fP array for the target.
+.UNINDENT
+.TP
+.B \fBruntimeDependencySetName\fP
+Optional member that is present when \fBtype\fP is \fBruntimeDependencySet\fP
+and the installer was created by an
+\X'tty: link #runtime-dependency-set'\fI\%install(RUNTIME_DEPENDENCY_SET)\fP\X'tty: link' call. The value is a string
+specifying the name of the runtime dependency set that was installed.
+.TP
+.B \fBruntimeDependencySetType\fP
+Optional member that is present when \fBtype\fP is \fBruntimeDependencySet\fP\&.
+The value is a string with one of the following values:
+.INDENT 7.0
+.TP
+.B \fBlibrary\fP
+Indicates that this installer installs dependencies that are not macOS
+frameworks.
+.TP
+.B \fBframework\fP
+Indicates that this installer installs dependencies that are macOS
+frameworks.
+.UNINDENT
+.TP
+.B \fBfileSetName\fP
+Optional member that is present when \fBtype\fP is \fBfileSet\fP\&. The value is
+a string with the name of the file set.
+.sp
+This field was added in codemodel version 2.4.
+.TP
+.B \fBfileSetType\fP
+Optional member that is present when \fBtype\fP is \fBfileSet\fP\&. The value is
+a string with the type of the file set.
+.sp
+This field was added in codemodel version 2.4.
+.TP
+.B \fBfileSetDirectories\fP
+Optional member that is present when \fBtype\fP is \fBfileSet\fP\&. The value
+is a list of strings with the file set\(aqs base directories (determined by
+genex\-evaluation of \X'tty: link #prop_tgt:HEADER_DIRS'\fI\%HEADER_DIRS\fP\X'tty: link' or
+\X'tty: link #prop_tgt:HEADER_DIRS_<NAME>'\fI\%HEADER_DIRS_<NAME>\fP\X'tty: link').
+.sp
+This field was added in codemodel version 2.4.
+.TP
+.B \fBfileSetTarget\fP
+Optional member that is present when \fBtype\fP is \fBfileSet\fP\&. The value
+is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBid\fP
+A string uniquely identifying the target.  This matches
+the \fBid\fP member of the target in the main \(dqcodemodel\(dq
+object\(aqs \fBtargets\fP array.
+.TP
+.B \fBindex\fP
+An unsigned integer 0\-based index into the main \(dqcodemodel\(dq
+object\(aqs \fBtargets\fP array for the target.
+.UNINDENT
+.sp
+This field was added in codemodel version 2.4.
+.TP
+.B \fBscriptFile\fP
+Optional member that is present when \fBtype\fP is \fBscript\fP\&.
+The value is a string specifying the path to the script file on disk,
+represented with forward slashes.  If the file is inside the top\-level
+source directory then the path is specified relative to that directory.
+Otherwise the path is absolute.
+.TP
+.B \fBbacktrace\fP
+Optional member that is present when a CMake language backtrace to
+the \X'tty: link #command:install'\fI\%install()\fP\X'tty: link' or other command invocation that added this
+installer is available.  The value is an unsigned integer 0\-based
+index into the \fBbacktraceGraph\fP member\(aqs \fBnodes\fP array.
+.UNINDENT
+.TP
+.B \fBbacktraceGraph\fP
+A \fI\%\(dqcodemodel\(dq version 2 \(dqbacktrace graph\(dq\fP whose nodes are referenced
+from \fBbacktrace\fP members elsewhere in this \(dqdirectory\(dq object.
+.UNINDENT
+.SS \(dqcodemodel\(dq version 2 \(dqtarget\(dq object
+.sp
+A codemodel \(dqtarget\(dq object is referenced by a \fI\%\(dqcodemodel\(dq version 2\fP
+object\(aqs \fBtargets\fP array.  Each \(dqtarget\(dq object is a JSON object
+with members:
+.INDENT 0.0
+.TP
+.B \fBname\fP
+A string specifying the logical name of the target.
+.TP
+.B \fBid\fP
+A string uniquely identifying the target.  The format is unspecified
+and should not be interpreted by clients.
+.TP
+.B \fBtype\fP
+A string specifying the type of the target.  The value is one of
+\fBEXECUTABLE\fP, \fBSTATIC_LIBRARY\fP, \fBSHARED_LIBRARY\fP,
+\fBMODULE_LIBRARY\fP, \fBOBJECT_LIBRARY\fP, \fBINTERFACE_LIBRARY\fP,
+or \fBUTILITY\fP\&.
+.TP
+.B \fBbacktrace\fP
+Optional member that is present when a CMake language backtrace to
+the command in the source code that created the target is available.
+The value is an unsigned integer 0\-based index into the
+\fBbacktraceGraph\fP member\(aqs \fBnodes\fP array.
+.TP
+.B \fBfolder\fP
+Optional member that is present when the \X'tty: link #prop_tgt:FOLDER'\fI\%FOLDER\fP\X'tty: link' target
+property is set.  The value is a JSON object with one member:
+.INDENT 7.0
+.TP
+.B \fBname\fP
+A string specifying the name of the target folder.
+.UNINDENT
+.TP
+.B \fBpaths\fP
+A JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBsource\fP
+A string specifying the path to the target\(aqs source directory,
+represented with forward slashes.  If the directory is inside the
+top\-level source directory then the path is specified relative to
+that directory (with \fB\&.\fP for the top\-level source directory itself).
+Otherwise the path is absolute.
+.TP
+.B \fBbuild\fP
+A string specifying the path to the target\(aqs build directory,
+represented with forward slashes.  If the directory is inside the
+top\-level build directory then the path is specified relative to
+that directory (with \fB\&.\fP for the top\-level build directory itself).
+Otherwise the path is absolute.
+.UNINDENT
+.TP
+.B \fBnameOnDisk\fP
+Optional member that is present for executable and library targets
+that are linked or archived into a single primary artifact.
+The value is a string specifying the file name of that artifact on disk.
+.TP
+.B \fBartifacts\fP
+Optional member that is present for executable and library targets
+that produce artifacts on disk meant for consumption by dependents.
+The value is a JSON array of entries corresponding to the artifacts.
+Each entry is a JSON object containing one member:
+.INDENT 7.0
+.TP
+.B \fBpath\fP
+A string specifying the path to the file on disk, represented with
+forward slashes.  If the file is inside the top\-level build directory
+then the path is specified relative to that directory.
+Otherwise the path is absolute.
+.UNINDENT
+.TP
+.B \fBisGeneratorProvided\fP
+Optional member that is present with boolean value \fBtrue\fP if the
+target is provided by CMake\(aqs build system generator rather than by
+a command in the source code.
+.TP
+.B \fBinstall\fP
+Optional member that is present when the target has an \X'tty: link #command:install'\fI\%install()\fP\X'tty: link'
+rule.  The value is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBprefix\fP
+A JSON object specifying the installation prefix.  It has one member:
+.INDENT 7.0
+.TP
+.B \fBpath\fP
+A string specifying the value of \X'tty: link #variable:CMAKE_INSTALL_PREFIX'\fI\%CMAKE_INSTALL_PREFIX\fP\X'tty: link'\&.
+.UNINDENT
+.TP
+.B \fBdestinations\fP
+A JSON array of entries specifying an install destination path.
+Each entry is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBpath\fP
+A string specifying the install destination path.  The path may
+be absolute or relative to the install prefix.
+.TP
+.B \fBbacktrace\fP
+Optional member that is present when a CMake language backtrace to
+the \X'tty: link #command:install'\fI\%install()\fP\X'tty: link' command invocation that specified this
+destination is available.  The value is an unsigned integer 0\-based
+index into the \fBbacktraceGraph\fP member\(aqs \fBnodes\fP array.
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBlaunchers\fP
+Optional member that is present on executable targets that have
+at least one launcher specified by the project.  The value is a
+JSON array of entries corresponding to the specified launchers.
+Each entry is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBcommand\fP
+A string specifying the path to the launcher on disk, represented
+with forward slashes. If the file is inside the top\-level source
+directory then the path is specified relative to that directory.
+.TP
+.B \fBarguments\fP
+Optional member that is present when the launcher command has
+arguments preceding the executable to be launched.  The value
+is a JSON array of strings representing the arguments.
+.TP
+.B \fBtype\fP
+A string specifying the type of launcher.  The value is one of
+the following:
+.INDENT 7.0
+.TP
+.B \fBemulator\fP
+An emulator for the target platform when cross\-compiling.
+See the \X'tty: link #prop_tgt:CROSSCOMPILING_EMULATOR'\fI\%CROSSCOMPILING_EMULATOR\fP\X'tty: link' target property.
+.TP
+.B \fBtest\fP
+A start program for the execution of tests.
+See the \X'tty: link #prop_tgt:TEST_LAUNCHER'\fI\%TEST_LAUNCHER\fP\X'tty: link' target property.
+.UNINDENT
+.UNINDENT
+.sp
+This field was added in codemodel version 2.7.
+.TP
+.B \fBlink\fP
+Optional member that is present for executables and shared library
+targets that link into a runtime binary.  The value is a JSON object
+with members describing the link step:
+.INDENT 7.0
+.TP
+.B \fBlanguage\fP
+A string specifying the language (e.g. \fBC\fP, \fBCXX\fP, \fBFortran\fP)
+of the toolchain is used to invoke the linker.
+.TP
+.B \fBcommandFragments\fP
+Optional member that is present when fragments of the link command
+line invocation are available.  The value is a JSON array of entries
+specifying ordered fragments.  Each entry is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBfragment\fP
+A string specifying a fragment of the link command line invocation.
+The value is encoded in the build system\(aqs native shell format.
+.TP
+.B \fBrole\fP
+A string specifying the role of the fragment\(aqs content:
+.INDENT 7.0
+.IP \(bu 2
+\fBflags\fP: link flags.
+.IP \(bu 2
+\fBlibraries\fP: link library file paths or flags.
+.IP \(bu 2
+\fBlibraryPath\fP: library search path flags.
+.IP \(bu 2
+\fBframeworkPath\fP: macOS framework search path flags.
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBlto\fP
+Optional member that is present with boolean value \fBtrue\fP
+when link\-time optimization (a.k.a. interprocedural optimization
+or link\-time code generation) is enabled.
+.TP
+.B \fBsysroot\fP
+Optional member that is present when the \X'tty: link #variable:CMAKE_SYSROOT_LINK'\fI\%CMAKE_SYSROOT_LINK\fP\X'tty: link'
+or \X'tty: link #variable:CMAKE_SYSROOT'\fI\%CMAKE_SYSROOT\fP\X'tty: link' variable is defined.  The value is a
+JSON object with one member:
+.INDENT 7.0
+.TP
+.B \fBpath\fP
+A string specifying the absolute path to the sysroot, represented
+with forward slashes.
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBarchive\fP
+Optional member that is present for static library targets.  The value
+is a JSON object with members describing the archive step:
+.INDENT 7.0
+.TP
+.B \fBcommandFragments\fP
+Optional member that is present when fragments of the archiver command
+line invocation are available.  The value is a JSON array of entries
+specifying the fragments.  Each entry is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBfragment\fP
+A string specifying a fragment of the archiver command line invocation.
+The value is encoded in the build system\(aqs native shell format.
+.TP
+.B \fBrole\fP
+A string specifying the role of the fragment\(aqs content:
+.INDENT 7.0
+.IP \(bu 2
+\fBflags\fP: archiver flags.
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBlto\fP
+Optional member that is present with boolean value \fBtrue\fP
+when link\-time optimization (a.k.a. interprocedural optimization
+or link\-time code generation) is enabled.
+.UNINDENT
+.TP
+.B \fBdependencies\fP
+Optional member that is present when the target depends on other targets.
+The value is a JSON array of entries corresponding to the dependencies.
+Each entry is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBid\fP
+A string uniquely identifying the target on which this target depends.
+This matches the main \fBid\fP member of the other target.
+.TP
+.B \fBbacktrace\fP
+Optional member that is present when a CMake language backtrace to
+the \X'tty: link #command:add_dependencies'\fI\%add_dependencies()\fP\X'tty: link', \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link',
+or other command invocation that created this dependency is
+available.  The value is an unsigned integer 0\-based index into
+the \fBbacktraceGraph\fP member\(aqs \fBnodes\fP array.
+.UNINDENT
+.TP
+.B \fBfileSets\fP
+A JSON array of entries corresponding to the target\(aqs file sets. Each entry
+is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBname\fP
+A string specifying the name of the file set.
+.TP
+.B \fBtype\fP
+A string specifying the type of the file set.  See
+\X'tty: link #command:target_sources'\fI\%target_sources()\fP\X'tty: link' supported file set types.
+.TP
+.B \fBvisibility\fP
+A string specifying the visibility of the file set; one of \fBPUBLIC\fP,
+\fBPRIVATE\fP, or \fBINTERFACE\fP\&.
+.TP
+.B \fBbaseDirectories\fP
+A JSON array of strings, each specifying a base directory containing
+sources in the file set.  If the directory is inside the top\-level source
+directory then the path is specified relative to that directory.
+Otherwise the path is absolute.
+.UNINDENT
+.sp
+This field was added in codemodel version 2.5.
+.TP
+.B \fBsources\fP
+A JSON array of entries corresponding to the target\(aqs source files.
+Each entry is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBpath\fP
+A string specifying the path to the source file on disk, represented
+with forward slashes.  If the file is inside the top\-level source
+directory then the path is specified relative to that directory.
+Otherwise the path is absolute.
+.TP
+.B \fBcompileGroupIndex\fP
+Optional member that is present when the source is compiled.
+The value is an unsigned integer 0\-based index into the
+\fBcompileGroups\fP array.
+.TP
+.B \fBsourceGroupIndex\fP
+Optional member that is present when the source is part of a source
+group either via the \X'tty: link #command:source_group'\fI\%source_group()\fP\X'tty: link' command or by default.
+The value is an unsigned integer 0\-based index into the
+\fBsourceGroups\fP array.
+.TP
+.B \fBisGenerated\fP
+Optional member that is present with boolean value \fBtrue\fP if
+the source is \X'tty: link #prop_sf:GENERATED'\fI\%GENERATED\fP\X'tty: link'\&.
+.TP
+.B \fBfileSetIndex\fP
+Optional member that is present when the source is part of a file set.
+The value is an unsigned integer 0\-based index into the \fBfileSets\fP
+array.
+.sp
+This field was added in codemodel version 2.5.
+.TP
+.B \fBbacktrace\fP
+Optional member that is present when a CMake language backtrace to
+the \X'tty: link #command:target_sources'\fI\%target_sources()\fP\X'tty: link', \X'tty: link #command:add_executable'\fI\%add_executable()\fP\X'tty: link',
+\X'tty: link #command:add_library'\fI\%add_library()\fP\X'tty: link', \X'tty: link #command:add_custom_target'\fI\%add_custom_target()\fP\X'tty: link', or other
+command invocation that added this source to the target is
+available.  The value is an unsigned integer 0\-based index into
+the \fBbacktraceGraph\fP member\(aqs \fBnodes\fP array.
+.UNINDENT
+.TP
+.B \fBsourceGroups\fP
+Optional member that is present when sources are grouped together by
+the \X'tty: link #command:source_group'\fI\%source_group()\fP\X'tty: link' command or by default.  The value is a
+JSON array of entries corresponding to the groups.  Each entry is
+a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBname\fP
+A string specifying the name of the source group.
+.TP
+.B \fBsourceIndexes\fP
+A JSON array listing the sources belonging to the group.
+Each entry is an unsigned integer 0\-based index into the
+main \fBsources\fP array for the target.
+.UNINDENT
+.TP
+.B \fBcompileGroups\fP
+Optional member that is present when the target has sources that compile.
+The value is a JSON array of entries corresponding to groups of sources
+that all compile with the same settings.  Each entry is a JSON object
+with members:
+.INDENT 7.0
+.TP
+.B \fBsourceIndexes\fP
+A JSON array listing the sources belonging to the group.
+Each entry is an unsigned integer 0\-based index into the
+main \fBsources\fP array for the target.
+.TP
+.B \fBlanguage\fP
+A string specifying the language (e.g. \fBC\fP, \fBCXX\fP, \fBFortran\fP)
+of the toolchain is used to compile the source file.
+.TP
+.B \fBlanguageStandard\fP
+Optional member that is present when the language standard is set
+explicitly (e.g. via \X'tty: link #prop_tgt:CXX_STANDARD'\fI\%CXX_STANDARD\fP\X'tty: link') or implicitly by
+compile features.  Each entry is a JSON object with two members:
+.INDENT 7.0
+.TP
+.B \fBbacktraces\fP
+Optional member that is present when a CMake language backtrace to
+the \fB<LANG>_STANDARD\fP setting is available.  If the language
+standard was set implicitly by compile features those are used as
+the backtrace(s).  It\(aqs possible for multiple compile features to
+require the same language standard so there could be multiple
+backtraces. The value is a JSON array with each entry being an
+unsigned integer 0\-based index into the \fBbacktraceGraph\fP
+member\(aqs \fBnodes\fP array.
+.TP
+.B \fBstandard\fP
+String representing the language standard.
+.UNINDENT
+.sp
+This field was added in codemodel version 2.2.
+.TP
+.B \fBcompileCommandFragments\fP
+Optional member that is present when fragments of the compiler command
+line invocation are available.  The value is a JSON array of entries
+specifying ordered fragments.  Each entry is a JSON object with
+one member:
+.INDENT 7.0
+.TP
+.B \fBfragment\fP
+A string specifying a fragment of the compile command line invocation.
+The value is encoded in the build system\(aqs native shell format.
+.UNINDENT
+.TP
+.B \fBincludes\fP
+Optional member that is present when there are include directories.
+The value is a JSON array with an entry for each directory.  Each
+entry is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBpath\fP
+A string specifying the path to the include directory,
+represented with forward slashes.
+.TP
+.B \fBisSystem\fP
+Optional member that is present with boolean value \fBtrue\fP if
+the include directory is marked as a system include directory.
+.TP
+.B \fBbacktrace\fP
+Optional member that is present when a CMake language backtrace to
+the \X'tty: link #command:target_include_directories'\fI\%target_include_directories()\fP\X'tty: link' or other command invocation
+that added this include directory is available.  The value is
+an unsigned integer 0\-based index into the \fBbacktraceGraph\fP
+member\(aqs \fBnodes\fP array.
+.UNINDENT
+.TP
+.B \fBframeworks\fP
+Optional member that is present when, on Apple platforms, there are
+frameworks. The value is a JSON array with an entry for each directory.
+Each entry is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBpath\fP
+A string specifying the path to the framework directory,
+represented with forward slashes.
+.TP
+.B \fBisSystem\fP
+Optional member that is present with boolean value \fBtrue\fP if
+the framework is marked as a system one.
+.TP
+.B \fBbacktrace\fP
+Optional member that is present when a CMake language backtrace to
+the \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' or other command invocation
+that added this framework is available.  The value is
+an unsigned integer 0\-based index into the \fBbacktraceGraph\fP
+member\(aqs \fBnodes\fP array.
+.UNINDENT
+.sp
+This field was added in codemodel version 2.6.
+.TP
+.B \fBprecompileHeaders\fP
+Optional member that is present when \X'tty: link #command:target_precompile_headers'\fI\%target_precompile_headers()\fP\X'tty: link'
+or other command invocations set \X'tty: link #prop_tgt:PRECOMPILE_HEADERS'\fI\%PRECOMPILE_HEADERS\fP\X'tty: link' on the
+target.  The value is a JSON array with an entry for each header.  Each
+entry is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBheader\fP
+Full path to the precompile header file.
+.TP
+.B \fBbacktrace\fP
+Optional member that is present when a CMake language backtrace to
+the \X'tty: link #command:target_precompile_headers'\fI\%target_precompile_headers()\fP\X'tty: link' or other command invocation
+that added this precompiled header is available.  The value is an
+unsigned integer 0\-based index into the \fBbacktraceGraph\fP member\(aqs
+\fBnodes\fP array.
+.UNINDENT
+.sp
+This field was added in codemodel version 2.1.
+.TP
+.B \fBdefines\fP
+Optional member that is present when there are preprocessor definitions.
+The value is a JSON array with an entry for each definition.  Each
+entry is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBdefine\fP
+A string specifying the preprocessor definition in the format
+\fB<name>[=<value>]\fP, e.g. \fBDEF\fP or \fBDEF=1\fP\&.
+.TP
+.B \fBbacktrace\fP
+Optional member that is present when a CMake language backtrace to
+the \X'tty: link #command:target_compile_definitions'\fI\%target_compile_definitions()\fP\X'tty: link' or other command invocation
+that added this preprocessor definition is available.  The value is
+an unsigned integer 0\-based index into the \fBbacktraceGraph\fP
+member\(aqs \fBnodes\fP array.
+.UNINDENT
+.TP
+.B \fBsysroot\fP
+Optional member that is present when the
+\X'tty: link #variable:CMAKE_SYSROOT_COMPILE'\fI\%CMAKE_SYSROOT_COMPILE\fP\X'tty: link' or \X'tty: link #variable:CMAKE_SYSROOT'\fI\%CMAKE_SYSROOT\fP\X'tty: link'
+variable is defined.  The value is a JSON object with one member:
+.INDENT 7.0
+.TP
+.B \fBpath\fP
+A string specifying the absolute path to the sysroot, represented
+with forward slashes.
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBbacktraceGraph\fP
+A \fI\%\(dqcodemodel\(dq version 2 \(dqbacktrace graph\(dq\fP whose nodes are referenced
+from \fBbacktrace\fP members elsewhere in this \(dqtarget\(dq object.
+.UNINDENT
+.SS \(dqcodemodel\(dq version 2 \(dqbacktrace graph\(dq
+.sp
+The \fBbacktraceGraph\fP member of a \fI\%\(dqcodemodel\(dq version 2 \(dqdirectory\(dq object\fP,
+or \fI\%\(dqcodemodel\(dq version 2 \(dqtarget\(dq object\fP is a JSON object describing a
+graph of backtraces.  Its nodes are referenced from \fBbacktrace\fP members
+elsewhere in the containing object.  The backtrace graph object members are:
+.INDENT 0.0
+.TP
+.B \fBnodes\fP
+A JSON array listing nodes in the backtrace graph.  Each entry
+is a JSON object with members:
+.INDENT 7.0
+.TP
+.B \fBfile\fP
+An unsigned integer 0\-based index into the backtrace \fBfiles\fP array.
+.TP
+.B \fBline\fP
+An optional member present when the node represents a line within
+the file.  The value is an unsigned integer 1\-based line number.
+.TP
+.B \fBcommand\fP
+An optional member present when the node represents a command
+invocation within the file.  The value is an unsigned integer
+0\-based index into the backtrace \fBcommands\fP array.
+.TP
+.B \fBparent\fP
+An optional member present when the node is not the bottom of
+the call stack.  The value is an unsigned integer 0\-based index
+of another entry in the backtrace \fBnodes\fP array.
+.UNINDENT
+.TP
+.B \fBcommands\fP
+A JSON array listing command names referenced by backtrace nodes.
+Each entry is a string specifying a command name.
+.TP
+.B \fBfiles\fP
+A JSON array listing CMake language files referenced by backtrace nodes.
+Each entry is a string specifying the path to a file, represented
+with forward slashes.  If the file is inside the top\-level source
+directory then the path is specified relative to that directory.
+Otherwise the path is absolute.
+.UNINDENT
+.SS Object Kind \(dqconfigureLog\(dq
+.sp
+The \fBconfigureLog\fP object kind describes the location and contents of
+a \X'tty: link #manual:cmake-configure-log(7)'\fI\%cmake\-configure\-log(7)\fP\X'tty: link' file.
+.sp
+There is only one \fBconfigureLog\fP object major version, version 1.
+.SS \(dqconfigureLog\(dq version 1
+.sp
+\fBconfigureLog\fP object version 1 is a JSON object:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  \(dqkind\(dq: \(dqconfigureLog\(dq,
+  \(dqversion\(dq: { \(dqmajor\(dq: 1, \(dqminor\(dq: 0 },
+  \(dqpath\(dq: \(dq/path/to/top\-level\-build\-dir/CMakeFiles/CMakeConfigureLog.yaml\(dq,
+  \(dqeventKindNames\(dq: [ \(dqtry_compile\-v1\(dq, \(dqtry_run\-v1\(dq ]
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The members specific to \fBconfigureLog\fP objects are:
+.INDENT 0.0
+.TP
+.B \fBpath\fP
+A string specifying the path to the configure log file.
+Clients must read the log file from this path, which may be
+different than the path documented by \X'tty: link #manual:cmake-configure-log(7)'\fI\%cmake\-configure\-log(7)\fP\X'tty: link'\&.
+The log file may not exist if no events are logged.
+.TP
+.B \fBeventKindNames\fP
+A JSON array whose entries are each a JSON string naming one
+of the \X'tty: link #manual:cmake-configure-log(7)'\fI\%cmake\-configure\-log(7)\fP\X'tty: link' versioned event kinds.
+At most one version of each configure log event kind will be listed.
+Although the configure log may contain other (versioned) event kinds,
+clients must ignore those that are not listed in this field.
+.UNINDENT
+.SS Object Kind \(dqcache\(dq
+.sp
+The \fBcache\fP object kind lists cache entries.  These are the
+\X'tty: link #cmake-language-variables'\fI\%Variables\fP\X'tty: link' stored in the persistent cache
+(\fBCMakeCache.txt\fP) for the build tree.
+.sp
+There is only one \fBcache\fP object major version, version 2.
+Version 1 does not exist to avoid confusion with that from
+\X'tty: link #manual:cmake-server(7)'\fI\%cmake\-server(7)\fP\X'tty: link' mode.
+.SS \(dqcache\(dq version 2
+.sp
+\fBcache\fP object version 2 is a JSON object:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  \(dqkind\(dq: \(dqcache\(dq,
+  \(dqversion\(dq: { \(dqmajor\(dq: 2, \(dqminor\(dq: 0 },
+  \(dqentries\(dq: [
+    {
+      \(dqname\(dq: \(dqBUILD_SHARED_LIBS\(dq,
+      \(dqvalue\(dq: \(dqON\(dq,
+      \(dqtype\(dq: \(dqBOOL\(dq,
+      \(dqproperties\(dq: [
+        {
+          \(dqname\(dq: \(dqHELPSTRING\(dq,
+          \(dqvalue\(dq: \(dqBuild shared libraries\(dq
+        }
+      ]
+    },
+    {
+      \(dqname\(dq: \(dqCMAKE_GENERATOR\(dq,
+      \(dqvalue\(dq: \(dqUnix Makefiles\(dq,
+      \(dqtype\(dq: \(dqINTERNAL\(dq,
+      \(dqproperties\(dq: [
+        {
+          \(dqname\(dq: \(dqHELPSTRING\(dq,
+          \(dqvalue\(dq: \(dqName of generator.\(dq
+        }
+      ]
+    }
+  ]
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The members specific to \fBcache\fP objects are:
+.INDENT 0.0
+.TP
+.B \fBentries\fP
+A JSON array whose entries are each a JSON object specifying a
+cache entry.  The members of each entry are:
+.INDENT 7.0
+.TP
+.B \fBname\fP
+A string specifying the name of the entry.
+.TP
+.B \fBvalue\fP
+A string specifying the value of the entry.
+.TP
+.B \fBtype\fP
+A string specifying the type of the entry used by
+\X'tty: link #manual:cmake-gui(1)'\fI\%cmake\-gui(1)\fP\X'tty: link' to choose a widget for editing.
+.TP
+.B \fBproperties\fP
+A JSON array of entries specifying associated
+\X'tty: link #cache-entry-properties'\fI\%cache entry properties\fP\X'tty: link'\&.
+Each entry is a JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBname\fP
+A string specifying the name of the cache entry property.
+.TP
+.B \fBvalue\fP
+A string specifying the value of the cache entry property.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS Object Kind \(dqcmakeFiles\(dq
+.sp
+The \fBcmakeFiles\fP object kind lists files used by CMake while
+configuring and generating the build system.  These include the
+\fBCMakeLists.txt\fP files as well as included \fB\&.cmake\fP files.
+.sp
+There is only one \fBcmakeFiles\fP object major version, version 1.
+.SS \(dqcmakeFiles\(dq version 1
+.sp
+\fBcmakeFiles\fP object version 1 is a JSON object:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  \(dqkind\(dq: \(dqcmakeFiles\(dq,
+  \(dqversion\(dq: { \(dqmajor\(dq: 1, \(dqminor\(dq: 1 },
+  \(dqpaths\(dq: {
+    \(dqbuild\(dq: \(dq/path/to/top\-level\-build\-dir\(dq,
+    \(dqsource\(dq: \(dq/path/to/top\-level\-source\-dir\(dq
+  },
+  \(dqinputs\(dq: [
+    {
+      \(dqpath\(dq: \(dqCMakeLists.txt\(dq
+    },
+    {
+      \(dqisGenerated\(dq: true,
+      \(dqpath\(dq: \(dq/path/to/top\-level\-build\-dir/.../CMakeSystem.cmake\(dq
+    },
+    {
+      \(dqisExternal\(dq: true,
+      \(dqpath\(dq: \(dq/path/to/external/third\-party/module.cmake\(dq
+    },
+    {
+      \(dqisCMake\(dq: true,
+      \(dqisExternal\(dq: true,
+      \(dqpath\(dq: \(dq/path/to/cmake/Modules/CMakeGenericSystem.cmake\(dq
+    }
+  ],
+  \(dqglobsDependent\(dq: [
+    {
+      \(dqexpression\(dq: \(dqsrc/*.cxx\(dq,
+      \(dqrecurse\(dq: true,
+      \(dqfiles\(dq: [
+        \(dqsrc/foo.cxx\(dq,
+        \(dqsrc/bar.cxx\(dq
+      ]
+    }
+  ]
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The members specific to \fBcmakeFiles\fP objects are:
+.INDENT 0.0
+.TP
+.B \fBpaths\fP
+A JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBsource\fP
+A string specifying the absolute path to the top\-level source directory,
+represented with forward slashes.
+.TP
+.B \fBbuild\fP
+A string specifying the absolute path to the top\-level build directory,
+represented with forward slashes.
+.UNINDENT
+.TP
+.B \fBinputs\fP
+A JSON array whose entries are each a JSON object specifying an input
+file used by CMake when configuring and generating the build system.
+The members of each entry are:
+.INDENT 7.0
+.TP
+.B \fBpath\fP
+A string specifying the path to an input file to CMake, represented
+with forward slashes.  If the file is inside the top\-level source
+directory then the path is specified relative to that directory.
+Otherwise the path is absolute.
+.TP
+.B \fBisGenerated\fP
+Optional member that is present with boolean value \fBtrue\fP
+if the path specifies a file that is under the top\-level
+build directory and the build is out\-of\-source.
+This member is not available on in\-source builds.
+.TP
+.B \fBisExternal\fP
+Optional member that is present with boolean value \fBtrue\fP
+if the path specifies a file that is not under the top\-level
+source or build directories.
+.TP
+.B \fBisCMake\fP
+Optional member that is present with boolean value \fBtrue\fP
+if the path specifies a file in the CMake installation.
+.UNINDENT
+.TP
+.B \fBglobsDependent\fP
+Optional member that is present when the project calls \X'tty: link #glob'\fI\%file(GLOB)\fP\X'tty: link'
+or \X'tty: link #glob-recurse'\fI\%file(GLOB_RECURSE)\fP\X'tty: link' with the \fBCONFIGURE_DEPENDS\fP option.
+The value is a JSON array of JSON objects, each specifying a globbing
+expression and the list of paths it matched.  If the globbing expression
+no longer matches the same list of paths, CMake considers the build system
+to be out of date.
+.sp
+This field was added in \fBcmakeFiles\fP version 1.1.
+.sp
+The members of each entry are:
+.INDENT 7.0
+.TP
+.B \fBexpression\fP
+A string specifying the globbing expression.
+.TP
+.B \fBrecurse\fP
+Optional member that is present with boolean value \fBtrue\fP
+if the entry corresponds to a \X'tty: link #glob-recurse'\fI\%file(GLOB_RECURSE)\fP\X'tty: link' call.
+Otherwise the entry corresponds to a \X'tty: link #glob'\fI\%file(GLOB)\fP\X'tty: link' call.
+.TP
+.B \fBlistDirectories\fP
+Optional member that is present with boolean value \fBtrue\fP if
+\X'tty: link #glob'\fI\%file(GLOB)\fP\X'tty: link' was called without \fBLIST_DIRECTORIES false\fP or
+\X'tty: link #glob-recurse'\fI\%file(GLOB_RECURSE)\fP\X'tty: link' was called with \fBLIST_DIRECTORIES true\fP\&.
+.TP
+.B \fBfollowSymlinks\fP
+Optional member that is present with boolean value \fBtrue\fP if
+\X'tty: link #glob'\fI\%file(GLOB)\fP\X'tty: link' was called with the \fBFOLLOW_SYMLINKS\fP option.
+.TP
+.B \fBrelative\fP
+Optional member that is present if \X'tty: link #glob'\fI\%file(GLOB)\fP\X'tty: link' was called
+with the \fBRELATIVE <path>\fP option.  The value is a string containing
+the \fB<path>\fP given.
+.TP
+.B \fBpaths\fP
+A JSON array of strings specifying the paths matched by the call
+to \X'tty: link #glob'\fI\%file(GLOB)\fP\X'tty: link' or \X'tty: link #glob-recurse'\fI\%file(GLOB_RECURSE)\fP\X'tty: link'\&.
+.UNINDENT
+.UNINDENT
+.SS Object Kind \(dqtoolchains\(dq
+.sp
+The \fBtoolchains\fP object kind lists properties of the toolchains used during
+the build.  These include the language, compiler path, ID, and version.
+.sp
+There is only one \fBtoolchains\fP object major version, version 1.
+.SS \(dqtoolchains\(dq version 1
+.sp
+\fBtoolchains\fP object version 1 is a JSON object:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  \(dqkind\(dq: \(dqtoolchains\(dq,
+  \(dqversion\(dq: { \(dqmajor\(dq: 1, \(dqminor\(dq: 0 },
+  \(dqtoolchains\(dq: [
+    {
+      \(dqlanguage\(dq: \(dqC\(dq,
+      \(dqcompiler\(dq: {
+        \(dqpath\(dq: \(dq/usr/bin/cc\(dq,
+        \(dqid\(dq: \(dqGNU\(dq,
+        \(dqversion\(dq: \(dq9.3.0\(dq,
+        \(dqimplicit\(dq: {
+          \(dqincludeDirectories\(dq: [
+            \(dq/usr/lib/gcc/x86_64\-linux\-gnu/9/include\(dq,
+            \(dq/usr/local/include\(dq,
+            \(dq/usr/include/x86_64\-linux\-gnu\(dq,
+            \(dq/usr/include\(dq
+          ],
+          \(dqlinkDirectories\(dq: [
+            \(dq/usr/lib/gcc/x86_64\-linux\-gnu/9\(dq,
+            \(dq/usr/lib/x86_64\-linux\-gnu\(dq,
+            \(dq/usr/lib\(dq,
+            \(dq/lib/x86_64\-linux\-gnu\(dq,
+            \(dq/lib\(dq
+          ],
+          \(dqlinkFrameworkDirectories\(dq: [],
+          \(dqlinkLibraries\(dq: [ \(dqgcc\(dq, \(dqgcc_s\(dq, \(dqc\(dq, \(dqgcc\(dq, \(dqgcc_s\(dq ]
+        }
+      },
+      \(dqsourceFileExtensions\(dq: [ \(dqc\(dq, \(dqm\(dq ]
+    },
+    {
+      \(dqlanguage\(dq: \(dqCXX\(dq,
+      \(dqcompiler\(dq: {
+        \(dqpath\(dq: \(dq/usr/bin/c++\(dq,
+        \(dqid\(dq: \(dqGNU\(dq,
+        \(dqversion\(dq: \(dq9.3.0\(dq,
+        \(dqimplicit\(dq: {
+          \(dqincludeDirectories\(dq: [
+            \(dq/usr/include/c++/9\(dq,
+            \(dq/usr/include/x86_64\-linux\-gnu/c++/9\(dq,
+            \(dq/usr/include/c++/9/backward\(dq,
+            \(dq/usr/lib/gcc/x86_64\-linux\-gnu/9/include\(dq,
+            \(dq/usr/local/include\(dq,
+            \(dq/usr/include/x86_64\-linux\-gnu\(dq,
+            \(dq/usr/include\(dq
+          ],
+          \(dqlinkDirectories\(dq: [
+            \(dq/usr/lib/gcc/x86_64\-linux\-gnu/9\(dq,
+            \(dq/usr/lib/x86_64\-linux\-gnu\(dq,
+            \(dq/usr/lib\(dq,
+            \(dq/lib/x86_64\-linux\-gnu\(dq,
+            \(dq/lib\(dq
+          ],
+          \(dqlinkFrameworkDirectories\(dq: [],
+          \(dqlinkLibraries\(dq: [
+            \(dqstdc++\(dq, \(dqm\(dq, \(dqgcc_s\(dq, \(dqgcc\(dq, \(dqc\(dq, \(dqgcc_s\(dq, \(dqgcc\(dq
+          ]
+        }
+      },
+      \(dqsourceFileExtensions\(dq: [
+        \(dqC\(dq, \(dqM\(dq, \(dqc++\(dq, \(dqcc\(dq, \(dqcpp\(dq, \(dqcxx\(dq, \(dqmm\(dq, \(dqCPP\(dq
+      ]
+    }
+  ]
+}
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The members specific to \fBtoolchains\fP objects are:
+.INDENT 0.0
+.TP
+.B \fBtoolchains\fP
+A JSON array whose entries are each a JSON object specifying a toolchain
+associated with a particular language. The members of each entry are:
+.INDENT 7.0
+.TP
+.B \fBlanguage\fP
+A JSON string specifying the toolchain language, like C or CXX. Language
+names are the same as language names that can be passed to the
+\X'tty: link #command:project'\fI\%project()\fP\X'tty: link' command. Because CMake only supports a single toolchain
+per language, this field can be used as a key.
+.TP
+.B \fBcompiler\fP
+A JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBpath\fP
+Optional member that is present when the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_<LANG>_COMPILER\fP\X'tty: link' variable is defined for the current
+language. Its value is a JSON string holding the path to the compiler.
+.TP
+.B \fBid\fP
+Optional member that is present when the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER_ID'\fI\%CMAKE_<LANG>_COMPILER_ID\fP\X'tty: link' variable is defined for the current
+language. Its value is a JSON string holding the ID (GNU, MSVC, etc.) of
+the compiler.
+.TP
+.B \fBversion\fP
+Optional member that is present when the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER_VERSION'\fI\%CMAKE_<LANG>_COMPILER_VERSION\fP\X'tty: link' variable is defined for the
+current language. Its value is a JSON string holding the version of the
+compiler.
+.TP
+.B \fBtarget\fP
+Optional member that is present when the
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER_TARGET'\fI\%CMAKE_<LANG>_COMPILER_TARGET\fP\X'tty: link' variable is defined for the
+current language. Its value is a JSON string holding the cross\-compiling
+target of the compiler.
+.TP
+.B \fBimplicit\fP
+A JSON object containing members:
+.INDENT 7.0
+.TP
+.B \fBincludeDirectories\fP
+Optional member that is present when the
+\X'tty: link #variable:CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES'\fI\%CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES\fP\X'tty: link' variable is
+defined for the current language. Its value is a JSON array of JSON
+strings where each string holds a path to an implicit include
+directory for the compiler.
+.TP
+.B \fBlinkDirectories\fP
+Optional member that is present when the
+\X'tty: link #variable:CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES'\fI\%CMAKE_<LANG>_IMPLICIT_LINK_DIRECTORIES\fP\X'tty: link' variable is
+defined for the current language. Its value is a JSON array of JSON
+strings where each string holds a path to an implicit link directory
+for the compiler.
+.TP
+.B \fBlinkFrameworkDirectories\fP
+Optional member that is present when the
+\X'tty: link #variable:CMAKE_<LANG>_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES'\fI\%CMAKE_<LANG>_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES\fP\X'tty: link' variable
+is defined for the current language. Its value is a JSON array of JSON
+strings where each string holds a path to an implicit link framework
+directory for the compiler.
+.TP
+.B \fBlinkLibraries\fP
+Optional member that is present when the
+\X'tty: link #variable:CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES'\fI\%CMAKE_<LANG>_IMPLICIT_LINK_LIBRARIES\fP\X'tty: link' variable is defined
+for the current language. Its value is a JSON array of JSON strings
+where each string holds a path to an implicit link library for the
+compiler.
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBsourceFileExtensions\fP
+Optional member that is present when the
+\X'tty: link #variable:CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS'\fI\%CMAKE_<LANG>_SOURCE_FILE_EXTENSIONS\fP\X'tty: link' variable is defined for
+the current language. Its value is a JSON array of JSON strings where each
+each string holds a file extension (without the leading dot) for the
+language.
+.UNINDENT
+.UNINDENT
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-generators.7

@@ -0,0 +1,1188 @@
+.\" 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-GENERATORS" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-generators \- CMake Generators Reference
+.SH INTRODUCTION
+.sp
+A \fICMake Generator\fP is responsible for writing the input files for
+a native build system.  Exactly one of the \fI\%CMake Generators\fP must be
+selected for a build tree to determine what native build system is to
+be used.  Optionally one of the \fI\%Extra Generators\fP may be selected
+as a variant of some of the \fI\%Command\-Line Build Tool Generators\fP to
+produce project files for an auxiliary IDE.
+.sp
+CMake Generators are platform\-specific so each may be available only
+on certain platforms.  The \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' command\-line tool
+\X'tty: link #cmdoption-cmake-h'\fI\%\-\-help\fP\X'tty: link' output lists available generators on the
+current platform.  Use its \X'tty: link #cmdoption-cmake-G'\fI\%\-G\fP\X'tty: link' option to specify the
+generator for a new build tree. The \X'tty: link #manual:cmake-gui(1)'\fI\%cmake\-gui(1)\fP\X'tty: link' offers
+interactive selection of a generator when creating a new build tree.
+.SH CMAKE GENERATORS
+.SS Command\-Line Build Tool Generators
+.sp
+These generators support command\-line build tools.  In order to use them,
+one must launch CMake from a command\-line prompt whose environment is
+already configured for the chosen compiler and build tool.
+.SS Makefile Generators
+.SS Borland Makefiles
+.sp
+Generates Borland makefiles.
+.SS MSYS Makefiles
+.sp
+Generates makefiles for use with MSYS (Minimal SYStem)
+\fBmake\fP under the MSYS shell.
+.sp
+Use this generator in a MSYS shell prompt and using \fBmake\fP as the build
+tool.  The generated makefiles use \fB/bin/sh\fP as the shell to launch build
+rules.  They are not compatible with a Windows command prompt.
+.sp
+To build under a Windows command prompt, use the
+\X'tty: link #generator:MinGW Makefiles'\fI\%MinGW Makefiles\fP\X'tty: link' generator.
+.SS MinGW Makefiles
+.sp
+Generates makefiles for use with \fBmingw32\-make\fP under a Windows command
+prompt.
+.sp
+Use this generator under a Windows command prompt with
+MinGW (Minimalist GNU for Windows) in the \fBPATH\fP
+and using \fBmingw32\-make\fP as the build tool.  The generated makefiles use
+\fBcmd.exe\fP as the shell to launch build rules.  They are not compatible with
+MSYS or a unix shell.
+.sp
+To build under the MSYS shell, use the \X'tty: link #generator:MSYS Makefiles'\fI\%MSYS Makefiles\fP\X'tty: link' generator.
+.SS NMake Makefiles
+.sp
+Generates NMake makefiles.
+.SS NMake Makefiles JOM
+.sp
+Generates JOM makefiles.
+.sp
+Added in version 3.8: \X'tty: link #generator:CodeBlocks'\fI\%CodeBlocks\fP\X'tty: link' generator can be used as an extra generator.
+
+.SS Unix Makefiles
+.sp
+Generates standard UNIX makefiles.
+.sp
+A hierarchy of UNIX makefiles is generated into the build tree.  Use
+any standard UNIX\-style make program to build the project through
+the \fBall\fP target and install the project through the \fBinstall\fP
+(or \fBinstall/strip\fP) target.
+.sp
+For each subdirectory \fBsub/dir\fP of the project a UNIX makefile will
+be created, containing the following targets:
+.INDENT 0.0
+.TP
+.B \fBall\fP
+Depends on all targets required by the subdirectory.
+.TP
+.B \fBinstall\fP
+Runs the install step in the subdirectory, if any.
+.TP
+.B \fBinstall/strip\fP
+Runs the install step in the subdirectory followed by a \fBCMAKE_STRIP\fP command,
+if any.
+.sp
+The \fBCMAKE_STRIP\fP variable will contain the platform\(aqs \fBstrip\fP utility, which
+removes symbols information from generated binaries.
+.TP
+.B \fBtest\fP
+Runs the test step in the subdirectory, if any.
+.TP
+.B \fBpackage\fP
+Runs the package step in the subdirectory, if any.
+.UNINDENT
+.SS Watcom WMake
+.sp
+Generates Watcom WMake makefiles.
+.SS Ninja Generators
+.SS Ninja
+.sp
+Generates a \fBbuild.ninja\fP file into the build tree.
+.SS Builtin Targets
+.sp
+\fBall\fP
+.INDENT 0.0
+.INDENT 3.5
+Depends on all targets required by the project, except those with
+\X'tty: link #prop_tgt:EXCLUDE_FROM_ALL'\fI\%EXCLUDE_FROM_ALL\fP\X'tty: link' set to true.
+.UNINDENT
+.UNINDENT
+.sp
+\fBinstall\fP
+.INDENT 0.0
+.INDENT 3.5
+Runs the install step.
+.UNINDENT
+.UNINDENT
+.sp
+\fBinstall/strip\fP
+.INDENT 0.0
+.INDENT 3.5
+Added in version 3.7: Runs the install followed by a \fBCMAKE_STRIP\fP command, if any.
+.sp
+The \fBCMAKE_STRIP\fP variable will contain the platform\(aqs \fBstrip\fP utility, which
+removes symbols information from generated binaries.
+
+.UNINDENT
+.UNINDENT
+.sp
+\fBinstall/parallel\fP
+.INDENT 0.0
+.INDENT 3.5
+Added in version 3.30: Created only if the \X'tty: link #prop_gbl:INSTALL_PARALLEL'\fI\%INSTALL_PARALLEL\fP\X'tty: link' global property is \fBON\fP\&.
+Runs the install step for each subdirectory independently and in parallel.
+
+.UNINDENT
+.UNINDENT
+.sp
+For each subdirectory \fBsub/dir\fP of the project, additional targets
+are generated:
+.sp
+\fBsub/dir/all\fP
+.INDENT 0.0
+.INDENT 3.5
+Added in version 3.6: Depends on all targets required by the subdirectory.
+
+.UNINDENT
+.UNINDENT
+.sp
+\fBsub/dir/install\fP
+.INDENT 0.0
+.INDENT 3.5
+Added in version 3.7: Runs the install step in the subdirectory, if any.
+
+.UNINDENT
+.UNINDENT
+.sp
+\fBsub/dir/install/strip\fP
+.INDENT 0.0
+.INDENT 3.5
+Added in version 3.7: Runs the install step in the subdirectory followed by a \fBCMAKE_STRIP\fP command,
+if any.
+
+.UNINDENT
+.UNINDENT
+.sp
+\fBsub/dir/test\fP
+.INDENT 0.0
+.INDENT 3.5
+Added in version 3.7: Runs the test step in the subdirectory, if any.
+
+.UNINDENT
+.UNINDENT
+.sp
+\fBsub/dir/package\fP
+.INDENT 0.0
+.INDENT 3.5
+Added in version 3.7: Runs the package step in the subdirectory, if any.
+
+.UNINDENT
+.UNINDENT
+.SS Fortran Support
+.sp
+Added in version 3.7.
+
+.sp
+The \fBNinja\fP generator conditionally supports Fortran when the \fBninja\fP
+tool is at least version 1.10 (which has the required features).
+.SS Swift Support
+.sp
+Added in version 3.15.
+
+.sp
+The Swift support is experimental, not considered stable, and may change
+in future releases of CMake.
+.SS See Also
+.sp
+Added in version 3.17: The \X'tty: link #generator:Ninja Multi-Config'\fI\%Ninja Multi\-Config\fP\X'tty: link' generator is similar to the \fBNinja\fP
+generator, but generates multiple configurations at once.
+
+.SS Ninja Multi\-Config
+.sp
+Added in version 3.17.
+
+.sp
+Generates multiple \fBbuild\-<Config>.ninja\fP files.
+.sp
+This generator is very much like the \X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link' generator, but with
+some key differences. Only these differences will be discussed in this
+document.
+.sp
+Unlike the \X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link' generator, \fBNinja Multi\-Config\fP generates
+multiple configurations at once with \X'tty: link #variable:CMAKE_CONFIGURATION_TYPES'\fI\%CMAKE_CONFIGURATION_TYPES\fP\X'tty: link'
+instead of only one configuration with \X'tty: link #variable:CMAKE_BUILD_TYPE'\fI\%CMAKE_BUILD_TYPE\fP\X'tty: link'\&. One
+\fBbuild\-<Config>.ninja\fP file will be generated for each of these
+configurations (with \fB<Config>\fP being the configuration name.) These files
+are intended to be run with \fBninja \-f build\-<Config>.ninja\fP\&. A
+\fBbuild.ninja\fP file is also generated, using the configuration from either
+\X'tty: link #variable:CMAKE_DEFAULT_BUILD_TYPE'\fI\%CMAKE_DEFAULT_BUILD_TYPE\fP\X'tty: link' or the first item from
+\X'tty: link #variable:CMAKE_CONFIGURATION_TYPES'\fI\%CMAKE_CONFIGURATION_TYPES\fP\X'tty: link'\&.
+.sp
+\fBcmake \-\-build . \-\-config <Config>\fP will always use \fBbuild\-<Config>.ninja\fP
+to build. If no \X'tty: link #cmdoption-cmake-build-config'\fI\%\-\-config\fP\X'tty: link' argument is
+specified, \X'tty: link #cmdoption-cmake-build'\fI\%cmake \-\-build .\fP\X'tty: link' will use \fBbuild.ninja\fP\&.
+.sp
+Each \fBbuild\-<Config>.ninja\fP file contains \fB<target>\fP targets as well as
+\fB<target>:<Config>\fP targets, where \fB<Config>\fP is the same as the
+configuration specified in \fBbuild\-<Config>.ninja\fP Additionally, if
+cross\-config mode is enabled, \fBbuild\-<Config>.ninja\fP may contain
+\fB<target>:<OtherConfig>\fP targets, where \fB<OtherConfig>\fP is a cross\-config,
+as well as \fB<target>:all\fP, which builds the target in all cross\-configs. See
+below for how to enable cross\-config mode.
+.sp
+The \fBNinja Multi\-Config\fP generator recognizes the following variables:
+.INDENT 0.0
+.TP
+.B \X'tty: link #variable:CMAKE_CONFIGURATION_TYPES'\fI\%CMAKE_CONFIGURATION_TYPES\fP\X'tty: link'
+Specifies the total set of configurations to build. Unlike with other
+multi\-config generators, this variable has a value of
+\fBDebug;Release;RelWithDebInfo\fP by default.
+.TP
+.B \X'tty: link #variable:CMAKE_CROSS_CONFIGS'\fI\%CMAKE_CROSS_CONFIGS\fP\X'tty: link'
+Specifies a \X'tty: link #cmake-language-lists'\fI\%semicolon\-separated list\fP\X'tty: link' of
+configurations available from all \fBbuild\-<Config>.ninja\fP files.
+.TP
+.B \X'tty: link #variable:CMAKE_DEFAULT_BUILD_TYPE'\fI\%CMAKE_DEFAULT_BUILD_TYPE\fP\X'tty: link'
+Specifies the configuration to use by default in a \fBbuild.ninja\fP file.
+.TP
+.B \X'tty: link #variable:CMAKE_DEFAULT_CONFIGS'\fI\%CMAKE_DEFAULT_CONFIGS\fP\X'tty: link'
+Specifies a \X'tty: link #cmake-language-lists'\fI\%semicolon\-separated list\fP\X'tty: link' of
+configurations to build for a target in \fBbuild.ninja\fP
+if no \fB:<Config>\fP suffix is specified.
+.UNINDENT
+.sp
+Consider the following example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+cmake_minimum_required(VERSION 3.16)
+project(MultiConfigNinja C)
+
+add_executable(generator generator.c)
+add_custom_command(OUTPUT generated.c COMMAND generator generated.c)
+add_library(generated ${CMAKE_BINARY_DIR}/generated.c)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Now assume you configure the project with \fBNinja Multi\-Config\fP and run one of
+the following commands:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+ninja \-f build\-Debug.ninja generated
+# OR
+cmake \-\-build . \-\-config Debug \-\-target generated
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This would build the \fBDebug\fP configuration of \fBgenerator\fP, which would be
+used to generate \fBgenerated.c\fP, which would be used to build the \fBDebug\fP
+configuration of \fBgenerated\fP\&.
+.sp
+But if \X'tty: link #variable:CMAKE_CROSS_CONFIGS'\fI\%CMAKE_CROSS_CONFIGS\fP\X'tty: link' is set to \fBall\fP, and you run the
+following instead:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+ninja \-f build\-Release.ninja generated:Debug
+# OR
+cmake \-\-build . \-\-config Release \-\-target generated:Debug
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This would build the \fBRelease\fP configuration of \fBgenerator\fP, which would be
+used to generate \fBgenerated.c\fP, which would be used to build the \fBDebug\fP
+configuration of \fBgenerated\fP\&. This is useful for running a release\-optimized
+version of a generator utility while still building the debug version of the
+targets built with the generated code.
+.SS Custom Commands
+.sp
+Added in version 3.20.
+
+.sp
+The \fBNinja Multi\-Config\fP generator adds extra capabilities to
+\X'tty: link #command:add_custom_command'\fI\%add_custom_command()\fP\X'tty: link' and \X'tty: link #command:add_custom_target'\fI\%add_custom_target()\fP\X'tty: link' through its
+cross\-config mode. The \fBCOMMAND\fP, \fBDEPENDS\fP, and \fBWORKING_DIRECTORY\fP
+arguments can be evaluated in the context of either the \(dqcommand config\(dq (the
+\(dqnative\(dq configuration of the \fBbuild\-<Config>.ninja\fP file in use) or the
+\(dqoutput config\(dq (the configuration used to evaluate the \fBOUTPUT\fP and
+\fBBYPRODUCTS\fP).
+.sp
+If either \fBOUTPUT\fP or \fBBYPRODUCTS\fP names a path that is common to
+more than one configuration (e.g. it does not use any generator expressions),
+all arguments are evaluated in the command config by default.
+If all \fBOUTPUT\fP and \fBBYPRODUCTS\fP paths are unique to each configuration
+(e.g. by using the \X'tty: link #genex:CONFIG'\fI\%$<CONFIG>\fP\X'tty: link' generator expression), the first argument of
+\fBCOMMAND\fP is still evaluated in the command config by default, while all
+subsequent arguments, as well as the arguments to \fBDEPENDS\fP and
+\fBWORKING_DIRECTORY\fP, are evaluated in the output config. These defaults can
+be overridden with the \X'tty: link #genex:OUTPUT_CONFIG'\fI\%$<OUTPUT_CONFIG:...>\fP\X'tty: link' and \X'tty: link #genex:COMMAND_CONFIG'\fI\%$<COMMAND_CONFIG:...>\fP\X'tty: link'
+generator\-expressions. Note that if a target is specified by its name in
+\fBDEPENDS\fP, or as the first argument of \fBCOMMAND\fP, it is always evaluated
+in the command config, even if it is wrapped in \X'tty: link #genex:OUTPUT_CONFIG'\fI\%$<OUTPUT_CONFIG:...>\fP\X'tty: link'
+(because its plain name is not a generator expression).
+.sp
+As an example, consider the following:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_custom_command(
+  OUTPUT \(dq$<CONFIG>.txt\(dq
+  COMMAND
+    generator \(dq$<CONFIG>.txt\(dq
+              \(dq$<OUTPUT_CONFIG:$<CONFIG>>\(dq
+              \(dq$<COMMAND_CONFIG:$<CONFIG>>\(dq
+  DEPENDS
+    tgt1
+    \(dq$<TARGET_FILE:tgt2>\(dq
+    \(dq$<OUTPUT_CONFIG:$<TARGET_FILE:tgt3>>\(dq
+    \(dq$<COMMAND_CONFIG:$<TARGET_FILE:tgt4>>\(dq
+  )
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Assume that \fBgenerator\fP, \fBtgt1\fP, \fBtgt2\fP, \fBtgt3\fP, and \fBtgt4\fP are all
+executable targets, and assume that \fB$<CONFIG>.txt\fP is built in the \fBDebug\fP
+output config using the \fBRelease\fP command config. The \fBRelease\fP build of
+the \fBgenerator\fP target is called with \fBDebug.txt Debug Release\fP as
+arguments. The command depends on the \fBRelease\fP builds of \fBtgt1\fP and
+\fBtgt4\fP, and the \fBDebug\fP builds of \fBtgt2\fP and \fBtgt3\fP\&.
+.sp
+\fBPRE_BUILD\fP, \fBPRE_LINK\fP, and \fBPOST_BUILD\fP custom commands for targets
+only get run in their \(dqnative\(dq configuration (the \fBRelease\fP configuration in
+the \fBbuild\-Release.ninja\fP file) unless they have no \fBBYPRODUCTS\fP or their
+\fBBYPRODUCTS\fP are unique per config. Consider the following example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_executable(exe main.c)
+add_custom_command(
+  TARGET exe
+  POST_BUILD
+  COMMAND
+    ${CMAKE_COMMAND} \-E echo \(dqRunning no\-byproduct command\(dq
+  )
+add_custom_command(
+  TARGET exe
+  POST_BUILD
+  COMMAND
+    ${CMAKE_COMMAND} \-E echo
+    \(dqRunning separate\-byproduct command for $<CONFIG>\(dq
+  BYPRODUCTS $<CONFIG>.txt
+  )
+add_custom_command(
+  TARGET exe
+  POST_BUILD
+  COMMAND
+    ${CMAKE_COMMAND} \-E echo
+    \(dqRunning common\-byproduct command for $<CONFIG>\(dq
+  BYPRODUCTS exe.txt
+  )
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In this example, if you build \fBexe:Debug\fP in \fBbuild\-Release.ninja\fP, the
+first and second custom commands get run, since their byproducts are unique
+per\-config, but the last custom command does not. However, if you build
+\fBexe:Release\fP in \fBbuild\-Release.ninja\fP, all three custom commands get run.
+.SS IDE Build Tool Generators
+.sp
+These generators support Integrated Development Environment (IDE)
+project files.  Since the IDEs configure their own environment
+one may launch CMake from any environment.
+.SS Visual Studio Generators
+.SS Visual Studio 6
+.sp
+Removed.  This once generated Visual Studio 6 project files, but the
+generator has been removed since CMake 3.6.  It is still possible to
+build with VS 6 tools using the \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link' generator.
+.SS Visual Studio 7
+.sp
+Removed.  This once generated Visual Studio .NET 2002 project files, but
+the generator has been removed since CMake 3.6.  It is still possible to
+build with VS 7.0 tools using the \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link' generator.
+.SS Visual Studio 7 .NET 2003
+.sp
+Removed.  This once generated Visual Studio .NET 2003 project files, but
+the generator has been removed since CMake 3.9.  It is still possible to
+build with VS 7.1 tools using the \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link' generator.
+.SS Visual Studio 8 2005
+.sp
+Removed.  This once generated Visual Studio 8 2005 project files, but
+the generator has been removed since CMake 3.12.  It is still possible to
+build with VS 2005 tools using the \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link' generator.
+.SS Visual Studio 9 2008
+.sp
+Removed.  This once generated Visual Studio 9 2008 project files, but
+the generator has been removed since CMake 3.30.  It is still possible
+to build with the VS 9 2008 toolset by also installing VS 10 2010 and
+VS 2015 (or above) and using the \X'tty: link #generator:Visual Studio 14 2015'\fI\%Visual Studio 14 2015\fP\X'tty: link'
+generator (or above) with \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' set to \fBv90\fP,
+or by using the \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link' generator.
+.SS Visual Studio 10 2010
+.sp
+Removed.  This once generated Visual Studio 10 2010 project files, but
+the generator has been removed since CMake 3.25.  It is still possible
+to build with the VS 10 2010 toolset by also installing VS 2015 (or above)
+and using the \X'tty: link #generator:Visual Studio 14 2015'\fI\%Visual Studio 14 2015\fP\X'tty: link' (or above) generator with
+\X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' set to \fBv100\fP,
+or by using the \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link' generator.
+.SS Visual Studio 11 2012
+.sp
+Removed.  This once generated Visual Studio 11 2012 project files, but
+the generator has been removed since CMake 3.28.  It is still possible
+to build with the VS 11 2012 toolset by also installing VS 2015 (or above)
+and using the \X'tty: link #generator:Visual Studio 14 2015'\fI\%Visual Studio 14 2015\fP\X'tty: link' (or above) generator with
+\X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' set to \fBv110\fP,
+or by using the \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link' generator.
+.SS Visual Studio 12 2013
+.sp
+Removed.  This once generated Visual Studio 12 2013 project files, but
+the generator has been removed since CMake 3.31.  It is still possible
+to build with the VS 12 2013 toolset by also installing VS 2015 (or above)
+and using the \X'tty: link #generator:Visual Studio 14 2015'\fI\%Visual Studio 14 2015\fP\X'tty: link' (or above) generator with
+\X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' set to \fBv120\fP,
+or by using the \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link' generator.
+.SS Visual Studio 14 2015
+.sp
+Added in version 3.1.
+
+.sp
+Generates Visual Studio 14 (VS 2015) project files.
+.SS Project Types
+.sp
+Only Visual C++ and C# projects may be generated (and Fortran with
+Intel compiler integration).  Other types of projects (JavaScript,
+Powershell, Python, etc.) are not supported.
+.SS Platform Selection
+.sp
+The default target platform name (architecture) is \fBWin32\fP\&.
+.sp
+The \X'tty: link #variable:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link' variable may be set, perhaps
+via the \X'tty: link #cmdoption-cmake-A'\fI\%cmake \-A\fP\X'tty: link' option, to specify a target platform
+name (architecture).  For example:
+.INDENT 0.0
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 14 2015\(dq \-A Win32\fP
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 14 2015\(dq \-A x64\fP
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 14 2015\(dq \-A ARM\fP
+.UNINDENT
+.sp
+For compatibility with CMake versions prior to 3.1, one may specify
+a target platform name optionally at the end of the generator name.
+This is supported only for:
+.INDENT 0.0
+.TP
+.B \fBVisual Studio 14 2015 Win64\fP
+Specify target platform \fBx64\fP\&.
+.TP
+.B \fBVisual Studio 14 2015 ARM\fP
+Specify target platform \fBARM\fP\&.
+.UNINDENT
+.SS Toolset Selection
+.sp
+The \fBv140\fP toolset that comes with Visual Studio 14 2015 is selected by
+default.  The \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' option may be set, perhaps
+via the \X'tty: link #cmdoption-cmake-T'\fI\%cmake \-T\fP\X'tty: link' option, to specify another toolset.
+.sp
+Added in version 3.8: For each toolset that comes with this version of Visual Studio, there are
+variants that are themselves compiled for 32\-bit (\fBx86\fP) and
+64\-bit (\fBx64\fP) hosts (independent of the architecture they target).
+By default this generator uses the 32\-bit variant even on a 64\-bit host.
+One may explicitly request use of either the 32\-bit or 64\-bit host tools
+by adding either \fBhost=x86\fP or \fBhost=x64\fP to the toolset specification.
+See the \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' variable for details.
+
+.sp
+Added in version 3.14: Added support for \fBhost=x86\fP option.
+
+.SS Windows 10 SDK Maximum Version for VS 2015
+.sp
+Added in version 3.19.
+
+.sp
+Microsoft stated in a \(dqWindows 10 October 2018 Update\(dq blog post that Windows
+10 SDK versions (15063, 16299, 17134, 17763) are not supported by VS 2015 and
+are only supported by VS 2017 and later.  Therefore by default CMake
+automatically ignores Windows 10 SDKs beyond \fB10.0.14393.0\fP\&.
+.sp
+However, there are other recommendations for certain driver/Win32 builds that
+indicate otherwise.  A user can override this behavior by either setting the
+\X'tty: link #variable:CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM'\fI\%CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM\fP\X'tty: link' to a false value
+or setting the \X'tty: link #variable:CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM'\fI\%CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION_MAXIMUM\fP\X'tty: link' to
+the string value of the required maximum (e.g. \fB10.0.15063.0\fP).
+.SS Visual Studio 15 2017
+.sp
+Added in version 3.7.1.
+
+.sp
+Generates Visual Studio 15 (VS 2017) project files.
+.SS Project Types
+.sp
+Only Visual C++ and C# projects may be generated (and Fortran with
+Intel compiler integration).  Other types of projects (JavaScript,
+Powershell, Python, etc.) are not supported.
+.SS Instance Selection
+.sp
+Added in version 3.11.
+
+.sp
+VS 2017 supports multiple installations on the same machine.  The
+\X'tty: link #variable:CMAKE_GENERATOR_INSTANCE'\fI\%CMAKE_GENERATOR_INSTANCE\fP\X'tty: link' variable may be used to select one.
+.SS Platform Selection
+.sp
+The default target platform name (architecture) is \fBWin32\fP\&.
+.sp
+The \X'tty: link #variable:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link' variable may be set, perhaps
+via the \X'tty: link #cmdoption-cmake-A'\fI\%cmake \-A\fP\X'tty: link' option, to specify a target platform
+name (architecture).  For example:
+.INDENT 0.0
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 15 2017\(dq \-A Win32\fP
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 15 2017\(dq \-A x64\fP
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 15 2017\(dq \-A ARM\fP
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 15 2017\(dq \-A ARM64\fP
+.UNINDENT
+.sp
+For compatibility with CMake versions prior to 3.1, one may specify
+a target platform name optionally at the end of the generator name.
+This is supported only for:
+.INDENT 0.0
+.TP
+.B \fBVisual Studio 15 2017 Win64\fP
+Specify target platform \fBx64\fP\&.
+.TP
+.B \fBVisual Studio 15 2017 ARM\fP
+Specify target platform \fBARM\fP\&.
+.UNINDENT
+.SS Toolset Selection
+.sp
+The \fBv141\fP toolset that comes with Visual Studio 15 2017 is selected by
+default.  The \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' option may be set, perhaps
+via the \X'tty: link #cmdoption-cmake-T'\fI\%cmake \-T\fP\X'tty: link' option, to specify another toolset.
+.sp
+Added in version 3.8: For each toolset that comes with this version of Visual Studio, there are
+variants that are themselves compiled for 32\-bit (\fBx86\fP) and
+64\-bit (\fBx64\fP) hosts (independent of the architecture they target).
+By default this generator uses the 32\-bit variant even on a 64\-bit host.
+One may explicitly request use of either the 32\-bit or 64\-bit host tools
+by adding either \fBhost=x86\fP or \fBhost=x64\fP to the toolset specification.
+See the \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' variable for details.
+
+.sp
+Added in version 3.14: Added support for \fBhost=x86\fP option.
+
+.SS Visual Studio 16 2019
+.sp
+Added in version 3.14.
+
+.sp
+Generates Visual Studio 16 (VS 2019) project files.
+.SS Project Types
+.sp
+Only Visual C++ and C# projects may be generated (and Fortran with
+Intel compiler integration).  Other types of projects (JavaScript,
+Powershell, Python, etc.) are not supported.
+.SS Instance Selection
+.sp
+VS 2019 supports multiple installations on the same machine.  The
+\X'tty: link #variable:CMAKE_GENERATOR_INSTANCE'\fI\%CMAKE_GENERATOR_INSTANCE\fP\X'tty: link' variable may be used to select one.
+.SS Platform Selection
+.sp
+The default target platform name (architecture) is that of the host
+and is provided in the \X'tty: link #variable:CMAKE_VS_PLATFORM_NAME_DEFAULT'\fI\%CMAKE_VS_PLATFORM_NAME_DEFAULT\fP\X'tty: link' variable.
+.sp
+The \X'tty: link #variable:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link' variable may be set, perhaps
+via the \X'tty: link #cmdoption-cmake-A'\fI\%cmake \-A\fP\X'tty: link' option, to specify a target platform
+name (architecture).  For example:
+.INDENT 0.0
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 16 2019\(dq \-A Win32\fP
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 16 2019\(dq \-A x64\fP
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 16 2019\(dq \-A ARM\fP
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 16 2019\(dq \-A ARM64\fP
+.UNINDENT
+.SS Toolset Selection
+.sp
+The \fBv142\fP toolset that comes with Visual Studio 16 2019 is selected by
+default.  The \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' option may be set, perhaps
+via the \X'tty: link #cmdoption-cmake-T'\fI\%cmake \-T\fP\X'tty: link' option, to specify another toolset.
+.sp
+For each toolset that comes with this version of Visual Studio, there are
+variants that are themselves compiled for 32\-bit (\fBx86\fP) and
+64\-bit (\fBx64\fP) hosts (independent of the architecture they target).
+By default this generator uses the 64\-bit variant on x64 hosts and
+the 32\-bit variant otherwise.
+One may explicitly request use of either the 32\-bit or 64\-bit host tools
+by adding either \fBhost=x86\fP or \fBhost=x64\fP to the toolset specification.
+See the \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' variable for details.
+.SS Visual Studio 17 2022
+.sp
+Added in version 3.21.
+
+.sp
+Generates Visual Studio 17 (VS 2022) project files.
+.SS Project Types
+.sp
+Only Visual C++ and C# projects may be generated (and Fortran with
+Intel compiler integration).  Other types of projects (JavaScript,
+Powershell, Python, etc.) are not supported.
+.SS Instance Selection
+.sp
+VS 2022 supports multiple installations on the same machine.  The
+\X'tty: link #variable:CMAKE_GENERATOR_INSTANCE'\fI\%CMAKE_GENERATOR_INSTANCE\fP\X'tty: link' variable may be used to select one.
+.SS Platform Selection
+.sp
+The default target platform name (architecture) is that of the host
+and is provided in the \X'tty: link #variable:CMAKE_VS_PLATFORM_NAME_DEFAULT'\fI\%CMAKE_VS_PLATFORM_NAME_DEFAULT\fP\X'tty: link' variable.
+.sp
+The \X'tty: link #variable:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link' variable may be set, perhaps
+via the \X'tty: link #cmdoption-cmake-A'\fI\%cmake \-A\fP\X'tty: link' option, to specify a target platform
+name (architecture).  For example:
+.INDENT 0.0
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 17 2022\(dq \-A Win32\fP
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 17 2022\(dq \-A x64\fP
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 17 2022\(dq \-A ARM\fP
+.IP \(bu 2
+\fBcmake \-G \(dqVisual Studio 17 2022\(dq \-A ARM64\fP
+.UNINDENT
+.SS Toolset Selection
+.sp
+The \fBv143\fP toolset that comes with VS 17 2022 is selected by default.
+The \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' option may be set, perhaps
+via the \X'tty: link #cmdoption-cmake-T'\fI\%cmake \-T\fP\X'tty: link' option, to specify another toolset.
+.sp
+For each toolset that comes with this version of Visual Studio, there are
+variants that are themselves compiled for 32\-bit (\fBx86\fP) and
+64\-bit (\fBx64\fP) hosts (independent of the architecture they target).
+By default this generator uses the 64\-bit variant on x64 hosts and
+the 32\-bit variant otherwise.
+One may explicitly request use of either the 32\-bit or 64\-bit host tools
+by adding either \fBhost=x86\fP or \fBhost=x64\fP to the toolset specification.
+See the \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' variable for details.
+.SS Other Generators
+.SS Green Hills MULTI
+.sp
+Added in version 3.3.
+
+.sp
+Added in version 3.15: Linux support.
+
+.sp
+Generates Green Hills MULTI project files (experimental, work\-in\-progress).
+.INDENT 0.0
+.INDENT 3.5
+The buildsystem has predetermined build\-configuration settings that can be controlled
+via the \X'tty: link #variable:CMAKE_BUILD_TYPE'\fI\%CMAKE_BUILD_TYPE\fP\X'tty: link' variable.
+.UNINDENT
+.UNINDENT
+.SS Platform Selection
+.sp
+Added in version 3.13.
+
+.sp
+The variable \fBGHS_PRIMARY_TARGET\fP can be used to select the target platform.
+.INDENT 0.0
+.INDENT 3.5
+.nf
+Sets \fBprimaryTarget\fP entry in project file.
+.fi
+.sp
+.UNINDENT
+.UNINDENT
+.sp
+For example:
+.INDENT 0.0
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-D GHS_PRIMARY_TARGET=ppc_integrity.tgt\fP
+.UNINDENT
+.sp
+Otherwise the \fBprimaryTarget\fP will be composed from the values of \X'tty: link #variable:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link'
+and \fBGHS_TARGET_PLATFORM\fP\&. Defaulting to the value of \fBarm_integrity.tgt\fP
+.INDENT 0.0
+.IP \(bu 2
+The \X'tty: link #variable:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link' variable may be set, perhaps
+via the \X'tty: link #cmdoption-cmake-A'\fI\%cmake \-A\fP\X'tty: link' option.
+.nf
+Typical values of \fBarm\fP, \fBppc\fP, \fB86\fP, etcetera, are used.
+.fi
+.sp
+.IP \(bu 2
+The variable \fBGHS_TARGET_PLATFORM\fP may be set, perhaps via the \X'tty: link #cmdoption-cmake-D'\fI\%cmake \-D\fP\X'tty: link'
+option.
+.nf
+Defaults to \fBintegrity\fP\&.
+Usual values are \fBintegrity\fP, \fBthreadx\fP, \fBuvelosity\fP, \fBvelosity\fP,
+\fBvxworks\fP, \fBstandalone\fP\&.
+.fi
+.sp
+.UNINDENT
+.sp
+For example:
+.INDENT 0.0
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq\fP for \fBarm_integrity.tgt\fP\&.
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-A 86\fP for \fB86_integrity.tgt\fP\&.
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-D GHS_TARGET_PLATFORM=standalone\fP for \fBarm_standalone.tgt\fP\&.
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-A ppc \-D GHS_TARGET_PLATFORM=standalone\fP for \fBppc_standalone.tgt\fP\&.
+.UNINDENT
+.SS Toolset Selection
+.sp
+Added in version 3.13.
+
+.sp
+The generator searches for the latest compiler or can be given a location to use.
+\fBGHS_TOOLSET_ROOT\fP is the directory that is checked for the latest compiler.
+.INDENT 0.0
+.IP \(bu 2
+The \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' option may be set, perhaps
+via the \X'tty: link #cmdoption-cmake-T'\fI\%cmake \-T\fP\X'tty: link' option, to specify the location of the toolset.
+Both absolute and relative paths are valid. Paths are relative to \fBGHS_TOOLSET_ROOT\fP\&.
+.IP \(bu 2
+The variable \fBGHS_TOOLSET_ROOT\fP may be set, perhaps via the \X'tty: link #cmdoption-cmake-D'\fI\%cmake \-D\fP\X'tty: link'
+option.
+.nf
+Root path for toolset searches and relative paths.
+Defaults to \fBC:/ghs\fP in Windows or \fB/usr/ghs\fP in Linux.
+.fi
+.sp
+.UNINDENT
+.sp
+For example, setting a specific compiler:
+.INDENT 0.0
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-T comp_201754\fP for \fB/usr/ghs/comp_201754\fP\&.
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-T comp_201754 \-D GHS_TOOLSET_ROOT=/opt/ghs\fP for \fB/opt/ghs/comp_201754\fP\&.
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-T /usr/ghs/comp_201554\fP
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-T C:/ghs/comp_201754\fP
+.UNINDENT
+.sp
+For example, searching for latest compiler:
+.INDENT 0.0
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq\fP for searching \fB/usr/ghs\fP\&.
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI \-D GHS_TOOLSET_ROOT=/opt/ghs\(dq\fP for searching \fB/opt/ghs\fP\&.
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+The \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' should use CMake style paths.
+.UNINDENT
+.UNINDENT
+.SS OS and BSP Selection
+.sp
+Added in version 3.3.
+
+.sp
+Certain target platforms, like Integrity, require an OS.  The RTOS directory path
+can be explicitly set using \fBGHS_OS_DIR\fP\&.  Otherwise \fBGHS_OS_ROOT\fP will be
+searched for the latest Integrity RTOS.
+.sp
+If the target platform, like Integrity, requires a BSP name then it can be set via
+the \fBGHS_BSP_NAME\fP variable.
+.INDENT 0.0
+.IP \(bu 2
+\fBGHS_OS_DIR\fP and \fBGHS_OS_DIR_OPTION\fP
+.nf
+Sets \fB\-os_dir\fP entry in project file.
+.fi
+.sp
+.nf
+\fBGHS_OS_DIR_OPTION\fP default value is \fB\-os_dir\fP\&.
+.fi
+.sp
+.sp
+Added in version 3.15: The \fBGHS_OS_DIR_OPTION\fP variable.
+
+.sp
+For example:
+.INDENT 2.0
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-D GHS_OS_DIR=/usr/ghs/int1144\fP
+.UNINDENT
+.IP \(bu 2
+\fBGHS_OS_ROOT\fP
+.nf
+Root path for RTOS searches.
+Defaults to \fBC:/ghs\fP in Windows or \fB/usr/ghs\fP in Linux.
+.fi
+.sp
+.sp
+For example:
+.INDENT 2.0
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-D GHS_OS_ROOT=/opt/ghs\fP
+.UNINDENT
+.IP \(bu 2
+\fBGHS_BSP_NAME\fP
+.nf
+Sets \fB\-bsp\fP entry in project file.
+Defaults to \fBsim<arch>\fP for \fBintegrity\fP platforms.
+.fi
+.sp
+.sp
+For example:
+.INDENT 2.0
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq\fP for \fBsimarm\fP on \fBarm_integrity.tgt\fP\&.
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-A 86\fP for \fBsim86\fP on \fB86_integrity.tgt\fP\&.
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-A ppc \-D GHS_BSP_NAME=sim800\fP for \fBsim800\fP
+on \fBppc_integrity.tgt\fP\&.
+.IP \(bu 2
+\fBcmake \-G \(dqGreen Hills MULTI\(dq \-D GHS_PRIMARY_TARGET=ppc_integrity.tgt \-D GHS_BSP_NAME=fsl\-t1040\fP
+for \fBfsl\-t1040\fP on \fBppc_integrity.tgt\fP\&.
+.UNINDENT
+.UNINDENT
+.SS Target Properties
+.sp
+Added in version 3.14.
+
+.sp
+The following properties are available:
+.INDENT 0.0
+.IP \(bu 2
+\X'tty: link #prop_tgt:GHS_INTEGRITY_APP'\fI\%GHS_INTEGRITY_APP\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:GHS_NO_SOURCE_GROUP_FILE'\fI\%GHS_NO_SOURCE_GROUP_FILE\fP\X'tty: link'
+.UNINDENT
+.SS MULTI Project Variables
+.sp
+Added in version 3.3.
+
+.sp
+Adding a Customization file and macros are available through the use of the following
+variables:
+.INDENT 0.0
+.IP \(bu 2
+\fBGHS_CUSTOMIZATION\fP \- CMake path name to Customization File.
+.IP \(bu 2
+\fBGHS_GPJ_MACROS\fP \- CMake list of Macros.
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+This generator is deemed experimental as of CMake 3.31.4
+and is still a work in progress.  Future versions of CMake
+may make breaking changes as the generator matures.
+.UNINDENT
+.UNINDENT
+.SS Xcode
+.sp
+Generate Xcode project files.
+.sp
+Changed in version 3.15: This generator supports Xcode 5.0 and above.
+
+.SS Toolset and Build System Selection
+.sp
+By default Xcode is allowed to select its own default toolchain.
+The \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' option may be set, perhaps
+via the \X'tty: link #cmdoption-cmake-T'\fI\%cmake \-T\fP\X'tty: link' option, to specify another toolset.
+.sp
+Added in version 3.19: This generator supports toolset specification using one of these forms:
+
+.INDENT 0.0
+.IP \(bu 2
+\fBtoolset\fP
+.IP \(bu 2
+\fBtoolset[,key=value]*\fP
+.IP \(bu 2
+\fBkey=value[,key=value]*\fP
+.UNINDENT
+.sp
+The \fBtoolset\fP specifies the toolset name.  The selected toolset name
+is provided in the \X'tty: link #variable:CMAKE_XCODE_PLATFORM_TOOLSET'\fI\%CMAKE_XCODE_PLATFORM_TOOLSET\fP\X'tty: link' variable.
+.sp
+The \fBkey=value\fP pairs form a comma\-separated list of options to
+specify generator\-specific details of the toolset selection.
+Supported pairs are:
+.INDENT 0.0
+.TP
+.B \fBbuildsystem=<variant>\fP
+Specify the buildsystem variant to use.
+See the \X'tty: link #variable:CMAKE_XCODE_BUILD_SYSTEM'\fI\%CMAKE_XCODE_BUILD_SYSTEM\fP\X'tty: link' variable for allowed values.
+.sp
+For example, to select the original build system under Xcode 12,
+run \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' with the option \X'tty: link #cmdoption-cmake-T'\fI\%\-T buildsystem=1\fP\X'tty: link'\&.
+.UNINDENT
+.SS Swift Support
+.sp
+Added in version 3.4.
+
+.sp
+When using the \fBXcode\fP generator with Xcode 6.1 or higher,
+one may enable the \fBSwift\fP language with the \X'tty: link #command:enable_language'\fI\%enable_language()\fP\X'tty: link'
+command or the \X'tty: link #command:project'\fI\%project()\fP\X'tty: link'\&.
+.SS Limitations
+.sp
+The Xcode generator does not support per\-configuration sources.
+Code like the following will result in a generation error:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_executable(MyApp mymain\-$<CONFIG>.cpp)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH EXTRA GENERATORS
+.sp
+Deprecated since version 3.27: Support for \(dqExtra Generators\(dq is deprecated and will be removed from
+a future version of CMake.  IDEs may use the \X'tty: link #manual:cmake-file-api(7)'\fI\%cmake\-file\-api(7)\fP\X'tty: link'
+to view CMake\-generated project build trees.
+
+.sp
+Some of the \fI\%CMake Generators\fP listed in the \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link'
+command\-line tool \X'tty: link #cmdoption-cmake-h'\fI\%\-\-help\fP\X'tty: link' output may have
+variants that specify an extra generator for an auxiliary IDE tool.
+Such generator names have the form \fB<extra\-generator> \- <main\-generator>\fP\&.
+The following extra generators are known to CMake.
+.SS CodeBlocks
+.sp
+Deprecated since version 3.27: Support for \X'tty: link #extra-generators'\fI\%Extra Generators\fP\X'tty: link' is deprecated and will be removed from
+a future version of CMake.  IDEs may use the \X'tty: link #manual:cmake-file-api(7)'\fI\%cmake\-file\-api(7)\fP\X'tty: link'
+to view CMake\-generated project build trees.
+
+.sp
+Generates CodeBlocks project files.
+.sp
+Project files for CodeBlocks will be created in the top directory and
+in every subdirectory which features a \fBCMakeLists.txt\fP file containing
+a \X'tty: link #command:project'\fI\%project()\fP\X'tty: link' call.  Additionally a hierarchy of makefiles is generated
+into the build tree.
+The appropriate make program can build the
+project through the default \fBall\fP target.  An \fBinstall\fP target is
+also provided.
+.sp
+Added in version 3.10: The \X'tty: link #variable:CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES'\fI\%CMAKE_CODEBLOCKS_EXCLUDE_EXTERNAL_FILES\fP\X'tty: link' variable may
+be set to \fBON\fP to exclude any files which are located outside of
+the project root directory.
+
+.sp
+This \(dqextra\(dq generator may be specified as:
+.INDENT 0.0
+.TP
+.B \fBCodeBlocks \- MinGW Makefiles\fP
+Generate with \X'tty: link #generator:MinGW Makefiles'\fI\%MinGW Makefiles\fP\X'tty: link'\&.
+.TP
+.B \fBCodeBlocks \- NMake Makefiles\fP
+Generate with \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link'\&.
+.TP
+.B \fBCodeBlocks \- NMake Makefiles JOM\fP
+Added in version 3.8: Generate with \X'tty: link #generator:NMake Makefiles JOM'\fI\%NMake Makefiles JOM\fP\X'tty: link'\&.
+
+.TP
+.B \fBCodeBlocks \- Ninja\fP
+Generate with \X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link'\&.
+.TP
+.B \fBCodeBlocks \- Unix Makefiles\fP
+Generate with \X'tty: link #generator:Unix Makefiles'\fI\%Unix Makefiles\fP\X'tty: link'\&.
+.UNINDENT
+.SS CodeLite
+.sp
+Deprecated since version 3.27: Support for \X'tty: link #extra-generators'\fI\%Extra Generators\fP\X'tty: link' is deprecated and will be removed from
+a future version of CMake.  IDEs may use the \X'tty: link #manual:cmake-file-api(7)'\fI\%cmake\-file\-api(7)\fP\X'tty: link'
+to view CMake\-generated project build trees.
+
+.sp
+Generates CodeLite project files.
+.sp
+Project files for CodeLite will be created in the top directory and
+in every subdirectory which features a CMakeLists.txt file containing
+a \X'tty: link #command:project'\fI\%project()\fP\X'tty: link' call.
+The appropriate make program can build the
+project through the default \fBall\fP target.  An \fBinstall\fP target
+is also provided.
+.sp
+Added in version 3.7: The \X'tty: link #variable:CMAKE_CODELITE_USE_TARGETS'\fI\%CMAKE_CODELITE_USE_TARGETS\fP\X'tty: link' variable may be set to \fBON\fP
+to change the default behavior from projects to targets as the basis
+for project files.
+
+.sp
+This \(dqextra\(dq generator may be specified as:
+.INDENT 0.0
+.TP
+.B \fBCodeLite \- MinGW Makefiles\fP
+Generate with \X'tty: link #generator:MinGW Makefiles'\fI\%MinGW Makefiles\fP\X'tty: link'\&.
+.TP
+.B \fBCodeLite \- NMake Makefiles\fP
+Generate with \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link'\&.
+.TP
+.B \fBCodeLite \- Ninja\fP
+Generate with \X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link'\&.
+.TP
+.B \fBCodeLite \- Unix Makefiles\fP
+Generate with \X'tty: link #generator:Unix Makefiles'\fI\%Unix Makefiles\fP\X'tty: link'\&.
+.UNINDENT
+.SS Eclipse CDT4
+.sp
+Deprecated since version 3.27: Support for \X'tty: link #extra-generators'\fI\%Extra Generators\fP\X'tty: link' is deprecated and will be removed from
+a future version of CMake.  IDEs may use the \X'tty: link #manual:cmake-file-api(7)'\fI\%cmake\-file\-api(7)\fP\X'tty: link'
+to view CMake\-generated project build trees.
+
+.sp
+Generates Eclipse CDT 4.0 project files.
+.sp
+Project files for Eclipse will be created in the top directory.  In
+out of source builds, a linked resource to the top level source
+directory will be created.  Additionally a hierarchy of makefiles is
+generated into the build tree.  The appropriate make program can build
+the project through the default \fBall\fP target.  An \fBinstall\fP target
+is also provided.
+.sp
+This \(dqextra\(dq generator may be specified as:
+.INDENT 0.0
+.TP
+.B \fBEclipse CDT4 \- MinGW Makefiles\fP
+Generate with \X'tty: link #generator:MinGW Makefiles'\fI\%MinGW Makefiles\fP\X'tty: link'\&.
+.TP
+.B \fBEclipse CDT4 \- NMake Makefiles\fP
+Generate with \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link'\&.
+.TP
+.B \fBEclipse CDT4 \- Ninja\fP
+Generate with \X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link'\&.
+.TP
+.B \fBEclipse CDT4 \- Unix Makefiles\fP
+Generate with \X'tty: link #generator:Unix Makefiles'\fI\%Unix Makefiles\fP\X'tty: link'\&.
+.UNINDENT
+.SS Kate
+.sp
+Deprecated since version 3.27: Support for \X'tty: link #extra-generators'\fI\%Extra Generators\fP\X'tty: link' is deprecated and will be removed from
+a future version of CMake.  IDEs may use the \X'tty: link #manual:cmake-file-api(7)'\fI\%cmake\-file\-api(7)\fP\X'tty: link'
+to view CMake\-generated project build trees.
+
+.sp
+Generates Kate project files.
+.sp
+A project file for Kate will be created in the top directory in the top level
+build directory.
+To use it in Kate, the Project plugin must be enabled.
+The project file is loaded in Kate by opening the
+\fBProjectName.kateproject\fP file in the editor.
+If the Kate Build\-plugin is enabled, all targets generated by CMake are
+available for building.
+.sp
+This \(dqextra\(dq generator may be specified as:
+.INDENT 0.0
+.TP
+.B \fBKate \- MinGW Makefiles\fP
+Generate with \X'tty: link #generator:MinGW Makefiles'\fI\%MinGW Makefiles\fP\X'tty: link'\&.
+.TP
+.B \fBKate \- NMake Makefiles\fP
+Generate with \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link'\&.
+.TP
+.B \fBKate \- Ninja\fP
+Generate with \X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link'\&.
+.TP
+.B \fBKate \- Ninja Multi\-Config\fP
+Generate with \X'tty: link #generator:Ninja Multi-Config'\fI\%Ninja Multi\-Config\fP\X'tty: link'\&.
+.TP
+.B \fBKate \- Unix Makefiles\fP
+Generate with \X'tty: link #generator:Unix Makefiles'\fI\%Unix Makefiles\fP\X'tty: link'\&.
+.UNINDENT
+.SS Sublime Text 2
+.sp
+Deprecated since version 3.27: Support for \X'tty: link #extra-generators'\fI\%Extra Generators\fP\X'tty: link' is deprecated and will be removed from
+a future version of CMake.  IDEs may use the \X'tty: link #manual:cmake-file-api(7)'\fI\%cmake\-file\-api(7)\fP\X'tty: link'
+to view CMake\-generated project build trees.
+
+.sp
+Generates Sublime Text 2 project files.
+.sp
+Project files for Sublime Text 2 will be created in the top directory
+and in every subdirectory which features a \fBCMakeLists.txt\fP file
+containing a \X'tty: link #command:project'\fI\%project()\fP\X'tty: link' call.  Additionally \fBMakefiles\fP
+(or \fBbuild.ninja\fP files) are generated into the build tree.
+The appropriate make program can build the project through the default \fBall\fP
+target.  An \fBinstall\fP target is also provided.
+.sp
+This \(dqextra\(dq generator may be specified as:
+.INDENT 0.0
+.TP
+.B \fBSublime Text 2 \- MinGW Makefiles\fP
+Generate with \X'tty: link #generator:MinGW Makefiles'\fI\%MinGW Makefiles\fP\X'tty: link'\&.
+.TP
+.B \fBSublime Text 2 \- NMake Makefiles\fP
+Generate with \X'tty: link #generator:NMake Makefiles'\fI\%NMake Makefiles\fP\X'tty: link'\&.
+.TP
+.B \fBSublime Text 2 \- Ninja\fP
+Generate with \X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link'\&.
+.TP
+.B \fBSublime Text 2 \- Unix Makefiles\fP
+Generate with \X'tty: link #generator:Unix Makefiles'\fI\%Unix Makefiles\fP\X'tty: link'\&.
+.UNINDENT
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-language.7

@@ -0,0 +1,684 @@
+.\" 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-LANGUAGE" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-language \- CMake Language Reference
+.SH ORGANIZATION
+.sp
+CMake input files are written in the \(dqCMake Language\(dq in source files
+named \fBCMakeLists.txt\fP or ending in a \fB\&.cmake\fP file name extension.
+.sp
+CMake Language source files in a project are organized into:
+.INDENT 0.0
+.IP \(bu 2
+\fI\%Directories\fP (\fBCMakeLists.txt\fP),
+.IP \(bu 2
+\fI\%Scripts\fP (\fB<script>.cmake\fP), and
+.IP \(bu 2
+\fI\%Modules\fP (\fB<module>.cmake\fP).
+.UNINDENT
+.SS Directories
+.sp
+When CMake processes a project source tree, the entry point is
+a source file called \fBCMakeLists.txt\fP in the top\-level source
+directory.  This file may contain the entire build specification
+or use the \X'tty: link #command:add_subdirectory'\fI\%add_subdirectory()\fP\X'tty: link' command to add subdirectories
+to the build.  Each subdirectory added by the command must also
+contain a \fBCMakeLists.txt\fP file as the entry point to that
+directory.  For each source directory whose \fBCMakeLists.txt\fP file
+is processed CMake generates a corresponding directory in the build
+tree to act as the default working and output directory.
+.SS Scripts
+.sp
+An individual \fB<script>.cmake\fP source file may be processed
+in \fIscript mode\fP by using the \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' command\-line tool
+with the \X'tty: link #cmdoption-cmake-P'\fI\%\-P\fP\X'tty: link' option.  Script mode simply runs
+the commands in the given CMake Language source file and does not
+generate a build system.  It does not allow CMake commands that
+define build targets or actions.
+.SS Modules
+.sp
+CMake Language code in either \fI\%Directories\fP or \fI\%Scripts\fP may
+use the \X'tty: link #command:include'\fI\%include()\fP\X'tty: link' command to load a \fB<module>.cmake\fP
+source file in the scope of the including context.
+See the \X'tty: link #manual:cmake-modules(7)'\fI\%cmake\-modules(7)\fP\X'tty: link' manual page for documentation
+of modules included with the CMake distribution.
+Project source trees may also provide their own modules and
+specify their location(s) in the \X'tty: link #variable:CMAKE_MODULE_PATH'\fI\%CMAKE_MODULE_PATH\fP\X'tty: link'
+variable.
+.SH SYNTAX
+.SS Encoding
+.sp
+A CMake Language source file may be written in 7\-bit ASCII text for
+maximum portability across all supported platforms.  Newlines may be
+encoded as either \fB\en\fP or \fB\er\en\fP but will be converted to \fB\en\fP
+as input files are read.
+.sp
+Note that the implementation is 8\-bit clean so source files may
+be encoded as UTF\-8 on platforms with system APIs supporting this
+encoding.  In addition, CMake 3.2 and above support source files
+encoded in UTF\-8 on Windows (using UTF\-16 to call system APIs).
+Furthermore, CMake 3.0 and above allow a leading UTF\-8
+\X'tty: link https://en.wikipedia.org/wiki/Byte_order_mark'\fI\%Byte\-Order Mark\fP\X'tty: link' in source files.
+.SS Source Files
+.sp
+A CMake Language source file consists of zero or more
+\fI\%Command Invocations\fP separated by newlines and optionally
+spaces and \fI\%Comments\fP:
+.sp
+.nf
+\fBfile        \fP ::=  \fI\%file_element\fP*
+\fBfile_element\fP ::=  \fI\%command_invocation\fP \fI\%line_ending\fP |
+                  (\fI\%bracket_comment\fP|\fI\%space\fP)* \fI\%line_ending\fP
+\fBline_ending \fP ::=  \fI\%line_comment\fP? \fI\%newline\fP
+\fBspace       \fP ::=  <match \(aq[ \et]+\(aq>
+\fBnewline     \fP ::=  <match \(aq\en\(aq>
+
+.fi
+.sp
+Note that any source file line not inside \fI\%Command Arguments\fP or
+a \fI\%Bracket Comment\fP can end in a \fI\%Line Comment\fP\&.
+.SS Command Invocations
+.sp
+A \fIcommand invocation\fP is a name followed by paren\-enclosed arguments
+separated by whitespace:
+.sp
+.nf
+\fBcommand_invocation \fP ::=  \fI\%space\fP* \fI\%identifier\fP \fI\%space\fP* \(aq(\(aq \fI\%arguments\fP \(aq)\(aq
+\fBidentifier         \fP ::=  <match \(aq[A\-Za\-z_][A\-Za\-z0\-9_]*\(aq>
+\fBarguments          \fP ::=  \fI\%argument\fP? \fI\%separated_arguments\fP*
+\fBseparated_arguments\fP ::=  \fI\%separation\fP+ \fI\%argument\fP? |
+                         \fI\%separation\fP* \(aq(\(aq \fI\%arguments\fP \(aq)\(aq
+\fBseparation         \fP ::=  \fI\%space\fP | \fI\%line_ending\fP
+
+.fi
+.sp
+For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_executable(hello world.c)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Command names are case\-insensitive.
+Nested unquoted parentheses in the arguments must balance.
+Each \fB(\fP or \fB)\fP is given to the command invocation as
+a literal \fI\%Unquoted Argument\fP\&.  This may be used in calls
+to the \X'tty: link #command:if'\fI\%if()\fP\X'tty: link' command to enclose conditions.
+For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+if(FALSE AND (FALSE OR TRUE)) # evaluates to FALSE
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+CMake versions prior to 3.0 require command name identifiers
+to be at least 2 characters.
+.sp
+CMake versions prior to 2.8.12 silently accept an \fI\%Unquoted Argument\fP
+or a \fI\%Quoted Argument\fP immediately following a \fI\%Quoted Argument\fP and
+not separated by any whitespace.  For compatibility, CMake 2.8.12 and
+higher accept such code but produce a warning.
+.UNINDENT
+.UNINDENT
+.SS Command Arguments
+.sp
+There are three types of arguments within \fI\%Command Invocations\fP:
+.sp
+.nf
+\fBargument\fP ::=  \fI\%bracket_argument\fP | \fI\%quoted_argument\fP | \fI\%unquoted_argument\fP
+
+.fi
+.SS Bracket Argument
+.sp
+A \fIbracket argument\fP, inspired by \X'tty: link https://www.lua.org/'\fI\%Lua\fP\X'tty: link' long bracket syntax,
+encloses content between opening and closing \(dqbrackets\(dq of the
+same length:
+.sp
+.nf
+\fBbracket_argument\fP ::=  \fI\%bracket_open\fP \fI\%bracket_content\fP \fI\%bracket_close\fP
+\fBbracket_open    \fP ::=  \(aq[\(aq \(aq=\(aq* \(aq[\(aq
+\fBbracket_content \fP ::=  <any text not containing a \fI\%bracket_close\fP with
+                       the same number of \(aq=\(aq as the \fI\%bracket_open\fP>
+\fBbracket_close   \fP ::=  \(aq]\(aq \(aq=\(aq* \(aq]\(aq
+
+.fi
+.sp
+An opening bracket is written \fB[\fP followed by zero or more \fB=\fP followed
+by \fB[\fP\&.  The corresponding closing bracket is written \fB]\fP followed
+by the same number of \fB=\fP followed by \fB]\fP\&.
+Brackets do not nest.  A unique length may always be chosen
+for the opening and closing brackets to contain closing brackets
+of other lengths.
+.sp
+Bracket argument content consists of all text between the opening
+and closing brackets, except that one newline immediately following
+the opening bracket, if any, is ignored.  No evaluation of the
+enclosed content, such as \fI\%Escape Sequences\fP or \fI\%Variable References\fP,
+is performed.  A bracket argument is always given to the command
+invocation as exactly one argument.
+.sp
+For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+message([=[
+This is the first line in a bracket argument with bracket length 1.
+No \e\-escape sequences or ${variable} references are evaluated.
+This is always one argument even though it contains a ; character.
+The text does not end on a closing bracket of length 0 like ]].
+It does end in a closing bracket of length 1.
+]=])
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+CMake versions prior to 3.0 do not support bracket arguments.
+They interpret the opening bracket as the start of an
+\fI\%Unquoted Argument\fP\&.
+.UNINDENT
+.UNINDENT
+.SS Quoted Argument
+.sp
+A \fIquoted argument\fP encloses content between opening and closing
+double\-quote characters:
+.sp
+.nf
+\fBquoted_argument    \fP ::=  \(aq\(dq\(aq \fI\%quoted_element\fP* \(aq\(dq\(aq
+\fBquoted_element     \fP ::=  <any character except \(aq\e\(aq or \(aq\(dq\(aq> |
+                         \fI\%escape_sequence\fP |
+                         \fI\%quoted_continuation\fP
+\fBquoted_continuation\fP ::=  \(aq\e\(aq \fI\%newline\fP
+
+.fi
+.sp
+Quoted argument content consists of all text between opening and
+closing quotes.  Both \fI\%Escape Sequences\fP and \fI\%Variable References\fP
+are evaluated.  A quoted argument is always given to the command
+invocation as exactly one argument.
+.sp
+For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+message(\(dqThis is a quoted argument containing multiple lines.
+This is always one argument even though it contains a ; character.
+Both \e\e\-escape sequences and ${variable} references are evaluated.
+The text does not end on an escaped double\-quote like \e\(dq.
+It does end in an unescaped double quote.
+\(dq)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The final \fB\e\fP on any line ending in an odd number of backslashes
+is treated as a line continuation and ignored along with the
+immediately following newline character.  For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+message(\(dq\e
+This is the first line of a quoted argument. \e
+In fact it is the only line but since it is long \e
+the source code uses line continuation.\e
+\(dq)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+CMake versions prior to 3.0 do not support continuation with \fB\e\fP\&.
+They report errors in quoted arguments containing lines ending in
+an odd number of \fB\e\fP characters.
+.UNINDENT
+.UNINDENT
+.SS Unquoted Argument
+.sp
+An \fIunquoted argument\fP is not enclosed by any quoting syntax.
+It may not contain any whitespace, \fB(\fP, \fB)\fP, \fB#\fP, \fB\(dq\fP, or \fB\e\fP
+except when escaped by a backslash:
+.sp
+.nf
+\fBunquoted_argument\fP ::=  \fI\%unquoted_element\fP+ | \fI\%unquoted_legacy\fP
+\fBunquoted_element \fP ::=  <any character except whitespace or one of \(aq()#\(dq\e\(aq> |
+                       \fI\%escape_sequence\fP
+\fBunquoted_legacy  \fP ::=  <see note in text>
+
+.fi
+.sp
+Unquoted argument content consists of all text in a contiguous block
+of allowed or escaped characters.  Both \fI\%Escape Sequences\fP and
+\fI\%Variable References\fP are evaluated.  The resulting value is divided
+in the same way \fI\%Lists\fP divide into elements.  Each non\-empty element
+is given to the command invocation as an argument.  Therefore an
+unquoted argument may be given to a command invocation as zero or
+more arguments.
+.sp
+For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+foreach(arg
+    NoSpace
+    Escaped\e Space
+    This;Divides;Into;Five;Arguments
+    Escaped\e;Semicolon
+    )
+  message(\(dq${arg}\(dq)
+endforeach()
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+To support legacy CMake code, unquoted arguments may also contain
+double\-quoted strings (\fB\(dq...\(dq\fP, possibly enclosing horizontal
+whitespace), and make\-style variable references (\fB$(MAKEVAR)\fP).
+.sp
+Unescaped double\-quotes must balance, may not appear at the
+beginning of an unquoted argument, and are treated as part of the
+content.  For example, the unquoted arguments \fB\-Da=\(dqb c\(dq\fP,
+\fB\-Da=$(v)\fP, and \fBa\(dq \(dqb\(dqc\(dqd\fP are each interpreted literally.
+They may instead be written as quoted arguments \fB\(dq\-Da=\e\(dqb c\e\(dq\(dq\fP,
+\fB\(dq\-Da=$(v)\(dq\fP, and \fB\(dqa\e\(dq \e\(dqb\e\(dqc\e\(dqd\(dq\fP, respectively.
+.sp
+Make\-style references are treated literally as part of the content
+and do not undergo variable expansion.  They are treated as part
+of a single argument (rather than as separate \fB$\fP, \fB(\fP,
+\fBMAKEVAR\fP, and \fB)\fP arguments).
+.sp
+The above \(dqunquoted_legacy\(dq production represents such arguments.
+We do not recommend using legacy unquoted arguments in new code.
+Instead use a \fI\%Quoted Argument\fP or a \fI\%Bracket Argument\fP to
+represent the content.
+.UNINDENT
+.UNINDENT
+.SS Escape Sequences
+.sp
+An \fIescape sequence\fP is a \fB\e\fP followed by one character:
+.sp
+.nf
+\fBescape_sequence \fP ::=  \fI\%escape_identity\fP | \fI\%escape_encoded\fP | \fI\%escape_semicolon\fP
+\fBescape_identity \fP ::=  \(aq\e\(aq <match \(aq[^A\-Za\-z0\-9;]\(aq>
+\fBescape_encoded  \fP ::=  \(aq\et\(aq | \(aq\er\(aq | \(aq\en\(aq
+\fBescape_semicolon\fP ::=  \(aq\e;\(aq
+
+.fi
+.sp
+A \fB\e\fP followed by a non\-alphanumeric character simply encodes the literal
+character without interpreting it as syntax.  A \fB\et\fP, \fB\er\fP, or \fB\en\fP
+encodes a tab, carriage return, or newline character, respectively. A \fB\e;\fP
+outside of any \fI\%Variable References\fP  encodes itself but may be used in an
+\fI\%Unquoted Argument\fP to encode the \fB;\fP without dividing the argument
+value on it.  A \fB\e;\fP inside \fI\%Variable References\fP encodes the literal
+\fB;\fP character.  (See also policy \X'tty: link #policy:CMP0053'\fI\%CMP0053\fP\X'tty: link' documentation for
+historical considerations.)
+.SS Variable References
+.sp
+A \fIvariable reference\fP has the form \fB${<variable>}\fP and is
+evaluated inside a \fI\%Quoted Argument\fP or an \fI\%Unquoted Argument\fP\&.
+A variable reference is replaced by the value of the specified
+variable or cache entry, or if neither is set, by the empty string.
+Variable references can nest and are evaluated from the
+inside out, e.g. \fB${outer_${inner_variable}_variable}\fP\&.
+.sp
+Literal variable references may consist of alphanumeric characters,
+the characters \fB/_.+\-\fP, and \fI\%Escape Sequences\fP\&.  Nested references
+may be used to evaluate variables of any name.  See also policy
+\X'tty: link #policy:CMP0053'\fI\%CMP0053\fP\X'tty: link' documentation for historical considerations and reasons why
+the \fB$\fP is also technically permitted but is discouraged.
+.sp
+The \fI\%Variables\fP section documents the scope of variable names
+and how their values are set.
+.sp
+An \fIenvironment variable reference\fP has the form \fB$ENV{<variable>}\fP\&.
+See the \fI\%Environment Variables\fP section for more information.
+.sp
+A \fIcache variable reference\fP has the form \fB$CACHE{<variable>}\fP,
+and is replaced by the value of the specified cache entry without
+checking for a normal variable of the same name.  If the cache
+entry does not exist, it is replaced by the empty string.
+See \X'tty: link #variable:CACHE'\fI\%CACHE\fP\X'tty: link' for more information.
+.sp
+The \X'tty: link #command:if'\fI\%if()\fP\X'tty: link' command has a special condition syntax that
+allows for variable references in the short form \fB<variable>\fP
+instead of \fB${<variable>}\fP\&.  However, environment variables
+always need to be referenced as \fB$ENV{<variable>}\fP\&.
+.SS Comments
+.sp
+A comment starts with a \fB#\fP character that is not inside a
+\fI\%Bracket Argument\fP, \fI\%Quoted Argument\fP, or escaped with \fB\e\fP
+as part of an \fI\%Unquoted Argument\fP\&.  There are two types of
+comments: a \fI\%Bracket Comment\fP and a \fI\%Line Comment\fP\&.
+.SS Bracket Comment
+.sp
+A \fB#\fP immediately followed by a \fI\%bracket_open\fP forms a
+\fIbracket comment\fP consisting of the entire bracket enclosure:
+.sp
+.nf
+\fBbracket_comment\fP ::=  \(aq#\(aq \fI\%bracket_argument\fP
+
+.fi
+.sp
+For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+#[[This is a bracket comment.
+It runs until the close bracket.]]
+message(\(dqFirst Argument\en\(dq #[[Bracket Comment]] \(dqSecond Argument\(dq)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+CMake versions prior to 3.0 do not support bracket comments.
+They interpret the opening \fB#\fP as the start of a \fI\%Line Comment\fP\&.
+.UNINDENT
+.UNINDENT
+.SS Line Comment
+.sp
+A \fB#\fP not immediately followed by a \fI\%bracket_open\fP forms a
+\fIline comment\fP that runs until the end of the line:
+.sp
+.nf
+\fBline_comment\fP ::=  \(aq#\(aq <any text not starting in a \fI\%bracket_open\fP
+                       and not containing a \fI\%newline\fP>
+
+.fi
+.sp
+For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# This is a line comment.
+message(\(dqFirst Argument\en\(dq # This is a line comment :)
+        \(dqSecond Argument\(dq) # This is a line comment.
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH CONTROL STRUCTURES
+.SS Conditional Blocks
+.sp
+The \X'tty: link #command:if'\fI\%if()\fP\X'tty: link'/\X'tty: link #command:elseif'\fI\%elseif()\fP\X'tty: link'/\X'tty: link #command:else'\fI\%else()\fP\X'tty: link'/\X'tty: link #command:endif'\fI\%endif()\fP\X'tty: link'
+commands delimit code blocks to be executed conditionally.
+.SS Loops
+.sp
+The \X'tty: link #command:foreach'\fI\%foreach()\fP\X'tty: link'/\X'tty: link #command:endforeach'\fI\%endforeach()\fP\X'tty: link' and
+\X'tty: link #command:while'\fI\%while()\fP\X'tty: link'/\X'tty: link #command:endwhile'\fI\%endwhile()\fP\X'tty: link' commands delimit code
+blocks to be executed in a loop.  Inside such blocks the
+\X'tty: link #command:break'\fI\%break()\fP\X'tty: link' command may be used to terminate the loop
+early whereas the \X'tty: link #command:continue'\fI\%continue()\fP\X'tty: link' command may be used
+to start with the next iteration immediately.
+.SS Command Definitions
+.sp
+The \X'tty: link #command:macro'\fI\%macro()\fP\X'tty: link'/\X'tty: link #command:endmacro'\fI\%endmacro()\fP\X'tty: link', and
+\X'tty: link #command:function'\fI\%function()\fP\X'tty: link'/\X'tty: link #command:endfunction'\fI\%endfunction()\fP\X'tty: link' commands delimit
+code blocks to be recorded for later invocation as commands.
+.SH VARIABLES
+.sp
+Variables are the basic unit of storage in the CMake Language.
+Their values are always of string type, though some commands may
+interpret the strings as values of other types.
+The \X'tty: link #command:set'\fI\%set()\fP\X'tty: link' and \X'tty: link #command:unset'\fI\%unset()\fP\X'tty: link' commands explicitly
+set or unset a variable, but other commands have semantics
+that modify variables as well.
+Variable names are case\-sensitive and may consist of almost
+any text, but we recommend sticking to names consisting only
+of alphanumeric characters plus \fB_\fP and \fB\-\fP\&.
+.sp
+Variables have dynamic scope.  Each variable \(dqset\(dq or \(dqunset\(dq
+creates a binding in the current scope:
+.INDENT 0.0
+.TP
+.B Block Scope
+The \X'tty: link #command:block'\fI\%block()\fP\X'tty: link' command may create a new scope for variable bindings.
+.TP
+.B Function Scope
+\fI\%Command Definitions\fP created by the \X'tty: link #command:function'\fI\%function()\fP\X'tty: link' command
+create commands that, when invoked, process the recorded commands
+in a new variable binding scope.  A variable \(dqset\(dq or \(dqunset\(dq
+binds in this scope and is visible for the current function and
+any nested calls within it, but not after the function returns.
+.TP
+.B Directory Scope
+Each of the \fI\%Directories\fP in a source tree has its own variable
+bindings.  Before processing the \fBCMakeLists.txt\fP file for a
+directory, CMake copies all variable bindings currently defined
+in the parent directory, if any, to initialize the new directory
+scope.  CMake \fI\%Scripts\fP, when processed with \X'tty: link #cmdoption-cmake-P'\fI\%cmake \-P\fP\X'tty: link',
+bind variables in one \(dqdirectory\(dq scope.
+.sp
+A variable \(dqset\(dq or \(dqunset\(dq not inside a function call binds
+to the current directory scope.
+.TP
+.B Persistent Cache
+CMake stores a separate set of \(dqcache\(dq variables, or \(dqcache entries\(dq,
+whose values persist across multiple runs within a project build
+tree.  Cache entries have an isolated binding scope modified only
+by explicit request, such as by the \fBCACHE\fP option of the
+\X'tty: link #command:set'\fI\%set()\fP\X'tty: link' and \X'tty: link #command:unset'\fI\%unset()\fP\X'tty: link' commands.
+.UNINDENT
+.sp
+When evaluating \fI\%Variable References\fP, CMake first searches the
+function call stack, if any, for a binding and then falls back
+to the binding in the current directory scope, if any.  If a
+\(dqset\(dq binding is found, its value is used.  If an \(dqunset\(dq binding
+is found, or no binding is found, CMake then searches for a
+cache entry.  If a cache entry is found, its value is used.
+Otherwise, the variable reference evaluates to an empty string.
+The \fB$CACHE{VAR}\fP syntax can be used to do direct cache entry
+lookups.
+.sp
+The \X'tty: link #manual:cmake-variables(7)'\fI\%cmake\-variables(7)\fP\X'tty: link' manual documents the many variables
+that are provided by CMake or have meaning to CMake when set
+by project code.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+CMake reserves identifiers that:
+.INDENT 0.0
+.IP \(bu 2
+begin with \fBCMAKE_\fP (upper\-, lower\-, or mixed\-case), or
+.IP \(bu 2
+begin with \fB_CMAKE_\fP (upper\-, lower\-, or mixed\-case), or
+.IP \(bu 2
+begin with \fB_\fP followed by the name of any \X'tty: link #manual:cmake-commands(7)'\fI\%CMake Command\fP\X'tty: link'\&.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SH ENVIRONMENT VARIABLES
+.sp
+Environment Variables are like ordinary \fI\%Variables\fP, with the
+following differences:
+.INDENT 0.0
+.TP
+.B Scope
+Environment variables have global scope in a CMake process.
+They are never cached.
+.TP
+.B References
+\fI\%Variable References\fP have the form \fB$ENV{<variable>}\fP, using the
+\X'tty: link #variable:ENV'\fI\%ENV\fP\X'tty: link' operator.
+.TP
+.B Initialization
+Initial values of the CMake environment variables are those of
+the calling process.
+Values can be changed using the \X'tty: link #command:set'\fI\%set()\fP\X'tty: link' and \X'tty: link #command:unset'\fI\%unset()\fP\X'tty: link'
+commands.
+These commands only affect the running CMake process,
+not the system environment at large.
+Changed values are not written back to the calling process,
+and they are not seen by subsequent build or test processes.
+.sp
+See the \X'tty: link #cmdoption-cmake-E-arg-env'\fI\%cmake \-E env\fP\X'tty: link' command\-line
+tool to run a command in a modified environment.
+.TP
+.B Inspection
+See the \X'tty: link #cmdoption-cmake-E-arg-environment'\fI\%cmake \-E environment\fP\X'tty: link' command\-line
+tool to display all current environment variables.
+.UNINDENT
+.sp
+The \X'tty: link #manual:cmake-env-variables(7)'\fI\%cmake\-env\-variables(7)\fP\X'tty: link' manual documents environment
+variables that have special meaning to CMake.
+.SH LISTS
+.sp
+Although all values in CMake are stored as strings, a string
+may be treated as a list in certain contexts, such as during
+evaluation of an \fI\%Unquoted Argument\fP\&.  In such contexts, a string
+is divided into list elements by splitting on \fB;\fP characters not
+following an unequal number of \fB[\fP and \fB]\fP characters and not
+immediately preceded by a \fB\e\fP\&.  The sequence \fB\e;\fP does not
+divide a value but is replaced by \fB;\fP in the resulting element.
+.sp
+A list of elements is represented as a string by concatenating
+the elements separated by \fB;\fP\&.  For example, the \X'tty: link #command:set'\fI\%set()\fP\X'tty: link'
+command stores multiple values into the destination variable
+as a list:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(srcs a.c b.c c.c) # sets \(dqsrcs\(dq to \(dqa.c;b.c;c.c\(dq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Lists are meant for simple use cases such as a list of source
+files and should not be used for complex data processing tasks.
+Most commands that construct lists do not escape \fB;\fP characters
+in list elements, thus flattening nested lists:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(x a \(dqb;c\(dq) # sets \(dqx\(dq to \(dqa;b;c\(dq, not \(dqa;b\e;c\(dq
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In general, lists do not support elements containing \fB;\fP characters.
+To avoid problems, consider the following advice:
+.INDENT 0.0
+.IP \(bu 2
+The interfaces of many CMake commands, variables, and properties accept
+semicolon\-separated lists.  Avoid passing lists with elements containing
+semicolons to these interfaces unless they document either direct support
+or some way to escape or encode semicolons.
+.IP \(bu 2
+When constructing a list, substitute an otherwise\-unused placeholder
+for \fB;\fP in elements when.  Then substitute \fB;\fP for the placeholder
+when processing list elements.
+For example, the following code uses \fB|\fP in place of \fB;\fP characters:
+.INDENT 2.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(mylist a \(dqb|c\(dq)
+foreach(entry IN LISTS mylist)
+  string(REPLACE \(dq|\(dq \(dq;\(dq entry \(dq${entry}\(dq)
+  # use \(dq${entry}\(dq normally
+endforeach()
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \X'tty: link #module:ExternalProject'\fI\%ExternalProject\fP\X'tty: link' module\(aqs \fBLIST_SEPARATOR\fP option is an
+example of an interface built using this approach.
+.IP \(bu 2
+In lists of \X'tty: link #manual:cmake-generator-expressions(7)'\fI\%generator expressions\fP\X'tty: link',
+use the \X'tty: link #genex:SEMICOLON'\fI\%$<SEMICOLON>\fP\X'tty: link' generator expression.
+.IP \(bu 2
+In command calls, use \fI\%Quoted Argument\fP syntax whenever possible.
+The called command will receive the content of the argument with
+semicolons preserved.  An \fI\%Unquoted Argument\fP will be split on
+semicolons.
+.IP \(bu 2
+In \X'tty: link #command:function'\fI\%function()\fP\X'tty: link' implementations, avoid \fBARGV\fP and \fBARGN\fP,
+which do not distinguish semicolons in values from those separating values.
+Instead, prefer using named positional arguments and the \fBARGC\fP and
+\fBARGV#\fP variables.
+When using \X'tty: link #command:cmake_parse_arguments'\fI\%cmake_parse_arguments()\fP\X'tty: link' to parse arguments, prefer
+its \fBPARSE_ARGV\fP signature, which uses the \fBARGV#\fP variables.
+.sp
+Note that this approach does not apply to \X'tty: link #command:macro'\fI\%macro()\fP\X'tty: link' implementations
+because they reference arguments using placeholders, not real variables.
+.UNINDENT
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-packages.7

@@ -0,0 +1,899 @@
+.\" 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-PACKAGES" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-packages \- CMake Packages Reference
+.SH INTRODUCTION
+.sp
+Packages provide dependency information to CMake based buildsystems.  Packages
+are found with the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command.  The result of
+using \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' is either a set of \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets, or
+a set of variables corresponding to build\-relevant information.
+.SH USING PACKAGES
+.sp
+CMake provides direct support for two forms of packages,
+\fI\%Config\-file Packages\fP and \fI\%Find\-module Packages\fP\&.
+Indirect support for \fBpkg\-config\fP packages is also provided via
+the \X'tty: link #module:FindPkgConfig'\fI\%FindPkgConfig\fP\X'tty: link' module.  In all cases, the basic form
+of \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' calls is the same:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_package(Qt4 4.7.0 REQUIRED) # CMake provides a Qt4 find\-module
+find_package(Qt5Core 5.1.0 REQUIRED) # Qt provides a Qt5 package config file.
+find_package(LibXml2 REQUIRED) # Use pkg\-config via the LibXml2 find\-module
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+In cases where it is known that a package configuration file is provided by
+upstream, and only that should be used, the \fBCONFIG\fP keyword may be passed
+to \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link':
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_package(Qt5Core 5.1.0 CONFIG REQUIRED)
+find_package(Qt5Gui 5.1.0 CONFIG)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Similarly, the \fBMODULE\fP keyword says to use only a find\-module:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_package(Qt4 4.7.0 MODULE REQUIRED)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Specifying the type of package explicitly improves the error message shown to
+the user if it is not found.
+.sp
+Both types of packages also support specifying components of a package,
+either after the \fBREQUIRED\fP keyword:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_package(Qt5 5.1.0 CONFIG REQUIRED Widgets Xml Sql)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+or as a separate \fBCOMPONENTS\fP list:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_package(Qt5 5.1.0 COMPONENTS Widgets Xml Sql)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+or as a separate \fBOPTIONAL_COMPONENTS\fP list:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_package(Qt5 5.1.0 COMPONENTS Widgets
+                       OPTIONAL_COMPONENTS Xml Sql
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Handling of \fBCOMPONENTS\fP and \fBOPTIONAL_COMPONENTS\fP is defined by the
+package.
+.sp
+By setting the \X'tty: link #variable:CMAKE_DISABLE_FIND_PACKAGE_<PackageName>'\fI\%CMAKE_DISABLE_FIND_PACKAGE_<PackageName>\fP\X'tty: link' variable to
+\fBTRUE\fP, the \fB<PackageName>\fP package will not be searched, and will always
+be \fBNOTFOUND\fP\&. Likewise, setting the
+\X'tty: link #variable:CMAKE_REQUIRE_FIND_PACKAGE_<PackageName>'\fI\%CMAKE_REQUIRE_FIND_PACKAGE_<PackageName>\fP\X'tty: link' to \fBTRUE\fP will make the
+package REQUIRED.
+.SS Config\-file Packages
+.sp
+A config\-file package is a set of files provided by upstreams for downstreams
+to use. CMake searches in a number of locations for package configuration files, as
+described in the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' documentation.  The most simple way for
+a CMake user to tell \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' to search in a non\-standard prefix for
+a package is to set the \fBCMAKE_PREFIX_PATH\fP cache variable.
+.sp
+Config\-file packages are provided by upstream vendors as part of development
+packages, that is, they belong with the header files and any other files
+provided to assist downstreams in using the package.
+.sp
+A set of variables which provide package status information are also set
+automatically when using a config\-file package.  The \fB<PackageName>_FOUND\fP
+variable is set to true or false, depending on whether the package was
+found.  The \fB<PackageName>_DIR\fP cache variable is set to the location of the
+package configuration file.
+.SS Find\-module Packages
+.sp
+A find module is a file with a set of rules for finding the required pieces of
+a dependency, primarily header files and libraries.  Typically, a find module
+is needed when the upstream is not built with CMake, or is not CMake\-aware
+enough to otherwise provide a package configuration file.  Unlike a package configuration
+file, it is not shipped with upstream, but is used by downstream to find the
+files by guessing locations of files with platform\-specific hints.
+.sp
+Unlike the case of an upstream\-provided package configuration file, no single point
+of reference identifies the package as being found, so the \fB<PackageName>_FOUND\fP
+variable is not automatically set by the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command.  It
+can still be expected to be set by convention however and should be set by
+the author of the Find\-module.  Similarly there is no \fB<PackageName>_DIR\fP variable,
+but each of the artifacts such as library locations and header file locations
+provide a separate cache variable.
+.sp
+See the \X'tty: link #manual:cmake-developer(7)'\fI\%cmake\-developer(7)\fP\X'tty: link' manual for more information about creating
+Find\-module files.
+.SH PACKAGE LAYOUT
+.sp
+A config\-file package consists of a \fI\%Package Configuration File\fP and
+optionally a \fI\%Package Version File\fP provided with the project distribution.
+.SS Package Configuration File
+.sp
+Consider a project \fBFoo\fP that installs the following files:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<prefix>/include/foo\-1.2/foo.h
+<prefix>/lib/foo\-1.2/libfoo.a
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+It may also provide a CMake package configuration file:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<prefix>/lib/cmake/foo\-1.2/FooConfig.cmake
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+with content defining \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets, or defining variables, such
+as:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# ...
+# (compute PREFIX relative to file location)
+# ...
+set(Foo_INCLUDE_DIRS ${PREFIX}/include/foo\-1.2)
+set(Foo_LIBRARIES ${PREFIX}/lib/foo\-1.2/libfoo.a)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+If another project wishes to use \fBFoo\fP it need only to locate the \fBFooConfig.cmake\fP
+file and load it to get all the information it needs about package content
+locations.  Since the package configuration file is provided by the package
+installation it already knows all the file locations.
+.sp
+The \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command may be used to search for the package
+configuration file.  This command constructs a set of installation prefixes
+and searches under each prefix in several locations.  Given the name \fBFoo\fP,
+it looks for a file called \fBFooConfig.cmake\fP or \fBfoo\-config.cmake\fP\&.
+The full set of locations is specified in the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command
+documentation. One place it looks is:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<prefix>/lib/cmake/Foo*/
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+where \fBFoo*\fP is a case\-insensitive globbing expression.  In our example the
+globbing expression will match \fB<prefix>/lib/cmake/foo\-1.2\fP and the package
+configuration file will be found.
+.sp
+Once found, a package configuration file is immediately loaded.  It, together
+with a package version file, contains all the information the project needs to
+use the package.
+.SS Package Version File
+.sp
+When the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command finds a candidate package configuration
+file it looks next to it for a version file. The version file is loaded to test
+whether the package version is an acceptable match for the version requested.
+If the version file claims compatibility the configuration file is accepted.
+Otherwise it is ignored.
+.sp
+The name of the package version file must match that of the package configuration
+file but has either \fB\-version\fP or \fBVersion\fP appended to the name before
+the \fB\&.cmake\fP extension.  For example, the files:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<prefix>/lib/cmake/foo\-1.3/foo\-config.cmake
+<prefix>/lib/cmake/foo\-1.3/foo\-config\-version.cmake
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+and:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+<prefix>/lib/cmake/bar\-4.2/BarConfig.cmake
+<prefix>/lib/cmake/bar\-4.2/BarConfigVersion.cmake
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+are each pairs of package configuration files and corresponding package version
+files.
+.sp
+When the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command loads a version file it first sets the
+following variables:
+.INDENT 0.0
+.TP
+.B \fBPACKAGE_FIND_NAME\fP
+The \fB<PackageName>\fP
+.TP
+.B \fBPACKAGE_FIND_VERSION\fP
+Full requested version string
+.TP
+.B \fBPACKAGE_FIND_VERSION_MAJOR\fP
+Major version if requested, else 0
+.TP
+.B \fBPACKAGE_FIND_VERSION_MINOR\fP
+Minor version if requested, else 0
+.TP
+.B \fBPACKAGE_FIND_VERSION_PATCH\fP
+Patch version if requested, else 0
+.TP
+.B \fBPACKAGE_FIND_VERSION_TWEAK\fP
+Tweak version if requested, else 0
+.TP
+.B \fBPACKAGE_FIND_VERSION_COUNT\fP
+Number of version components, 0 to 4
+.UNINDENT
+.sp
+The version file must use these variables to check whether it is compatible or
+an exact match for the requested version and set the following variables with
+results:
+.INDENT 0.0
+.TP
+.B \fBPACKAGE_VERSION\fP
+Full provided version string
+.TP
+.B \fBPACKAGE_VERSION_EXACT\fP
+True if version is exact match
+.TP
+.B \fBPACKAGE_VERSION_COMPATIBLE\fP
+True if version is compatible
+.TP
+.B \fBPACKAGE_VERSION_UNSUITABLE\fP
+True if unsuitable as any version
+.UNINDENT
+.sp
+Version files are loaded in a nested scope so they are free to set any variables
+they wish as part of their computation. The find_package command wipes out the
+scope when the version file has completed and it has checked the output
+variables. When the version file claims to be an acceptable match for the
+requested version the find_package command sets the following variables for
+use by the project:
+.INDENT 0.0
+.TP
+.B \fB<PackageName>_VERSION\fP
+Full provided version string
+.TP
+.B \fB<PackageName>_VERSION_MAJOR\fP
+Major version if provided, else 0
+.TP
+.B \fB<PackageName>_VERSION_MINOR\fP
+Minor version if provided, else 0
+.TP
+.B \fB<PackageName>_VERSION_PATCH\fP
+Patch version if provided, else 0
+.TP
+.B \fB<PackageName>_VERSION_TWEAK\fP
+Tweak version if provided, else 0
+.TP
+.B \fB<PackageName>_VERSION_COUNT\fP
+Number of version components, 0 to 4
+.UNINDENT
+.sp
+The variables report the version of the package that was actually found.
+The \fB<PackageName>\fP part of their name matches the argument given to the
+\X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command.
+.SH CREATING PACKAGES
+.sp
+Usually, the upstream depends on CMake itself and can use some CMake facilities
+for creating the package files. Consider an upstream which provides a single
+shared library:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+project(UpstreamLib)
+
+set(CMAKE_INCLUDE_CURRENT_DIR ON)
+set(CMAKE_INCLUDE_CURRENT_DIR_IN_INTERFACE ON)
+
+set(Upstream_VERSION 3.4.1)
+
+include(GenerateExportHeader)
+
+add_library(ClimbingStats SHARED climbingstats.cpp)
+generate_export_header(ClimbingStats)
+set_property(TARGET ClimbingStats PROPERTY VERSION ${Upstream_VERSION})
+set_property(TARGET ClimbingStats PROPERTY SOVERSION 3)
+set_property(TARGET ClimbingStats PROPERTY
+  INTERFACE_ClimbingStats_MAJOR_VERSION 3)
+set_property(TARGET ClimbingStats APPEND PROPERTY
+  COMPATIBLE_INTERFACE_STRING ClimbingStats_MAJOR_VERSION
+)
+
+install(TARGETS ClimbingStats EXPORT ClimbingStatsTargets
+  LIBRARY DESTINATION lib
+  ARCHIVE DESTINATION lib
+  RUNTIME DESTINATION bin
+  INCLUDES DESTINATION include
+)
+install(
+  FILES
+    climbingstats.h
+    \(dq${CMAKE_CURRENT_BINARY_DIR}/climbingstats_export.h\(dq
+  DESTINATION
+    include
+  COMPONENT
+    Devel
+)
+
+include(CMakePackageConfigHelpers)
+write_basic_package_version_file(
+  \(dq${CMAKE_CURRENT_BINARY_DIR}/ClimbingStats/ClimbingStatsConfigVersion.cmake\(dq
+  VERSION ${Upstream_VERSION}
+  COMPATIBILITY AnyNewerVersion
+)
+
+export(EXPORT ClimbingStatsTargets
+  FILE \(dq${CMAKE_CURRENT_BINARY_DIR}/ClimbingStats/ClimbingStatsTargets.cmake\(dq
+  NAMESPACE Upstream::
+)
+configure_file(cmake/ClimbingStatsConfig.cmake
+  \(dq${CMAKE_CURRENT_BINARY_DIR}/ClimbingStats/ClimbingStatsConfig.cmake\(dq
+  COPYONLY
+)
+
+set(ConfigPackageLocation lib/cmake/ClimbingStats)
+install(EXPORT ClimbingStatsTargets
+  FILE
+    ClimbingStatsTargets.cmake
+  NAMESPACE
+    Upstream::
+  DESTINATION
+    ${ConfigPackageLocation}
+)
+install(
+  FILES
+    cmake/ClimbingStatsConfig.cmake
+    \(dq${CMAKE_CURRENT_BINARY_DIR}/ClimbingStats/ClimbingStatsConfigVersion.cmake\(dq
+  DESTINATION
+    ${ConfigPackageLocation}
+  COMPONENT
+    Devel
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \X'tty: link #module:CMakePackageConfigHelpers'\fI\%CMakePackageConfigHelpers\fP\X'tty: link' module provides a macro for creating
+a simple \fBConfigVersion.cmake\fP file.  This file sets the version of the
+package.  It is read by CMake when \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' is called to
+determine the compatibility with the requested version, and to set some
+version\-specific variables \fB<PackageName>_VERSION\fP, \fB<PackageName>_VERSION_MAJOR\fP,
+\fB<PackageName>_VERSION_MINOR\fP etc.  The \X'tty: link #export'\fI\%install(EXPORT)\fP\X'tty: link' command is
+used to export the targets in the \fBClimbingStatsTargets\fP export\-set, defined
+previously by the \X'tty: link #targets'\fI\%install(TARGETS)\fP\X'tty: link' command. This command generates
+the \fBClimbingStatsTargets.cmake\fP file to contain \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link'
+targets, suitable for use by downstreams and arranges to install it to
+\fBlib/cmake/ClimbingStats\fP\&.  The generated \fBClimbingStatsConfigVersion.cmake\fP
+and a \fBcmake/ClimbingStatsConfig.cmake\fP are installed to the same location,
+completing the package.
+.sp
+The generated \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets have appropriate properties set
+to define their \X'tty: link #target-usage-requirements'\fI\%usage requirements\fP\X'tty: link', such as
+\X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link',
+\X'tty: link #prop_tgt:INTERFACE_COMPILE_DEFINITIONS'\fI\%INTERFACE_COMPILE_DEFINITIONS\fP\X'tty: link' and other relevant built\-in
+\fBINTERFACE_\fP properties.  The \fBINTERFACE\fP variant of user\-defined
+properties listed in \X'tty: link #prop_tgt:COMPATIBLE_INTERFACE_STRING'\fI\%COMPATIBLE_INTERFACE_STRING\fP\X'tty: link' and
+other \X'tty: link #compatible-interface-properties'\fI\%Compatible Interface Properties\fP\X'tty: link' are also propagated to the
+generated \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets.  In the above case,
+\fBClimbingStats_MAJOR_VERSION\fP is defined as a string which must be
+compatible among the dependencies of any depender.  By setting this custom
+defined user property in this version and in the next version of
+\fBClimbingStats\fP, \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' will issue a diagnostic if there is an
+attempt to use version 3 together with version 4.  Packages can choose to
+employ such a pattern if different major versions of the package are designed
+to be incompatible.
+.sp
+A \fBNAMESPACE\fP with double\-colons is specified when exporting the targets
+for installation.  This convention of double\-colons gives CMake a hint that
+the name is an \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' target when it is used by downstreams
+with the \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' command.  This way, CMake can
+issue a diagnostic if the package providing it has not yet been found.
+.sp
+In this case, when using \X'tty: link #targets'\fI\%install(TARGETS)\fP\X'tty: link' the \fBINCLUDES DESTINATION\fP
+was specified.  This causes the \fBIMPORTED\fP targets to have their
+\X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link' populated with the \fBinclude\fP
+directory in the \X'tty: link #variable:CMAKE_INSTALL_PREFIX'\fI\%CMAKE_INSTALL_PREFIX\fP\X'tty: link'\&.  When the \fBIMPORTED\fP
+target is used by downstream, it automatically consumes the entries from
+that property.
+.SS Creating a Package Configuration File
+.sp
+In this case, the \fBClimbingStatsConfig.cmake\fP file could be as simple as:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+include(\(dq${CMAKE_CURRENT_LIST_DIR}/ClimbingStatsTargets.cmake\(dq)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+As this allows downstreams to use the \fBIMPORTED\fP targets.  If any macros
+should be provided by the \fBClimbingStats\fP package, they should
+be in a separate file which is installed to the same location as the
+\fBClimbingStatsConfig.cmake\fP file, and included from there.
+.sp
+This can also be extended to cover dependencies:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# ...
+add_library(ClimbingStats SHARED climbingstats.cpp)
+generate_export_header(ClimbingStats)
+
+find_package(Stats 2.6.4 REQUIRED)
+target_link_libraries(ClimbingStats PUBLIC Stats::Types)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+As the \fBStats::Types\fP target is a \fBPUBLIC\fP dependency of \fBClimbingStats\fP,
+downstreams must also find the \fBStats\fP package and link to the \fBStats::Types\fP
+library.  The \fBStats\fP package should be found in the \fBClimbingStatsConfig.cmake\fP
+file to ensure this.  The \fBfind_dependency\fP macro from the
+\X'tty: link #module:CMakeFindDependencyMacro'\fI\%CMakeFindDependencyMacro\fP\X'tty: link' helps with this by propagating
+whether the package is \fBREQUIRED\fP, or \fBQUIET\fP etc.  All \fBREQUIRED\fP
+dependencies of a package should be found in the \fBConfig.cmake\fP file:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+include(CMakeFindDependencyMacro)
+find_dependency(Stats 2.6.4)
+
+include(\(dq${CMAKE_CURRENT_LIST_DIR}/ClimbingStatsTargets.cmake\(dq)
+include(\(dq${CMAKE_CURRENT_LIST_DIR}/ClimbingStatsMacros.cmake\(dq)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \fBfind_dependency\fP macro also sets \fBClimbingStats_FOUND\fP to \fBFalse\fP if
+the dependency is not found, along with a diagnostic that the \fBClimbingStats\fP
+package can not be used without the \fBStats\fP package.
+.sp
+If \fBCOMPONENTS\fP are specified when the downstream uses \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link',
+they are listed in the \fB<PackageName>_FIND_COMPONENTS\fP variable. If a particular
+component is non\-optional, then the \fB<PackageName>_FIND_REQUIRED_<comp>\fP will
+be true. This can be tested with logic in the package configuration file:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+include(CMakeFindDependencyMacro)
+find_dependency(Stats 2.6.4)
+
+include(\(dq${CMAKE_CURRENT_LIST_DIR}/ClimbingStatsTargets.cmake\(dq)
+include(\(dq${CMAKE_CURRENT_LIST_DIR}/ClimbingStatsMacros.cmake\(dq)
+
+set(_ClimbingStats_supported_components Plot Table)
+
+foreach(_comp ${ClimbingStats_FIND_COMPONENTS})
+  if (NOT \(dq;${_ClimbingStats_supported_components};\(dq MATCHES \(dq;${_comp};\(dq)
+    set(ClimbingStats_FOUND False)
+    set(ClimbingStats_NOT_FOUND_MESSAGE \(dqUnsupported component: ${_comp}\(dq)
+  endif()
+  include(\(dq${CMAKE_CURRENT_LIST_DIR}/ClimbingStats${_comp}Targets.cmake\(dq)
+endforeach()
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Here, the \fBClimbingStats_NOT_FOUND_MESSAGE\fP is set to a diagnosis that the package
+could not be found because an invalid component was specified.  This message
+variable can be set for any case where the \fB_FOUND\fP variable is set to \fBFalse\fP,
+and will be displayed to the user.
+.SS Creating a Package Configuration File for the Build Tree
+.sp
+The \X'tty: link #command:export'\fI\%export(EXPORT)\fP\X'tty: link' command creates an \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets
+definition file which is specific to the build\-tree, and is not relocatable.
+This can similarly be used with a suitable package configuration file and
+package version file to define a package for the build tree which may be used
+without installation.  Consumers of the build tree can simply ensure that the
+\X'tty: link #variable:CMAKE_PREFIX_PATH'\fI\%CMAKE_PREFIX_PATH\fP\X'tty: link' contains the build directory, or set the
+\fBClimbingStats_DIR\fP to \fB<build_dir>/ClimbingStats\fP in the cache.
+.SS Creating Relocatable Packages
+.sp
+A relocatable package must not reference absolute paths of files on
+the machine where the package is built that will not exist on the
+machines where the package may be installed.
+.sp
+Packages created by \X'tty: link #export'\fI\%install(EXPORT)\fP\X'tty: link' are designed to be relocatable,
+using paths relative to the location of the package itself.  When defining
+the interface of a target for \fBEXPORT\fP, keep in mind that the include
+directories should be specified as relative paths which are relative to the
+\X'tty: link #variable:CMAKE_INSTALL_PREFIX'\fI\%CMAKE_INSTALL_PREFIX\fP\X'tty: link':
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+target_include_directories(tgt INTERFACE
+  # Wrong, not relocatable:
+  $<INSTALL_INTERFACE:${CMAKE_INSTALL_PREFIX}/include/TgtName>
+)
+
+target_include_directories(tgt INTERFACE
+  # Ok, relocatable:
+  $<INSTALL_INTERFACE:include/TgtName>
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \fB$<INSTALL_PREFIX>\fP
+\X'tty: link #manual:cmake-generator-expressions(7)'\fI\%generator expression\fP\X'tty: link' may be used as
+a placeholder for the install prefix without resulting in a non\-relocatable
+package.  This is necessary if complex generator expressions are used:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+target_include_directories(tgt INTERFACE
+  # Ok, relocatable:
+  $<INSTALL_INTERFACE:$<$<CONFIG:Debug>:$<INSTALL_PREFIX>/include/TgtName>>
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This also applies to paths referencing external dependencies.
+It is not advisable to populate any properties which may contain
+paths, such as \X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link' and
+\X'tty: link #prop_tgt:INTERFACE_LINK_LIBRARIES'\fI\%INTERFACE_LINK_LIBRARIES\fP\X'tty: link', with paths relevant to dependencies.
+For example, this code may not work well for a relocatable package:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+target_link_libraries(ClimbingStats INTERFACE
+  ${Foo_LIBRARIES} ${Bar_LIBRARIES}
+  )
+target_include_directories(ClimbingStats INTERFACE
+  \(dq$<INSTALL_INTERFACE:${Foo_INCLUDE_DIRS};${Bar_INCLUDE_DIRS}>\(dq
+  )
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The referenced variables may contain the absolute paths to libraries
+and include directories \fBas found on the machine the package was made on\fP\&.
+This would create a package with hard\-coded paths to dependencies and not
+suitable for relocation.
+.sp
+Ideally such dependencies should be used through their own
+\X'tty: link #imported-targets'\fI\%IMPORTED targets\fP\X'tty: link' that have their own
+\X'tty: link #prop_tgt:IMPORTED_LOCATION'\fI\%IMPORTED_LOCATION\fP\X'tty: link' and usage requirement properties
+such as \X'tty: link #prop_tgt:INTERFACE_INCLUDE_DIRECTORIES'\fI\%INTERFACE_INCLUDE_DIRECTORIES\fP\X'tty: link' populated
+appropriately.  Those imported targets may then be used with
+the \X'tty: link #command:target_link_libraries'\fI\%target_link_libraries()\fP\X'tty: link' command for \fBClimbingStats\fP:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+target_link_libraries(ClimbingStats INTERFACE Foo::Foo Bar::Bar)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+With this approach the package references its external dependencies
+only through the names of \X'tty: link #imported-targets'\fI\%IMPORTED targets\fP\X'tty: link'\&.
+When a consumer uses the installed package, the consumer will run the
+appropriate \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' commands (via the \fBfind_dependency\fP
+macro described above) to find the dependencies and populate the
+imported targets with appropriate paths on their own machine.
+.sp
+Unfortunately many \X'tty: link #manual:cmake-modules(7)'\fI\%modules\fP\X'tty: link' shipped with
+CMake do not yet provide \X'tty: link #imported-targets'\fI\%IMPORTED targets\fP\X'tty: link'
+because their development pre\-dated this approach.  This may improve
+incrementally over time.  Workarounds to create relocatable packages
+using such modules include:
+.INDENT 0.0
+.IP \(bu 2
+When building the package, specify each \fBFoo_LIBRARY\fP cache
+entry as just a library name, e.g. \fB\-DFoo_LIBRARY=foo\fP\&.  This
+tells the corresponding find module to populate the \fBFoo_LIBRARIES\fP
+with just \fBfoo\fP to ask the linker to search for the library
+instead of hard\-coding a path.
+.IP \(bu 2
+Or, after installing the package content but before creating the
+package installation binary for redistribution, manually replace
+the absolute paths with placeholders for substitution by the
+installation tool when the package is installed.
+.UNINDENT
+.SH PACKAGE REGISTRY
+.sp
+CMake provides two central locations to register packages that have
+been built or installed anywhere on a system:
+.INDENT 0.0
+.IP \(bu 2
+\fI\%User Package Registry\fP
+.IP \(bu 2
+\fI\%System Package Registry\fP
+.UNINDENT
+.sp
+The registries are especially useful to help projects find packages in
+non\-standard install locations or directly in their own build trees.
+A project may populate either the user or system registry (using its own
+means, see below) to refer to its location.
+In either case the package should store at the registered location a
+\fI\%Package Configuration File\fP (\fB<PackageName>Config.cmake\fP) and optionally a
+\fI\%Package Version File\fP (\fB<PackageName>ConfigVersion.cmake\fP).
+.sp
+The \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' command searches the two package registries
+as two of the search steps specified in its documentation.  If it has
+sufficient permissions it also removes stale package registry entries
+that refer to directories that do not exist or do not contain a matching
+package configuration file.
+.SS User Package Registry
+.sp
+The User Package Registry is stored in a per\-user location.
+The \X'tty: link #package'\fI\%export(PACKAGE)\fP\X'tty: link' command may be used to register a project
+build tree in the user package registry.  CMake currently provides no
+interface to add install trees to the user package registry.  Installers
+must be manually taught to register their packages if desired.
+.sp
+On Windows the user package registry is stored in the Windows registry
+under a key in \fBHKEY_CURRENT_USER\fP\&.
+.sp
+A \fB<PackageName>\fP may appear under registry key:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+HKEY_CURRENT_USER\eSoftware\eKitware\eCMake\ePackages\e<PackageName>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+as a \fBREG_SZ\fP value, with arbitrary name, that specifies the directory
+containing the package configuration file.
+.sp
+On UNIX platforms the user package registry is stored in the user home
+directory under \fB~/.cmake/packages\fP\&.  A \fB<PackageName>\fP may appear under
+the directory:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+~/.cmake/packages/<PackageName>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+as a file, with arbitrary name, whose content specifies the directory
+containing the package configuration file.
+.SS System Package Registry
+.sp
+The System Package Registry is stored in a system\-wide location.
+CMake currently provides no interface to add to the system package registry.
+Installers must be manually taught to register their packages if desired.
+.sp
+On Windows the system package registry is stored in the Windows registry
+under a key in \fBHKEY_LOCAL_MACHINE\fP\&.  A \fB<PackageName>\fP may appear under
+registry key:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+HKEY_LOCAL_MACHINE\eSoftware\eKitware\eCMake\ePackages\e<PackageName>
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+as a \fBREG_SZ\fP value, with arbitrary name, that specifies the directory
+containing the package configuration file.
+.sp
+There is no system package registry on non\-Windows platforms.
+.SS Disabling the Package Registry
+.sp
+In some cases using the Package Registries is not desirable. CMake
+allows one to disable them using the following variables:
+.INDENT 0.0
+.IP \(bu 2
+The \X'tty: link #package'\fI\%export(PACKAGE)\fP\X'tty: link' command does not populate the user
+package registry when \X'tty: link #policy:CMP0090'\fI\%CMP0090\fP\X'tty: link' is set to \fBNEW\fP unless the
+\X'tty: link #variable:CMAKE_EXPORT_PACKAGE_REGISTRY'\fI\%CMAKE_EXPORT_PACKAGE_REGISTRY\fP\X'tty: link' variable explicitly enables it.
+When \X'tty: link #policy:CMP0090'\fI\%CMP0090\fP\X'tty: link' is \fInot\fP set to \fBNEW\fP then
+\X'tty: link #package'\fI\%export(PACKAGE)\fP\X'tty: link' populates the user package registry unless
+the \X'tty: link #variable:CMAKE_EXPORT_NO_PACKAGE_REGISTRY'\fI\%CMAKE_EXPORT_NO_PACKAGE_REGISTRY\fP\X'tty: link' variable explicitly
+disables it.
+.IP \(bu 2
+\X'tty: link #variable:CMAKE_FIND_USE_PACKAGE_REGISTRY'\fI\%CMAKE_FIND_USE_PACKAGE_REGISTRY\fP\X'tty: link' disables the
+User Package Registry in all the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' calls when
+set to \fBFALSE\fP\&.
+.IP \(bu 2
+Deprecated \X'tty: link #variable:CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY'\fI\%CMAKE_FIND_PACKAGE_NO_PACKAGE_REGISTRY\fP\X'tty: link' disables the
+User Package Registry in all the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' calls when set
+to \fBTRUE\fP\&. This variable is ignored when
+\X'tty: link #variable:CMAKE_FIND_USE_PACKAGE_REGISTRY'\fI\%CMAKE_FIND_USE_PACKAGE_REGISTRY\fP\X'tty: link' has been set.
+.IP \(bu 2
+\X'tty: link #variable:CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY'\fI\%CMAKE_FIND_PACKAGE_NO_SYSTEM_PACKAGE_REGISTRY\fP\X'tty: link' disables
+the System Package Registry in all the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' calls.
+.UNINDENT
+.SS Package Registry Example
+.sp
+A simple convention for naming package registry entries is to use content
+hashes.  They are deterministic and unlikely to collide
+(\X'tty: link #package'\fI\%export(PACKAGE)\fP\X'tty: link' uses this approach).
+The name of an entry referencing a specific directory is simply the content
+hash of the directory path itself.
+.sp
+If a project arranges for package registry entries to exist, such as:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+> reg query HKCU\eSoftware\eKitware\eCMake\ePackages\eMyPackage
+HKEY_CURRENT_USER\eSoftware\eKitware\eCMake\ePackages\eMyPackage
+ 45e7d55f13b87179bb12f907c8de6fc4 REG_SZ c:/Users/Me/Work/lib/cmake/MyPackage
+ 7b4a9844f681c80ce93190d4e3185db9 REG_SZ c:/Users/Me/Work/MyPackage\-build
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+or:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ cat ~/.cmake/packages/MyPackage/7d1fb77e07ce59a81bed093bbee945bd
+/home/me/work/lib/cmake/MyPackage
+$ cat ~/.cmake/packages/MyPackage/f92c1db873a1937f3100706657c63e07
+/home/me/work/MyPackage\-build
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+then the \fBCMakeLists.txt\fP code:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+find_package(MyPackage)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+will search the registered locations for package configuration files
+(\fBMyPackageConfig.cmake\fP).  The search order among package registry
+entries for a single package is unspecified and the entry names
+(hashes in this example) have no meaning.  Registered locations may
+contain package version files (\fBMyPackageConfigVersion.cmake\fP) to
+tell \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' whether a specific location is suitable
+for the version requested.
+.SS Package Registry Ownership
+.sp
+Package registry entries are individually owned by the project installations
+that they reference.  A package installer is responsible for adding its own
+entry and the corresponding uninstaller is responsible for removing it.
+.sp
+The \X'tty: link #package'\fI\%export(PACKAGE)\fP\X'tty: link' command populates the user package registry
+with the location of a project build tree.  Build trees tend to be deleted by
+developers and have no \(dquninstall\(dq event that could trigger removal of their
+entries.  In order to keep the registries clean the \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link'
+command automatically removes stale entries it encounters if it has sufficient
+permissions.  CMake provides no interface to remove an entry referencing an
+existing build tree once \X'tty: link #package'\fI\%export(PACKAGE)\fP\X'tty: link' has been invoked.
+However, if the project removes its package configuration file from the build
+tree then the entry referencing the location will be considered stale.
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-presets.7

@@ -0,0 +1,1550 @@
+.\" 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-PRESETS" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-presets \- CMakePresets.json
+.SH INTRODUCTION
+.sp
+Added in version 3.19.
+
+.sp
+One problem that CMake users often face is sharing settings with other people
+for common ways to configure a project. This may be done to support CI builds,
+or for users who frequently use the same build. CMake supports two main files,
+\fBCMakePresets.json\fP and \fBCMakeUserPresets.json\fP, that allow users to
+specify common configure options and share them with others. CMake also
+supports files included with the \fBinclude\fP field.
+.sp
+\fBCMakePresets.json\fP and \fBCMakeUserPresets.json\fP live in the project\(aqs root
+directory. They both have exactly the same format, and both are optional
+(though at least one must be present if \X'tty: link #cmdoption-cmake-preset'\fI\%\-\-preset\fP\X'tty: link'
+is specified).  \fBCMakePresets.json\fP is meant to specify project\-wide build
+details, while \fBCMakeUserPresets.json\fP is meant for developers to specify
+their own local build details.
+.sp
+\fBCMakePresets.json\fP may be checked into a version control system, and
+\fBCMakeUserPresets.json\fP should NOT be checked in. For example, if a
+project is using Git, \fBCMakePresets.json\fP may be tracked, and
+\fBCMakeUserPresets.json\fP should be added to the \fB\&.gitignore\fP\&.
+.SH FORMAT
+.sp
+The files are a JSON document with an object as the root:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+{
+  \(dqversion\(dq: 10,
+  \(dqcmakeMinimumRequired\(dq: {
+    \(dqmajor\(dq: 3,
+    \(dqminor\(dq: 23,
+    \(dqpatch\(dq: 0
+  },
+  \(dq$comment\(dq: \(dqAn example CMakePresets.json file\(dq,
+  \(dqinclude\(dq: [
+    \(dqotherThings.json\(dq,
+    \(dqmoreThings.json\(dq
+  ],
+  \(dqconfigurePresets\(dq: [
+    {
+      \(dq$comment\(dq: [
+        \(dqThis is a comment row.\(dq,
+        \(dqThis is another comment,\(dq,
+        \(dqjust because we can do it\(dq
+      ],
+      \(dqname\(dq: \(dqdefault\(dq,
+      \(dqdisplayName\(dq: \(dqDefault Config\(dq,
+      \(dqdescription\(dq: \(dqDefault build using Ninja generator\(dq,
+      \(dqgenerator\(dq: \(dqNinja\(dq,
+      \(dqbinaryDir\(dq: \(dq${sourceDir}/build/default\(dq,
+      \(dqcacheVariables\(dq: {
+        \(dqFIRST_CACHE_VARIABLE\(dq: {
+          \(dqtype\(dq: \(dqBOOL\(dq,
+          \(dqvalue\(dq: \(dqOFF\(dq
+        },
+        \(dqSECOND_CACHE_VARIABLE\(dq: \(dqON\(dq
+      },
+      \(dqenvironment\(dq: {
+        \(dqMY_ENVIRONMENT_VARIABLE\(dq: \(dqTest\(dq,
+        \(dqPATH\(dq: \(dq$env{HOME}/ninja/bin:$penv{PATH}\(dq
+      },
+      \(dqvendor\(dq: {
+        \(dqexample.com/ExampleIDE/1.0\(dq: {
+          \(dqautoFormat\(dq: true
+        }
+      }
+    },
+    {
+      \(dqname\(dq: \(dqninja\-multi\(dq,
+      \(dqinherits\(dq: \(dqdefault\(dq,
+      \(dqdisplayName\(dq: \(dqNinja Multi\-Config\(dq,
+      \(dqdescription\(dq: \(dqDefault build using Ninja Multi\-Config generator\(dq,
+      \(dqgenerator\(dq: \(dqNinja Multi\-Config\(dq
+    },
+    {
+      \(dqname\(dq: \(dqwindows\-only\(dq,
+      \(dqinherits\(dq: \(dqdefault\(dq,
+      \(dqdisplayName\(dq: \(dqWindows\-only configuration\(dq,
+      \(dqdescription\(dq: \(dqThis build is only available on Windows\(dq,
+      \(dqcondition\(dq: {
+        \(dqtype\(dq: \(dqequals\(dq,
+        \(dqlhs\(dq: \(dq${hostSystemName}\(dq,
+        \(dqrhs\(dq: \(dqWindows\(dq
+      }
+    }
+  ],
+  \(dqbuildPresets\(dq: [
+    {
+      \(dqname\(dq: \(dqdefault\(dq,
+      \(dqconfigurePreset\(dq: \(dqdefault\(dq
+    }
+  ],
+  \(dqtestPresets\(dq: [
+    {
+      \(dqname\(dq: \(dqdefault\(dq,
+      \(dqconfigurePreset\(dq: \(dqdefault\(dq,
+      \(dqoutput\(dq: {\(dqoutputOnFailure\(dq: true},
+      \(dqexecution\(dq: {\(dqnoTestsAction\(dq: \(dqerror\(dq, \(dqstopOnFailure\(dq: true}
+    }
+  ],
+  \(dqpackagePresets\(dq: [
+    {
+      \(dqname\(dq: \(dqdefault\(dq,
+      \(dqconfigurePreset\(dq: \(dqdefault\(dq,
+      \(dqgenerators\(dq: [
+        \(dqTGZ\(dq
+      ]
+    }
+  ],
+  \(dqworkflowPresets\(dq: [
+    {
+      \(dqname\(dq: \(dqdefault\(dq,
+      \(dqsteps\(dq: [
+        {
+          \(dqtype\(dq: \(dqconfigure\(dq,
+          \(dqname\(dq: \(dqdefault\(dq
+        },
+        {
+          \(dqtype\(dq: \(dqbuild\(dq,
+          \(dqname\(dq: \(dqdefault\(dq
+        },
+        {
+          \(dqtype\(dq: \(dqtest\(dq,
+          \(dqname\(dq: \(dqdefault\(dq
+        },
+        {
+          \(dqtype\(dq: \(dqpackage\(dq,
+          \(dqname\(dq: \(dqdefault\(dq
+        }
+      ]
+    }
+  ],
+  \(dqvendor\(dq: {
+    \(dqexample.com/ExampleIDE/1.0\(dq: {
+      \(dqautoFormat\(dq: false
+    }
+  }
+}
+
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Preset files specifying version \fB10\fP or above may include comments using the
+key \fB$comment\fP at any level within the JSON object to provide documentation.
+.sp
+The root object recognizes the following fields:
+.INDENT 0.0
+.TP
+.B \fB$schema\fP
+An optional string that provides a URI to the JSON schema that describes the
+structure of this JSON document. This field is used for validation and
+autocompletion in editors that support JSON schema. It doesn\(aqt affect the
+behavior of the document itself. If this field is not specified, the JSON
+document will still be valid, but tools that use JSON schema for validation
+and autocompletion may not function correctly.
+This is allowed in preset files specifying version \fB8\fP or above.
+.TP
+.B \fBversion\fP
+A required integer representing the version of the JSON schema.
+The supported versions are:
+.INDENT 7.0
+.TP
+.B \fB1\fP
+Added in version 3.19.
+
+.TP
+.B \fB2\fP
+Added in version 3.20.
+
+.TP
+.B \fB3\fP
+Added in version 3.21.
+
+.TP
+.B \fB4\fP
+Added in version 3.23.
+
+.TP
+.B \fB5\fP
+Added in version 3.24.
+
+.TP
+.B \fB6\fP
+Added in version 3.25.
+
+.TP
+.B \fB7\fP
+Added in version 3.27.
+
+.TP
+.B \fB8\fP
+Added in version 3.28.
+
+.TP
+.B \fB9\fP
+Added in version 3.30.
+
+.TP
+.B \fB10\fP
+Added in version 3.31.
+
+.UNINDENT
+.TP
+.B \fBcmakeMinimumRequired\fP
+An optional object representing the minimum version of CMake needed to
+build this project. This object consists of the following fields:
+.INDENT 7.0
+.TP
+.B \fBmajor\fP
+An optional integer representing the major version.
+.TP
+.B \fBminor\fP
+An optional integer representing the minor version.
+.TP
+.B \fBpatch\fP
+An optional integer representing the patch version.
+.UNINDENT
+.TP
+.B \fBinclude\fP
+An optional array of strings representing files to include. If the filenames
+are not absolute, they are considered relative to the current file.
+This is allowed in preset files specifying version \fB4\fP or above.
+See \fI\%Includes\fP for discussion of the constraints on included files.
+.TP
+.B \fBvendor\fP
+An optional map containing vendor\-specific information. CMake does not
+interpret the contents of this field except to verify that it is a map if
+it does exist. However, the keys should be a vendor\-specific domain name
+followed by a \fB/\fP\-separated path. For example, the Example IDE 1.0 could
+use \fBexample.com/ExampleIDE/1.0\fP\&. The value of each field can be anything
+desired by the vendor, though will typically be a map.
+.TP
+.B \fBconfigurePresets\fP
+An optional array of \fI\%Configure Preset\fP objects.
+This is allowed in preset files specifying version \fB1\fP or above.
+.TP
+.B \fBbuildPresets\fP
+An optional array of \fI\%Build Preset\fP objects.
+This is allowed in preset files specifying version \fB2\fP or above.
+.TP
+.B \fBtestPresets\fP
+An optional array of \fI\%Test Preset\fP objects.
+This is allowed in preset files specifying version \fB2\fP or above.
+.TP
+.B \fBpackagePresets\fP
+An optional array of \fI\%Package Preset\fP objects.
+This is allowed in preset files specifying version \fB6\fP or above.
+.TP
+.B \fBworkflowPresets\fP
+An optional array of \fI\%Workflow Preset\fP objects.
+This is allowed in preset files specifying version \fB6\fP or above.
+.UNINDENT
+.SS Includes
+.sp
+\fBCMakePresets.json\fP and \fBCMakeUserPresets.json\fP can include other files
+with the \fBinclude\fP field in file version \fB4\fP and later. Files included
+by these files can also include other files. If \fBCMakePresets.json\fP and
+\fBCMakeUserPresets.json\fP are both present, \fBCMakeUserPresets.json\fP
+implicitly includes \fBCMakePresets.json\fP, even with no \fBinclude\fP field,
+in all versions of the format.
+.sp
+If a preset file contains presets that inherit from presets in another file,
+the file must include the other file either directly or indirectly.
+Include cycles are not allowed among files. If \fBa.json\fP includes
+\fBb.json\fP, \fBb.json\fP cannot include \fBa.json\fP\&. However, a file may be
+included multiple times from the same file or from different files.
+.sp
+Files directly or indirectly included from \fBCMakePresets.json\fP should be
+guaranteed to be provided by the project. \fBCMakeUserPresets.json\fP may
+include files from anywhere.
+.sp
+Starting from version \fB7\fP, the \fBinclude\fP field supports
+\fI\%macro expansion\fP, but only \fB$penv{}\fP macro expansion. Starting from version
+\fB9\fP, other macro expansions are also available, except for \fB$env{}\fP and
+preset\-specific macros, i.e., those derived from the fields inside a preset\(aqs
+definition like \fBpresetName\fP\&.
+.SS Configure Preset
+.sp
+Each entry of the \fBconfigurePresets\fP array is a JSON object
+that may contain the following fields:
+.INDENT 0.0
+.TP
+.B \fBname\fP
+A required string representing the machine\-friendly name of the preset.
+This identifier is used in the \X'tty: link #cmake-options'\fI\%cmake \-\-preset\fP\X'tty: link' option.
+There must not be two configure presets in the union of \fBCMakePresets.json\fP
+and \fBCMakeUserPresets.json\fP in the same directory with the same name.
+However, a configure preset may have the same name as a build, test,
+package, or workflow preset.
+.TP
+.B \fBhidden\fP
+An optional boolean specifying whether or not a preset should be hidden.
+If a preset is hidden, it cannot be used in the \fB\-\-preset=\fP argument,
+will not show up in the \X'tty: link #manual:cmake-gui(1)'\fI\%CMake GUI\fP\X'tty: link', and does not
+have to have a valid \fBgenerator\fP or \fBbinaryDir\fP, even from
+inheritance. \fBhidden\fP presets are intended to be used as a base for
+other presets to inherit via the \fBinherits\fP field.
+.TP
+.B \fBinherits\fP
+An optional array of strings representing the names of presets to inherit
+from. This field can also be a string, which is equivalent to an array
+containing one string.
+.sp
+The preset will inherit all of the fields from the \fBinherits\fP
+presets by default (except \fBname\fP, \fBhidden\fP, \fBinherits\fP,
+\fBdescription\fP, and \fBdisplayName\fP), but can override them as
+desired. If multiple \fBinherits\fP presets provide conflicting values for
+the same field, the earlier preset in the \fBinherits\fP array will be
+preferred.
+.sp
+A preset can only inherit from another preset that is defined in the
+same file or in one of the files it includes (directly or indirectly).
+Presets in \fBCMakePresets.json\fP may not inherit from presets in
+\fBCMakeUserPresets.json\fP\&.
+.TP
+.B \fBcondition\fP
+An optional \fI\%Condition\fP object. This is allowed in preset files specifying
+version \fB3\fP or above.
+.TP
+.B \fBvendor\fP
+An optional map containing vendor\-specific information. CMake does not
+interpret the contents of this field except to verify that it is a map
+if it does exist. However, it should follow the same conventions as the
+root\-level \fBvendor\fP field. If vendors use their own per\-preset
+\fBvendor\fP field, they should implement inheritance in a sensible manner
+when appropriate.
+.TP
+.B \fBdisplayName\fP
+An optional string with a human\-friendly name of the preset.
+.TP
+.B \fBdescription\fP
+An optional string with a human\-friendly description of the preset.
+.TP
+.B \fBgenerator\fP
+An optional string representing the generator to use for the preset. If
+\fBgenerator\fP is not specified, it must be inherited from the
+\fBinherits\fP preset (unless this preset is \fBhidden\fP). In version \fB3\fP
+or above, this field may be omitted to fall back to regular generator
+discovery procedure.
+.sp
+Note that for Visual Studio generators, unlike in the command line
+\X'tty: link #cmdoption-cmake-G'\fI\%\-G\fP\X'tty: link' argument, you cannot include the platform name
+in the generator name. Use the \fBarchitecture\fP field instead.
+.TP
+.B \fBarchitecture\fP, \fBtoolset\fP
+Optional fields representing the platform and toolset, respectively, for
+\X'tty: link #manual:cmake-generators(7)'\fI\%generators\fP\X'tty: link' that support them.
+.sp
+See \X'tty: link #cmdoption-cmake-A'\fI\%cmake \-A\fP\X'tty: link' option for possible values for \fBarchitecture\fP
+and \X'tty: link #cmdoption-cmake-T'\fI\%cmake \-T\fP\X'tty: link' for \fBtoolset\fP\&.
+.sp
+Each may be either a string or an object with the following fields:
+.INDENT 7.0
+.TP
+.B \fBvalue\fP
+An optional string representing the value.
+.TP
+.B \fBstrategy\fP
+An optional string telling CMake how to handle the \fBarchitecture\fP or
+\fBtoolset\fP field. Valid values are:
+.INDENT 7.0
+.TP
+.B \fB\(dqset\(dq\fP
+Set the respective value. This will result in an error for generators
+that do not support the respective field.
+.TP
+.B \fB\(dqexternal\(dq\fP
+Do not set the value, even if the generator supports it. This is
+useful if, for example, a preset uses the Ninja generator, and an IDE
+knows how to set up the Visual C++ environment from the
+\fBarchitecture\fP and \fBtoolset\fP fields. In that case, CMake will
+ignore the field, but the IDE can use them to set up the environment
+before invoking CMake.
+.UNINDENT
+.sp
+If no \fBstrategy\fP field is given, or if the field uses the string form
+rather than the object form, the behavior is the same as \fB\(dqset\(dq\fP\&.
+.UNINDENT
+.TP
+.B \fBtoolchainFile\fP
+An optional string representing the path to the toolchain file.
+This field supports \fI\%macro expansion\fP\&. If a relative path is specified,
+it is calculated relative to the build directory, and if not found,
+relative to the source directory. This field takes precedence over any
+\X'tty: link #variable:CMAKE_TOOLCHAIN_FILE'\fI\%CMAKE_TOOLCHAIN_FILE\fP\X'tty: link' value. It is allowed in preset files
+specifying version \fB3\fP or above.
+.TP
+.B \fBgraphviz\fP
+An optional string representing the path to the graphviz input file,
+that will contain all the library and executable dependencies
+in the project. See the documentation for \X'tty: link #module:CMakeGraphVizOptions'\fI\%CMakeGraphVizOptions\fP\X'tty: link'
+for more details.
+.sp
+This field supports \fI\%macro expansion\fP\&. If a relative path is specified,
+it is calculated relative to the current working directory. It is allowed
+in preset files specifying version \fB10\fP or above.
+.TP
+.B \fBbinaryDir\fP
+An optional string representing the path to the output binary directory.
+This field supports \fI\%macro expansion\fP\&. If a relative path is specified,
+it is calculated relative to the source directory. If \fBbinaryDir\fP is not
+specified, it must be inherited from the \fBinherits\fP preset (unless this
+preset is \fBhidden\fP). In version \fB3\fP or above, this field may be
+omitted.
+.TP
+.B \fBinstallDir\fP
+An optional string representing the path to the installation directory.
+This field supports \fI\%macro expansion\fP\&. If a relative path is specified,
+it is calculated relative to the source directory. This is allowed in
+preset files specifying version \fB3\fP or above.
+.TP
+.B \fBcmakeExecutable\fP
+An optional string representing the path to the CMake executable to use
+for this preset. This is reserved for use by IDEs, and is not used by
+CMake itself. IDEs that use this field should expand any macros in it.
+.TP
+.B \fBcacheVariables\fP
+An optional map of cache variables. The key is the variable name (which
+may not be an empty string), and the value is either \fBnull\fP, a boolean
+(which is equivalent to a value of \fB\(dqTRUE\(dq\fP or \fB\(dqFALSE\(dq\fP and a type
+of \fBBOOL\fP), a string representing the value of the variable (which
+supports \fI\%macro expansion\fP), or an object with the following fields:
+.INDENT 7.0
+.TP
+.B \fBtype\fP
+An optional string representing the type of the variable.
+.TP
+.B \fBvalue\fP
+A required string or boolean representing the value of the variable.
+A boolean is equivalent to \fB\(dqTRUE\(dq\fP or \fB\(dqFALSE\(dq\fP\&. This field
+supports \fI\%macro expansion\fP\&.
+.UNINDENT
+.sp
+Cache variables are inherited through the \fBinherits\fP field, and the
+preset\(aqs variables will be the union of its own \fBcacheVariables\fP and
+the \fBcacheVariables\fP from all its parents. If multiple presets in this
+union define the same variable, the standard rules of \fBinherits\fP are
+applied. Setting a variable to \fBnull\fP causes it to not be set, even if
+a value was inherited from another preset.
+.TP
+.B \fBenvironment\fP
+An optional map of environment variables. The key is the variable name
+(which may not be an empty string), and the value is either \fBnull\fP or
+a string representing the value of the variable. Each variable is set
+regardless of whether or not a value was given to it by the process\(aqs
+environment.
+.sp
+This field supports \fI\%macro expansion\fP, and environment variables in this map
+may reference each other, and may be listed in any order, as long as such
+references do not cause a cycle (for example, if \fBENV_1\fP is
+\fB$env{ENV_2}\fP, \fBENV_2\fP may not be \fB$env{ENV_1}\fP).  \fB$penv{NAME}\fP
+allows one to prepend or append values to existing environment variables by
+accessing only values from the parent environment.
+.sp
+Environment variables are inherited through the \fBinherits\fP field, and
+the preset\(aqs environment will be the union of its own \fBenvironment\fP and
+the \fBenvironment\fP from all its parents. If multiple presets in this
+union define the same variable, the standard rules of \fBinherits\fP are
+applied. Setting a variable to \fBnull\fP causes it to not be set, even if
+a value was inherited from another preset.
+.TP
+.B \fBwarnings\fP
+An optional object specifying the warnings to enable. The object may
+contain the following fields:
+.INDENT 7.0
+.TP
+.B \fBdev\fP
+An optional boolean. Equivalent to passing \X'tty: link #cmdoption-cmake-Wdev'\fI\%\-Wdev\fP\X'tty: link'
+or \X'tty: link #cmdoption-cmake-Wno-dev'\fI\%\-Wno\-dev\fP\X'tty: link' on the command line. This may not
+be set to \fBfalse\fP if \fBerrors.dev\fP is set to \fBtrue\fP\&.
+.TP
+.B \fBdeprecated\fP
+An optional boolean. Equivalent to passing
+\X'tty: link #cmdoption-cmake-Wdeprecated'\fI\%\-Wdeprecated\fP\X'tty: link' or
+\X'tty: link #cmdoption-cmake-Wno-deprecated'\fI\%\-Wno\-deprecated\fP\X'tty: link' on the command line.
+This may not be set to \fBfalse\fP if \fBerrors.deprecated\fP is set to
+\fBtrue\fP\&.
+.TP
+.B \fBuninitialized\fP
+An optional boolean. Setting this to \fBtrue\fP is equivalent to passing
+\X'tty: link #cmdoption-cmake-warn-uninitialized'\fI\%\-\-warn\-uninitialized\fP\X'tty: link' on the command
+line.
+.TP
+.B \fBunusedCli\fP
+An optional boolean. Setting this to \fBfalse\fP is equivalent to passing
+\X'tty: link #cmdoption-cmake-no-warn-unused-cli'\fI\%\-\-no\-warn\-unused\-cli\fP\X'tty: link' on the command
+line.
+.TP
+.B \fBsystemVars\fP
+An optional boolean. Setting this to \fBtrue\fP is equivalent to passing
+\X'tty: link #cmdoption-cmake-check-system-vars'\fI\%\-\-check\-system\-vars\fP\X'tty: link' on the command
+line.
+.UNINDENT
+.TP
+.B \fBerrors\fP
+An optional object specifying the errors to enable. The object may
+contain the following fields:
+.INDENT 7.0
+.TP
+.B \fBdev\fP
+An optional boolean. Equivalent to passing \X'tty: link #cmdoption-cmake-Werror'\fI\%\-Werror=dev\fP\X'tty: link'
+or \X'tty: link #cmdoption-cmake-Werror'\fI\%\-Wno\-error=dev\fP\X'tty: link' on the command line.
+This may not be set to \fBtrue\fP if \fBwarnings.dev\fP is set to \fBfalse\fP\&.
+.TP
+.B \fBdeprecated\fP
+An optional boolean. Equivalent to passing
+\X'tty: link #cmdoption-cmake-Werror'\fI\%\-Werror=deprecated\fP\X'tty: link' or
+\X'tty: link #cmdoption-cmake-Werror'\fI\%\-Wno\-error=deprecated\fP\X'tty: link' on the command line.
+This may not be set to \fBtrue\fP if \fBwarnings.deprecated\fP is set to
+\fBfalse\fP\&.
+.UNINDENT
+.TP
+.B \fBdebug\fP
+An optional object specifying debug options. The object may contain the
+following fields:
+.INDENT 7.0
+.TP
+.B \fBoutput\fP
+An optional boolean. Setting this to \fBtrue\fP is equivalent to passing
+\X'tty: link #cmdoption-cmake-debug-output'\fI\%\-\-debug\-output\fP\X'tty: link' on the command line.
+.TP
+.B \fBtryCompile\fP
+An optional boolean. Setting this to \fBtrue\fP is equivalent to passing
+\X'tty: link #cmdoption-cmake-debug-trycompile'\fI\%\-\-debug\-trycompile\fP\X'tty: link' on the command
+line.
+.TP
+.B \fBfind\fP
+An optional boolean. Setting this to \fBtrue\fP is equivalent to passing
+\X'tty: link #cmdoption-cmake-debug-find'\fI\%\-\-debug\-find\fP\X'tty: link' on the command line.
+.UNINDENT
+.TP
+.B \fBtrace\fP
+An optional object specifying trace options. This is allowed in preset
+files specifying version \fB7\fP\&. The object may contain the following fields:
+.INDENT 7.0
+.TP
+.B \fBmode\fP
+An optional string that specifies the trace mode. Valid values are:
+.INDENT 7.0
+.TP
+.B \fBon\fP
+Causes a trace of all calls made and from where to be printed.
+Equivalent to passing \X'tty: link #cmdoption-cmake-trace'\fI\%\-\-trace\fP\X'tty: link' on the command
+line.
+.TP
+.B \fBoff\fP
+A trace of all calls will not be printed.
+.TP
+.B \fBexpand\fP
+Causes a trace with variables expanded of all calls made and from where
+to be printed. Equivalent to passing \X'tty: link #cmdoption-cmake-trace-expand'\fI\%\-\-trace\-expand\fP\X'tty: link'
+on the command line.
+.UNINDENT
+.TP
+.B \fBformat\fP
+An optional string that specifies the format output of the trace.
+Valid values are:
+.INDENT 7.0
+.TP
+.B \fBhuman\fP
+Prints each trace line in a human\-readable format.
+This is the default format.  Equivalent to passing
+\X'tty: link #cmdoption-cmake-trace-format'\fI\%\-\-trace\-format=human\fP\X'tty: link'
+on the command line.
+.TP
+.B \fBjson\-v1\fP
+Prints each line as a separate JSON document.  Equivalent to passing
+\X'tty: link #cmdoption-cmake-trace-format'\fI\%\-\-trace\-format=json\-v1\fP\X'tty: link'
+on the command line.
+.UNINDENT
+.TP
+.B \fBsource\fP
+An optional array of strings representing the paths of source files to
+be traced.  This field can also be a string, which is equivalent to an
+array containing one string.  Equivalent to passing
+\X'tty: link #cmdoption-cmake-trace-source'\fI\%\-\-trace\-source\fP\X'tty: link' on the command line.
+.TP
+.B \fBredirect\fP
+An optional string specifying a path to a trace output file.  Equivalent
+to passing \X'tty: link #cmdoption-cmake-trace-redirect'\fI\%\-\-trace\-redirect\fP\X'tty: link'
+on the command line.
+.UNINDENT
+.UNINDENT
+.SS Build Preset
+.sp
+Each entry of the \fBbuildPresets\fP array is a JSON object
+that may contain the following fields:
+.INDENT 0.0
+.TP
+.B \fBname\fP
+A required string representing the machine\-friendly name of the preset.
+This identifier is used in the
+\X'tty: link #build-tool-mode'\fI\%cmake \-\-build \-\-preset\fP\X'tty: link' option.
+There must not be two build presets in the union of \fBCMakePresets.json\fP
+and \fBCMakeUserPresets.json\fP in the same directory with the same name.
+However, a build preset may have the same name as a configure, test,
+package, or workflow preset.
+.TP
+.B \fBhidden\fP
+An optional boolean specifying whether or not a preset should be hidden.
+If a preset is hidden, it cannot be used in the
+\X'tty: link #cmdoption-cmake-preset'\fI\%\-\-preset\fP\X'tty: link' argument
+and does not have to have a valid \fBconfigurePreset\fP, even from
+inheritance. \fBhidden\fP presets are intended to be used as a base for
+other presets to inherit via the \fBinherits\fP field.
+.TP
+.B \fBinherits\fP
+An optional array of strings representing the names of presets to inherit
+from. This field can also be a string, which is equivalent to an array
+containing one string.
+.sp
+The preset will inherit all of the fields from the
+\fBinherits\fP presets by default (except \fBname\fP, \fBhidden\fP,
+\fBinherits\fP, \fBdescription\fP, and \fBdisplayName\fP), but can override
+them as desired. If multiple \fBinherits\fP presets provide conflicting
+values for the same field, the earlier preset in the \fBinherits\fP array
+will be preferred.
+.sp
+A preset can only inherit from another preset that is defined in the
+same file or in one of the files it includes (directly or indirectly).
+Presets in \fBCMakePresets.json\fP may not inherit from presets in
+\fBCMakeUserPresets.json\fP\&.
+.TP
+.B \fBcondition\fP
+An optional \fI\%Condition\fP object. This is allowed in preset files specifying
+version \fB3\fP or above.
+.TP
+.B \fBvendor\fP
+An optional map containing vendor\-specific information. CMake does not
+interpret the contents of this field except to verify that it is a map
+if it does exist. However, it should follow the same conventions as the
+root\-level \fBvendor\fP field. If vendors use their own per\-preset
+\fBvendor\fP field, they should implement inheritance in a sensible manner
+when appropriate.
+.TP
+.B \fBdisplayName\fP
+An optional string with a human\-friendly name of the preset.
+.TP
+.B \fBdescription\fP
+An optional string with a human\-friendly description of the preset.
+.TP
+.B \fBenvironment\fP
+An optional map of environment variables. The key is the variable name
+(which may not be an empty string), and the value is either \fBnull\fP or
+a string representing the value of the variable. Each variable is set
+regardless of whether or not a value was given to it by the process\(aqs
+environment.
+.sp
+This field supports \fI\%macro expansion\fP, and environment variables in this map
+may reference each other, and may be listed in any order, as long as such
+references do not cause a cycle (for example, if \fBENV_1\fP is
+\fB$env{ENV_2}\fP, \fBENV_2\fP may not be \fB$env{ENV_1}\fP).  \fB$penv{NAME}\fP
+allows one to prepend or append values to existing environment variables by
+accessing only values from the parent environment.
+.sp
+Environment variables are inherited through the \fBinherits\fP field, and
+the preset\(aqs environment will be the union of its own \fBenvironment\fP
+and the \fBenvironment\fP from all its parents. If multiple presets in
+this union define the same variable, the standard rules of \fBinherits\fP
+are applied. Setting a variable to \fBnull\fP causes it to not be set,
+even if a value was inherited from another preset.
+.sp
+\fBNOTE:\fP
+.INDENT 7.0
+.INDENT 3.5
+For a CMake project using ExternalProject with a configuration preset
+having environment variables needed in the ExternalProject, use a build
+preset that inherits that configuration preset or the ExternalProject
+will not have the environment variables set in the configuration preset.
+Example: suppose the host defaults to one compiler (say Clang)
+and the user wishes to use another compiler (say GCC). Set configuration
+preset environment variables \fBCC\fP and \fBCXX\fP and use a build preset
+that inherits that configuration preset. Otherwise the ExternalProject
+may use a different (system default) compiler than the top\-level CMake
+project.
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBconfigurePreset\fP
+An optional string specifying the name of a configure preset to
+associate with this build preset. If \fBconfigurePreset\fP is not
+specified, it must be inherited from the inherits preset (unless this
+preset is hidden). The build directory is inferred from the configure
+preset, so the build will take place in the same \fBbinaryDir\fP that the
+configuration did.
+.TP
+.B \fBinheritConfigureEnvironment\fP
+An optional boolean that defaults to true. If true, the environment
+variables from the associated configure preset are inherited after all
+inherited build preset environments, but before environment variables
+explicitly specified in this build preset.
+.TP
+.B \fBjobs\fP
+An optional integer. Equivalent to passing
+\X'tty: link #cmdoption-cmake-build-j'\fI\%\-\-parallel\fP\X'tty: link' or \fB\-j\fP on the command line.
+.TP
+.B \fBtargets\fP
+An optional string or array of strings. Equivalent to passing
+\X'tty: link #cmdoption-cmake-build-t'\fI\%\-\-target\fP\X'tty: link' or \fB\-t\fP on the command line.
+Vendors may ignore the targets property or hide build presets that
+explicitly specify targets. This field supports macro expansion.
+.TP
+.B \fBconfiguration\fP
+An optional string. Equivalent to passing
+\X'tty: link #cmdoption-cmake-build-config'\fI\%\-\-config\fP\X'tty: link' on the command line.
+.TP
+.B \fBcleanFirst\fP
+An optional bool. If true, equivalent to passing
+\X'tty: link #cmdoption-cmake-build-clean-first'\fI\%\-\-clean\-first\fP\X'tty: link' on the command line.
+.TP
+.B \fBresolvePackageReferences\fP
+An optional string that specifies the package resolve mode. This is
+allowed in preset files specifying version \fB4\fP or above.
+.sp
+Package references are used to define dependencies to packages from
+external package managers. Currently only NuGet in combination with the
+Visual Studio generator is supported. If there are no targets that define
+package references, this option does nothing. Valid values are:
+.INDENT 7.0
+.TP
+.B \fBon\fP
+Causes package references to be resolved before attempting a build.
+.TP
+.B \fBoff\fP
+Package references will not be resolved. Note that this may cause
+errors in some build environments, such as .NET SDK style projects.
+.TP
+.B \fBonly\fP
+Only resolve package references, but do not perform a build.
+.UNINDENT
+.sp
+\fBNOTE:\fP
+.INDENT 7.0
+.INDENT 3.5
+The command line parameter
+\X'tty: link #cmdoption-cmake-build-resolve-package-references'\fI\%\-\-resolve\-package\-references\fP\X'tty: link'
+will take priority over this setting. If the command line parameter is not
+provided and this setting is not specified, an environment\-specific cache
+variable will be evaluated to decide, if package restoration should be
+performed.
+.sp
+When using the Visual Studio generator, package references are defined
+using the \X'tty: link #prop_tgt:VS_PACKAGE_REFERENCES'\fI\%VS_PACKAGE_REFERENCES\fP\X'tty: link' property. Package references
+are restored using NuGet. It can be disabled by setting the
+\fBCMAKE_VS_NUGET_PACKAGE_RESTORE\fP variable to \fBOFF\fP\&. This can also be
+done from within a configure preset.
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBverbose\fP
+An optional bool. If true, equivalent to passing
+\X'tty: link #cmdoption-cmake-build-v'\fI\%\-\-verbose\fP\X'tty: link' on the command line.
+.TP
+.B \fBnativeToolOptions\fP
+An optional array of strings. Equivalent to passing options after \fB\-\-\fP
+on the command line. The array values support macro expansion.
+.UNINDENT
+.SS Test Preset
+.sp
+Each entry of the \fBtestPresets\fP array is a JSON object
+that may contain the following fields:
+.INDENT 0.0
+.TP
+.B \fBname\fP
+A required string representing the machine\-friendly name of the preset.
+This identifier is used in the \X'tty: link #cmdoption-ctest-preset'\fI\%ctest \-\-preset\fP\X'tty: link' option.
+There must not be two test presets in the union of \fBCMakePresets.json\fP
+and \fBCMakeUserPresets.json\fP in the same directory with the same name.
+However, a test preset may have the same name as a configure, build,
+package, or workflow preset.
+.TP
+.B \fBhidden\fP
+An optional boolean specifying whether or not a preset should be hidden.
+If a preset is hidden, it cannot be used in the
+\X'tty: link #cmdoption-ctest-preset'\fI\%\-\-preset\fP\X'tty: link' argument
+and does not have to have a valid \fBconfigurePreset\fP, even from
+inheritance. \fBhidden\fP presets are intended to be used as a base for
+other presets to inherit via the \fBinherits\fP field.
+.TP
+.B \fBinherits\fP
+An optional array of strings representing the names of presets to inherit
+from. This field can also be a string, which is equivalent to an array
+containing one string.
+.sp
+The preset will inherit all of the fields from the
+\fBinherits\fP presets by default (except \fBname\fP, \fBhidden\fP,
+\fBinherits\fP, \fBdescription\fP, and \fBdisplayName\fP), but can override
+them as desired. If multiple \fBinherits\fP presets provide conflicting
+values for the same field, the earlier preset in the \fBinherits\fP array
+will be preferred.
+.sp
+A preset can only inherit from another preset that is defined in the
+same file or in one of the files it includes (directly or indirectly).
+Presets in \fBCMakePresets.json\fP may not inherit from presets in
+\fBCMakeUserPresets.json\fP\&.
+.TP
+.B \fBcondition\fP
+An optional \fI\%Condition\fP object. This is allowed in preset files specifying
+version \fB3\fP or above.
+.TP
+.B \fBvendor\fP
+An optional map containing vendor\-specific information. CMake does not
+interpret the contents of this field except to verify that it is a map
+if it does exist. However, it should follow the same conventions as the
+root\-level \fBvendor\fP field. If vendors use their own per\-preset
+\fBvendor\fP field, they should implement inheritance in a sensible manner
+when appropriate.
+.TP
+.B \fBdisplayName\fP
+An optional string with a human\-friendly name of the preset.
+.TP
+.B \fBdescription\fP
+An optional string with a human\-friendly description of the preset.
+.TP
+.B \fBenvironment\fP
+An optional map of environment variables. The key is the variable name
+(which may not be an empty string), and the value is either \fBnull\fP or
+a string representing the value of the variable. Each variable is set
+regardless of whether or not a value was given to it by the process\(aqs
+environment.
+.sp
+This field supports \fI\%macro expansion\fP, and environment variables in this map
+may reference each other, and may be listed in any order, as long as such
+references do not cause a cycle (for example, if \fBENV_1\fP is
+\fB$env{ENV_2}\fP, \fBENV_2\fP may not be \fB$env{ENV_1}\fP).  \fB$penv{NAME}\fP
+allows one to prepend or append values to existing environment variables by
+accessing only values from the parent environment.
+.sp
+Environment variables are inherited through the \fBinherits\fP field, and
+the preset\(aqs environment will be the union of its own \fBenvironment\fP
+and the \fBenvironment\fP from all its parents. If multiple presets in
+this union define the same variable, the standard rules of \fBinherits\fP
+are applied. Setting a variable to \fBnull\fP causes it to not be set,
+even if a value was inherited from another preset.
+.TP
+.B \fBconfigurePreset\fP
+An optional string specifying the name of a configure preset to
+associate with this test preset. If \fBconfigurePreset\fP is not
+specified, it must be inherited from the inherits preset (unless this
+preset is hidden). The build directory is inferred from the configure
+preset, so tests will run in the same \fBbinaryDir\fP that the
+configuration did and build did.
+.TP
+.B \fBinheritConfigureEnvironment\fP
+An optional boolean that defaults to true. If true, the environment
+variables from the associated configure preset are inherited after all
+inherited test preset environments, but before environment variables
+explicitly specified in this test preset.
+.TP
+.B \fBconfiguration\fP
+An optional string. Equivalent to passing
+\X'tty: link #cmdoption-ctest-C'\fI\%\-\-build\-config\fP\X'tty: link' on the command line.
+.TP
+.B \fBoverwriteConfigurationFile\fP
+An optional array of configuration options to overwrite options
+specified in the CTest configuration file. Equivalent to passing
+\X'tty: link #cmdoption-ctest-overwrite'\fI\%\-\-overwrite\fP\X'tty: link' for each value in the array.
+The array values support macro expansion.
+.TP
+.B \fBoutput\fP
+An optional object specifying output options. The object may contain the
+following fields.
+.INDENT 7.0
+.TP
+.B \fBshortProgress\fP
+An optional bool. If true, equivalent to passing
+\X'tty: link #cmdoption-ctest-progress'\fI\%\-\-progress\fP\X'tty: link' on the command line.
+.TP
+.B \fBverbosity\fP
+An optional string specifying verbosity level. Must be one of the
+following:
+.INDENT 7.0
+.TP
+.B \fBdefault\fP
+Equivalent to passing no verbosity flags on the command line.
+.TP
+.B \fBverbose\fP
+Equivalent to passing \X'tty: link #cmdoption-ctest-V'\fI\%\-\-verbose\fP\X'tty: link' on
+the command line.
+.TP
+.B \fBextra\fP
+Equivalent to passing \X'tty: link #cmdoption-ctest-VV'\fI\%\-\-extra\-verbose\fP\X'tty: link'
+on the command line.
+.UNINDENT
+.TP
+.B \fBdebug\fP
+An optional bool. If true, equivalent to passing
+\X'tty: link #cmdoption-ctest-debug'\fI\%\-\-debug\fP\X'tty: link' on the command line.
+.TP
+.B \fBoutputOnFailure\fP
+An optional bool. If true, equivalent to passing
+\X'tty: link #cmdoption-ctest-output-on-failure'\fI\%\-\-output\-on\-failure\fP\X'tty: link' on the command
+line.
+.TP
+.B \fBquiet\fP
+An optional bool. If true, equivalent to passing
+\X'tty: link #cmdoption-ctest-Q'\fI\%\-\-quiet\fP\X'tty: link' on the command line.
+.TP
+.B \fBoutputLogFile\fP
+An optional string specifying a path to a log file. Equivalent to
+passing \X'tty: link #cmdoption-ctest-O'\fI\%\-\-output\-log\fP\X'tty: link' on the command line.
+This field supports macro expansion.
+.TP
+.B \fBoutputJUnitFile\fP
+An optional string specifying a path to a JUnit file. Equivalent to
+passing \X'tty: link #cmdoption-ctest-output-junit'\fI\%\-\-output\-junit\fP\X'tty: link' on the command line.
+This field supports macro expansion. This is allowed in preset files
+specifying version \fB6\fP or above.
+.TP
+.B \fBlabelSummary\fP
+An optional bool. If false, equivalent to passing
+\X'tty: link #cmdoption-ctest-no-label-summary'\fI\%\-\-no\-label\-summary\fP\X'tty: link' on the command
+line.
+.TP
+.B \fBsubprojectSummary\fP
+An optional bool. If false, equivalent to passing
+\X'tty: link #cmdoption-ctest-no-subproject-summary'\fI\%\-\-no\-subproject\-summary\fP\X'tty: link'
+on the command line.
+.TP
+.B \fBmaxPassedTestOutputSize\fP
+An optional integer specifying the maximum output for passed tests in
+bytes. Equivalent to passing
+\X'tty: link #cmdoption-ctest-test-output-size-passed'\fI\%\-\-test\-output\-size\-passed\fP\X'tty: link'
+on the command line.
+.TP
+.B \fBmaxFailedTestOutputSize\fP
+An optional integer specifying the maximum output for failed tests in
+bytes. Equivalent to passing
+\X'tty: link #cmdoption-ctest-test-output-size-failed'\fI\%\-\-test\-output\-size\-failed\fP\X'tty: link'
+on the command line.
+.TP
+.B \fBtestOutputTruncation\fP
+An optional string specifying the test output truncation mode. Equivalent
+to passing
+\X'tty: link #cmdoption-ctest-test-output-truncation'\fI\%\-\-test\-output\-truncation\fP\X'tty: link' on
+the command line. This is allowed in preset files specifying version
+\fB5\fP or above.
+.TP
+.B \fBmaxTestNameWidth\fP
+An optional integer specifying the maximum width of a test name to
+output. Equivalent to passing \X'tty: link #cmdoption-ctest-max-width'\fI\%\-\-max\-width\fP\X'tty: link'
+on the command line.
+.UNINDENT
+.TP
+.B \fBfilter\fP
+An optional object specifying how to filter the tests to run. The object
+may contain the following fields.
+.INDENT 7.0
+.TP
+.B \fBinclude\fP
+An optional object specifying which tests to include. The object may
+contain the following fields.
+.INDENT 7.0
+.TP
+.B \fBname\fP
+An optional string specifying a regex for test names. Equivalent to
+passing \X'tty: link #cmdoption-ctest-R'\fI\%\-\-tests\-regex\fP\X'tty: link' on the command
+line. This field supports macro expansion. CMake regex syntax is
+described under \X'tty: link #regex-specification'\fI\%string(REGEX)\fP\X'tty: link'\&.
+.TP
+.B \fBlabel\fP
+An optional string specifying a regex for test labels. Equivalent to
+passing \X'tty: link #cmdoption-ctest-L'\fI\%\-\-label\-regex\fP\X'tty: link' on the command
+line. This field supports macro expansion.
+.TP
+.B \fBuseUnion\fP
+An optional bool. Equivalent to passing \X'tty: link #cmdoption-ctest-U'\fI\%\-\-union\fP\X'tty: link'
+on the command line.
+.TP
+.B \fBindex\fP
+An optional object specifying tests to include by test index. The
+object may contain the following fields. Can also be an optional
+string specifying a file with the command line syntax for
+\X'tty: link #cmdoption-ctest-I'\fI\%\-\-tests\-information\fP\X'tty: link'\&.
+If specified as a string, this field supports macro expansion.
+.INDENT 7.0
+.TP
+.B \fBstart\fP
+An optional integer specifying a test index to start testing at.
+.TP
+.B \fBend\fP
+An optional integer specifying a test index to stop testing at.
+.TP
+.B \fBstride\fP
+An optional integer specifying the increment.
+.TP
+.B \fBspecificTests\fP
+An optional array of integers specifying specific test indices to
+run.
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBexclude\fP
+An optional object specifying which tests to exclude. The object may
+contain the following fields.
+.INDENT 7.0
+.TP
+.B \fBname\fP
+An optional string specifying a regex for test names. Equivalent to
+passing \X'tty: link #cmdoption-ctest-E'\fI\%\-\-exclude\-regex\fP\X'tty: link' on the
+command line. This field supports macro expansion.
+.TP
+.B \fBlabel\fP
+An optional string specifying a regex for test labels. Equivalent to
+passing \X'tty: link #cmdoption-ctest-LE'\fI\%\-\-label\-exclude\fP\X'tty: link' on the
+command line. This field supports macro expansion.
+.TP
+.B \fBfixtures\fP
+An optional object specifying which fixtures to exclude from adding
+tests. The object may contain the following fields.
+.INDENT 7.0
+.TP
+.B \fBany\fP
+An optional string specifying a regex for text fixtures to exclude
+from adding any tests. Equivalent to
+\X'tty: link #cmdoption-ctest-FA'\fI\%\-\-fixture\-exclude\-any\fP\X'tty: link' on
+the command line. This field supports macro expansion.
+.TP
+.B \fBsetup\fP
+An optional string specifying a regex for text fixtures to exclude
+from adding setup tests. Equivalent to
+\X'tty: link #cmdoption-ctest-FS'\fI\%\-\-fixture\-exclude\-setup\fP\X'tty: link'
+on the command line. This field supports macro expansion.
+.TP
+.B \fBcleanup\fP
+An optional string specifying a regex for text fixtures to exclude
+from adding cleanup tests. Equivalent to
+\X'tty: link #cmdoption-ctest-FC'\fI\%\-\-fixture\-exclude\-cleanup\fP\X'tty: link'
+on the command line. This field supports macro expansion.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.TP
+.B \fBexecution\fP
+An optional object specifying options for test execution. The object may
+contain the following fields.
+.INDENT 7.0
+.TP
+.B \fBstopOnFailure\fP
+An optional bool. If true, equivalent to passing
+\X'tty: link #cmdoption-ctest-stop-on-failure'\fI\%\-\-stop\-on\-failure\fP\X'tty: link' on the command
+line.
+.TP
+.B \fBenableFailover\fP
+An optional bool. If true, equivalent to passing \X'tty: link #cmdoption-ctest-F'\fI\%\-F\fP\X'tty: link'
+on the command line.
+.TP
+.B \fBjobs\fP
+An optional integer. Equivalent to passing
+\X'tty: link #cmdoption-ctest-j'\fI\%\-\-parallel\fP\X'tty: link' on the command line.
+.TP
+.B \fBresourceSpecFile\fP
+An optional string. Equivalent to passing
+\X'tty: link #cmdoption-ctest-resource-spec-file'\fI\%\-\-resource\-spec\-file\fP\X'tty: link' on
+the command line. This field supports macro expansion.
+.TP
+.B \fBtestLoad\fP
+An optional integer. Equivalent to passing
+\X'tty: link #cmdoption-ctest-test-load'\fI\%\-\-test\-load\fP\X'tty: link' on the command line.
+.TP
+.B \fBshowOnly\fP
+An optional string. Equivalent to passing
+\X'tty: link #cmdoption-ctest-N'\fI\%\-\-show\-only\fP\X'tty: link' on the
+command line. The string must be one of the following values:
+.sp
+\fBhuman\fP
+.sp
+\fBjson\-v1\fP
+.TP
+.B \fBrepeat\fP
+An optional object specifying how to repeat tests. Equivalent to
+passing \X'tty: link #cmdoption-ctest-repeat'\fI\%\-\-repeat\fP\X'tty: link' on the command line.
+The object must have the following fields.
+.INDENT 7.0
+.TP
+.B \fBmode\fP
+A required string. Must be one of the following values:
+.sp
+\fBuntil\-fail\fP
+.sp
+\fBuntil\-pass\fP
+.sp
+\fBafter\-timeout\fP
+.TP
+.B \fBcount\fP
+A required integer.
+.UNINDENT
+.TP
+.B \fBinteractiveDebugging\fP
+An optional bool. If true, equivalent to passing
+\X'tty: link #cmdoption-ctest-interactive-debug-mode'\fI\%\-\-interactive\-debug\-mode 1\fP\X'tty: link'
+on the command line. If false, equivalent to passing
+\X'tty: link #cmdoption-ctest-interactive-debug-mode'\fI\%\-\-interactive\-debug\-mode 0\fP\X'tty: link'
+on the command line.
+.TP
+.B \fBscheduleRandom\fP
+An optional bool. If true, equivalent to passing
+\X'tty: link #cmdoption-ctest-schedule-random'\fI\%\-\-schedule\-random\fP\X'tty: link' on the command
+line.
+.TP
+.B \fBtimeout\fP
+An optional integer. Equivalent to passing
+\X'tty: link #cmdoption-ctest-timeout'\fI\%\-\-timeout\fP\X'tty: link' on the command line.
+.TP
+.B \fBnoTestsAction\fP
+An optional string specifying the behavior if no tests are found. Must
+be one of the following values:
+.INDENT 7.0
+.TP
+.B \fBdefault\fP
+Equivalent to not passing any value on the command line.
+.TP
+.B \fBerror\fP
+Equivalent to passing \X'tty: link #cmdoption-ctest-no-tests'\fI\%\-\-no\-tests=error\fP\X'tty: link'
+on the command line.
+.TP
+.B \fBignore\fP
+Equivalent to passing \X'tty: link #cmdoption-ctest-no-tests'\fI\%\-\-no\-tests=ignore\fP\X'tty: link'
+on the command line.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS Package Preset
+.sp
+Package presets may be used in schema version \fB6\fP or above. Each entry of
+the \fBpackagePresets\fP array is a JSON object that may contain the following
+fields:
+.INDENT 0.0
+.TP
+.B \fBname\fP
+A required string representing the machine\-friendly name of the preset.
+This identifier is used in the \X'tty: link #cmdoption-cpack-preset'\fI\%cpack \-\-preset\fP\X'tty: link' option.
+There must not be two package presets in the union of \fBCMakePresets.json\fP
+and \fBCMakeUserPresets.json\fP in the same directory with the same name.
+However, a package preset may have the same name as a configure, build,
+test, or workflow preset.
+.TP
+.B \fBhidden\fP
+An optional boolean specifying whether or not a preset should be hidden.
+If a preset is hidden, it cannot be used in the
+\X'tty: link #cmdoption-cpack-preset'\fI\%\-\-preset\fP\X'tty: link' argument
+and does not have to have a valid \fBconfigurePreset\fP, even from
+inheritance. \fBhidden\fP presets are intended to be used as a base for
+other presets to inherit via the \fBinherits\fP field.
+.TP
+.B \fBinherits\fP
+An optional array of strings representing the names of presets to inherit
+from. This field can also be a string, which is equivalent to an array
+containing one string.
+.sp
+The preset will inherit all of the fields from the
+\fBinherits\fP presets by default (except \fBname\fP, \fBhidden\fP,
+\fBinherits\fP, \fBdescription\fP, and \fBdisplayName\fP), but can override
+them as desired. If multiple \fBinherits\fP presets provide conflicting
+values for the same field, the earlier preset in the \fBinherits\fP array
+will be preferred.
+.sp
+A preset can only inherit from another preset that is defined in the
+same file or in one of the files it includes (directly or indirectly).
+Presets in \fBCMakePresets.json\fP may not inherit from presets in
+\fBCMakeUserPresets.json\fP\&.
+.TP
+.B \fBcondition\fP
+An optional \fI\%Condition\fP object.
+.TP
+.B \fBvendor\fP
+An optional map containing vendor\-specific information. CMake does not
+interpret the contents of this field except to verify that it is a map
+if it does exist. However, it should follow the same conventions as the
+root\-level \fBvendor\fP field. If vendors use their own per\-preset
+\fBvendor\fP field, they should implement inheritance in a sensible manner
+when appropriate.
+.TP
+.B \fBdisplayName\fP
+An optional string with a human\-friendly name of the preset.
+.TP
+.B \fBdescription\fP
+An optional string with a human\-friendly description of the preset.
+.TP
+.B \fBenvironment\fP
+An optional map of environment variables. The key is the variable name
+(which may not be an empty string), and the value is either \fBnull\fP or
+a string representing the value of the variable. Each variable is set
+regardless of whether or not a value was given to it by the process\(aqs
+environment.
+.sp
+This field supports \fI\%macro expansion\fP, and environment variables in this map
+may reference each other, and may be listed in any order, as long as such
+references do not cause a cycle (for example, if \fBENV_1\fP is
+\fB$env{ENV_2}\fP, \fBENV_2\fP may not be \fB$env{ENV_1}\fP).  \fB$penv{NAME}\fP
+allows one to prepend or append values to existing environment variables by
+accessing only values from the parent environment.
+.sp
+Environment variables are inherited through the \fBinherits\fP field, and
+the preset\(aqs environment will be the union of its own \fBenvironment\fP
+and the \fBenvironment\fP from all its parents. If multiple presets in
+this union define the same variable, the standard rules of \fBinherits\fP
+are applied. Setting a variable to \fBnull\fP causes it to not be set,
+even if a value was inherited from another preset.
+.TP
+.B \fBconfigurePreset\fP
+An optional string specifying the name of a configure preset to
+associate with this package preset. If \fBconfigurePreset\fP is not
+specified, it must be inherited from the inherits preset (unless this
+preset is hidden). The build directory is inferred from the configure
+preset, so packaging will run in the same \fBbinaryDir\fP that the
+configuration did and build did.
+.TP
+.B \fBinheritConfigureEnvironment\fP
+An optional boolean that defaults to true. If true, the environment
+variables from the associated configure preset are inherited after all
+inherited package preset environments, but before environment variables
+explicitly specified in this package preset.
+.TP
+.B \fBgenerators\fP
+An optional array of strings representing generators for CPack to use.
+.TP
+.B \fBconfigurations\fP
+An optional array of strings representing build configurations for CPack to
+package.
+.TP
+.B \fBvariables\fP
+An optional map of variables to pass to CPack, equivalent to
+\X'tty: link #cmdoption-cpack-D'\fI\%\-D\fP\X'tty: link' arguments. Each key is the name of a variable, and
+the value is the string to assign to that variable.
+.TP
+.B \fBconfigFile\fP
+An optional string representing the config file for CPack to use.
+.TP
+.B \fBoutput\fP
+An optional object specifying output options. Valid keys are:
+.INDENT 7.0
+.TP
+.B \fBdebug\fP
+An optional boolean specifying whether or not to print debug information.
+A value of \fBtrue\fP is equivalent to passing
+\X'tty: link #cmdoption-cpack-debug'\fI\%\-\-debug\fP\X'tty: link' on the command line.
+.TP
+.B \fBverbose\fP
+An optional boolean specifying whether or not to print verbosely. A value
+of \fBtrue\fP is equivalent to passing \X'tty: link #cmdoption-cpack-V'\fI\%\-\-verbose\fP\X'tty: link'
+on the command line.
+.UNINDENT
+.TP
+.B \fBpackageName\fP
+An optional string representing the package name.
+.TP
+.B \fBpackageVersion\fP
+An optional string representing the package version.
+.TP
+.B \fBpackageDirectory\fP
+An optional string representing the directory in which to place the package.
+.TP
+.B \fBvendorName\fP
+An optional string representing the vendor name.
+.UNINDENT
+.SS Workflow Preset
+.sp
+Workflow presets may be used in schema version \fB6\fP or above. Each entry of
+the \fBworkflowPresets\fP array is a JSON object that may contain the following
+fields:
+.INDENT 0.0
+.TP
+.B \fBname\fP
+A required string representing the machine\-friendly name of the preset.
+This identifier is used in the
+\X'tty: link #workflow-mode'\fI\%cmake \-\-workflow \-\-preset\fP\X'tty: link' option. There must not be
+two workflow presets in the union of \fBCMakePresets.json\fP and
+\fBCMakeUserPresets.json\fP in the same directory with the same name. However,
+a workflow preset may have the same name as a configure, build, test, or
+package preset.
+.TP
+.B \fBvendor\fP
+An optional map containing vendor\-specific information. CMake does not
+interpret the contents of this field except to verify that it is a map
+if it does exist. However, it should follow the same conventions as the
+root\-level \fBvendor\fP field.
+.TP
+.B \fBdisplayName\fP
+An optional string with a human\-friendly name of the preset.
+.TP
+.B \fBdescription\fP
+An optional string with a human\-friendly description of the preset.
+.TP
+.B \fBsteps\fP
+A required array of objects describing the steps of the workflow. The first
+step must be a configure preset, and all subsequent steps must be non\-
+configure presets whose \fBconfigurePreset\fP field matches the starting
+configure preset. Each object may contain the following fields:
+.INDENT 7.0
+.TP
+.B \fBtype\fP
+A required string. The first step must be \fBconfigure\fP\&. Subsequent steps
+must be either \fBbuild\fP, \fBtest\fP, or \fBpackage\fP\&.
+.TP
+.B \fBname\fP
+A required string representing the name of the configure, build, test, or
+package preset to run as this workflow step.
+.UNINDENT
+.UNINDENT
+.SS Condition
+.sp
+The \fBcondition\fP field of a preset, allowed in preset files specifying version
+\fB3\fP or above, is used to determine whether or not the preset is enabled. For
+example, this can be used to disable a preset on platforms other than Windows.
+\fBcondition\fP may be either a boolean, \fBnull\fP, or an object. If it is a
+boolean, the boolean indicates whether the preset is enabled or disabled. If it
+is \fBnull\fP, the preset is enabled, but the \fBnull\fP condition is not inherited
+by any presets that may inherit from the preset. Sub\-conditions (for example in
+a \fBnot\fP, \fBanyOf\fP, or \fBallOf\fP condition) may not be \fBnull\fP\&. If it is an
+object, it has the following fields:
+.INDENT 0.0
+.TP
+.B \fBtype\fP
+A required string with one of the following values:
+.INDENT 7.0
+.TP
+.B \fB\(dqconst\(dq\fP
+Indicates that the condition is constant. This is equivalent to using a
+boolean in place of the object. The condition object will have the
+following additional fields:
+.INDENT 7.0
+.TP
+.B \fBvalue\fP
+A required boolean which provides a constant value for the condition\(aqs
+evaluation.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\(dqequals\(dq\fP
+.INDENT 7.0
+.TP
+.B \fB\(dqnotEquals\(dq\fP
+Indicates that the condition compares two strings to see if they are equal
+(or not equal). The condition object will have the following additional
+fields:
+.INDENT 7.0
+.TP
+.B \fBlhs\fP
+First string to compare. This field supports macro expansion.
+.TP
+.B \fBrhs\fP
+Second string to compare. This field supports macro expansion.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\(dqinList\(dq\fP
+.INDENT 7.0
+.TP
+.B \fB\(dqnotInList\(dq\fP
+Indicates that the condition searches for a string in a list of strings.
+The condition object will have the following additional fields:
+.INDENT 7.0
+.TP
+.B \fBstring\fP
+A required string to search for. This field supports macro expansion.
+.TP
+.B \fBlist\fP
+A required array of strings to search. This field supports macro
+expansion, and uses short\-circuit evaluation.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\(dqmatches\(dq\fP
+.INDENT 7.0
+.TP
+.B \fB\(dqnotMatches\(dq\fP
+Indicates that the condition searches for a regular expression in a string.
+The condition object will have the following additional fields:
+.INDENT 7.0
+.TP
+.B \fBstring\fP
+A required string to search. This field supports macro expansion.
+.TP
+.B \fBregex\fP
+A required regular expression to search for. This field supports macro
+expansion.
+.UNINDENT
+.UNINDENT
+.sp
+\fB\(dqanyOf\(dq\fP
+.sp
+\fB\(dqallOf\(dq\fP
+.INDENT 7.0
+.INDENT 3.5
+Indicates that the condition is an aggregation of zero or more nested
+conditions. The condition object will have the following additional fields:
+.INDENT 0.0
+.TP
+.B \fBconditions\fP
+A required array of condition objects. These conditions use short\-circuit
+evaluation.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.INDENT 7.0
+.TP
+.B \fB\(dqnot\(dq\fP
+Indicates that the condition is an inversion of another condition. The
+condition object will have the following additional fields:
+.INDENT 7.0
+.TP
+.B \fBcondition\fP
+A required condition object.
+.UNINDENT
+.UNINDENT
+.UNINDENT
+.SS Macro Expansion
+.sp
+As mentioned above, some fields support macro expansion. Macros are
+recognized in the form \fB$<macro\-namespace>{<macro\-name>}\fP\&. All macros are
+evaluated in the context of the preset being used, even if the macro is in a
+field that was inherited from another preset. For example, if the \fBBase\fP
+preset sets variable \fBPRESET_NAME\fP to \fB${presetName}\fP, and the
+\fBDerived\fP preset inherits from \fBBase\fP, \fBPRESET_NAME\fP will be set to
+\fBDerived\fP\&.
+.sp
+It is an error to not put a closing brace at the end of a macro name. For
+example, \fB${sourceDir\fP is invalid. A dollar sign (\fB$\fP) followed by
+anything other than a left curly brace (\fB{\fP) with a possible namespace is
+interpreted as a literal dollar sign.
+.sp
+Recognized macros include:
+.INDENT 0.0
+.TP
+.B \fB${sourceDir}\fP
+Path to the project source directory (i.e. the same as
+\X'tty: link #variable:CMAKE_SOURCE_DIR'\fI\%CMAKE_SOURCE_DIR\fP\X'tty: link').
+.TP
+.B \fB${sourceParentDir}\fP
+Path to the project source directory\(aqs parent directory.
+.TP
+.B \fB${sourceDirName}\fP
+The last filename component of \fB${sourceDir}\fP\&. For example, if
+\fB${sourceDir}\fP is \fB/path/to/source\fP, this would be \fBsource\fP\&.
+.TP
+.B \fB${presetName}\fP
+Name specified in the preset\(aqs \fBname\fP field.
+.sp
+This is a preset\-specific macro.
+.TP
+.B \fB${generator}\fP
+Generator specified in the preset\(aqs \fBgenerator\fP field. For build and
+test presets, this will evaluate to the generator specified by
+\fBconfigurePreset\fP\&.
+.sp
+This is a preset\-specific macro.
+.TP
+.B \fB${hostSystemName}\fP
+The name of the host operating system. Contains the same value as
+\X'tty: link #variable:CMAKE_HOST_SYSTEM_NAME'\fI\%CMAKE_HOST_SYSTEM_NAME\fP\X'tty: link'\&. This is allowed in preset files
+specifying version \fB3\fP or above.
+.TP
+.B \fB${fileDir}\fP
+Path to the directory containing the preset file which contains the macro.
+This is allowed in preset files specifying version \fB4\fP or above.
+.TP
+.B \fB${dollar}\fP
+A literal dollar sign (\fB$\fP).
+.TP
+.B \fB${pathListSep}\fP
+Native character for separating lists of paths, such as \fB:\fP or \fB;\fP\&.
+.sp
+For example, by setting \fBPATH\fP to
+\fB/path/to/ninja/bin${pathListSep}$env{PATH}\fP, \fB${pathListSep}\fP will
+expand to the underlying operating system\(aqs character used for
+concatenation in \fBPATH\fP\&.
+.sp
+This is allowed in preset files specifying version \fB5\fP or above.
+.TP
+.B \fB$env{<variable\-name>}\fP
+Environment variable with name \fB<variable\-name>\fP\&. The variable name may
+not be an empty string. If the variable is defined in the \fBenvironment\fP
+field, that value is used instead of the value from the parent environment.
+If the environment variable is not defined, this evaluates as an empty
+string.
+.sp
+Note that while Windows environment variable names are case\-insensitive,
+variable names within a preset are still case\-sensitive. This may lead to
+unexpected results when using inconsistent casing. For best results, keep
+the casing of environment variable names consistent.
+.TP
+.B \fB$penv{<variable\-name>}\fP
+Similar to \fB$env{<variable\-name>}\fP, except that the value only comes from
+the parent environment, and never from the \fBenvironment\fP field. This
+allows one to prepend or append values to existing environment variables.
+For example, setting \fBPATH\fP to \fB/path/to/ninja/bin:$penv{PATH}\fP will
+prepend \fB/path/to/ninja/bin\fP to the \fBPATH\fP environment variable. This
+is needed because \fB$env{<variable\-name>}\fP does not allow circular
+references.
+.TP
+.B \fB$vendor{<macro\-name>}\fP
+An extension point for vendors to insert their own macros. CMake will not
+be able to use presets which have a \fB$vendor{<macro\-name>}\fP macro, and
+effectively ignores such presets. However, it will still be able to use
+other presets from the same file.
+.sp
+CMake does not make any attempt to interpret \fB$vendor{<macro\-name>}\fP
+macros. However, to avoid name collisions, IDE vendors should prefix
+\fB<macro\-name>\fP with a very short (preferably <= 4 characters) vendor
+identifier prefix, followed by a \fB\&.\fP, followed by the macro name. For
+example, the Example IDE could have \fB$vendor{xide.ideInstallDir}\fP\&.
+.UNINDENT
+.SH SCHEMA
+.sp
+\fBThis file\fP provides a machine\-readable
+JSON schema for the \fBCMakePresets.json\fP format.
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-qt.7

@@ -0,0 +1,333 @@
+.\" 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-QT" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-qt \- CMake Qt Features Reference
+.SH INTRODUCTION
+.sp
+CMake can find and use Qt 4, Qt 5 and Qt 6 libraries. The Qt 4 libraries are
+found by the \X'tty: link #module:FindQt4'\fI\%FindQt4\fP\X'tty: link' find\-module shipped with CMake, whereas the
+Qt 5 and Qt 6 libraries are found using \(dqConfig\-file Packages\(dq shipped with
+Qt 5 and Qt 6. See \X'tty: link #manual:cmake-packages(7)'\fI\%cmake\-packages(7)\fP\X'tty: link' for more information about CMake
+packages, and see \X'tty: link https://doc.qt.io/qt-6/cmake-manual.html'\fI\%the Qt cmake manual\fP\X'tty: link' for your Qt version.
+.sp
+Qt 4, Qt 5 and Qt 6 may be used together in the same
+\X'tty: link #manual:cmake-buildsystem(7)'\fI\%CMake buildsystem\fP\X'tty: link':
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+cmake_minimum_required(VERSION 3.16 FATAL_ERROR)
+
+project(Qt4_5_6)
+
+set(CMAKE_AUTOMOC ON)
+
+find_package(Qt6 COMPONENTS Widgets DBus REQUIRED)
+add_executable(publisher publisher.cpp)
+target_link_libraries(publisher Qt6::Widgets Qt6::DBus)
+
+find_package(Qt5 COMPONENTS Gui DBus REQUIRED)
+add_executable(subscriber1 subscriber1.cpp)
+target_link_libraries(subscriber1 Qt5::Gui Qt5::DBus)
+
+find_package(Qt4 REQUIRED)
+add_executable(subscriber2 subscriber2.cpp)
+target_link_libraries(subscriber2 Qt4::QtGui Qt4::QtDBus)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+A CMake target may not link to more than one Qt version.  A diagnostic is issued
+if this is attempted or results from transitive target dependency evaluation.
+.SH QT BUILD TOOLS
+.sp
+Qt relies on some bundled tools for code generation, such as \fBmoc\fP for
+meta\-object code generation, \fBuic\fP for widget layout and population,
+and \fBrcc\fP for virtual file system content generation.  These tools may be
+automatically invoked by \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' if the appropriate conditions
+are met.  The automatic tool invocation may be used with Qt version 4 to 6.
+.SS AUTOMOC
+.sp
+The \X'tty: link #prop_tgt:AUTOMOC'\fI\%AUTOMOC\fP\X'tty: link' target property controls whether \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link'
+inspects the C++ files in the target to determine if they require \fBmoc\fP to
+be run, and to create rules to execute \fBmoc\fP at the appropriate time.
+.sp
+If a macro from \X'tty: link #prop_tgt:AUTOMOC_MACRO_NAMES'\fI\%AUTOMOC_MACRO_NAMES\fP\X'tty: link' is found in a header file,
+\fBmoc\fP will be run on the file.  The result will be put into a file named
+according to \fBmoc_<basename>.cpp\fP\&.
+If the macro is found in a C++ implementation
+file, the moc output will be put into a file named according to
+\fB<basename>.moc\fP, following the Qt conventions.  The \fB<basename>.moc\fP must
+be included by the user in the C++ implementation file with a preprocessor
+\fB#include\fP\&.
+.sp
+Included \fBmoc_*.cpp\fP and \fB*.moc\fP files will be generated in the
+\fB<AUTOGEN_BUILD_DIR>/include\fP directory which is
+automatically added to the target\(aqs \X'tty: link #prop_tgt:INCLUDE_DIRECTORIES'\fI\%INCLUDE_DIRECTORIES\fP\X'tty: link'\&.
+.INDENT 0.0
+.IP \(bu 2
+This differs from CMake 3.7 and below; see their documentation for details.
+.IP \(bu 2
+For \X'tty: link #prop_gbl:GENERATOR_IS_MULTI_CONFIG'\fI\%multi configuration generators\fP\X'tty: link',
+the include directory is \fB<AUTOGEN_BUILD_DIR>/include_<CONFIG>\fP\&.
+.IP \(bu 2
+See \X'tty: link #prop_tgt:AUTOGEN_BUILD_DIR'\fI\%AUTOGEN_BUILD_DIR\fP\X'tty: link'\&.
+.UNINDENT
+.sp
+Not included \fBmoc_<basename>.cpp\fP files will be generated in custom
+folders to avoid name collisions and included in a separate
+file which is compiled into the target, named either
+\fB<AUTOGEN_BUILD_DIR>/mocs_compilation.cpp\fP or
+\fB<AUTOGEN_BUILD_DIR>/mocs_compilation_$<CONFIG>.cpp\fP\&.
+.INDENT 0.0
+.IP \(bu 2
+See \X'tty: link #prop_tgt:AUTOGEN_BUILD_DIR'\fI\%AUTOGEN_BUILD_DIR\fP\X'tty: link'\&.
+.UNINDENT
+.sp
+The \fBmoc\fP command line will consume the \X'tty: link #prop_tgt:COMPILE_DEFINITIONS'\fI\%COMPILE_DEFINITIONS\fP\X'tty: link' and
+\X'tty: link #prop_tgt:INCLUDE_DIRECTORIES'\fI\%INCLUDE_DIRECTORIES\fP\X'tty: link' target properties from the target it is being
+invoked for, and for the appropriate build configuration.
+.sp
+The \X'tty: link #prop_tgt:AUTOMOC'\fI\%AUTOMOC\fP\X'tty: link' target property may be pre\-set for all
+following targets by setting the \X'tty: link #variable:CMAKE_AUTOMOC'\fI\%CMAKE_AUTOMOC\fP\X'tty: link' variable.  The
+\X'tty: link #prop_tgt:AUTOMOC_MOC_OPTIONS'\fI\%AUTOMOC_MOC_OPTIONS\fP\X'tty: link' target property may be populated to set
+options to pass to \fBmoc\fP\&. The \X'tty: link #variable:CMAKE_AUTOMOC_MOC_OPTIONS'\fI\%CMAKE_AUTOMOC_MOC_OPTIONS\fP\X'tty: link'
+variable may be populated to pre\-set the options for all following targets.
+.sp
+Additional macro names to search for can be added to
+\X'tty: link #prop_tgt:AUTOMOC_MACRO_NAMES'\fI\%AUTOMOC_MACRO_NAMES\fP\X'tty: link'\&.
+.sp
+Additional \fBmoc\fP dependency file names can be extracted from source code
+by using \X'tty: link #prop_tgt:AUTOMOC_DEPEND_FILTERS'\fI\%AUTOMOC_DEPEND_FILTERS\fP\X'tty: link'\&.
+.sp
+Source C++ files can be excluded from \X'tty: link #prop_tgt:AUTOMOC'\fI\%AUTOMOC\fP\X'tty: link' processing by
+enabling \X'tty: link #prop_sf:SKIP_AUTOMOC'\fI\%SKIP_AUTOMOC\fP\X'tty: link' or the broader \X'tty: link #prop_sf:SKIP_AUTOGEN'\fI\%SKIP_AUTOGEN\fP\X'tty: link'\&.
+.SS AUTOUIC
+.sp
+The \X'tty: link #prop_tgt:AUTOUIC'\fI\%AUTOUIC\fP\X'tty: link' target property controls whether \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link'
+inspects the C++ files in the target to determine if they require \fBuic\fP to
+be run, and to create rules to execute \fBuic\fP at the appropriate time.
+.sp
+If a preprocessor \fB#include\fP directive is found which matches
+\fB<path>ui_<basename>.h\fP, and a \fB<basename>.ui\fP file exists,
+then \fBuic\fP will be executed to generate the appropriate file.
+The \fB<basename>.ui\fP file is searched for in the following places
+.INDENT 0.0
+.IP 1. 3
+\fB<source_dir>/<basename>.ui\fP
+.IP 2. 3
+\fB<source_dir>/<path><basename>.ui\fP
+.IP 3. 3
+\fB<AUTOUIC_SEARCH_PATHS>/<basename>.ui\fP
+.IP 4. 3
+\fB<AUTOUIC_SEARCH_PATHS>/<path><basename>.ui\fP
+.UNINDENT
+.sp
+where \fB<source_dir>\fP is the directory of the C++ file and
+\X'tty: link #prop_tgt:AUTOUIC_SEARCH_PATHS'\fI\%AUTOUIC_SEARCH_PATHS\fP\X'tty: link' is a list of additional search paths.
+.sp
+The generated generated \fBui_*.h\fP files are placed in the
+\fB<AUTOGEN_BUILD_DIR>/include\fP directory which is
+automatically added to the target\(aqs \X'tty: link #prop_tgt:INCLUDE_DIRECTORIES'\fI\%INCLUDE_DIRECTORIES\fP\X'tty: link'\&.
+.INDENT 0.0
+.IP \(bu 2
+This differs from CMake 3.7 and below; see their documentation for details.
+.IP \(bu 2
+For \X'tty: link #prop_gbl:GENERATOR_IS_MULTI_CONFIG'\fI\%multi configuration generators\fP\X'tty: link',
+the include directory is \fB<AUTOGEN_BUILD_DIR>/include_<CONFIG>\fP\&.
+.IP \(bu 2
+See \X'tty: link #prop_tgt:AUTOGEN_BUILD_DIR'\fI\%AUTOGEN_BUILD_DIR\fP\X'tty: link'\&.
+.UNINDENT
+.sp
+The \X'tty: link #prop_tgt:AUTOUIC'\fI\%AUTOUIC\fP\X'tty: link' target property may be pre\-set for all following
+targets by setting the \X'tty: link #variable:CMAKE_AUTOUIC'\fI\%CMAKE_AUTOUIC\fP\X'tty: link' variable.  The
+\X'tty: link #prop_tgt:AUTOUIC_OPTIONS'\fI\%AUTOUIC_OPTIONS\fP\X'tty: link' target property may be populated to set options
+to pass to \fBuic\fP\&.  The \X'tty: link #variable:CMAKE_AUTOUIC_OPTIONS'\fI\%CMAKE_AUTOUIC_OPTIONS\fP\X'tty: link' variable may be
+populated to pre\-set the options for all following targets.  The
+\X'tty: link #prop_sf:AUTOUIC_OPTIONS'\fI\%AUTOUIC_OPTIONS\fP\X'tty: link' source file property may be set on the
+\fB<basename>.ui\fP file to set particular options for the file.  This
+overrides options from the \X'tty: link #prop_tgt:AUTOUIC_OPTIONS'\fI\%AUTOUIC_OPTIONS\fP\X'tty: link' target property.
+.sp
+A target may populate the \X'tty: link #prop_tgt:INTERFACE_AUTOUIC_OPTIONS'\fI\%INTERFACE_AUTOUIC_OPTIONS\fP\X'tty: link' target
+property with options that should be used when invoking \fBuic\fP\&.  This must be
+consistent with the \X'tty: link #prop_tgt:AUTOUIC_OPTIONS'\fI\%AUTOUIC_OPTIONS\fP\X'tty: link' target property content of the
+depender target.  The \X'tty: link #variable:CMAKE_DEBUG_TARGET_PROPERTIES'\fI\%CMAKE_DEBUG_TARGET_PROPERTIES\fP\X'tty: link' variable may
+be used to track the origin target of such
+\X'tty: link #prop_tgt:INTERFACE_AUTOUIC_OPTIONS'\fI\%INTERFACE_AUTOUIC_OPTIONS\fP\X'tty: link'\&.  This means that a library which
+provides an alternative translation system for Qt may specify options which
+should be used when running \fBuic\fP:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_library(KI18n klocalizedstring.cpp)
+target_link_libraries(KI18n Qt6::Core)
+
+# KI18n uses the tr2i18n() function instead of tr().  That function is
+# declared in the klocalizedstring.h header.
+set(autouic_options
+  \-tr tr2i18n
+  \-include klocalizedstring.h
+)
+
+set_property(TARGET KI18n APPEND PROPERTY
+  INTERFACE_AUTOUIC_OPTIONS ${autouic_options}
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+A consuming project linking to the target exported from upstream automatically
+uses appropriate options when \fBuic\fP is run by \X'tty: link #prop_tgt:AUTOUIC'\fI\%AUTOUIC\fP\X'tty: link', as a
+result of linking with the \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' target:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_AUTOUIC ON)
+# Uses a libwidget.ui file:
+add_library(LibWidget libwidget.cpp)
+target_link_libraries(LibWidget
+  KF5::KI18n
+  Qt5::Widgets
+)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Source files can be excluded from \X'tty: link #prop_tgt:AUTOUIC'\fI\%AUTOUIC\fP\X'tty: link' processing by
+enabling \X'tty: link #prop_sf:SKIP_AUTOUIC'\fI\%SKIP_AUTOUIC\fP\X'tty: link' or the broader \X'tty: link #prop_sf:SKIP_AUTOGEN'\fI\%SKIP_AUTOGEN\fP\X'tty: link'\&.
+.SS AUTORCC
+.sp
+The \X'tty: link #prop_tgt:AUTORCC'\fI\%AUTORCC\fP\X'tty: link' target property controls whether \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link'
+creates rules to execute \fBrcc\fP at the appropriate time on source files
+which have the suffix \fB\&.qrc\fP\&.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_executable(myexe main.cpp resource_file.qrc)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \X'tty: link #prop_tgt:AUTORCC'\fI\%AUTORCC\fP\X'tty: link' target property may be pre\-set for all following targets
+by setting the \X'tty: link #variable:CMAKE_AUTORCC'\fI\%CMAKE_AUTORCC\fP\X'tty: link' variable.  The
+\X'tty: link #prop_tgt:AUTORCC_OPTIONS'\fI\%AUTORCC_OPTIONS\fP\X'tty: link' target property may be populated to set options
+to pass to \fBrcc\fP\&.  The \X'tty: link #variable:CMAKE_AUTORCC_OPTIONS'\fI\%CMAKE_AUTORCC_OPTIONS\fP\X'tty: link' variable may be
+populated to pre\-set the options for all following targets.  The
+\X'tty: link #prop_sf:AUTORCC_OPTIONS'\fI\%AUTORCC_OPTIONS\fP\X'tty: link' source file property may be set on the
+\fB<name>.qrc\fP file to set particular options for the file.  This
+overrides options from the \X'tty: link #prop_tgt:AUTORCC_OPTIONS'\fI\%AUTORCC_OPTIONS\fP\X'tty: link' target property.
+.sp
+Source files can be excluded from \X'tty: link #prop_tgt:AUTORCC'\fI\%AUTORCC\fP\X'tty: link' processing by
+enabling \X'tty: link #prop_sf:SKIP_AUTORCC'\fI\%SKIP_AUTORCC\fP\X'tty: link' or the broader \X'tty: link #prop_sf:SKIP_AUTOGEN'\fI\%SKIP_AUTOGEN\fP\X'tty: link'\&.
+.SH THE <ORIGIN>_AUTOGEN TARGET
+.sp
+The \fBmoc\fP and \fBuic\fP tools are executed as part of a synthesized
+\fI\%The <ORIGIN>_autogen target\fP \X'tty: link #command:add_custom_target'\fI\%custom target\fP\X'tty: link' generated by
+CMake.  By default that \fI\%The <ORIGIN>_autogen target\fP target inherits the dependencies
+of the \fB<ORIGIN>\fP target (see \X'tty: link #prop_tgt:AUTOGEN_ORIGIN_DEPENDS'\fI\%AUTOGEN_ORIGIN_DEPENDS\fP\X'tty: link').
+Target dependencies may be added to the \fI\%The <ORIGIN>_autogen target\fP target by adding
+them to the \X'tty: link #prop_tgt:AUTOGEN_TARGET_DEPENDS'\fI\%AUTOGEN_TARGET_DEPENDS\fP\X'tty: link' target property.
+.sp
+\fBNOTE:\fP
+.INDENT 0.0
+.INDENT 3.5
+If Qt 5.15 or later is used and the generator is either \X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link' or
+\X'tty: link #makefile-generators'\fI\%Makefile Generators\fP\X'tty: link', see \fI\%The <ORIGIN>_autogen_timestamp_deps target\fP\&.
+.UNINDENT
+.UNINDENT
+.SH THE <ORIGIN>_AUTOGEN_TIMESTAMP_DEPS TARGET
+.sp
+If Qt 5.15 or later is used and the generator is either \X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link' or
+\X'tty: link #makefile-generators'\fI\%Makefile Generators\fP\X'tty: link', the \fB<ORIGIN>_autogen_timestamp_deps\fP target is
+also created in addition to the \fI\%The <ORIGIN>_autogen target\fP target.  This target
+does not have any sources or commands to execute, but it has dependencies that
+were previously inherited by the pre\-Qt 5.15 \fI\%The <ORIGIN>_autogen target\fP target.
+These dependencies will serve as a list of order\-only dependencies for the
+custom command, without forcing the custom command to re\-execute.
+.SH VISUAL STUDIO GENERATORS
+.sp
+When using the \X'tty: link #manual:cmake-generators(7)'\fI\%Visual Studio generators\fP\X'tty: link', CMake
+generates a \fBPRE_BUILD\fP \X'tty: link #command:add_custom_command'\fI\%custom command\fP\X'tty: link'
+instead of the \fI\%The <ORIGIN>_autogen target\fP
+\X'tty: link #command:add_custom_target'\fI\%custom target\fP\X'tty: link' (for \X'tty: link #prop_tgt:AUTOMOC'\fI\%AUTOMOC\fP\X'tty: link' and
+\X'tty: link #prop_tgt:AUTOUIC'\fI\%AUTOUIC\fP\X'tty: link').  This isn\(aqt always possible though and an
+\fI\%The <ORIGIN>_autogen target\fP \X'tty: link #command:add_custom_target'\fI\%custom target\fP\X'tty: link' is used,
+when either
+.INDENT 0.0
+.IP \(bu 2
+the \fB<ORIGIN>\fP target depends on \X'tty: link #prop_sf:GENERATED'\fI\%GENERATED\fP\X'tty: link' files which aren\(aqt
+excluded from \X'tty: link #prop_tgt:AUTOMOC'\fI\%AUTOMOC\fP\X'tty: link' and \X'tty: link #prop_tgt:AUTOUIC'\fI\%AUTOUIC\fP\X'tty: link' by
+\X'tty: link #prop_sf:SKIP_AUTOMOC'\fI\%SKIP_AUTOMOC\fP\X'tty: link', \X'tty: link #prop_sf:SKIP_AUTOUIC'\fI\%SKIP_AUTOUIC\fP\X'tty: link', \X'tty: link #prop_sf:SKIP_AUTOGEN'\fI\%SKIP_AUTOGEN\fP\X'tty: link'
+or \X'tty: link #policy:CMP0071'\fI\%CMP0071\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:AUTOGEN_TARGET_DEPENDS'\fI\%AUTOGEN_TARGET_DEPENDS\fP\X'tty: link' lists a source file
+.IP \(bu 2
+\X'tty: link #variable:CMAKE_GLOBAL_AUTOGEN_TARGET'\fI\%CMAKE_GLOBAL_AUTOGEN_TARGET\fP\X'tty: link' is enabled
+.UNINDENT
+.SH QTMAIN.LIB ON WINDOWS
+.sp
+The Qt 4 and 5 \X'tty: link #prop_tgt:IMPORTED'\fI\%IMPORTED\fP\X'tty: link' targets for the QtGui libraries specify
+that the qtmain.lib static library shipped with Qt will be linked by all
+dependent executables which have the \X'tty: link #prop_tgt:WIN32_EXECUTABLE'\fI\%WIN32_EXECUTABLE\fP\X'tty: link' enabled.
+.sp
+To disable this behavior, enable the \fBQt5_NO_LINK_QTMAIN\fP target property for
+Qt 5 based targets or \fBQT4_NO_LINK_QTMAIN\fP target property for Qt 4 based
+targets.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+add_executable(myexe WIN32 main.cpp)
+target_link_libraries(myexe Qt4::QtGui)
+
+add_executable(myexe_no_qtmain WIN32 main_no_qtmain.cpp)
+set_property(TARGET main_no_qtmain PROPERTY QT4_NO_LINK_QTMAIN ON)
+target_link_libraries(main_no_qtmain Qt4::QtGui)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-server.7

@@ -0,0 +1,39 @@
+.\" 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-SERVER" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-server \- CMake Server
+.sp
+The \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' server mode has been removed since CMake 3.20.
+Clients should use the \X'tty: link #manual:cmake-file-api(7)'\fI\%cmake\-file\-api(7)\fP\X'tty: link' instead.
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/man/man7/cmake-toolchains.7

@@ -0,0 +1,906 @@
+.\" 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-TOOLCHAINS" "7" "Jan 10, 2025" "3.31.4" "CMake"
+.SH NAME
+cmake-toolchains \- CMake Toolchains Reference
+.SH INTRODUCTION
+.sp
+CMake uses a toolchain of utilities to compile, link libraries and create
+archives, and other tasks to drive the build. The toolchain utilities available
+are determined by the languages enabled. In normal builds, CMake automatically
+determines the toolchain for host builds based on system introspection and
+defaults. In cross\-compiling scenarios, a toolchain file may be specified
+with information about compiler and utility paths.
+.sp
+Added in version 3.19: One may use \X'tty: link #manual:cmake-presets(7)'\fI\%cmake\-presets(7)\fP\X'tty: link' to specify toolchain files.
+
+.SH LANGUAGES
+.sp
+Languages are enabled by the \X'tty: link #command:project'\fI\%project()\fP\X'tty: link' command.  Language\-specific
+built\-in variables, such as
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_CXX_COMPILER\fP\X'tty: link',
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER_ID'\fI\%CMAKE_CXX_COMPILER_ID\fP\X'tty: link' etc are set by
+invoking the \X'tty: link #command:project'\fI\%project()\fP\X'tty: link' command.  If no project command
+is in the top\-level CMakeLists file, one will be implicitly generated. By default
+the enabled languages are \fBC\fP and \fBCXX\fP:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+project(C_Only C)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+A special value of \fBNONE\fP can also be used with the \X'tty: link #command:project'\fI\%project()\fP\X'tty: link' command
+to enable no languages:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+project(MyProject NONE)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \X'tty: link #command:enable_language'\fI\%enable_language()\fP\X'tty: link' command can be used to enable languages after the
+\X'tty: link #command:project'\fI\%project()\fP\X'tty: link' command:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+enable_language(CXX)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+When a language is enabled, CMake finds a compiler for that language, and
+determines some information, such as the vendor and version of the compiler,
+the target architecture and bitwidth, the location of corresponding utilities
+etc.
+.sp
+The \X'tty: link #prop_gbl:ENABLED_LANGUAGES'\fI\%ENABLED_LANGUAGES\fP\X'tty: link' global property contains the languages which
+are currently enabled.
+.SH VARIABLES AND PROPERTIES
+.sp
+Several variables relate to the language components of a toolchain which are
+enabled:
+.INDENT 0.0
+.TP
+.B \X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_<LANG>_COMPILER\fP\X'tty: link'
+The full path to the compiler used for \fB<LANG>\fP
+.TP
+.B \X'tty: link #variable:CMAKE_<LANG>_COMPILER_ID'\fI\%CMAKE_<LANG>_COMPILER_ID\fP\X'tty: link'
+The compiler identifier used by CMake
+.TP
+.B \X'tty: link #variable:CMAKE_<LANG>_COMPILER_VERSION'\fI\%CMAKE_<LANG>_COMPILER_VERSION\fP\X'tty: link'
+The version of the compiler.
+.TP
+.B \X'tty: link #variable:CMAKE_<LANG>_FLAGS'\fI\%CMAKE_<LANG>_FLAGS\fP\X'tty: link'
+The variables and the configuration\-specific equivalents contain flags that
+will be added to the compile command when compiling a file of a particular
+language.
+.UNINDENT
+.sp
+CMake needs a way to determine which compiler to use to invoke the linker.
+This is determined by the \X'tty: link #prop_sf:LANGUAGE'\fI\%LANGUAGE\fP\X'tty: link' property of source files of the
+\X'tty: link #manual:cmake-buildsystem(7)'\fI\%target\fP\X'tty: link', and in the case of static libraries,
+the \fBLANGUAGE\fP of the dependent libraries. The choice CMake makes may be overridden
+with the \X'tty: link #prop_tgt:LINKER_LANGUAGE'\fI\%LINKER_LANGUAGE\fP\X'tty: link' target property.
+.SH TOOLCHAIN FEATURES
+.sp
+CMake provides the \X'tty: link #command:try_compile'\fI\%try_compile()\fP\X'tty: link' command and wrapper macros such as
+\X'tty: link #module:CheckSourceCompiles'\fI\%CheckSourceCompiles\fP\X'tty: link', \X'tty: link #module:CheckCXXSymbolExists'\fI\%CheckCXXSymbolExists\fP\X'tty: link' and
+\X'tty: link #module:CheckIncludeFile'\fI\%CheckIncludeFile\fP\X'tty: link' to test capability and availability of various
+toolchain features. These APIs test the toolchain in some way and cache the
+result so that the test does not have to be performed again the next time
+CMake runs.
+.sp
+Some toolchain features have built\-in handling in CMake, and do not require
+compile\-tests. For example, \X'tty: link #prop_tgt:POSITION_INDEPENDENT_CODE'\fI\%POSITION_INDEPENDENT_CODE\fP\X'tty: link' allows
+specifying that a target should be built as position\-independent code, if
+the compiler supports that feature. The \X'tty: link #prop_tgt:<LANG>_VISIBILITY_PRESET'\fI\%<LANG>_VISIBILITY_PRESET\fP\X'tty: link'
+and \X'tty: link #prop_tgt:VISIBILITY_INLINES_HIDDEN'\fI\%VISIBILITY_INLINES_HIDDEN\fP\X'tty: link' target properties add flags for
+hidden visibility, if supported by the compiler.
+.SH CROSS COMPILING
+.sp
+If \X'tty: link #manual:cmake(1)'\fI\%cmake(1)\fP\X'tty: link' is invoked with the command line parameter
+\X'tty: link #cmdoption-cmake-toolchain'\fI\%\-\-toolchain path/to/file\fP\X'tty: link' or
+\X'tty: link #cmdoption-cmake-D'\fI\%\-DCMAKE_TOOLCHAIN_FILE=path/to/file\fP\X'tty: link', the
+file will be loaded early to set values for the compilers.
+The \X'tty: link #variable:CMAKE_CROSSCOMPILING'\fI\%CMAKE_CROSSCOMPILING\fP\X'tty: link' variable is set to true when CMake is
+cross\-compiling.
+.sp
+Note that using the \X'tty: link #variable:CMAKE_SOURCE_DIR'\fI\%CMAKE_SOURCE_DIR\fP\X'tty: link' or \X'tty: link #variable:CMAKE_BINARY_DIR'\fI\%CMAKE_BINARY_DIR\fP\X'tty: link'
+variables inside a toolchain file is typically undesirable.  The toolchain
+file is used in contexts where these variables have different values when used
+in different places (e.g. as part of a call to \X'tty: link #command:try_compile'\fI\%try_compile()\fP\X'tty: link').  In most
+cases, where there is a need to evaluate paths inside a toolchain file, the more
+appropriate variable to use would be \X'tty: link #variable:CMAKE_CURRENT_LIST_DIR'\fI\%CMAKE_CURRENT_LIST_DIR\fP\X'tty: link', since
+it always has an unambiguous, predictable value.
+.SS Cross Compiling for Linux
+.sp
+A typical cross\-compiling toolchain for Linux has content such
+as:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_SYSTEM_NAME Linux)
+set(CMAKE_SYSTEM_PROCESSOR arm)
+
+set(CMAKE_SYSROOT /home/devel/rasp\-pi\-rootfs)
+set(CMAKE_STAGING_PREFIX /home/devel/stage)
+
+set(tools /home/devel/gcc\-4.7\-linaro\-rpi\-gnueabihf)
+set(CMAKE_C_COMPILER ${tools}/bin/arm\-linux\-gnueabihf\-gcc)
+set(CMAKE_CXX_COMPILER ${tools}/bin/arm\-linux\-gnueabihf\-g++)
+
+set(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
+set(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
+set(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)
+set(CMAKE_FIND_ROOT_PATH_MODE_PACKAGE ONLY)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Where:
+.INDENT 0.0
+.TP
+.B \X'tty: link #variable:CMAKE_SYSTEM_NAME'\fI\%CMAKE_SYSTEM_NAME\fP\X'tty: link'
+is the CMake\-identifier of the target platform to build for.
+.TP
+.B \X'tty: link #variable:CMAKE_SYSTEM_PROCESSOR'\fI\%CMAKE_SYSTEM_PROCESSOR\fP\X'tty: link'
+is the CMake\-identifier of the target architecture.
+.TP
+.B \X'tty: link #variable:CMAKE_SYSROOT'\fI\%CMAKE_SYSROOT\fP\X'tty: link'
+is optional, and may be specified if a sysroot is available.
+.TP
+.B \X'tty: link #variable:CMAKE_STAGING_PREFIX'\fI\%CMAKE_STAGING_PREFIX\fP\X'tty: link'
+is also optional. It may be used to specify a path on the host to install to.
+The \X'tty: link #variable:CMAKE_INSTALL_PREFIX'\fI\%CMAKE_INSTALL_PREFIX\fP\X'tty: link' is always the runtime installation
+location, even when cross\-compiling.
+.TP
+.B \X'tty: link #variable:CMAKE_<LANG>_COMPILER'\fI\%CMAKE_<LANG>_COMPILER\fP\X'tty: link'
+variable may be set to full paths, or to names of compilers to search for
+in standard locations.  For toolchains that do not support linking binaries
+without custom flags or scripts one may set the
+\X'tty: link #variable:CMAKE_TRY_COMPILE_TARGET_TYPE'\fI\%CMAKE_TRY_COMPILE_TARGET_TYPE\fP\X'tty: link' variable to \fBSTATIC_LIBRARY\fP to
+tell CMake not to try to link executables during its checks.
+.UNINDENT
+.sp
+CMake \fBfind_*\fP commands will look in the sysroot, and the \X'tty: link #variable:CMAKE_FIND_ROOT_PATH'\fI\%CMAKE_FIND_ROOT_PATH\fP\X'tty: link'
+entries by default in all cases, as well as looking in the host system root prefix.
+Although this can be controlled on a case\-by\-case basis, when cross\-compiling, it
+can be useful to exclude looking in either the host or the target for particular
+artifacts. Generally, includes, libraries and packages should be found in the
+target system prefixes, whereas executables which must be run as part of the build
+should be found only on the host and not on the target. This is the purpose of
+the \fBCMAKE_FIND_ROOT_PATH_MODE_*\fP variables.
+.SS Cross Compiling for the Cray Linux Environment
+.sp
+Cross compiling for compute nodes in the Cray Linux Environment can be done
+without needing a separate toolchain file.  Specifying
+\fB\-DCMAKE_SYSTEM_NAME=CrayLinuxEnvironment\fP on the CMake command line will
+ensure that the appropriate build settings and search paths are configured.
+The platform will pull its configuration from the current environment
+variables and will configure a project to use the compiler wrappers from the
+Cray Programming Environment\(aqs \fBPrgEnv\-*\fP modules if present and loaded.
+.sp
+The default configuration of the Cray Programming Environment is to only
+support static libraries.  This can be overridden and shared libraries
+enabled by setting the \fBCRAYPE_LINK_TYPE\fP environment variable to
+\fBdynamic\fP\&.
+.sp
+Running CMake without specifying \X'tty: link #variable:CMAKE_SYSTEM_NAME'\fI\%CMAKE_SYSTEM_NAME\fP\X'tty: link' will
+run the configure step in host mode assuming a standard Linux environment.
+If not overridden, the \fBPrgEnv\-*\fP compiler wrappers will end up getting used,
+which if targeting the either the login node or compute node, is likely not the
+desired behavior.  The exception to this would be if you are building directly
+on a NID instead of cross\-compiling from a login node. If trying to build
+software for a login node, you will need to either first unload the
+currently loaded \fBPrgEnv\-*\fP module or explicitly tell CMake to use the
+system compilers in \fB/usr/bin\fP instead of the Cray wrappers.  If instead
+targeting a compute node is desired, just specify the
+\X'tty: link #variable:CMAKE_SYSTEM_NAME'\fI\%CMAKE_SYSTEM_NAME\fP\X'tty: link' as mentioned above.
+.SS Cross Compiling using Clang
+.sp
+Some compilers such as Clang are inherently cross compilers.
+The \X'tty: link #variable:CMAKE_<LANG>_COMPILER_TARGET'\fI\%CMAKE_<LANG>_COMPILER_TARGET\fP\X'tty: link' can be set to pass a
+value to those supported compilers when compiling:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_SYSTEM_NAME Linux)
+set(CMAKE_SYSTEM_PROCESSOR arm)
+
+set(triple arm\-linux\-gnueabihf)
+
+set(CMAKE_C_COMPILER clang)
+set(CMAKE_C_COMPILER_TARGET ${triple})
+set(CMAKE_CXX_COMPILER clang++)
+set(CMAKE_CXX_COMPILER_TARGET ${triple})
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Similarly, some compilers do not ship their own supplementary utilities
+such as linkers, but provide a way to specify the location of the external
+toolchain which will be used by the compiler driver. The
+\X'tty: link #variable:CMAKE_<LANG>_COMPILER_EXTERNAL_TOOLCHAIN'\fI\%CMAKE_<LANG>_COMPILER_EXTERNAL_TOOLCHAIN\fP\X'tty: link' variable can be set in a
+toolchain file to pass the path to the compiler driver.
+.SS Cross Compiling for QNX
+.sp
+As the Clang compiler the QNX QCC compile is inherently a cross compiler.
+And the \X'tty: link #variable:CMAKE_<LANG>_COMPILER_TARGET'\fI\%CMAKE_<LANG>_COMPILER_TARGET\fP\X'tty: link' can be set to pass a
+value to those supported compilers when compiling:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_SYSTEM_NAME QNX)
+
+set(arch gcc_ntoarmv7le)
+
+set(CMAKE_C_COMPILER qcc)
+set(CMAKE_C_COMPILER_TARGET ${arch})
+set(CMAKE_CXX_COMPILER QCC)
+set(CMAKE_CXX_COMPILER_TARGET ${arch})
+
+set(CMAKE_SYSROOT $ENV{QNX_TARGET})
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Cross Compiling for Windows CE
+.sp
+Cross compiling for Windows CE requires the corresponding SDK being
+installed on your system.  These SDKs are usually installed under
+\fBC:/Program Files (x86)/Windows CE Tools/SDKs\fP\&.
+.sp
+A toolchain file to configure a Visual Studio generator for
+Windows CE may look like this:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_SYSTEM_NAME WindowsCE)
+
+set(CMAKE_SYSTEM_VERSION 8.0)
+set(CMAKE_SYSTEM_PROCESSOR arm)
+
+set(CMAKE_GENERATOR_TOOLSET CE800) # Can be omitted for 8.0
+set(CMAKE_GENERATOR_PLATFORM SDK_AM335X_SK_WEC2013_V310)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \X'tty: link #variable:CMAKE_GENERATOR_PLATFORM'\fI\%CMAKE_GENERATOR_PLATFORM\fP\X'tty: link' tells the generator which SDK to use.
+Further \X'tty: link #variable:CMAKE_SYSTEM_VERSION'\fI\%CMAKE_SYSTEM_VERSION\fP\X'tty: link' tells the generator what version of
+Windows CE to use.  Currently version 8.0 (Windows Embedded Compact 2013) is
+supported out of the box.  Other versions may require one to set
+\X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' to the correct value.
+.SS Cross Compiling for Windows 10 Universal Applications
+.sp
+A toolchain file to configure \X'tty: link #visual-studio-generators'\fI\%Visual Studio Generators\fP\X'tty: link' for a
+Windows 10 Universal Application may look like this:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_SYSTEM_NAME WindowsStore)
+set(CMAKE_SYSTEM_VERSION 10.0)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+A Windows 10 Universal Application targets both Windows Store and
+Windows Phone.  Specify the \X'tty: link #variable:CMAKE_SYSTEM_VERSION'\fI\%CMAKE_SYSTEM_VERSION\fP\X'tty: link' variable
+to be \fB10.0\fP or higher.
+.sp
+CMake selects a Windows SDK as described by documentation of the
+\X'tty: link #variable:CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION'\fI\%CMAKE_VS_WINDOWS_TARGET_PLATFORM_VERSION\fP\X'tty: link' variable.
+.SS Cross Compiling for Windows Phone
+.sp
+A toolchain file to configure a Visual Studio generator for
+Windows Phone may look like this:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_SYSTEM_NAME WindowsPhone)
+set(CMAKE_SYSTEM_VERSION 8.1)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Cross Compiling for Windows Store
+.sp
+A toolchain file to configure a Visual Studio generator for
+Windows Store may look like this:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_SYSTEM_NAME WindowsStore)
+set(CMAKE_SYSTEM_VERSION 8.1)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Cross Compiling for ADSP SHARC/Blackfin
+.sp
+Cross\-compiling for ADSP SHARC or Blackfin can be configured
+by setting the \X'tty: link #variable:CMAKE_SYSTEM_NAME'\fI\%CMAKE_SYSTEM_NAME\fP\X'tty: link' variable to \fBADSP\fP
+and the \X'tty: link #variable:CMAKE_SYSTEM_PROCESSOR'\fI\%CMAKE_SYSTEM_PROCESSOR\fP\X'tty: link' variable
+to the \(dqpart number\(dq, excluding the \fBADSP\-\fP prefix,
+for example, \fB21594\fP, \fBSC589\fP, etc.
+This value is case insensitive.
+.sp
+CMake will automatically search for CCES or VDSP++ installs
+in their default install locations
+and select the most recent version found.
+CCES will be selected over VDSP++ if both are installed.
+Custom install paths can be set via the \X'tty: link #variable:CMAKE_ADSP_ROOT'\fI\%CMAKE_ADSP_ROOT\fP\X'tty: link' variable
+or the \X'tty: link #envvar:ADSP_ROOT'\fI\%ADSP_ROOT\fP\X'tty: link' environment variable.
+.sp
+The compiler (\fBcc21k\fP vs. \fBccblkfn\fP) is selected automatically
+based on the \X'tty: link #variable:CMAKE_SYSTEM_PROCESSOR'\fI\%CMAKE_SYSTEM_PROCESSOR\fP\X'tty: link' value provided.
+.SS Cross Compiling for Android
+.sp
+A toolchain file may configure cross\-compiling for Android by setting the
+\X'tty: link #variable:CMAKE_SYSTEM_NAME'\fI\%CMAKE_SYSTEM_NAME\fP\X'tty: link' variable to \fBAndroid\fP\&.  Further configuration
+is specific to the Android development environment to be used.
+.sp
+For \X'tty: link #visual-studio-generators'\fI\%Visual Studio Generators\fP\X'tty: link', CMake expects \fI\%NVIDIA Nsight Tegra
+Visual Studio Edition\fP or the \fI\%Visual Studio tools for Android\fP to be installed. See those sections
+for further configuration details.
+.sp
+For \X'tty: link #makefile-generators'\fI\%Makefile Generators\fP\X'tty: link' and the \X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link' generator,
+CMake expects one of these environments:
+.INDENT 0.0
+.IP \(bu 2
+\fI\%NDK\fP
+.IP \(bu 2
+\fI\%Standalone Toolchain\fP
+.UNINDENT
+.sp
+CMake uses the following steps to select one of the environments:
+.INDENT 0.0
+.IP \(bu 2
+If the \X'tty: link #variable:CMAKE_ANDROID_NDK'\fI\%CMAKE_ANDROID_NDK\fP\X'tty: link' variable is set, the NDK at the
+specified location will be used.
+.IP \(bu 2
+Else, if the \X'tty: link #variable:CMAKE_ANDROID_STANDALONE_TOOLCHAIN'\fI\%CMAKE_ANDROID_STANDALONE_TOOLCHAIN\fP\X'tty: link' variable
+is set, the Standalone Toolchain at the specified location will be used.
+.IP \(bu 2
+Else, if the \X'tty: link #variable:CMAKE_SYSROOT'\fI\%CMAKE_SYSROOT\fP\X'tty: link' variable is set to a directory
+of the form \fB<ndk>/platforms/android\-<api>/arch\-<arch>\fP, the \fB<ndk>\fP
+part will be used as the value of \X'tty: link #variable:CMAKE_ANDROID_NDK'\fI\%CMAKE_ANDROID_NDK\fP\X'tty: link' and the
+NDK will be used.
+.IP \(bu 2
+Else, if the \X'tty: link #variable:CMAKE_SYSROOT'\fI\%CMAKE_SYSROOT\fP\X'tty: link' variable is set to a directory of the
+form \fB<standalone\-toolchain>/sysroot\fP, the \fB<standalone\-toolchain>\fP part
+will be used as the value of \X'tty: link #variable:CMAKE_ANDROID_STANDALONE_TOOLCHAIN'\fI\%CMAKE_ANDROID_STANDALONE_TOOLCHAIN\fP\X'tty: link'
+and the Standalone Toolchain will be used.
+.IP \(bu 2
+Else, if a cmake variable \fBANDROID_NDK\fP is set it will be used
+as the value of \X'tty: link #variable:CMAKE_ANDROID_NDK'\fI\%CMAKE_ANDROID_NDK\fP\X'tty: link', and the NDK will be used.
+.IP \(bu 2
+Else, if a cmake variable \fBANDROID_STANDALONE_TOOLCHAIN\fP is set, it will be
+used as the value of \X'tty: link #variable:CMAKE_ANDROID_STANDALONE_TOOLCHAIN'\fI\%CMAKE_ANDROID_STANDALONE_TOOLCHAIN\fP\X'tty: link', and the
+Standalone Toolchain will be used.
+.IP \(bu 2
+Else, if an environment variable \fBANDROID_NDK_ROOT\fP or
+\fBANDROID_NDK\fP is set, it will be used as the value of
+\X'tty: link #variable:CMAKE_ANDROID_NDK'\fI\%CMAKE_ANDROID_NDK\fP\X'tty: link', and the NDK will be used.
+.IP \(bu 2
+Else, if an environment variable \fBANDROID_STANDALONE_TOOLCHAIN\fP is
+set then it will be used as the value of
+\X'tty: link #variable:CMAKE_ANDROID_STANDALONE_TOOLCHAIN'\fI\%CMAKE_ANDROID_STANDALONE_TOOLCHAIN\fP\X'tty: link', and the Standalone
+Toolchain will be used.
+.IP \(bu 2
+Else, an error diagnostic will be issued that neither the NDK or
+Standalone Toolchain can be found.
+.UNINDENT
+.sp
+Added in version 3.20: If an Android NDK is selected, its version number is reported
+in the \X'tty: link #variable:CMAKE_ANDROID_NDK_VERSION'\fI\%CMAKE_ANDROID_NDK_VERSION\fP\X'tty: link' variable.
+
+.SS Cross Compiling for Android with the NDK
+.sp
+A toolchain file may configure \X'tty: link #makefile-generators'\fI\%Makefile Generators\fP\X'tty: link',
+\X'tty: link #ninja-generators'\fI\%Ninja Generators\fP\X'tty: link', or \X'tty: link #visual-studio-generators'\fI\%Visual Studio Generators\fP\X'tty: link' to target
+Android for cross\-compiling.
+.sp
+Configure use of an Android NDK with the following variables:
+.INDENT 0.0
+.TP
+.B \X'tty: link #variable:CMAKE_SYSTEM_NAME'\fI\%CMAKE_SYSTEM_NAME\fP\X'tty: link'
+Set to \fBAndroid\fP\&.  Must be specified to enable cross compiling
+for Android.
+.TP
+.B \X'tty: link #variable:CMAKE_SYSTEM_VERSION'\fI\%CMAKE_SYSTEM_VERSION\fP\X'tty: link'
+Set to the Android API level.  If not specified, the value is
+determined as follows:
+.INDENT 7.0
+.IP \(bu 2
+If the \X'tty: link #variable:CMAKE_ANDROID_API'\fI\%CMAKE_ANDROID_API\fP\X'tty: link' variable is set, its value
+is used as the API level.
+.IP \(bu 2
+If the \X'tty: link #variable:CMAKE_SYSROOT'\fI\%CMAKE_SYSROOT\fP\X'tty: link' variable is set, the API level is
+detected from the NDK directory structure containing the sysroot.
+.IP \(bu 2
+Otherwise, the latest API level available in the NDK is used.
+.UNINDENT
+.TP
+.B \X'tty: link #variable:CMAKE_ANDROID_ARCH_ABI'\fI\%CMAKE_ANDROID_ARCH_ABI\fP\X'tty: link'
+Set to the Android ABI (architecture).  If not specified, this
+variable will default to the first supported ABI in the list of
+\fBarmeabi\fP, \fBarmeabi\-v7a\fP and \fBarm64\-v8a\fP\&.
+The \X'tty: link #variable:CMAKE_ANDROID_ARCH'\fI\%CMAKE_ANDROID_ARCH\fP\X'tty: link' variable will be computed
+from \fBCMAKE_ANDROID_ARCH_ABI\fP automatically.
+Also see the \X'tty: link #variable:CMAKE_ANDROID_ARM_MODE'\fI\%CMAKE_ANDROID_ARM_MODE\fP\X'tty: link' and
+\X'tty: link #variable:CMAKE_ANDROID_ARM_NEON'\fI\%CMAKE_ANDROID_ARM_NEON\fP\X'tty: link' variables.
+.TP
+.B \X'tty: link #variable:CMAKE_ANDROID_NDK'\fI\%CMAKE_ANDROID_NDK\fP\X'tty: link'
+Set to the absolute path to the Android NDK root directory.
+If not specified, a default for this variable will be chosen
+as specified \fI\%above\fP\&.
+.TP
+.B \X'tty: link #variable:CMAKE_ANDROID_NDK_DEPRECATED_HEADERS'\fI\%CMAKE_ANDROID_NDK_DEPRECATED_HEADERS\fP\X'tty: link'
+Set to a true value to use the deprecated per\-api\-level headers
+instead of the unified headers.  If not specified, the default will
+be false unless using a NDK that does not provide unified headers.
+.TP
+.B \X'tty: link #variable:CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION'\fI\%CMAKE_ANDROID_NDK_TOOLCHAIN_VERSION\fP\X'tty: link'
+On NDK r19 or above, this variable must be unset or set to \fBclang\fP\&.
+On NDK r18 or below, set this to the version of the NDK toolchain to
+be selected as the compiler.  If not specified, the default will be
+the latest available GCC toolchain.
+.TP
+.B \X'tty: link #variable:CMAKE_ANDROID_STL_TYPE'\fI\%CMAKE_ANDROID_STL_TYPE\fP\X'tty: link'
+Set to specify which C++ standard library to use.  If not specified,
+a default will be selected as described in the variable documentation.
+.UNINDENT
+.sp
+The following variables will be computed and provided automatically:
+.INDENT 0.0
+.TP
+.B \X'tty: link #variable:CMAKE_<LANG>_ANDROID_TOOLCHAIN_PREFIX'\fI\%CMAKE_<LANG>_ANDROID_TOOLCHAIN_PREFIX\fP\X'tty: link'
+The absolute path prefix to the binutils in the NDK toolchain.
+.TP
+.B \X'tty: link #variable:CMAKE_<LANG>_ANDROID_TOOLCHAIN_SUFFIX'\fI\%CMAKE_<LANG>_ANDROID_TOOLCHAIN_SUFFIX\fP\X'tty: link'
+The host platform suffix of the binutils in the NDK toolchain.
+.UNINDENT
+.sp
+For example, a toolchain file might contain:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_SYSTEM_NAME Android)
+set(CMAKE_SYSTEM_VERSION 21) # API level
+set(CMAKE_ANDROID_ARCH_ABI arm64\-v8a)
+set(CMAKE_ANDROID_NDK /path/to/android\-ndk)
+set(CMAKE_ANDROID_STL_TYPE gnustl_static)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Alternatively one may specify the values without a toolchain file:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ cmake ../src \e
+  \-DCMAKE_SYSTEM_NAME=Android \e
+  \-DCMAKE_SYSTEM_VERSION=21 \e
+  \-DCMAKE_ANDROID_ARCH_ABI=arm64\-v8a \e
+  \-DCMAKE_ANDROID_NDK=/path/to/android\-ndk \e
+  \-DCMAKE_ANDROID_STL_TYPE=gnustl_static
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Cross Compiling for Android with a Standalone Toolchain
+.sp
+A toolchain file may configure \X'tty: link #makefile-generators'\fI\%Makefile Generators\fP\X'tty: link' or the
+\X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link' generator to target Android for cross\-compiling
+using a standalone toolchain.
+.sp
+Configure use of an Android standalone toolchain with the following variables:
+.INDENT 0.0
+.TP
+.B \X'tty: link #variable:CMAKE_SYSTEM_NAME'\fI\%CMAKE_SYSTEM_NAME\fP\X'tty: link'
+Set to \fBAndroid\fP\&.  Must be specified to enable cross compiling
+for Android.
+.TP
+.B \X'tty: link #variable:CMAKE_ANDROID_STANDALONE_TOOLCHAIN'\fI\%CMAKE_ANDROID_STANDALONE_TOOLCHAIN\fP\X'tty: link'
+Set to the absolute path to the standalone toolchain root directory.
+A \fB${CMAKE_ANDROID_STANDALONE_TOOLCHAIN}/sysroot\fP directory
+must exist.
+If not specified, a default for this variable will be chosen
+as specified \fI\%above\fP\&.
+.TP
+.B \X'tty: link #variable:CMAKE_ANDROID_ARM_MODE'\fI\%CMAKE_ANDROID_ARM_MODE\fP\X'tty: link'
+When the standalone toolchain targets ARM, optionally set this to \fBON\fP
+to target 32\-bit ARM instead of 16\-bit Thumb.
+See variable documentation for details.
+.TP
+.B \X'tty: link #variable:CMAKE_ANDROID_ARM_NEON'\fI\%CMAKE_ANDROID_ARM_NEON\fP\X'tty: link'
+When the standalone toolchain targets ARM v7, optionally set thisto \fBON\fP
+to target ARM NEON devices.  See variable documentation for details.
+.UNINDENT
+.sp
+The following variables will be computed and provided automatically:
+.INDENT 0.0
+.TP
+.B \X'tty: link #variable:CMAKE_SYSTEM_VERSION'\fI\%CMAKE_SYSTEM_VERSION\fP\X'tty: link'
+The Android API level detected from the standalone toolchain.
+.TP
+.B \X'tty: link #variable:CMAKE_ANDROID_ARCH_ABI'\fI\%CMAKE_ANDROID_ARCH_ABI\fP\X'tty: link'
+The Android ABI detected from the standalone toolchain.
+.TP
+.B \X'tty: link #variable:CMAKE_<LANG>_ANDROID_TOOLCHAIN_PREFIX'\fI\%CMAKE_<LANG>_ANDROID_TOOLCHAIN_PREFIX\fP\X'tty: link'
+The absolute path prefix to the \fBbinutils\fP in the standalone toolchain.
+.TP
+.B \X'tty: link #variable:CMAKE_<LANG>_ANDROID_TOOLCHAIN_SUFFIX'\fI\%CMAKE_<LANG>_ANDROID_TOOLCHAIN_SUFFIX\fP\X'tty: link'
+The host platform suffix of the \fBbinutils\fP in the standalone toolchain.
+.UNINDENT
+.sp
+For example, a toolchain file might contain:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_SYSTEM_NAME Android)
+set(CMAKE_ANDROID_STANDALONE_TOOLCHAIN /path/to/android\-toolchain)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Alternatively one may specify the values without a toolchain file:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ cmake ../src \e
+  \-DCMAKE_SYSTEM_NAME=Android \e
+  \-DCMAKE_ANDROID_STANDALONE_TOOLCHAIN=/path/to/android\-toolchain
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Cross Compiling for Android with NVIDIA Nsight Tegra Visual Studio Edition
+.sp
+A toolchain file to configure one of the \X'tty: link #visual-studio-generators'\fI\%Visual Studio Generators\fP\X'tty: link'
+to build using NVIDIA Nsight Tegra targeting Android may look like this:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+set(CMAKE_SYSTEM_NAME Android)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The \X'tty: link #variable:CMAKE_GENERATOR_TOOLSET'\fI\%CMAKE_GENERATOR_TOOLSET\fP\X'tty: link' may be set to select
+the Nsight Tegra \(dqToolchain Version\(dq value.
+.sp
+See also target properties:
+.INDENT 0.0
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_ANT_ADDITIONAL_OPTIONS'\fI\%ANDROID_ANT_ADDITIONAL_OPTIONS\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_API_MIN'\fI\%ANDROID_API_MIN\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_API'\fI\%ANDROID_API\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_ARCH'\fI\%ANDROID_ARCH\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_ASSETS_DIRECTORIES'\fI\%ANDROID_ASSETS_DIRECTORIES\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_GUI'\fI\%ANDROID_GUI\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_JAR_DEPENDENCIES'\fI\%ANDROID_JAR_DEPENDENCIES\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_JAR_DIRECTORIES'\fI\%ANDROID_JAR_DIRECTORIES\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_JAVA_SOURCE_DIR'\fI\%ANDROID_JAVA_SOURCE_DIR\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_NATIVE_LIB_DEPENDENCIES'\fI\%ANDROID_NATIVE_LIB_DEPENDENCIES\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_NATIVE_LIB_DIRECTORIES'\fI\%ANDROID_NATIVE_LIB_DIRECTORIES\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_PROCESS_MAX'\fI\%ANDROID_PROCESS_MAX\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_PROGUARD_CONFIG_PATH'\fI\%ANDROID_PROGUARD_CONFIG_PATH\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_PROGUARD'\fI\%ANDROID_PROGUARD\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_SECURE_PROPS_PATH'\fI\%ANDROID_SECURE_PROPS_PATH\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_SKIP_ANT_STEP'\fI\%ANDROID_SKIP_ANT_STEP\fP\X'tty: link'
+.IP \(bu 2
+\X'tty: link #prop_tgt:ANDROID_STL_TYPE'\fI\%ANDROID_STL_TYPE\fP\X'tty: link'
+.UNINDENT
+.SS Cross Compiling for iOS, tvOS, visionOS, or watchOS
+.sp
+For cross\-compiling to iOS, tvOS, visionOS, or watchOS, the \X'tty: link #generator:Xcode'\fI\%Xcode\fP\X'tty: link'
+generator is recommended.  The \X'tty: link #generator:Unix Makefiles'\fI\%Unix Makefiles\fP\X'tty: link' or
+\X'tty: link #generator:Ninja'\fI\%Ninja\fP\X'tty: link' generators can also be used, but they require the
+project to handle more areas like target CPU selection and code signing.
+.sp
+Any of the Apple device platforms can be targeted by setting the
+\X'tty: link #variable:CMAKE_SYSTEM_NAME'\fI\%CMAKE_SYSTEM_NAME\fP\X'tty: link' variable to a value from the table below.
+By default, the latest Device SDK is chosen.  As for all Apple platforms,
+a different SDK (e.g. a simulator) can be selected by setting the
+\X'tty: link #variable:CMAKE_OSX_SYSROOT'\fI\%CMAKE_OSX_SYSROOT\fP\X'tty: link' variable, although this should rarely be
+necessary (see \fI\%Switching Between Device and Simulator\fP below).
+A list of available SDKs can be obtained by running \fBxcodebuild \-showsdks\fP\&.
+.TS
+center;
+|l|l|l|l|l|.
+_
+T{
+OS
+T}	T{
+CMAKE_SYSTEM_NAME
+T}	T{
+Device SDK (default)
+T}	T{
+Simulator SDK
+T}	T{
+Catalyst SDK
+T}
+_
+T{
+iOS
+T}	T{
+iOS
+T}	T{
+iphoneos
+T}	T{
+iphonesimulator
+T}	T{
+macosx
+T}
+_
+T{
+tvOS
+T}	T{
+tvOS
+T}	T{
+appletvos
+T}	T{
+appletvsimulator
+T}	T{
+N/A
+T}
+_
+T{
+visionOS
+T}	T{
+visionOS
+T}	T{
+xros
+T}	T{
+xrsimulator
+T}	T{
+N/A
+T}
+_
+T{
+watchOS
+T}	T{
+watchOS
+T}	T{
+watchos
+T}	T{
+watchsimulator
+T}	T{
+N/A
+T}
+_
+.TE
+.sp
+For example, to create a CMake configuration for iOS, the following
+command is sufficient:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+cmake .. \-GXcode \-DCMAKE_SYSTEM_NAME=iOS
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Variable \X'tty: link #variable:CMAKE_OSX_ARCHITECTURES'\fI\%CMAKE_OSX_ARCHITECTURES\fP\X'tty: link' can be used to set architectures
+for both device and simulator. Variable \X'tty: link #variable:CMAKE_OSX_DEPLOYMENT_TARGET'\fI\%CMAKE_OSX_DEPLOYMENT_TARGET\fP\X'tty: link'
+can be used to set an iOS/tvOS/visionOS/watchOS deployment target.
+.sp
+The next example installs five architectures in a universal binary for an iOS
+library.  It adds the relevant \fB\-miphoneos\-version\-min=9.3\fP or
+\fB\-mios\-simulator\-version\-min=9.3\fP compiler flag where appropriate.
+Note that the \X'tty: link #variable:CMAKE_IOS_INSTALL_COMBINED'\fI\%CMAKE_IOS_INSTALL_COMBINED\fP\X'tty: link' variable used in the
+example is now deprecated, so this approach is no longer recommended.
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ cmake \-S. \-B_builds \-GXcode \e
+    \-DCMAKE_SYSTEM_NAME=iOS \e
+    \(dq\-DCMAKE_OSX_ARCHITECTURES=armv7;armv7s;arm64;i386;x86_64\(dq \e
+    \-DCMAKE_OSX_DEPLOYMENT_TARGET=9.3 \e
+    \-DCMAKE_INSTALL_PREFIX=\(gapwd\(ga/_install \e
+    \-DCMAKE_XCODE_ATTRIBUTE_ONLY_ACTIVE_ARCH=NO \e
+    \-DCMAKE_IOS_INSTALL_COMBINED=YES
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+# CMakeLists.txt
+cmake_minimum_required(VERSION 3.14)
+project(foo)
+add_library(foo foo.cpp)
+install(TARGETS foo DESTINATION lib)
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Install:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ cmake \-\-build _builds \-\-config Release \-\-target install
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Check library:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ lipo \-info _install/lib/libfoo.a
+Architectures in the fat file: _install/lib/libfoo.a are: i386 armv7 armv7s x86_64 arm64
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ otool \-l _install/lib/libfoo.a | grep \-A2 LC_VERSION_MIN_IPHONEOS
+      cmd LC_VERSION_MIN_IPHONEOS
+  cmdsize 16
+  version 9.3
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.SS Code Signing
+.sp
+Some build artifacts for the embedded Apple platforms require mandatory
+code signing.  If the \X'tty: link #generator:Xcode'\fI\%Xcode\fP\X'tty: link' generator is being used and
+code signing is required or desired, the development team ID can be
+specified via the \fBCMAKE_XCODE_ATTRIBUTE_DEVELOPMENT_TEAM\fP CMake variable.
+This team ID will then be included in the generated Xcode project.
+By default, CMake avoids the need for code signing during the internal
+configuration phase (i.e compiler ID and feature detection).
+.SS Switching Between Device and Simulator
+.sp
+When configuring for any of the embedded platforms, one can target either
+real devices or the simulator.  Both have their own separate SDK, but CMake
+only supports specifying a single SDK for the configuration phase.  This
+means the developer must select one or the other at configuration time.
+When using the \X'tty: link #generator:Xcode'\fI\%Xcode\fP\X'tty: link' generator, this is less of a limitation
+because Xcode still allows you to build for either a device or a simulator,
+even though configuration was only performed for one of the two.  From
+within the Xcode IDE, builds are performed for the selected \(dqdestination\(dq
+platform.  When building from the command line, the desired sdk can be
+specified directly by passing a \fB\-sdk\fP option to the underlying build
+tool (\fBxcodebuild\fP).  For example:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+$ cmake \-\-build ... \-\- \-sdk iphonesimulator
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+Please note that checks made during configuration were performed against
+the configure\-time SDK and might not hold true for other SDKs.  Commands
+like \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link', \X'tty: link #command:find_library'\fI\%find_library()\fP\X'tty: link', etc. store and use
+details only for the configured SDK/platform, so they can be problematic
+if wanting to switch between device and simulator builds. You can follow
+the next rules to make device + simulator configuration work:
+.INDENT 0.0
+.IP \(bu 2
+Use explicit \fB\-l\fP linker flag,
+e.g. \fBtarget_link_libraries(foo PUBLIC \(dq\-lz\(dq)\fP
+.IP \(bu 2
+Use explicit \fB\-framework\fP linker flag,
+e.g. \fBtarget_link_libraries(foo PUBLIC \(dq\-framework CoreFoundation\(dq)\fP
+.IP \(bu 2
+Use \X'tty: link #command:find_package'\fI\%find_package()\fP\X'tty: link' only for libraries installed with
+\X'tty: link #variable:CMAKE_IOS_INSTALL_COMBINED'\fI\%CMAKE_IOS_INSTALL_COMBINED\fP\X'tty: link' feature
+.UNINDENT
+.SH COPYRIGHT
+2000-2024 Kitware, Inc. and Contributors
+.\" Generated by docutils manpage writer.
+.

cmake/share/aclocal/cmake.m4

@@ -0,0 +1,44 @@
+dnl Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+dnl file Copyright.txt or https://cmake.org/licensing for details.
+
+AC_DEFUN([CMAKE_FIND_BINARY],
+[AC_ARG_VAR([CMAKE_BINARY], [path to the cmake binary])dnl
+
+if test "x$ac_cv_env_CMAKE_BINARY_set" != "xset"; then
+    AC_PATH_TOOL([CMAKE_BINARY], [cmake])dnl
+fi
+])dnl
+
+# $1: package name
+# $2: language (e.g. C/CXX/Fortran)
+# $3: The compiler ID, defaults to GNU.
+#     Possible values are: GNU, Intel, Clang, SunPro, HP, XL, VisualAge, PGI,
+#     PathScale, Cray, SCO, MSVC, LCC
+# $4: optional extra arguments to cmake, e.g. "-DCMAKE_SIZEOF_VOID_P=8"
+# $5: optional path to cmake binary
+AC_DEFUN([CMAKE_FIND_PACKAGE], [
+AC_REQUIRE([CMAKE_FIND_BINARY])dnl
+
+AC_ARG_VAR([$1][_][$2][FLAGS], [$2 compiler flags for $1. This overrides the cmake output])dnl
+AC_ARG_VAR([$1][_LIBS], [linker flags for $1. This overrides the cmake output])dnl
+
+failed=false
+AC_MSG_CHECKING([for $1])
+if test -z "${$1[]_$2[]FLAGS}"; then
+    $1[]_$2[]FLAGS=`$CMAKE_BINARY --find-package "-DNAME=$1" "-DCOMPILER_ID=m4_default([$3], [GNU])" "-DLANGUAGE=$2" -DMODE=COMPILE $4` || failed=true
+fi
+if test -z "${$1[]_LIBS}"; then
+    $1[]_LIBS=`$CMAKE_BINARY --find-package "-DNAME=$1" "-DCOMPILER_ID=m4_default([$3], [GNU])" "-DLANGUAGE=$2" -DMODE=LINK $4` || failed=true
+fi
+
+if $failed; then
+    unset $1[]_$2[]FLAGS
+    unset $1[]_LIBS
+
+    AC_MSG_RESULT([no])
+    $6
+else
+    AC_MSG_RESULT([yes])
+    $5
+fi[]dnl
+])

cmake/share/bash-completion/completions/cmake

@@ -0,0 +1,242 @@
+# bash completion for cmake(1)                             -*- shell-script -*-
+
+_cmake()
+{
+    local is_old_completion=false
+    local is_init_completion=false
+
+    local cur prev words cword split was_split
+    if type -t _comp_initialize >/dev/null; then
+        _comp_initialize -s || return
+    elif type -t _init_completion >/dev/null; then
+        _init_completion -s || return
+        is_init_completion=true
+    else
+        # manual initialization for older bash completion versions
+        COMPREPLY=()
+        cur="${COMP_WORDS[COMP_CWORD]}"
+        prev="${COMP_WORDS[COMP_CWORD-1]}"
+        is_old_completion=true
+        split=false
+    fi
+
+    # Workaround for options like -DCMAKE_BUILD_TYPE=Release
+    local prefix=
+    if [[ $cur == -D* ]]; then
+        prev=-D
+        prefix=-D
+        cur="${cur#-D}"
+    elif [[ $cur == -U* ]]; then
+        prev=-U
+        prefix=-U
+        cur="${cur#-U}"
+    fi
+
+    case "$prev" in
+        -D)
+            if [[ $cur == *=* ]]; then
+            # complete values for variables
+                local var type value
+                var="${cur%%[:=]*}"
+                value="${cur#*=}"
+
+                if [[ $cur == CMAKE_BUILD_TYPE* ]]; then # most widely used case
+                    COMPREPLY=( $( compgen -W 'Debug Release RelWithDebInfo
+                        MinSizeRel' -- "$value" ) )
+                    return
+                fi
+
+                if [[ $cur == *:* ]]; then
+                    type="${cur#*:}"
+                    type="${type%%=*}"
+                else # get type from cache if it's not set explicitly
+                    type=$( cmake -LA -N 2>/dev/null | grep "$var:" \
+                        2>/dev/null )
+                    type="${type#*:}"
+                    type="${type%%=*}"
+                fi
+                case "$type" in
+                    FILEPATH)
+                        cur="$value"
+                        _filedir
+                        return
+                        ;;
+                    PATH)
+                        cur="$value"
+                        _filedir -d
+                        return
+                        ;;
+                    BOOL)
+                        COMPREPLY=( $( compgen -W 'ON OFF TRUE FALSE' -- \
+                            "$value" ) )
+                        return
+                        ;;
+                    STRING|INTERNAL)
+                        # no completion available
+                        return
+                        ;;
+                esac
+            elif [[ $cur == *:* ]]; then
+            # complete types
+                local type="${cur#*:}"
+                COMPREPLY=( $( compgen -W 'FILEPATH PATH STRING BOOL INTERNAL'\
+                    -S = -- "$type" ) )
+                compopt -o nospace
+            else
+            # complete variable names
+                COMPREPLY=( $( compgen -W '$( cmake -LA -N 2>/dev/null |
+                    tail -n +2 | cut -f1 -d: )' -P "$prefix" -- "$cur" ) )
+                compopt -o nospace
+            fi
+            return
+            ;;
+        -U)
+            COMPREPLY=( $( compgen -W '$( cmake -LA -N | tail -n +2 |
+                cut -f1 -d: )' -P "$prefix" -- "$cur" ) )
+            return
+            ;;
+    esac
+
+    if $is_old_completion; then
+        _split_longopt && split=true
+    fi
+
+    case "$prev" in
+        -C|-P|--graphviz|--system-information)
+            _filedir
+            return
+            ;;
+        --build)
+            # Seed the reply with non-directory arguments that we know are
+            # allowed to follow --build. _filedir will then prepend any valid
+            # directory matches to these.
+            COMPREPLY=( $( compgen -W "--preset --list-presets" -- "$cur" ) )
+            _filedir -d
+            return
+            ;;
+        --install|--open)
+            _filedir -d
+            return
+            ;;
+        -E)
+            COMPREPLY=( $( compgen -W "$( cmake -E help |& sed -n \
+                '/^  [^ ]/{s|^  \([^ ]\{1,\}\) .*$|\1|;p}' 2>/dev/null )" \
+                -- "$cur" ) )
+            return
+            ;;
+        -G)
+            local IFS=$'\n'
+            local quoted
+            printf -v quoted %q "$cur"
+            COMPREPLY=( $( compgen -W '$( cmake --help 2>/dev/null | sed -n \
+                -e "1,/^Generators/d" \
+                -e "/^  *[^ =]/{s|^ *\([^=]*[^ =]\).*$|\1|;s| |\\\\ |g;p}" \
+                2>/dev/null )' -- "$quoted" ) )
+            return
+            ;;
+        --loglevel)
+            COMPREPLY=( $(compgen -W 'error warning notice status verbose debug trace' -- $cur ) )
+            ;;
+        --help-command)
+            COMPREPLY=( $( compgen -W '$( cmake --help-command-list 2>/dev/null|
+                grep -v "^cmake version " )' -- "$cur" ) )
+            return
+            ;;
+        --help-manual)
+            COMPREPLY=( $( compgen -W '$( cmake --help-manual-list 2>/dev/null|
+                grep -v "^cmake version " | sed -e "s/([0-9])$//" )' -- "$cur" ) )
+            return
+            ;;
+        --help-module)
+            COMPREPLY=( $( compgen -W '$( cmake --help-module-list 2>/dev/null|
+                grep -v "^cmake version " )' -- "$cur" ) )
+            return
+            ;;
+         --help-policy)
+            COMPREPLY=( $( compgen -W '$( cmake --help-policy-list 2>/dev/null |
+                grep -v "^cmake version " )' -- "$cur" ) )
+            return
+            ;;
+         --help-property)
+            COMPREPLY=( $( compgen -W '$( cmake --help-property-list \
+                2>/dev/null | grep -v "^cmake version " )' -- "$cur" ) )
+            return
+            ;;
+         --help-variable)
+            COMPREPLY=( $( compgen -W '$( cmake --help-variable-list \
+                2>/dev/null | grep -v "^cmake version " )' -- "$cur" ) )
+            return
+            ;;
+        --list-presets)
+            local IFS=$'\n'
+            local quoted
+            printf -v quoted %q "$cur"
+
+            if [[ ! "${IFS}${COMP_WORDS[*]}${IFS}" =~ "${IFS}--build${IFS}" ]]; then
+                COMPREPLY=(
+                    $( compgen -W "configure${IFS}build${IFS}package${IFS}test${IFS}workflow${IFS}all" -- "$quoted" )
+                  )
+            fi
+            return
+            ;;
+         --preset)
+            local IFS=$'\n'
+            local quoted
+            printf -v quoted %q "$cur"
+
+            local preset_type
+            if [[ "${IFS}${COMP_WORDS[*]}${IFS}" =~ "${IFS}--workflow${IFS}" ]]; then
+                preset_type="workflow"
+            elif [[ "${IFS}${COMP_WORDS[*]}${IFS}" =~ "${IFS}--build${IFS}" ]]; then
+                preset_type="build"
+            else
+                preset_type="configure"
+            fi
+
+            local presets=$( cmake --list-presets="$preset_type" 2>/dev/null |
+                grep -o "^  \".*\"" | sed \
+                -e "s/^  //g" \
+                -e "s/\"//g" \
+                -e 's/ /\\\\ /g' )
+            COMPREPLY=( $( compgen -W "$presets" -- "$quoted" ) )
+            return
+            ;;
+        --workflow)
+            local quoted
+            printf -v quoted %q "$cur"
+            # Options allowed right after `--workflow`
+            local workflow_options='--preset --list-presets --fresh'
+
+            if [[ "$cur" == -* ]]; then
+                COMPREPLY=( $( compgen -W "$workflow_options" -- "$quoted" ) )
+            else
+                local presets=$( cmake --list-presets=workflow 2>/dev/null |
+                    grep -o "^  \".*\"" | sed \
+                    -e "s/^  //g" \
+                    -e "s/\"//g" \
+                    -e 's/ /\\\\ /g' )
+                COMPREPLY=( $( compgen -W "$presets $workflow_options" -- "$quoted" ) )
+            fi
+            return
+            ;;
+    esac
+
+    if  ($is_old_completion || $is_init_completion); then
+        $split && return
+    else
+        [[ $was_split ]] && return
+    fi
+
+    if [[ "$cur" == -* ]]; then
+        # FIXME(#26100): `cmake --help` is missing some options and does not
+        # have any mode-specific options like `cmake --build`'s `--config`.
+        COMPREPLY=( $(compgen -W '$( _parse_help "$1" --help )' -- ${cur}) )
+        [[ $COMPREPLY == *= ]] && compopt -o nospace
+        [[ $COMPREPLY ]] && return
+    fi
+
+    _filedir
+} &&
+complete -F _cmake cmake
+
+# ex: ts=4 sw=4 et filetype=sh

cmake/share/bash-completion/completions/cpack

@@ -0,0 +1,90 @@
+# bash completion for cpack(1)                             -*- shell-script -*-
+
+_cpack()
+{
+    local cur prev words cword
+    if type -t _comp_initialize >/dev/null; then
+        _comp_initialize -n = || return
+    elif type -t _init_completion >/dev/null; then
+        _init_completion -n = || return
+    else
+        # manual initialization for older bash completion versions
+        COMPREPLY=()
+        cur="${COMP_WORDS[COMP_CWORD]}"
+        prev="${COMP_WORDS[COMP_CWORD-1]}"
+    fi
+
+    case "$prev" in
+        -G)
+            COMPREPLY=( $( compgen -W '$( cpack --help 2>/dev/null |
+                sed -e "1,/^Generators/d" -e "s|^ *\([^ ]*\) .*$|\1|" \
+                2>/dev/null )' -- "$cur" ) )
+            return
+            ;;
+        -C)
+            COMPREPLY=( $( compgen -W 'Debug Release RelWithDebInfo
+                MinSizeRel' -- "$cur" ) )
+            return
+            ;;
+        -D)
+            [[ $cur == *=* ]] && return # no completion for values
+            COMPREPLY=( $( compgen -W '$( cpack --help-variable-list \
+                2>/dev/null | grep -v "^cpack version " )' -S = -- "$cur" ) )
+            compopt -o nospace
+            return
+            ;;
+        -P|-R|--vendor)
+            # argument required but no completions available
+            return
+            ;;
+        -B)
+            _filedir -d
+            return
+            ;;
+        --config)
+            _filedir
+            return
+            ;;
+        --help-command)
+            COMPREPLY=( $( compgen -W '$( cpack --help-command-list 2>/dev/null|
+                grep -v "^cpack version " )' -- "$cur" ) )
+            return
+            ;;
+        --help-manual)
+            COMPREPLY=( $( compgen -W '$( cpack --help-manual-list 2>/dev/null|
+                grep -v "^cpack version " | sed -e "s/([0-9])$//" )' -- "$cur" ) )
+            return
+            ;;
+        --help-module)
+            COMPREPLY=( $( compgen -W '$( cpack --help-module-list 2>/dev/null|
+                grep -v "^cpack version " )' -- "$cur" ) )
+            return
+            ;;
+        --help-policy)
+            COMPREPLY=( $( compgen -W '$( cpack --help-policy-list 2>/dev/null |
+                grep -v "^cpack version " )' -- "$cur" ) )
+            return
+            ;;
+        --help-property)
+            COMPREPLY=( $( compgen -W '$( cpack --help-property-list \
+                2>/dev/null | grep -v "^cpack version " )' -- "$cur" ) )
+            return
+            ;;
+        --help-variable)
+            COMPREPLY=( $( compgen -W '$( cpack --help-variable-list \
+                2>/dev/null | grep -v "^cpack version " )' -- "$cur" ) )
+            return
+            ;;
+    esac
+
+    if [[ "$cur" == -* ]]; then
+        COMPREPLY=( $(compgen -W '$( _parse_help "$1" --help )' -- ${cur}) )
+        [[ $COMPREPLY == *= ]] && compopt -o nospace
+        [[ $COMPREPLY ]] && return
+    fi
+
+    _filedir
+} &&
+complete -F _cpack cpack
+
+# ex: ts=4 sw=4 et filetype=sh

cmake/share/bash-completion/completions/ctest

@@ -0,0 +1,131 @@
+# bash completion for ctest(1)                             -*- shell-script -*-
+
+_ctest()
+{
+    local cur prev words cword
+    if type -t _comp_initialize >/dev/null; then
+        _comp_initialize -n = || return
+    elif type -t _init_completion >/dev/null; then
+        _init_completion -n = || return
+    else
+        # manual initialization for older bash completion versions
+        COMPREPLY=()
+        cur="${COMP_WORDS[COMP_CWORD]}"
+        prev="${COMP_WORDS[COMP_CWORD-1]}"
+    fi
+
+    case "$prev" in
+        -C|--build-config)
+            COMPREPLY=( $( compgen -W 'Debug Release RelWithDebInfo
+                MinSizeRel' -- "$cur" ) )
+            return
+            ;;
+        -j|--parallel)
+            COMPREPLY=( $( compgen -W "{1..$(( $(_ncpus)*2 ))}" -- "$cur" ) )
+            return
+            ;;
+        -O|--output-log|-A|--add-notes|--extra-submit)
+            _filedir
+            return
+            ;;
+        -L|--label-regex|-LE|--label-exclude)
+            COMPREPLY=( $( compgen -W '$( ctest --print-labels 2>/dev/null |
+                grep "^  " 2>/dev/null | cut -d" " -f 3 )' -- "$cur" ) )
+            return
+            ;;
+        --track|-I|--tests-information|--max-width|--timeout|--stop-time)
+            # argument required but no completions available
+            return
+            ;;
+        -R|--tests-regex|-E|--exclude-regex)
+            COMPREPLY=( $( compgen -W '$( ctest -N 2>/dev/null |
+                grep "^  Test" 2>/dev/null | cut -d: -f 2 )' -- "$cur" ) )
+            return
+            ;;
+        -D|--dashboard)
+            if [[ $cur == @(Experimental|Nightly|Continuous)* ]]; then
+                local model action
+                action=${cur#@(Experimental|Nightly|Continuous)}
+                model=${cur%"$action"}
+                COMPREPLY=( $( compgen -W 'Start Update Configure Build Test
+                    Coverage Submit MemCheck' -P "$model" -- "$action" ) )
+            else
+                COMPREPLY=( $( compgen -W 'Experimental Nightly Continuous' \
+                -- "$cur" ) )
+                compopt -o nospace
+            fi
+            return
+            ;;
+        -M|--test-model)
+            COMPREPLY=( $( compgen -W 'Experimental Nightly Continuous' -- \
+                "$cur" ) )
+            return
+            ;;
+        -T|--test-action)
+            COMPREPLY=( $( compgen -W 'Start Update Configure Build Test
+                Coverage Submit MemCheck' -- "$cur" ) )
+            return
+            ;;
+        -S|--script|-SP|--script-new-process)
+            _filedir '@(cmake|ctest)'
+            return
+            ;;
+        --interactive-debug-mode)
+            COMPREPLY=( $( compgen -W '0 1' -- "$cur" ) )
+            return
+            ;;
+
+        --help-command)
+            COMPREPLY=( $( compgen -W '$( ctest --help-command-list 2>/dev/null|
+                grep -v "^ctest version " )' -- "$cur" ) )
+            return
+            ;;
+        --help-manual)
+            COMPREPLY=( $( compgen -W '$( ctest --help-manual-list 2>/dev/null|
+                grep -v "^ctest version " | sed -e "s/([0-9])$//" )' -- "$cur" ) )
+            return
+            ;;
+        --help-module)
+            COMPREPLY=( $( compgen -W '$( ctest --help-module-list 2>/dev/null|
+                grep -v "^ctest version " )' -- "$cur" ) )
+            return
+            ;;
+        --help-policy)
+            COMPREPLY=( $( compgen -W '$( ctest --help-policy-list 2>/dev/null |
+                grep -v "^ctest version " )' -- "$cur" ) )
+            return
+            ;;
+        --help-property)
+            COMPREPLY=( $( compgen -W '$( ctest --help-property-list \
+                2>/dev/null | grep -v "^ctest version " )' -- "$cur" ) )
+            return
+            ;;
+        --help-variable)
+            COMPREPLY=( $( compgen -W '$( ctest --help-variable-list \
+                2>/dev/null | grep -v "^ctest version " )' -- "$cur" ) )
+            return
+            ;;
+         --preset)
+            local IFS=$'\n'
+            local quoted
+            printf -v quoted %q "$cur"
+            COMPREPLY=( $( compgen -W '$( ctest --list-presets 2>/dev/null |
+                grep -o "^  \".*\"" | sed \
+                -e "s/^  //g" \
+                -e "s/\"//g" \
+                -e "s/ /\\\\ /g" )' -- "$quoted" ) )
+            return
+            ;;
+    esac
+
+    if [[ "$cur" == -* ]]; then
+        COMPREPLY=( $(compgen -W '$( _parse_help "$1" --help )' -- ${cur}) )
+        [[ $COMPREPLY == *= ]] && compopt -o nospace
+        [[ $COMPREPLY ]] && return
+    fi
+
+    _filedir
+} &&
+complete -F _ctest ctest
+
+# ex: ts=4 sw=4 et filetype=sh

cmake/share/cmake-3.31/Help/index.rst

@@ -0,0 +1,109 @@
+.. title:: CMake Reference Documentation
+
+Introduction
+############
+
+CMake is a tool to manage building of source code.  Originally, CMake was
+designed as a generator for various dialects of ``Makefile``, today
+CMake generates modern buildsystems such as ``Ninja`` as well as project
+files for IDEs such as Visual Studio and Xcode.
+
+CMake is widely used for the C and C++ languages, but it may be used to
+build source code of other languages too.
+
+People encountering CMake for the first time may have different initial
+goals.  To learn how to build a source code package downloaded from the
+internet, start with the :guide:`User Interaction Guide`.
+This will detail the steps needed to run the :manual:`cmake(1)` or
+:manual:`cmake-gui(1)` executable and how to choose a generator, and
+how to complete the build.
+
+The :guide:`Using Dependencies Guide` is aimed at developers
+wishing to get started using a third-party library.
+
+For developers starting a project using CMake, the :guide:`CMake Tutorial`
+is a suitable starting point.  The :manual:`cmake-buildsystem(7)`
+manual is aimed at developers expanding their knowledge of maintaining
+a buildsystem and becoming familiar with the build targets that
+can be represented in CMake.  The :manual:`cmake-packages(7)` manual
+explains how to create packages which can easily be consumed by
+third-party CMake-based buildsystems.
+
+Command-Line Tools
+##################
+
+.. toctree::
+   :maxdepth: 1
+
+   /manual/cmake.1
+   /manual/ctest.1
+   /manual/cpack.1
+
+Interactive Dialogs
+###################
+
+.. toctree::
+   :maxdepth: 1
+
+   /manual/cmake-gui.1
+   /manual/ccmake.1
+
+Reference Manuals
+#################
+
+.. toctree::
+   :maxdepth: 1
+
+   /manual/cmake-buildsystem.7
+   /manual/cmake-commands.7
+   /manual/cmake-compile-features.7
+   /manual/cmake-configure-log.7
+   /manual/cmake-cxxmodules.7
+   /manual/cmake-developer.7
+   /manual/cmake-env-variables.7
+   /manual/cmake-file-api.7
+   /manual/cmake-generator-expressions.7
+   /manual/cmake-generators.7
+   /manual/cmake-language.7
+   /manual/cmake-modules.7
+   /manual/cmake-packages.7
+   /manual/cmake-policies.7
+   /manual/cmake-presets.7
+   /manual/cmake-properties.7
+   /manual/cmake-qt.7
+   /manual/cmake-server.7
+   /manual/cmake-toolchains.7
+   /manual/cmake-variables.7
+   /manual/cpack-generators.7
+
+.. only:: not man
+
+ Guides
+ ######
+
+ .. toctree::
+    :maxdepth: 1
+
+    /guide/tutorial/index
+    /guide/user-interaction/index
+    /guide/using-dependencies/index
+    /guide/importing-exporting/index
+    /guide/ide-integration/index
+
+.. only:: html or text
+
+ Release Notes
+ #############
+
+ .. toctree::
+    :maxdepth: 1
+
+    /release/index
+
+.. only:: html
+
+ Index and Search
+ ################
+
+ * :ref:`genindex`
+ * :ref:`search`

cmake/share/cmake-3.31/Licenses/LGPLv3.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

cmake/share/cmake-3.31/Modules/AddFileDependencies.cmake

@@ -0,0 +1,33 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+#[=======================================================================[.rst:
+AddFileDependencies
+-------------------
+
+.. deprecated:: 3.20
+
+Add dependencies to a source file.
+
+.. code-block:: cmake
+
+  add_file_dependencies(<source> <files>...)
+
+Adds the given ``<files>`` to the dependencies of file ``<source>``.
+
+Do not use this command in new code.  It is just a wrapper around:
+
+.. code-block:: cmake
+
+  set_property(SOURCE <source> APPEND PROPERTY OBJECT_DEPENDS <files>...)
+
+Instead use the :command:`set_property` command to append to the
+:prop_sf:`OBJECT_DEPENDS` source file property directly.
+
+#]=======================================================================]
+
+function(add_file_dependencies _file)
+
+  set_property(SOURCE "${_file}" APPEND PROPERTY OBJECT_DEPENDS "${ARGN}")
+
+endfunction()

cmake/share/cmake-3.31/Modules/AndroidTestUtilities.cmake

@@ -0,0 +1,165 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+#[======================================================================[.rst:
+AndroidTestUtilities
+------------------------
+
+.. versionadded:: 3.7
+
+Create a test that automatically loads specified data onto an Android device.
+
+Introduction
+^^^^^^^^^^^^
+
+Use this module to push data needed for testing an Android device behavior
+onto a connected Android device. The module will accept files and libraries as
+well as separate destinations for each. It will create a test that loads the
+files into a device object store and link to them from the specified
+destination. The files are only uploaded if they are not already in the object
+store.
+
+For example:
+
+.. code-block:: cmake
+
+  include(AndroidTestUtilities)
+  android_add_test_data(
+    example_setup_test
+    FILES <files>...
+    LIBS <libs>...
+    DEVICE_TEST_DIR "/data/local/tests/example"
+    DEVICE_OBJECT_STORE "/sdcard/.ExternalData/SHA"
+    )
+
+
+At build time a test named "example_setup_test" will be created.  Run this test
+on the command line with :manual:`ctest(1)` to load the data onto the Android
+device.
+
+Module Functions
+^^^^^^^^^^^^^^^^
+
+.. command:: android_add_test_data
+
+  .. code-block:: cmake
+
+    android_add_test_data(<test-name>
+      [FILES <files>...] [FILES_DEST <device-dir>]
+      [LIBS <libs>...]   [LIBS_DEST <device-dir>]
+      [DEVICE_OBJECT_STORE <device-dir>]
+      [DEVICE_TEST_DIR <device-dir>]
+      [NO_LINK_REGEX <strings>...]
+      )
+
+  The ``android_add_test_data`` function is used to copy files and libraries
+  needed to run project-specific tests. On the host operating system, this is
+  done at build time. For on-device testing, the files are loaded onto the
+  device by the manufactured test at run time.
+
+  This function accepts the following named parameters:
+
+  ``FILES <files>...``
+    zero or more files needed for testing
+  ``LIBS <libs>...``
+    zero or more libraries needed for testing
+  ``FILES_DEST <device-dir>``
+    absolute path where the data files are expected to be
+  ``LIBS_DEST <device-dir>``
+    absolute path where the libraries are expected to be
+  ``DEVICE_OBJECT_STORE <device-dir>``
+    absolute path to the location where the data is stored on-device
+  ``DEVICE_TEST_DIR <device-dir>``
+    absolute path to the root directory of the on-device test location
+  ``NO_LINK_REGEX <strings>...``
+    list of regex strings matching the names of files that should be
+    copied from the object store to the testing directory
+#]======================================================================]
+
+include(${CMAKE_CURRENT_LIST_DIR}/ExternalData.cmake)
+
+# The parameters to this function should be set to the list of directories,
+# files, and libraries that need to be installed prior to testing.
+function(android_add_test_data test_name)
+  # As the names suggest, oneValueArgs lists the arguments that specify a
+  # single value, while multiValueArgs can contain one or more values.
+  set(keywordArgs)
+  set(oneValueArgs FILES_DEST LIBS_DEST DEVICE_OBJECT_STORE DEVICE_TEST_DIR)
+  set(multiValueArgs FILES LIBS NO_LINK_REGEX)
+
+  # For example, if you called this function with FILES </path/to/file>
+  # then this path would be stored in the variable AST_FILES.
+  # The AST prefix stands for the name of this function (android_add_test_data).
+  cmake_parse_arguments(AST "${keywordArgs}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+  if(NOT AST_DEVICE_TEST_DIR)
+    message(FATAL_ERROR "-- You must specify the location of the on device test directory.")
+  endif()
+  if(NOT AST_DEVICE_OBJECT_STORE)
+    message(FATAL_ERROR "-- You must specify the location of the on device object store.")
+  endif()
+  if(${AST_DEVICE_TEST_DIR} STREQUAL "/")
+    message(FATAL_ERROR "-- The device test directory cannot be '/'")
+  endif()
+
+  # Copy all test data files into the binary directory, where tests are run.
+  # ExternalData will handle fetching DATA{...} references.
+  string(REPLACE "|" ";" hash_algs "${_ExternalData_REGEX_EXT}")
+  # Convert ExternalData placeholder file names to DATA{} syntax.
+  foreach(alg ${hash_algs})
+    string(REGEX REPLACE "([^ ;]+)\\.${alg}" "DATA{\\1}" AST_FILES "${AST_FILES}")
+  endforeach()
+
+  set(DATA_TARGET_NAME "${test_name}")
+  string(FIND "${AST_FILES}" "DATA{" data_files_found)
+  if(${data_files_found} GREATER "-1")
+    # Use ExternalData if any DATA{} files were found.
+    ExternalData_Expand_Arguments(
+      ${DATA_TARGET_NAME}
+      extern_data_output
+      ${AST_FILES})
+    ExternalData_Add_Target(${DATA_TARGET_NAME})
+  else()
+    add_custom_target(${DATA_TARGET_NAME} ALL)
+    set(extern_data_output ${AST_FILES})
+  endif()
+
+  # For regular files on Linux, just copy them directly.
+  foreach(path ${AST_FILES})
+    foreach(output ${extern_data_output})
+      if(${output} STREQUAL ${path})
+        # Check if a destination was specified.  If not, we copy by default
+        # into this project's binary directory, preserving its relative path.
+        if(AST_${VAR}_DEST)
+          set(DEST ${CMAKE_BINARY_DIR}/${parent_dir}/${AST_${VAR}_DEST})
+        else()
+          get_filename_component(parent_dir ${path} DIRECTORY)
+          set(DEST "${CMAKE_BINARY_DIR}/${parent_dir}")
+        endif()
+        get_filename_component(extern_data_source ${output} REALPATH)
+        get_filename_component(extern_data_basename ${output} NAME)
+        add_custom_command(
+          TARGET ${DATA_TARGET_NAME} POST_BUILD
+          COMMAND ${CMAKE_COMMAND} -E copy_if_different ${extern_data_source} ${DEST}/${extern_data_basename}
+        )
+      endif()
+    endforeach()
+  endforeach()
+
+  if(ANDROID)
+    string(REGEX REPLACE "DATA{([^ ;]+)}" "\\1"  processed_FILES "${AST_FILES}")
+    # There's no target used for this command, so we don't need to do anything
+    # here for CMP0178.
+    add_test(
+      NAME ${test_name}
+      COMMAND ${CMAKE_COMMAND}
+      "-Darg_files_dest=${AST_FILES_DEST}"
+      "-Darg_libs_dest=${AST_LIBS_DEST}"
+      "-Darg_dev_test_dir=${AST_DEVICE_TEST_DIR}"
+      "-Darg_dev_obj_store=${AST_DEVICE_OBJECT_STORE}"
+      "-Darg_no_link_regex=${AST_NO_LINK_REGEX}"
+      "-Darg_files=${processed_FILES}"
+      "-Darg_libs=${AST_LIBS}"
+      "-Darg_src_dir=${CMAKE_CURRENT_SOURCE_DIR}"
+      -P ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/AndroidTestUtilities/PushToAndroidDevice.cmake)
+  endif()
+endfunction()

cmake/share/cmake-3.31/Modules/BasicConfigVersion-AnyNewerVersion.cmake.in

@@ -0,0 +1,32 @@
+# This is a basic version file for the Config-mode of find_package().
+# It is used by write_basic_package_version_file() as input file for configure_file()
+# to create a version-file which can be installed along a config.cmake file.
+#
+# The created file sets PACKAGE_VERSION_EXACT if the current version string and
+# the requested version string are exactly the same and it sets
+# PACKAGE_VERSION_COMPATIBLE if the current version is >= requested version.
+# The variable CVF_VERSION must be set before calling configure_file().
+
+set(PACKAGE_VERSION "@CVF_VERSION@")
+
+if (PACKAGE_FIND_VERSION_RANGE)
+  # Package version must be in the requested version range
+  if ((PACKAGE_FIND_VERSION_RANGE_MIN STREQUAL "INCLUDE" AND PACKAGE_VERSION VERSION_LESS PACKAGE_FIND_VERSION_MIN)
+      OR ((PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "INCLUDE" AND PACKAGE_VERSION VERSION_GREATER PACKAGE_FIND_VERSION_MAX)
+        OR (PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "EXCLUDE" AND PACKAGE_VERSION VERSION_GREATER_EQUAL PACKAGE_FIND_VERSION_MAX)))
+    set(PACKAGE_VERSION_COMPATIBLE FALSE)
+  else()
+    set(PACKAGE_VERSION_COMPATIBLE TRUE)
+  endif()
+else()
+  if(PACKAGE_VERSION VERSION_LESS PACKAGE_FIND_VERSION)
+    set(PACKAGE_VERSION_COMPATIBLE FALSE)
+  else()
+    set(PACKAGE_VERSION_COMPATIBLE TRUE)
+    if(PACKAGE_FIND_VERSION STREQUAL PACKAGE_VERSION)
+      set(PACKAGE_VERSION_EXACT TRUE)
+    endif()
+  endif()
+endif()
+
+@CVF_ARCH_INDEPENDENT_CHECK@

cmake/share/cmake-3.31/Modules/BasicConfigVersion-ExactVersion.cmake.in

@@ -0,0 +1,72 @@
+# This is a basic version file for the Config-mode of find_package().
+# It is used by write_basic_package_version_file() as input file for configure_file()
+# to create a version-file which can be installed along a config.cmake file.
+#
+# The created file sets PACKAGE_VERSION_EXACT if the current version string and
+# the requested version string are exactly the same and it sets
+# PACKAGE_VERSION_COMPATIBLE if the current version is equal to the requested version.
+# The tweak version component is ignored.
+# The variable CVF_VERSION must be set before calling configure_file().
+
+
+if (PACKAGE_FIND_VERSION_RANGE)
+  message(AUTHOR_WARNING
+    "`find_package()` specify a version range but the version strategy "
+    "(ExactVersion) of the module `${PACKAGE_FIND_NAME}` is incompatible "
+    "with this request. Only the lower endpoint of the range will be used.")
+endif()
+
+set(PACKAGE_VERSION "@CVF_VERSION@")
+
+if("@CVF_VERSION@" MATCHES "^([0-9]+)\\.([0-9]+)\\.([0-9]+)") # strip the tweak version
+  set(CVF_VERSION_MAJOR "${CMAKE_MATCH_1}")
+  set(CVF_VERSION_MINOR "${CMAKE_MATCH_2}")
+  set(CVF_VERSION_PATCH "${CMAKE_MATCH_3}")
+
+  if(NOT CVF_VERSION_MAJOR VERSION_EQUAL 0)
+    string(REGEX REPLACE "^0+" "" CVF_VERSION_MAJOR "${CVF_VERSION_MAJOR}")
+  endif()
+  if(NOT CVF_VERSION_MINOR VERSION_EQUAL 0)
+    string(REGEX REPLACE "^0+" "" CVF_VERSION_MINOR "${CVF_VERSION_MINOR}")
+  endif()
+  if(NOT CVF_VERSION_PATCH VERSION_EQUAL 0)
+    string(REGEX REPLACE "^0+" "" CVF_VERSION_PATCH "${CVF_VERSION_PATCH}")
+  endif()
+
+  set(CVF_VERSION_NO_TWEAK "${CVF_VERSION_MAJOR}.${CVF_VERSION_MINOR}.${CVF_VERSION_PATCH}")
+else()
+  set(CVF_VERSION_NO_TWEAK "@CVF_VERSION@")
+endif()
+
+if(PACKAGE_FIND_VERSION MATCHES "^([0-9]+)\\.([0-9]+)\\.([0-9]+)") # strip the tweak version
+  set(REQUESTED_VERSION_MAJOR "${CMAKE_MATCH_1}")
+  set(REQUESTED_VERSION_MINOR "${CMAKE_MATCH_2}")
+  set(REQUESTED_VERSION_PATCH "${CMAKE_MATCH_3}")
+
+  if(NOT REQUESTED_VERSION_MAJOR VERSION_EQUAL 0)
+    string(REGEX REPLACE "^0+" "" REQUESTED_VERSION_MAJOR "${REQUESTED_VERSION_MAJOR}")
+  endif()
+  if(NOT REQUESTED_VERSION_MINOR VERSION_EQUAL 0)
+    string(REGEX REPLACE "^0+" "" REQUESTED_VERSION_MINOR "${REQUESTED_VERSION_MINOR}")
+  endif()
+  if(NOT REQUESTED_VERSION_PATCH VERSION_EQUAL 0)
+    string(REGEX REPLACE "^0+" "" REQUESTED_VERSION_PATCH "${REQUESTED_VERSION_PATCH}")
+  endif()
+
+  set(REQUESTED_VERSION_NO_TWEAK
+      "${REQUESTED_VERSION_MAJOR}.${REQUESTED_VERSION_MINOR}.${REQUESTED_VERSION_PATCH}")
+else()
+  set(REQUESTED_VERSION_NO_TWEAK "${PACKAGE_FIND_VERSION}")
+endif()
+
+if(REQUESTED_VERSION_NO_TWEAK STREQUAL CVF_VERSION_NO_TWEAK)
+  set(PACKAGE_VERSION_COMPATIBLE TRUE)
+else()
+  set(PACKAGE_VERSION_COMPATIBLE FALSE)
+endif()
+
+if(PACKAGE_FIND_VERSION STREQUAL PACKAGE_VERSION)
+  set(PACKAGE_VERSION_EXACT TRUE)
+endif()
+
+@CVF_ARCH_INDEPENDENT_CHECK@

cmake/share/cmake-3.31/Modules/BasicConfigVersion-SameMajorVersion.cmake.in

@@ -0,0 +1,54 @@
+# This is a basic version file for the Config-mode of find_package().
+# It is used by write_basic_package_version_file() as input file for configure_file()
+# to create a version-file which can be installed along a config.cmake file.
+#
+# The created file sets PACKAGE_VERSION_EXACT if the current version string and
+# the requested version string are exactly the same and it sets
+# PACKAGE_VERSION_COMPATIBLE if the current version is >= requested version,
+# but only if the requested major version is the same as the current one.
+# The variable CVF_VERSION must be set before calling configure_file().
+
+
+set(PACKAGE_VERSION "@CVF_VERSION@")
+
+if(PACKAGE_VERSION VERSION_LESS PACKAGE_FIND_VERSION)
+  set(PACKAGE_VERSION_COMPATIBLE FALSE)
+else()
+
+  if("@CVF_VERSION@" MATCHES "^([0-9]+)\\.")
+    set(CVF_VERSION_MAJOR "${CMAKE_MATCH_1}")
+    if(NOT CVF_VERSION_MAJOR VERSION_EQUAL 0)
+      string(REGEX REPLACE "^0+" "" CVF_VERSION_MAJOR "${CVF_VERSION_MAJOR}")
+    endif()
+  else()
+    set(CVF_VERSION_MAJOR "@CVF_VERSION@")
+  endif()
+
+  if(PACKAGE_FIND_VERSION_RANGE)
+    # both endpoints of the range must have the expected major version
+    math (EXPR CVF_VERSION_MAJOR_NEXT "${CVF_VERSION_MAJOR} + 1")
+    if (NOT PACKAGE_FIND_VERSION_MIN_MAJOR STREQUAL CVF_VERSION_MAJOR
+        OR ((PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "INCLUDE" AND NOT PACKAGE_FIND_VERSION_MAX_MAJOR STREQUAL CVF_VERSION_MAJOR)
+          OR (PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "EXCLUDE" AND NOT PACKAGE_FIND_VERSION_MAX VERSION_LESS_EQUAL CVF_VERSION_MAJOR_NEXT)))
+      set(PACKAGE_VERSION_COMPATIBLE FALSE)
+    elseif(PACKAGE_FIND_VERSION_MIN_MAJOR STREQUAL CVF_VERSION_MAJOR
+        AND ((PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "INCLUDE" AND PACKAGE_VERSION VERSION_LESS_EQUAL PACKAGE_FIND_VERSION_MAX)
+        OR (PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "EXCLUDE" AND PACKAGE_VERSION VERSION_LESS PACKAGE_FIND_VERSION_MAX)))
+      set(PACKAGE_VERSION_COMPATIBLE TRUE)
+    else()
+      set(PACKAGE_VERSION_COMPATIBLE FALSE)
+    endif()
+  else()
+    if(PACKAGE_FIND_VERSION_MAJOR STREQUAL CVF_VERSION_MAJOR)
+      set(PACKAGE_VERSION_COMPATIBLE TRUE)
+    else()
+      set(PACKAGE_VERSION_COMPATIBLE FALSE)
+    endif()
+
+    if(PACKAGE_FIND_VERSION STREQUAL PACKAGE_VERSION)
+      set(PACKAGE_VERSION_EXACT TRUE)
+    endif()
+  endif()
+endif()
+
+@CVF_ARCH_INDEPENDENT_CHECK@

cmake/share/cmake-3.31/Modules/BasicConfigVersion-SameMinorVersion.cmake.in

@@ -0,0 +1,74 @@
+# This is a basic version file for the Config-mode of find_package().
+# It is used by write_basic_package_version_file() as input file for configure_file()
+# to create a version-file which can be installed along a config.cmake file.
+#
+# The created file sets PACKAGE_VERSION_EXACT if the current version string and
+# the requested version string are exactly the same and it sets
+# PACKAGE_VERSION_COMPATIBLE if the current version is >= requested version,
+# but only if the requested major and minor versions are the same as the current
+# one.
+# The variable CVF_VERSION must be set before calling configure_file().
+
+
+set(PACKAGE_VERSION "@CVF_VERSION@")
+
+if(PACKAGE_VERSION VERSION_LESS PACKAGE_FIND_VERSION)
+  set(PACKAGE_VERSION_COMPATIBLE FALSE)
+else()
+
+  if("@CVF_VERSION@" MATCHES "^([0-9]+)\\.([0-9]+)")
+    set(CVF_VERSION_MAJOR "${CMAKE_MATCH_1}")
+    set(CVF_VERSION_MINOR "${CMAKE_MATCH_2}")
+
+    if(NOT CVF_VERSION_MAJOR VERSION_EQUAL 0)
+      string(REGEX REPLACE "^0+" "" CVF_VERSION_MAJOR "${CVF_VERSION_MAJOR}")
+    endif()
+    if(NOT CVF_VERSION_MINOR VERSION_EQUAL 0)
+      string(REGEX REPLACE "^0+" "" CVF_VERSION_MINOR "${CVF_VERSION_MINOR}")
+    endif()
+  else()
+    set(CVF_VERSION_MAJOR "@CVF_VERSION@")
+    set(CVF_VERSION_MINOR "")
+  endif()
+
+  if(PACKAGE_FIND_VERSION_RANGE)
+    # both endpoints of the range must have the expected major and minor versions
+    math (EXPR CVF_VERSION_MINOR_NEXT "${CVF_VERSION_MINOR} + 1")
+    if (NOT (PACKAGE_FIND_VERSION_MIN_MAJOR STREQUAL CVF_VERSION_MAJOR
+          AND PACKAGE_FIND_VERSION_MIN_MINOR STREQUAL CVF_VERSION_MINOR)
+        OR ((PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "INCLUDE"
+            AND NOT (PACKAGE_FIND_VERSION_MAX_MAJOR STREQUAL CVF_VERSION_MAJOR
+              AND PACKAGE_FIND_VERSION_MAX_MINOR STREQUAL CVF_VERSION_MINOR))
+          OR (PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "EXCLUDE"
+            AND NOT PACKAGE_FIND_VERSION_MAX VERSION_LESS_EQUAL ${CVF_VERSION_MAJOR}.${CVF_VERSION_MINOR_NEXT})))
+      set(PACKAGE_VERSION_COMPATIBLE FALSE)
+    elseif(PACKAGE_FIND_VERSION_MIN_MAJOR STREQUAL CVF_VERSION_MAJOR
+        AND PACKAGE_FIND_VERSION_MIN_MINOR STREQUAL CVF_VERSION_MINOR
+        AND ((PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "INCLUDE" AND PACKAGE_VERSION VERSION_LESS_EQUAL PACKAGE_FIND_VERSION_MAX)
+        OR (PACKAGE_FIND_VERSION_RANGE_MAX STREQUAL "EXCLUDE" AND PACKAGE_VERSION VERSION_LESS PACKAGE_FIND_VERSION_MAX)))
+      set(PACKAGE_VERSION_COMPATIBLE TRUE)
+    else()
+      set(PACKAGE_VERSION_COMPATIBLE FALSE)
+    endif()
+  else()
+    if(NOT PACKAGE_FIND_VERSION_MAJOR VERSION_EQUAL 0)
+      string(REGEX REPLACE "^0+" "" PACKAGE_FIND_VERSION_MAJOR "${PACKAGE_FIND_VERSION_MAJOR}")
+    endif()
+    if(NOT PACKAGE_FIND_VERSION_MINOR VERSION_EQUAL 0)
+      string(REGEX REPLACE "^0+" "" PACKAGE_FIND_VERSION_MINOR "${PACKAGE_FIND_VERSION_MINOR}")
+    endif()
+
+    if((PACKAGE_FIND_VERSION_MAJOR STREQUAL CVF_VERSION_MAJOR) AND
+        (PACKAGE_FIND_VERSION_MINOR STREQUAL CVF_VERSION_MINOR))
+      set(PACKAGE_VERSION_COMPATIBLE TRUE)
+    else()
+      set(PACKAGE_VERSION_COMPATIBLE FALSE)
+    endif()
+
+    if(PACKAGE_FIND_VERSION STREQUAL PACKAGE_VERSION)
+      set(PACKAGE_VERSION_EXACT TRUE)
+    endif()
+  endif()
+endif()
+
+@CVF_ARCH_INDEPENDENT_CHECK@

cmake/share/cmake-3.31/Modules/BundleUtilities.cmake

@@ -0,0 +1,1131 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+#[=======================================================================[.rst:
+BundleUtilities
+---------------
+
+Functions to help assemble a standalone bundle application.
+
+A collection of CMake utility functions useful for dealing with ``.app``
+bundles on the Mac and bundle-like directories on any OS.
+
+The following functions are provided by this module:
+
+.. code-block:: cmake
+
+   fixup_bundle
+   copy_and_fixup_bundle
+   verify_app
+   get_bundle_main_executable
+   get_dotapp_dir
+   get_bundle_and_executable
+   get_bundle_all_executables
+   get_item_key
+   get_item_rpaths
+   clear_bundle_keys
+   set_bundle_key_values
+   get_bundle_keys
+   copy_resolved_item_into_bundle
+   copy_resolved_framework_into_bundle
+   fixup_bundle_item
+   verify_bundle_prerequisites
+   verify_bundle_symlinks
+
+Requires CMake 2.6 or greater because it uses function, break and
+``PARENT_SCOPE``.  Also depends on ``GetPrerequisites.cmake``.
+
+DO NOT USE THESE FUNCTIONS AT CONFIGURE TIME (from ``CMakeLists.txt``)!
+Instead, invoke them from an :command:`install(CODE)` or
+:command:`install(SCRIPT)` rule.
+
+.. code-block:: cmake
+
+  fixup_bundle(<app> <libs> <dirs>)
+
+Fix up ``<app>`` bundle in-place and make it standalone, such that it can be
+drag-n-drop copied to another machine and run on that machine as long
+as all of the system libraries are compatible.
+
+If you pass plugins to ``fixup_bundle`` as the libs parameter, you should
+install them or copy them into the bundle before calling ``fixup_bundle``.
+The ``<libs>`` parameter is a list of libraries that must be fixed up, but
+that cannot be determined by ``otool`` output analysis  (i.e. ``plugins``).
+
+Gather all the keys for all the executables and libraries in a bundle,
+and then, for each key, copy each prerequisite into the bundle.  Then
+fix each one up according to its own list of prerequisites.
+
+Then clear all the keys and call ``verify_app`` on the final bundle to
+ensure that it is truly standalone.
+
+.. versionadded:: 3.6
+  As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
+  which are then ignored
+  (e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``).
+
+.. code-block:: cmake
+
+  copy_and_fixup_bundle(<src> <dst> <libs> <dirs>)
+
+Makes a copy of the bundle ``<src>`` at location ``<dst>`` and then fixes up
+the new copied bundle in-place at ``<dst>``.
+
+.. code-block:: cmake
+
+  verify_app(<app>)
+
+Verifies that an application ``<app>`` appears valid based on running
+analysis tools on it.  Calls :command:`message(FATAL_ERROR)` if the application
+is not verified.
+
+.. versionadded:: 3.6
+  As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
+  which are then ignored
+  (e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``)
+
+.. code-block:: cmake
+
+  get_bundle_main_executable(<bundle> <result_var>)
+
+The result will be the full path name of the bundle's main executable
+file or an ``error:`` prefixed string if it could not be determined.
+
+.. code-block:: cmake
+
+  get_dotapp_dir(<exe> <dotapp_dir_var>)
+
+Returns the nearest parent dir whose name ends with ``.app`` given the
+full path to an executable.  If there is no such parent dir, then
+simply return the dir containing the executable.
+
+The returned directory may or may not exist.
+
+.. code-block:: cmake
+
+  get_bundle_and_executable(<app> <bundle_var> <executable_var> <valid_var>)
+
+Takes either a ``.app`` directory name or the name of an executable
+nested inside a ``.app`` directory and returns the path to the ``.app``
+directory in ``<bundle_var>`` and the path to its main executable in
+``<executable_var>``.
+
+.. code-block:: cmake
+
+  get_bundle_all_executables(<bundle> <exes_var>)
+
+Scans ``<bundle>`` bundle recursively for all ``<exes_var>`` executable
+files and accumulates them into a variable.
+
+.. code-block:: cmake
+
+  get_item_key(<item> <key_var>)
+
+Given ``<item>`` file name, generate ``<key_var>`` key that should be unique
+considering the set of libraries that need copying or fixing up to
+make a bundle standalone.  This is essentially the file name including
+extension with ``.`` replaced by ``_``
+
+This key is used as a prefix for CMake variables so that we can
+associate a set of variables with a given item based on its key.
+
+.. code-block:: cmake
+
+  clear_bundle_keys(<keys_var>)
+
+Loop over the ``<keys_var>`` list of keys, clearing all the variables
+associated with each key.  After the loop, clear the list of keys itself.
+
+Caller of ``get_bundle_keys`` should call ``clear_bundle_keys`` when done with
+list of keys.
+
+.. code-block:: cmake
+
+  set_bundle_key_values(<keys_var> <context> <item> <exepath> <dirs>
+                        <copyflag> [<rpaths>])
+
+Add ``<keys_var>`` key to the list (if necessary) for the given item.
+If added, also set all the variables associated with that key.
+
+.. code-block:: cmake
+
+  get_bundle_keys(<app> <libs> <dirs> <keys_var>)
+
+Loop over all the executable and library files within ``<app>`` bundle (and
+given as extra ``<libs>``) and accumulate a list of keys representing
+them.  Set values associated with each key such that we can loop over
+all of them and copy prerequisite libs into the bundle and then do
+appropriate ``install_name_tool`` fixups.
+
+.. versionadded:: 3.6
+  As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
+  which are then ignored
+  (e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``)
+
+.. code-block:: cmake
+
+  copy_resolved_item_into_bundle(<resolved_item> <resolved_embedded_item>)
+
+Copy a resolved item into the bundle if necessary.
+Copy is not necessary, if the ``<resolved_item>`` is "the same as" the
+``<resolved_embedded_item>``.
+
+.. code-block:: cmake
+
+  copy_resolved_framework_into_bundle(<resolved_item> <resolved_embedded_item>)
+
+Copy a resolved framework into the bundle if necessary.
+Copy is not necessary, if the ``<resolved_item>`` is "the same as" the
+``<resolved_embedded_item>``.
+
+By default, ``BU_COPY_FULL_FRAMEWORK_CONTENTS`` is not set.  If you want
+full frameworks embedded in your bundles, set
+``BU_COPY_FULL_FRAMEWORK_CONTENTS`` to ``ON`` before calling fixup_bundle.  By
+default, ``COPY_RESOLVED_FRAMEWORK_INTO_BUNDLE`` copies the framework
+dylib itself plus the framework ``Resources`` directory.
+
+.. code-block:: cmake
+
+  fixup_bundle_item(<resolved_embedded_item> <exepath> <dirs>)
+
+Get the direct/non-system prerequisites of the ``<resolved_embedded_item>``.
+For each prerequisite, change the way it is referenced to the value of
+the ``_EMBEDDED_ITEM`` keyed variable for that prerequisite.  (Most likely
+changing to an ``@executable_path`` style reference.)
+
+This function requires that the ``<resolved_embedded_item>`` be ``inside``
+the bundle already.  In other words, if you pass plugins to ``fixup_bundle``
+as the libs parameter, you should install them or copy them into the
+bundle before calling ``fixup_bundle``.  The ``libs`` parameter is a list of
+libraries that must be fixed up, but that cannot be determined by
+otool output analysis.  (i.e., ``plugins``)
+
+Also, change the id of the item being fixed up to its own
+``_EMBEDDED_ITEM`` value.
+
+Accumulate changes in a local variable and make *one* call to
+``install_name_tool`` at the end of the function with all the changes at
+once.
+
+If the ``BU_CHMOD_BUNDLE_ITEMS`` variable is set then bundle items will be
+marked writable before ``install_name_tool`` tries to change them.
+
+.. code-block:: cmake
+
+  verify_bundle_prerequisites(<bundle> <result_var> <info_var>)
+
+Verifies that the sum of all prerequisites of all files inside the
+bundle are contained within the bundle or are ``system`` libraries,
+presumed to exist everywhere.
+
+.. versionadded:: 3.6
+  As an optional parameter (``IGNORE_ITEM``) a list of file names can be passed,
+  which are then ignored
+  (e.g. ``IGNORE_ITEM "vcredist_x86.exe;vcredist_x64.exe"``)
+
+.. code-block:: cmake
+
+  verify_bundle_symlinks(<bundle> <result_var> <info_var>)
+
+Verifies that any symlinks found in the ``<bundle>`` bundle point to other files
+that are already also in the bundle...  Anything that points to an
+external file causes this function to fail the verification.
+#]=======================================================================]
+
+function(_warn_cmp0080)
+  cmake_policy(GET_WARNING CMP0080 _cmp0080_warning)
+  message(AUTHOR_WARNING "${_cmp0080_warning}\n")
+endfunction()
+
+# Do not include this module at configure time!
+if(DEFINED CMAKE_GENERATOR)
+  cmake_policy(GET CMP0080 _BundleUtilities_CMP0080)
+  if(_BundleUtilities_CMP0080 STREQUAL "NEW")
+    message(FATAL_ERROR "BundleUtilities cannot be included at configure time!")
+  elseif(NOT _BundleUtilities_CMP0080 STREQUAL "OLD" AND NOT _CMP0080_SUPPRESS_WARNING)
+    _warn_cmp0080()
+  endif()
+endif()
+
+cmake_policy(PUSH)
+cmake_policy(SET CMP0057 NEW) # if IN_LIST
+
+# The functions defined in this file depend on the get_prerequisites function
+# (and possibly others) found in:
+#
+include("${CMAKE_CURRENT_LIST_DIR}/GetPrerequisites.cmake")
+
+
+function(get_bundle_main_executable bundle result_var)
+  set(result "error: '${bundle}/Contents/Info.plist' file does not exist")
+
+  if(EXISTS "${bundle}/Contents/Info.plist")
+    set(result "error: no CFBundleExecutable in '${bundle}/Contents/Info.plist' file")
+    set(line_is_main_executable 0)
+    set(bundle_executable "")
+
+    # Read Info.plist as a list of lines:
+    #
+    set(eol_char "E")
+    file(READ "${bundle}/Contents/Info.plist" info_plist)
+    string(REPLACE ";" "\\;" info_plist "${info_plist}")
+    string(REPLACE "\n" "${eol_char};" info_plist "${info_plist}")
+    string(REPLACE "\r" "${eol_char};" info_plist "${info_plist}")
+
+    # Scan the lines for "<key>CFBundleExecutable</key>" - the line after that
+    # is the name of the main executable.
+    #
+    foreach(line ${info_plist})
+      if(line_is_main_executable)
+        string(REGEX REPLACE "^.*<string>(.*)</string>.*$" "\\1" bundle_executable "${line}")
+        break()
+      endif()
+
+      if(line MATCHES "<key>CFBundleExecutable</key>")
+        set(line_is_main_executable 1)
+      endif()
+    endforeach()
+
+    if(NOT bundle_executable STREQUAL "")
+      if(EXISTS "${bundle}/Contents/MacOS/${bundle_executable}")
+        set(result "${bundle}/Contents/MacOS/${bundle_executable}")
+      else()
+
+        # Ultimate goal:
+        # If not in "Contents/MacOS" then scan the bundle for matching files. If
+        # there is only one executable file that matches, then use it, otherwise
+        # it's an error...
+        #
+        #file(GLOB_RECURSE file_list "${bundle}/${bundle_executable}")
+
+        # But for now, pragmatically, it's an error. Expect the main executable
+        # for the bundle to be in Contents/MacOS, it's an error if it's not:
+        #
+        set(result "error: '${bundle}/Contents/MacOS/${bundle_executable}' does not exist")
+      endif()
+    endif()
+  else()
+    #
+    # More inclusive technique... (This one would work on Windows and Linux
+    # too, if a developer followed the typical Mac bundle naming convention...)
+    #
+    # If there is no Info.plist file, try to find an executable with the same
+    # base name as the .app directory:
+    #
+  endif()
+
+  set(${result_var} "${result}" PARENT_SCOPE)
+endfunction()
+
+
+function(get_dotapp_dir exe dotapp_dir_var)
+  set(s "${exe}")
+
+  if(s MATCHES "/.*\\.app/")
+    # If there is a ".app" parent directory,
+    # ascend until we hit it:
+    #   (typical of a Mac bundle executable)
+    #
+    set(done 0)
+    while(NOT ${done})
+      get_filename_component(snamewe "${s}" NAME_WE)
+      get_filename_component(sname "${s}" NAME)
+      get_filename_component(sdir "${s}" PATH)
+      set(s "${sdir}")
+      if(sname MATCHES "\\.app$")
+        set(done 1)
+        set(dotapp_dir "${sdir}/${sname}")
+      endif()
+    endwhile()
+  else()
+    # Otherwise use a directory containing the exe
+    #   (typical of a non-bundle executable on Mac, Windows or Linux)
+    #
+    is_file_executable("${s}" is_executable)
+    if(is_executable)
+      get_filename_component(sdir "${s}" PATH)
+      set(dotapp_dir "${sdir}")
+    else()
+      set(dotapp_dir "${s}")
+    endif()
+  endif()
+
+
+  set(${dotapp_dir_var} "${dotapp_dir}" PARENT_SCOPE)
+endfunction()
+
+
+function(get_bundle_and_executable app bundle_var executable_var valid_var)
+  set(valid 0)
+
+  if(EXISTS "${app}")
+    # Is it a directory ending in .app?
+    if(IS_DIRECTORY "${app}")
+      if(app MATCHES "\\.app$")
+        get_bundle_main_executable("${app}" executable)
+        if(EXISTS "${app}" AND EXISTS "${executable}")
+          set(${bundle_var} "${app}" PARENT_SCOPE)
+          set(${executable_var} "${executable}" PARENT_SCOPE)
+          set(valid 1)
+          #message(STATUS "info: handled .app directory case...")
+        else()
+          message(STATUS "warning: *NOT* handled - .app directory case...")
+        endif()
+      else()
+        message(STATUS "warning: *NOT* handled - directory but not .app case...")
+      endif()
+    else()
+      # Is it an executable file?
+      is_file_executable("${app}" is_executable)
+      if(is_executable)
+        get_dotapp_dir("${app}" dotapp_dir)
+        if(EXISTS "${dotapp_dir}")
+          set(${bundle_var} "${dotapp_dir}" PARENT_SCOPE)
+          set(${executable_var} "${app}" PARENT_SCOPE)
+          set(valid 1)
+          #message(STATUS "info: handled executable file in .app dir case...")
+        else()
+          get_filename_component(app_dir "${app}" PATH)
+          set(${bundle_var} "${app_dir}" PARENT_SCOPE)
+          set(${executable_var} "${app}" PARENT_SCOPE)
+          set(valid 1)
+          #message(STATUS "info: handled executable file in any dir case...")
+        endif()
+      else()
+        message(STATUS "warning: *NOT* handled - not .app dir, not executable file...")
+      endif()
+    endif()
+  else()
+    message(STATUS "warning: *NOT* handled - directory/file does not exist...")
+  endif()
+
+  if(NOT valid)
+    set(${bundle_var} "error: not a bundle" PARENT_SCOPE)
+    set(${executable_var} "error: not a bundle" PARENT_SCOPE)
+  endif()
+
+  set(${valid_var} ${valid} PARENT_SCOPE)
+endfunction()
+
+
+function(get_bundle_all_executables bundle exes_var)
+  set(exes "")
+
+  if(UNIX)
+    find_program(find_cmd "find")
+    mark_as_advanced(find_cmd)
+  endif()
+
+  # find command is much quicker than checking every file one by one on Unix
+  # which can take long time for large bundles, and since anyway we expect
+  # executable to have execute flag set we can narrow the list much quicker.
+  if(find_cmd)
+    execute_process(COMMAND "${find_cmd}" "${bundle}"
+      -type f \( -perm -0100 -o -perm -0010 -o -perm -0001 \)
+      OUTPUT_VARIABLE file_list
+      OUTPUT_STRIP_TRAILING_WHITESPACE
+      )
+    string(REPLACE "\n" ";" file_list "${file_list}")
+  else()
+    file(GLOB_RECURSE file_list "${bundle}/*")
+  endif()
+
+  foreach(f ${file_list})
+    is_file_executable("${f}" is_executable)
+    if(is_executable)
+      set(exes ${exes} "${f}")
+    endif()
+  endforeach()
+
+  set(${exes_var} "${exes}" PARENT_SCOPE)
+endfunction()
+
+
+function(get_item_rpaths item rpaths_var)
+  if(APPLE)
+    find_program(otool_cmd "otool")
+    mark_as_advanced(otool_cmd)
+  endif()
+
+  if(otool_cmd)
+    execute_process(
+      COMMAND "${otool_cmd}" -l "${item}"
+      OUTPUT_VARIABLE load_cmds_ov
+      RESULT_VARIABLE otool_rv
+      ERROR_VARIABLE otool_ev
+      )
+    if(NOT otool_rv STREQUAL "0")
+      message(FATAL_ERROR "otool -l failed: ${otool_rv}\n${otool_ev}")
+    endif()
+    string(REGEX REPLACE "[^\n]+cmd LC_RPATH\n[^\n]+\n[^\n]+path ([^\n]+) \\(offset[^\n]+\n" "rpath \\1\n" load_cmds_ov "${load_cmds_ov}")
+    string(REGEX MATCHALL "rpath [^\n]+" load_cmds_ov "${load_cmds_ov}")
+    string(REGEX REPLACE "rpath " "" load_cmds_ov "${load_cmds_ov}")
+    if(load_cmds_ov)
+      foreach(rpath ${load_cmds_ov})
+        gp_append_unique(${rpaths_var} "${rpath}")
+      endforeach()
+    endif()
+  endif()
+
+  if(UNIX AND NOT APPLE)
+    file(READ_ELF ${item} RPATH rpath_var RUNPATH runpath_var CAPTURE_ERROR error_var)
+    get_filename_component(item_dir ${item} DIRECTORY)
+    foreach(rpath ${rpath_var} ${runpath_var})
+      # Substitute $ORIGIN with the exepath and add to the found rpaths
+      string(REPLACE "$ORIGIN" "${item_dir}" rpath "${rpath}")
+      gp_append_unique(${rpaths_var} "${rpath}")
+    endforeach()
+  endif()
+
+  set(${rpaths_var} ${${rpaths_var}} PARENT_SCOPE)
+endfunction()
+
+
+function(get_item_key item key_var)
+  get_filename_component(item_name "${item}" NAME)
+  if(WIN32)
+    string(TOLOWER "${item_name}" item_name)
+  endif()
+  string(REPLACE "." "_" ${key_var} "${item_name}")
+  set(${key_var} ${${key_var}} PARENT_SCOPE)
+endfunction()
+
+
+function(clear_bundle_keys keys_var)
+  foreach(key ${${keys_var}})
+    set(${key}_ITEM PARENT_SCOPE)
+    set(${key}_RESOLVED_ITEM PARENT_SCOPE)
+    set(${key}_DEFAULT_EMBEDDED_PATH PARENT_SCOPE)
+    set(${key}_EMBEDDED_ITEM PARENT_SCOPE)
+    set(${key}_RESOLVED_EMBEDDED_ITEM PARENT_SCOPE)
+    set(${key}_COPYFLAG PARENT_SCOPE)
+    set(${key}_RPATHS PARENT_SCOPE)
+  endforeach()
+  set(${keys_var} PARENT_SCOPE)
+endfunction()
+
+
+function(set_bundle_key_values keys_var context item exepath dirs copyflag)
+  if(ARGC GREATER 6)
+    set(rpaths "${ARGV6}")
+  else()
+    set(rpaths "")
+  endif()
+  get_filename_component(item_name "${item}" NAME)
+
+  get_item_key("${item}" key)
+
+  list(LENGTH ${keys_var} length_before)
+  gp_append_unique(${keys_var} "${key}")
+  list(LENGTH ${keys_var} length_after)
+
+  if(NOT length_before EQUAL length_after)
+    gp_resolve_item("${context}" "${item}" "${exepath}" "${dirs}" resolved_item "${rpaths}")
+
+    gp_item_default_embedded_path("${item}" default_embedded_path)
+
+    get_item_rpaths("${resolved_item}" item_rpaths)
+
+    if((NOT item MATCHES "\\.dylib$") AND (item MATCHES "[^/]+\\.framework/"))
+      # For frameworks, construct the name under the embedded path from the
+      # opening "${item_name}.framework/" to the closing "/${item_name}":
+      #
+      string(REGEX REPLACE "^.*(${item_name}.framework/.*/?${item_name}).*$" "${default_embedded_path}/\\1" embedded_item "${item}")
+    else()
+      # For other items, just use the same name as the original, but in the
+      # embedded path:
+      #
+      set(embedded_item "${default_embedded_path}/${item_name}")
+    endif()
+
+    # Replace @executable_path and resolve ".." references:
+    #
+    string(REPLACE "@executable_path" "${exepath}" resolved_embedded_item "${embedded_item}")
+    get_filename_component(resolved_embedded_item "${resolved_embedded_item}" ABSOLUTE)
+
+    # *But* -- if we are not copying, then force resolved_embedded_item to be
+    # the same as resolved_item. In the case of multiple executables in the
+    # original bundle, using the default_embedded_path results in looking for
+    # the resolved executable next to the main bundle executable. This is here
+    # so that exes in the other sibling directories (like "bin") get fixed up
+    # properly...
+    #
+    if(NOT copyflag)
+      set(resolved_embedded_item "${resolved_item}")
+    endif()
+
+    set(${keys_var} ${${keys_var}} PARENT_SCOPE)
+    set(${key}_ITEM "${item}" PARENT_SCOPE)
+    set(${key}_RESOLVED_ITEM "${resolved_item}" PARENT_SCOPE)
+    set(${key}_DEFAULT_EMBEDDED_PATH "${default_embedded_path}" PARENT_SCOPE)
+    set(${key}_EMBEDDED_ITEM "${embedded_item}" PARENT_SCOPE)
+    set(${key}_RESOLVED_EMBEDDED_ITEM "${resolved_embedded_item}" PARENT_SCOPE)
+    set(${key}_COPYFLAG "${copyflag}" PARENT_SCOPE)
+    set(${key}_RPATHS "${item_rpaths}" PARENT_SCOPE)
+    set(${key}_RDEP_RPATHS "${rpaths}" PARENT_SCOPE)
+  else()
+    #message("warning: item key '${key}' already in the list, subsequent references assumed identical to first")
+  endif()
+endfunction()
+
+
+function(get_bundle_keys app libs dirs keys_var)
+  set(${keys_var} PARENT_SCOPE)
+
+  set(options)
+  set(oneValueArgs)
+  set(multiValueArgs IGNORE_ITEM)
+  cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
+
+  get_bundle_and_executable("${app}" bundle executable valid)
+  if(valid)
+    # Always use the exepath of the main bundle executable for @executable_path
+    # replacements:
+    #
+    get_filename_component(exepath "${executable}" PATH)
+
+    # But do fixups on all executables in the bundle:
+    #
+    get_bundle_all_executables("${bundle}" exes)
+
+    # Set keys for main executable first:
+    #
+    set_bundle_key_values(${keys_var} "${executable}" "${executable}" "${exepath}" "${dirs}" 0)
+
+    # Get rpaths specified by main executable:
+    #
+    get_item_key("${executable}" executable_key)
+    set(main_rpaths "${${executable_key}_RPATHS}")
+
+    # For each extra lib, accumulate a key as well and then also accumulate
+    # any of its prerequisites. (Extra libs are typically dynamically loaded
+    # plugins: libraries that are prerequisites for full runtime functionality
+    # but that do not show up in otool -L output...)
+    #
+    foreach(lib ${libs})
+      set_bundle_key_values(${keys_var} "${lib}" "${lib}" "${exepath}" "${dirs}" 0 "${main_rpaths}")
+
+      set(prereqs "")
+      get_filename_component(prereq_filename ${lib} NAME)
+
+      if(NOT prereq_filename IN_LIST CFG_IGNORE_ITEM)
+        get_prerequisites("${lib}" prereqs 1 1 "${exepath}" "${dirs}" "${main_rpaths}")
+        foreach(pr ${prereqs})
+          set_bundle_key_values(${keys_var} "${lib}" "${pr}" "${exepath}" "${dirs}" 1 "${main_rpaths}")
+        endforeach()
+      else()
+        message(STATUS "Ignoring file: ${prereq_filename}")
+      endif()
+    endforeach()
+
+    # For each executable found in the bundle, accumulate keys as we go.
+    # The list of keys should be complete when all prerequisites of all
+    # binaries in the bundle have been analyzed.
+    #
+    foreach(exe ${exes})
+      # Main executable is scanned first above:
+      #
+      if(NOT exe STREQUAL executable)
+        # Add the exe itself to the keys:
+        #
+        set_bundle_key_values(${keys_var} "${exe}" "${exe}" "${exepath}" "${dirs}" 0 "${main_rpaths}")
+
+        # Get rpaths specified by executable:
+        #
+        get_item_key("${exe}" exe_key)
+        set(exe_rpaths "${main_rpaths}" "${${exe_key}_RPATHS}")
+      else()
+        set(exe_rpaths "${main_rpaths}")
+      endif()
+
+      # Add each prerequisite to the keys:
+      #
+      set(prereqs "")
+      get_filename_component(prereq_filename ${exe} NAME)
+
+      if(NOT prereq_filename IN_LIST CFG_IGNORE_ITEM)
+        get_prerequisites("${exe}" prereqs 1 1 "${exepath}" "${dirs}" "${exe_rpaths}")
+        foreach(pr ${prereqs})
+          set_bundle_key_values(${keys_var} "${exe}" "${pr}" "${exepath}" "${dirs}" 1 "${exe_rpaths}")
+        endforeach()
+      else()
+        message(STATUS "Ignoring file: ${prereq_filename}")
+      endif()
+    endforeach()
+
+    # preserve library symlink structure
+    foreach(key ${${keys_var}})
+      if("${${key}_COPYFLAG}" STREQUAL "1")
+        if(IS_SYMLINK "${${key}_RESOLVED_ITEM}")
+          get_filename_component(target "${${key}_RESOLVED_ITEM}" REALPATH)
+          set_bundle_key_values(${keys_var} "${exe}" "${target}" "${exepath}" "${dirs}" 1 "${exe_rpaths}")
+          get_item_key("${target}" targetkey)
+
+          if(WIN32)
+            # ignore case on Windows
+            string(TOLOWER "${${key}_RESOLVED_ITEM}" resolved_item_compare)
+            string(TOLOWER "${${targetkey}_RESOLVED_EMBEDDED_ITEM}" resolved_embedded_item_compare)
+          else()
+            set(resolved_item_compare "${${key}_RESOLVED_ITEM}")
+            set(resolved_embedded_item_compare "${${targetkey}_RESOLVED_EMBEDDED_ITEM}")
+          endif()
+          get_filename_component(resolved_item_compare "${resolved_item_compare}" NAME)
+          get_filename_component(resolved_embedded_item_compare "${resolved_embedded_item_compare}" NAME)
+
+          if(NOT resolved_item_compare STREQUAL resolved_embedded_item_compare)
+            set(${key}_COPYFLAG "2")
+            set(${key}_RESOLVED_ITEM "${${targetkey}_RESOLVED_EMBEDDED_ITEM}")
+          endif()
+
+        endif()
+      endif()
+    endforeach()
+    # Propagate values to caller's scope:
+    #
+    set(${keys_var} ${${keys_var}} PARENT_SCOPE)
+    foreach(key ${${keys_var}})
+      set(${key}_ITEM "${${key}_ITEM}" PARENT_SCOPE)
+      set(${key}_RESOLVED_ITEM "${${key}_RESOLVED_ITEM}" PARENT_SCOPE)
+      set(${key}_DEFAULT_EMBEDDED_PATH "${${key}_DEFAULT_EMBEDDED_PATH}" PARENT_SCOPE)
+      set(${key}_EMBEDDED_ITEM "${${key}_EMBEDDED_ITEM}" PARENT_SCOPE)
+      set(${key}_RESOLVED_EMBEDDED_ITEM "${${key}_RESOLVED_EMBEDDED_ITEM}" PARENT_SCOPE)
+      set(${key}_COPYFLAG "${${key}_COPYFLAG}" PARENT_SCOPE)
+      set(${key}_RPATHS "${${key}_RPATHS}" PARENT_SCOPE)
+      set(${key}_RDEP_RPATHS "${${key}_RDEP_RPATHS}" PARENT_SCOPE)
+    endforeach()
+  endif()
+endfunction()
+
+function(link_resolved_item_into_bundle resolved_item resolved_embedded_item)
+  if(WIN32)
+    # ignore case on Windows
+    string(TOLOWER "${resolved_item}" resolved_item_compare)
+    string(TOLOWER "${resolved_embedded_item}" resolved_embedded_item_compare)
+  else()
+    set(resolved_item_compare "${resolved_item}")
+    set(resolved_embedded_item_compare "${resolved_embedded_item}")
+  endif()
+
+  if(resolved_item_compare STREQUAL resolved_embedded_item_compare)
+    message(STATUS "warning: resolved_item == resolved_embedded_item - not linking...")
+  else()
+    get_filename_component(target_dir "${resolved_embedded_item}" DIRECTORY)
+    file(RELATIVE_PATH symlink_target "${target_dir}" "${resolved_item}")
+    if (NOT EXISTS "${target_dir}")
+      file(MAKE_DIRECTORY "${target_dir}")
+    endif()
+    execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink "${symlink_target}" "${resolved_embedded_item}")
+  endif()
+endfunction()
+
+function(copy_resolved_item_into_bundle resolved_item resolved_embedded_item)
+  if(WIN32)
+    # ignore case on Windows
+    string(TOLOWER "${resolved_item}" resolved_item_compare)
+    string(TOLOWER "${resolved_embedded_item}" resolved_embedded_item_compare)
+  else()
+    set(resolved_item_compare "${resolved_item}")
+    set(resolved_embedded_item_compare "${resolved_embedded_item}")
+  endif()
+
+  if(resolved_item_compare STREQUAL resolved_embedded_item_compare)
+    message(STATUS "warning: resolved_item == resolved_embedded_item - not copying...")
+  else()
+    #message(STATUS "copying COMMAND ${CMAKE_COMMAND} -E copy ${resolved_item} ${resolved_embedded_item}")
+    execute_process(COMMAND ${CMAKE_COMMAND} -E copy "${resolved_item}" "${resolved_embedded_item}")
+    if(UNIX AND NOT APPLE)
+      file(RPATH_REMOVE FILE "${resolved_embedded_item}")
+    endif()
+  endif()
+
+endfunction()
+
+
+function(copy_resolved_framework_into_bundle resolved_item resolved_embedded_item)
+  if(WIN32)
+    # ignore case on Windows
+    string(TOLOWER "${resolved_item}" resolved_item_compare)
+    string(TOLOWER "${resolved_embedded_item}" resolved_embedded_item_compare)
+  else()
+    set(resolved_item_compare "${resolved_item}")
+    set(resolved_embedded_item_compare "${resolved_embedded_item}")
+  endif()
+
+  if(resolved_item_compare STREQUAL resolved_embedded_item_compare)
+    message(STATUS "warning: resolved_item == resolved_embedded_item - not copying...")
+  else()
+    if(BU_COPY_FULL_FRAMEWORK_CONTENTS)
+      # Full Framework (everything):
+      get_filename_component(resolved_dir "${resolved_item}" PATH)
+      get_filename_component(resolved_dir "${resolved_dir}/../.." ABSOLUTE)
+      get_filename_component(resolved_embedded_dir "${resolved_embedded_item}" PATH)
+      get_filename_component(resolved_embedded_dir "${resolved_embedded_dir}/../.." ABSOLUTE)
+      #message(STATUS "copying COMMAND ${CMAKE_COMMAND} -E copy_directory '${resolved_dir}' '${resolved_embedded_dir}'")
+      execute_process(COMMAND ${CMAKE_COMMAND} -E copy_directory "${resolved_dir}" "${resolved_embedded_dir}")
+    else()
+      # Framework lib itself:
+      #message(STATUS "copying COMMAND ${CMAKE_COMMAND} -E copy ${resolved_item} ${resolved_embedded_item}")
+      execute_process(COMMAND ${CMAKE_COMMAND} -E copy "${resolved_item}" "${resolved_embedded_item}")
+
+      # Plus Resources, if they exist:
+      string(REGEX REPLACE "^(.*)/[^/]+$" "\\1/Resources" resolved_resources "${resolved_item}")
+      string(REGEX REPLACE "^(.*)/[^/]+$" "\\1/Resources" resolved_embedded_resources "${resolved_embedded_item}")
+      if(EXISTS "${resolved_resources}")
+        #message(STATUS "copying COMMAND ${CMAKE_COMMAND} -E copy_directory '${resolved_resources}' '${resolved_embedded_resources}'")
+        execute_process(COMMAND ${CMAKE_COMMAND} -E copy_directory "${resolved_resources}" "${resolved_embedded_resources}")
+      endif()
+
+      # Some frameworks e.g. Qt put Info.plist in wrong place, so when it is
+      # missing in resources, copy it from other well known incorrect locations:
+      if(NOT EXISTS "${resolved_resources}/Info.plist")
+        # Check for Contents/Info.plist in framework root (older Qt SDK):
+        string(REGEX REPLACE "^(.*)/[^/]+/[^/]+/[^/]+$" "\\1/Contents/Info.plist" resolved_info_plist "${resolved_item}")
+        string(REGEX REPLACE "^(.*)/[^/]+$" "\\1/Resources/Info.plist" resolved_embedded_info_plist "${resolved_embedded_item}")
+        if(EXISTS "${resolved_info_plist}")
+          #message(STATUS "copying COMMAND ${CMAKE_COMMAND} -E copy_directory '${resolved_info_plist}' '${resolved_embedded_info_plist}'")
+          execute_process(COMMAND ${CMAKE_COMMAND} -E copy "${resolved_info_plist}" "${resolved_embedded_info_plist}")
+        endif()
+      endif()
+
+      # Check if framework is versioned and fix it layout
+      string(REGEX REPLACE "^.*/([^/]+)/[^/]+$" "\\1" resolved_embedded_version "${resolved_embedded_item}")
+      string(REGEX REPLACE "^(.*)/[^/]+/[^/]+$" "\\1" resolved_embedded_versions "${resolved_embedded_item}")
+      string(REGEX REPLACE "^.*/([^/]+)/[^/]+/[^/]+$" "\\1" resolved_embedded_versions_basename "${resolved_embedded_item}")
+      if(resolved_embedded_versions_basename STREQUAL "Versions")
+        # Ensure Current symlink points to the framework version
+        if(NOT EXISTS "${resolved_embedded_versions}/Current")
+          execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink "${resolved_embedded_version}" "${resolved_embedded_versions}/Current")
+        endif()
+        # Restore symlinks in framework root pointing to current framework
+        # binary and resources:
+        string(REGEX REPLACE "^(.*)/[^/]+/[^/]+/[^/]+$" "\\1" resolved_embedded_root "${resolved_embedded_item}")
+        string(REGEX REPLACE "^.*/([^/]+)$" "\\1" resolved_embedded_item_basename "${resolved_embedded_item}")
+        if(NOT EXISTS "${resolved_embedded_root}/${resolved_embedded_item_basename}")
+          execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink "Versions/Current/${resolved_embedded_item_basename}" "${resolved_embedded_root}/${resolved_embedded_item_basename}")
+        endif()
+        if(NOT EXISTS "${resolved_embedded_root}/Resources")
+          execute_process(COMMAND ${CMAKE_COMMAND} -E create_symlink "Versions/Current/Resources" "${resolved_embedded_root}/Resources")
+        endif()
+      endif()
+    endif()
+    if(UNIX AND NOT APPLE)
+      file(RPATH_REMOVE FILE "${resolved_embedded_item}")
+    endif()
+  endif()
+
+endfunction()
+
+
+function(fixup_bundle_item resolved_embedded_item exepath dirs)
+  # This item's key is "ikey":
+  #
+  get_item_key("${resolved_embedded_item}" ikey)
+
+  # Ensure the item is "inside the .app bundle" -- it should not be fixed up if
+  # it is not in the .app bundle... Otherwise, we'll modify files in the build
+  # tree, or in other varied locations around the file system, with our call to
+  # install_name_tool. Make sure that doesn't happen here:
+  #
+  get_dotapp_dir("${exepath}" exe_dotapp_dir)
+  string(LENGTH "${exe_dotapp_dir}/" exe_dotapp_dir_length)
+  string(LENGTH "${resolved_embedded_item}" resolved_embedded_item_length)
+  set(path_too_short 0)
+  set(is_embedded 0)
+  if(resolved_embedded_item_length LESS exe_dotapp_dir_length)
+    set(path_too_short 1)
+  endif()
+  if(NOT path_too_short)
+    string(SUBSTRING "${resolved_embedded_item}" 0 ${exe_dotapp_dir_length} item_substring)
+    if("${exe_dotapp_dir}/" STREQUAL item_substring)
+      set(is_embedded 1)
+    endif()
+  endif()
+  if(NOT is_embedded)
+    message("  exe_dotapp_dir/='${exe_dotapp_dir}/'")
+    message("  item_substring='${item_substring}'")
+    message("  resolved_embedded_item='${resolved_embedded_item}'")
+    message("")
+    message("Install or copy the item into the bundle before calling fixup_bundle.")
+    message("Or maybe there's a typo or incorrect path in one of the args to fixup_bundle?")
+    message("")
+    message(FATAL_ERROR "cannot fixup an item that is not in the bundle...")
+  endif()
+
+  set(rpaths "${${ikey}_RPATHS}" "${${ikey}_RDEP_RPATHS}")
+
+  set(prereqs "")
+  get_prerequisites("${resolved_embedded_item}" prereqs 1 0 "${exepath}" "${dirs}" "${rpaths}")
+
+  set(changes "")
+
+  foreach(pr ${prereqs})
+    # Each referenced item's key is "rkey" in the loop:
+    #
+    get_item_key("${pr}" rkey)
+
+    if(NOT "${${rkey}_EMBEDDED_ITEM}" STREQUAL "")
+      set(changes ${changes} "-change" "${pr}" "${${rkey}_EMBEDDED_ITEM}")
+    else()
+      message("warning: unexpected reference to '${pr}'")
+    endif()
+  endforeach()
+
+  # CMAKE_INSTALL_NAME_TOOL may not be set if executed in script mode
+  # Duplicated from CMakeFindBinUtils.cmake
+  find_program(CMAKE_INSTALL_NAME_TOOL NAMES install_name_tool HINTS ${_CMAKE_TOOLCHAIN_LOCATION})
+
+  # Only if install_name_tool supports -delete_rpath:
+  #
+  execute_process(COMMAND ${CMAKE_INSTALL_NAME_TOOL}
+    OUTPUT_VARIABLE install_name_tool_usage
+    ERROR_VARIABLE  install_name_tool_usage
+    )
+  if(install_name_tool_usage MATCHES ".*-delete_rpath.*")
+    foreach(rpath ${${ikey}_RPATHS})
+      set(changes ${changes} -delete_rpath "${rpath}")
+    endforeach()
+  endif()
+
+  if(${ikey}_EMBEDDED_ITEM)
+    set(changes ${changes} -id "${${ikey}_EMBEDDED_ITEM}")
+  endif()
+
+  # Change this item's id and all of its references in one call
+  # to install_name_tool:
+  #
+  if(changes)
+    # Check for a script by extension (.bat,.sh,...) or if the file starts with "#!" (shebang)
+    file(READ ${resolved_embedded_item} file_contents LIMIT 5)
+    if(NOT "${resolved_embedded_item}" MATCHES "\\.(bat|c?sh|bash|ksh|cmd)$" AND
+       NOT file_contents MATCHES "^#!")
+      set(cmd ${CMAKE_INSTALL_NAME_TOOL} ${changes} "${resolved_embedded_item}")
+      if(BU_CHMOD_BUNDLE_ITEMS)
+        execute_process(COMMAND chmod u+w "${resolved_embedded_item}")
+      endif()
+      execute_process(COMMAND ${cmd} RESULT_VARIABLE install_name_tool_result)
+      if(NOT install_name_tool_result EQUAL 0)
+        string(REPLACE ";" "' '" msg "'${cmd}'")
+        message(FATAL_ERROR "Command failed:\n ${msg}")
+      endif()
+    endif()
+  endif()
+endfunction()
+
+
+function(fixup_bundle app libs dirs)
+  message(STATUS "fixup_bundle")
+  message(STATUS "  app='${app}'")
+  message(STATUS "  libs='${libs}'")
+  message(STATUS "  dirs='${dirs}'")
+
+  set(options)
+  set(oneValueArgs)
+  set(multiValueArgs IGNORE_ITEM)
+  cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
+
+  message(STATUS "  ignoreItems='${CFG_IGNORE_ITEM}'")
+
+  get_bundle_and_executable("${app}" bundle executable valid)
+  if(valid)
+    get_filename_component(exepath "${executable}" PATH)
+
+    message(STATUS "fixup_bundle: preparing...")
+    get_bundle_keys("${app}" "${libs}" "${dirs}" keys IGNORE_ITEM "${CFG_IGNORE_ITEM}")
+
+    message(STATUS "fixup_bundle: copying...")
+    list(LENGTH keys n)
+    math(EXPR n ${n}*2)
+
+    set(i 0)
+    foreach(key ${keys})
+      math(EXPR i ${i}+1)
+      if("${${key}_COPYFLAG}" STREQUAL "2")
+        message(STATUS "${i}/${n}: linking '${${key}_RESOLVED_ITEM}' -> '${${key}_RESOLVED_EMBEDDED_ITEM}'")
+      elseif(${${key}_COPYFLAG})
+        message(STATUS "${i}/${n}: copying '${${key}_RESOLVED_ITEM}'")
+      else()
+        message(STATUS "${i}/${n}: *NOT* copying '${${key}_RESOLVED_ITEM}'")
+      endif()
+
+      set(show_status 0)
+      if(show_status)
+        message(STATUS "key='${key}'")
+        message(STATUS "item='${${key}_ITEM}'")
+        message(STATUS "resolved_item='${${key}_RESOLVED_ITEM}'")
+        message(STATUS "default_embedded_path='${${key}_DEFAULT_EMBEDDED_PATH}'")
+        message(STATUS "embedded_item='${${key}_EMBEDDED_ITEM}'")
+        message(STATUS "resolved_embedded_item='${${key}_RESOLVED_EMBEDDED_ITEM}'")
+        message(STATUS "copyflag='${${key}_COPYFLAG}'")
+        message(STATUS "")
+      endif()
+
+      if("${${key}_COPYFLAG}" STREQUAL "2")
+        link_resolved_item_into_bundle("${${key}_RESOLVED_ITEM}"
+          "${${key}_RESOLVED_EMBEDDED_ITEM}")
+      elseif(${${key}_COPYFLAG})
+        set(item "${${key}_ITEM}")
+        if(item MATCHES "[^/]+\\.framework/")
+          copy_resolved_framework_into_bundle("${${key}_RESOLVED_ITEM}"
+            "${${key}_RESOLVED_EMBEDDED_ITEM}")
+        else()
+          copy_resolved_item_into_bundle("${${key}_RESOLVED_ITEM}"
+            "${${key}_RESOLVED_EMBEDDED_ITEM}")
+        endif()
+      endif()
+    endforeach()
+
+    message(STATUS "fixup_bundle: fixing...")
+    foreach(key ${keys})
+      math(EXPR i ${i}+1)
+      if(APPLE)
+        message(STATUS "${i}/${n}: fixing up '${${key}_RESOLVED_EMBEDDED_ITEM}'")
+        if(NOT "${${key}_COPYFLAG}" STREQUAL "2")
+          fixup_bundle_item("${${key}_RESOLVED_EMBEDDED_ITEM}" "${exepath}" "${dirs}")
+        endif()
+      else()
+        message(STATUS "${i}/${n}: fix-up not required on this platform '${${key}_RESOLVED_EMBEDDED_ITEM}'")
+      endif()
+    endforeach()
+
+    message(STATUS "fixup_bundle: cleaning up...")
+    clear_bundle_keys(keys)
+
+    message(STATUS "fixup_bundle: verifying...")
+    verify_app("${app}" IGNORE_ITEM "${CFG_IGNORE_ITEM}")
+  else()
+    message(SEND_ERROR "error: fixup_bundle: not a valid bundle")
+  endif()
+
+  message(STATUS "fixup_bundle: done")
+endfunction()
+
+
+function(copy_and_fixup_bundle src dst libs dirs)
+  execute_process(COMMAND ${CMAKE_COMMAND} -E copy_directory "${src}" "${dst}")
+  fixup_bundle("${dst}" "${libs}" "${dirs}")
+endfunction()
+
+
+function(verify_bundle_prerequisites bundle result_var info_var)
+  set(result 1)
+  set(info "")
+  set(count 0)
+
+  set(options)
+  set(oneValueArgs)
+  set(multiValueArgs IGNORE_ITEM)
+  cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
+
+  get_bundle_main_executable("${bundle}" main_bundle_exe)
+
+  get_bundle_all_executables("${bundle}" file_list)
+  foreach(f ${file_list})
+      get_filename_component(exepath "${f}" PATH)
+      math(EXPR count "${count} + 1")
+
+      message(STATUS "executable file ${count}: ${f}")
+
+      set(prereqs "")
+      get_filename_component(prereq_filename ${f} NAME)
+
+      if(NOT prereq_filename IN_LIST CFG_IGNORE_ITEM)
+        get_item_rpaths(${f} _main_exe_rpaths)
+        get_prerequisites("${f}" prereqs 1 1 "${exepath}" "${_main_exe_rpaths}")
+
+        # On the Mac,
+        # "embedded" and "system" prerequisites are fine... anything else means
+        # the bundle's prerequisites are not verified (i.e., the bundle is not
+        # really "standalone")
+        #
+        # On Windows (and others? Linux/Unix/...?)
+        # "local" and "system" prereqs are fine...
+        #
+
+        set(external_prereqs "")
+
+        foreach(p ${prereqs})
+          set(p_type "")
+          gp_file_type("${f}" "${p}" p_type)
+
+          if(APPLE)
+            if(NOT p_type STREQUAL "embedded" AND NOT p_type STREQUAL "system")
+              set(external_prereqs ${external_prereqs} "${p}")
+            endif()
+          else()
+            if(NOT p_type STREQUAL "local" AND NOT p_type STREQUAL "system")
+              set(external_prereqs ${external_prereqs} "${p}")
+            endif()
+          endif()
+        endforeach()
+
+        if(external_prereqs)
+          # Found non-system/somehow-unacceptable prerequisites:
+          set(result 0)
+          set(info ${info} "external prerequisites found:\nf='${f}'\nexternal_prereqs='${external_prereqs}'\n")
+        endif()
+      else()
+        message(STATUS "Ignoring file: ${prereq_filename}")
+      endif()
+  endforeach()
+
+  if(result)
+    set(info "Verified ${count} executable files in '${bundle}'")
+  endif()
+
+  set(${result_var} "${result}" PARENT_SCOPE)
+  set(${info_var} "${info}" PARENT_SCOPE)
+endfunction()
+
+
+function(verify_bundle_symlinks bundle result_var info_var)
+  set(result 1)
+  set(info "")
+  set(count 0)
+
+  # TODO: implement this function for real...
+  # Right now, it is just a stub that verifies unconditionally...
+
+  set(${result_var} "${result}" PARENT_SCOPE)
+  set(${info_var} "${info}" PARENT_SCOPE)
+endfunction()
+
+
+function(verify_app app)
+  set(verified 0)
+  set(info "")
+
+  set(options)
+  set(oneValueArgs)
+  set(multiValueArgs IGNORE_ITEM)
+  cmake_parse_arguments(CFG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
+
+  get_bundle_and_executable("${app}" bundle executable valid)
+
+  message(STATUS "===========================================================================")
+  message(STATUS "Analyzing app='${app}'")
+  message(STATUS "bundle='${bundle}'")
+  message(STATUS "executable='${executable}'")
+  message(STATUS "valid='${valid}'")
+
+  # Verify that the bundle does not have any "external" prerequisites:
+  #
+  verify_bundle_prerequisites("${bundle}" verified info IGNORE_ITEM "${CFG_IGNORE_ITEM}")
+  message(STATUS "verified='${verified}'")
+  message(STATUS "info='${info}'")
+  message(STATUS "")
+
+  if(verified)
+    # Verify that the bundle does not have any symlinks to external files:
+    #
+    verify_bundle_symlinks("${bundle}" verified info)
+    message(STATUS "verified='${verified}'")
+    message(STATUS "info='${info}'")
+    message(STATUS "")
+  endif()
+
+  if(NOT verified)
+    message(FATAL_ERROR "error: verify_app failed")
+  endif()
+endfunction()
+
+cmake_policy(POP)

cmake/share/cmake-3.31/Modules/CMakeCSharpCompiler.cmake.in

@@ -0,0 +1,10 @@
+set(CMAKE_CSharp_COMPILER "@CMAKE_CSharp_COMPILER@")
+set(CMAKE_CSharp_COMPILER_ID "@CMAKE_CSharp_COMPILER_ID@")
+set(CMAKE_CSharp_COMPILER_VERSION "@CMAKE_CSharp_COMPILER_VERSION@")
+
+set(CMAKE_CSharp_COMPILER_LOADED 1)
+set(CMAKE_CSharp_COMPILER_WORKS "@CMAKE_CSharp_COMPILER_WORKS@")
+
+set(CMAKE_CSharp_COMPILER_ID_RUN "@CMAKE_CSharp_COMPILER_ID_RUN@")
+set(CMAKE_CSharp_IGNORE_EXTENSIONS "inl;h;hpp;HPP;H;o;O;obj;OBJ;def;DEF;rc;RC")
+set(CMAKE_CSharp_SOURCE_FILE_EXTENSIONS "cs")

cmake/share/cmake-3.31/Modules/CMakeCSharpCompilerId.cs.in

@@ -0,0 +1,71 @@
+using System;
+
+namespace CSharp
+{
+    public class CSharpApp
+    {
+        const string InfoCompiler = "INFO:compiler[Microsoft "
+#if PlatformToolsetv100
+        + "Visual Studio"
+#elif PlatformToolsetv110
+        + "Visual Studio"
+#elif PlatformToolsetv120
+        + "Visual Studio"
+#elif PlatformToolsetv140
+        + "Visual Studio"
+#elif PlatformToolsetv141
+        + "Visual Studio"
+#elif PlatformToolsetv142
+        + "Visual Studio"
+#elif PlatformToolsetv143
+        + "Visual Studio"
+#else
+        + "unknown"
+#endif
+        + "]";
+
+        const string InfoPlatform = "INFO:platform[Windows]";
+
+        const string InfoArchitecture = "INFO:arch["
+#if Platformx64
+        + "x64"
+#elif Platformx86
+        + "x86"
+#elif PlatformxWin32
+        + "Win32]"
+#else
+        + "unknown"
+#endif
+        + "]";
+
+        const string InfoCompilerVersion = "INFO:compiler_version["
+#if PlatformToolsetv100
+        + "2010"
+#elif PlatformToolsetv110
+        + "2012"
+#elif PlatformToolsetv120
+        + "2013"
+#elif PlatformToolsetv140
+        + "2015"
+#elif PlatformToolsetv141
+        + "2017"
+#elif PlatformToolsetv142
+        + "2019"
+#elif PlatformToolsetv143
+        + "2022"
+#else
+        + "9999"
+#endif
+        + "]";
+
+        static void Main(string[] args)
+        {
+            // we have to print the lines to make sure
+            // the compiler does not optimize them away ...
+            System.Console.WriteLine(InfoCompiler);
+            System.Console.WriteLine(InfoPlatform);
+            System.Console.WriteLine(InfoArchitecture);
+            System.Console.WriteLine(InfoCompilerVersion);
+        }
+    }
+}

cmake/share/cmake-3.31/Modules/CMakeCSharpInformation.cmake

@@ -0,0 +1,70 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+# This file sets the basic flags for the C# language in CMake.
+# It also loads the available platform file for the system-compiler
+# if it exists.
+
+set(CMAKE_BASE_NAME)
+get_filename_component(CMAKE_BASE_NAME "${CMAKE_CSharp_COMPILER}" NAME_WE)
+
+set(CMAKE_BUILD_TYPE_INIT Debug)
+
+set(CMAKE_CSharp_FLAGS_INIT "/define:TRACE")
+set(CMAKE_CSharp_FLAGS_DEBUG_INIT "/debug:full /optimize- /warn:3 /errorreport:prompt /define:DEBUG")
+set(CMAKE_CSharp_FLAGS_RELEASE_INIT "/debug:none /optimize  /warn:1  /errorreport:queue")
+set(CMAKE_CSharp_FLAGS_RELWITHDEBINFO_INIT "/debug:full /optimize-")
+set(CMAKE_CSharp_FLAGS_MINSIZEREL_INIT "/debug:none /optimize")
+set(CMAKE_CSharp_LINKER_SUPPORTS_PDB ON)
+
+set(CMAKE_CSharp_STANDARD_LIBRARIES_INIT "System")
+
+if(CMAKE_SIZEOF_VOID_P EQUAL 4)
+  set(CMAKE_CSharp_FLAGS_INIT "/platform:x86 ${CMAKE_CSharp_FLAGS_INIT}")
+else()
+  set(CMAKE_CSharp_FLAGS_INIT "/platform:x64 ${CMAKE_CSharp_FLAGS_INIT}")
+endif()
+
+# This should be included before the _INIT variables are
+# used to initialize the cache.  Since the rule variables
+# have if blocks on them, users can still define them here.
+# But, it should still be after the platform file so changes can
+# be made to those values.
+
+# for most systems a module is the same as a shared library
+# so unless the variable CMAKE_MODULE_EXISTS is set just
+# copy the values from the LIBRARY variables
+if(NOT CMAKE_MODULE_EXISTS)
+  set(CMAKE_SHARED_MODULE_CSharp_FLAGS ${CMAKE_SHARED_LIBRARY_CSharp_FLAGS})
+  set(CMAKE_SHARED_MODULE_CREATE_CSharp_FLAGS ${CMAKE_SHARED_LIBRARY_CREATE_CSharp_FLAGS})
+endif()
+
+# add the flags to the cache based
+# on the initial values computed in the platform/*.cmake files
+# use _INIT variables so that this only happens the first time
+# and you can set these flags in the cmake cache
+set(CMAKE_CSharp_FLAGS_INIT "$ENV{CSFLAGS} ${CMAKE_CSharp_FLAGS_INIT}")
+
+cmake_initialize_per_config_variable(CMAKE_CSharp_FLAGS "Flags used by the C# compiler")
+
+if(CMAKE_CSharp_STANDARD_LIBRARIES_INIT)
+  set(CMAKE_CSharp_STANDARD_LIBRARIES "${CMAKE_CSharp_STANDARD_LIBRARIES_INIT}"
+    CACHE STRING "Libraries linked by default with all C# applications.")
+  mark_as_advanced(CMAKE_CSharp_STANDARD_LIBRARIES)
+endif()
+
+# set missing flags (if they are not defined). This is needed in the
+# unlikely case that you have only C# and no C/C++ targets in your
+# project.
+cmake_initialize_per_config_variable(CMAKE_EXE_LINKER_FLAGS    "Flags used by the linker")
+cmake_initialize_per_config_variable(CMAKE_SHARED_LINKER_FLAGS "Flags used by the linker during the creation of shared libraries")
+
+set(CMAKE_CSharp_CREATE_SHARED_LIBRARY "CSharp_NO_CREATE_SHARED_LIBRARY")
+set(CMAKE_CSharp_CREATE_SHARED_MODULE "CSharp_NO_CREATE_SHARED_MODULE")
+set(CMAKE_CSharp_LINK_EXECUTABLE "CSharp_NO_LINK_EXECUTABLE")
+
+set(CMAKE_CSharp_USE_RESPONSE_FILE_FOR_OBJECTS 1)
+
+set(CMAKE_CSharp_USE_LINKER_INFORMATION FALSE)
+
+set(CMAKE_CSharp_INFORMATION_LOADED 1)

cmake/share/cmake-3.31/Modules/CMakeCUDACompiler.cmake.in

@@ -0,0 +1,87 @@
+set(CMAKE_CUDA_COMPILER "@CMAKE_CUDA_COMPILER@")
+set(CMAKE_CUDA_HOST_COMPILER "@CMAKE_CUDA_HOST_COMPILER@")
+set(CMAKE_CUDA_HOST_LINK_LAUNCHER "@CMAKE_CUDA_HOST_LINK_LAUNCHER@")
+set(CMAKE_CUDA_COMPILER_ID "@CMAKE_CUDA_COMPILER_ID@")
+set(CMAKE_CUDA_COMPILER_VERSION "@CMAKE_CUDA_COMPILER_VERSION@")
+set(CMAKE_CUDA_HOST_COMPILER_ID "@CMAKE_CUDA_HOST_COMPILER_ID@")
+set(CMAKE_CUDA_HOST_COMPILER_VERSION "@CMAKE_CUDA_HOST_COMPILER_VERSION@")
+set(CMAKE_CUDA_DEVICE_LINKER "@CMAKE_CUDA_DEVICE_LINKER@")
+set(CMAKE_CUDA_FATBINARY "@CMAKE_CUDA_FATBINARY@")
+set(CMAKE_CUDA_STANDARD_COMPUTED_DEFAULT "@CMAKE_CUDA_STANDARD_COMPUTED_DEFAULT@")
+set(CMAKE_CUDA_EXTENSIONS_COMPUTED_DEFAULT "@CMAKE_CUDA_EXTENSIONS_COMPUTED_DEFAULT@")
+set(CMAKE_CUDA_STANDARD_LATEST "@CMAKE_CUDA_STANDARD_LATEST@")
+set(CMAKE_CUDA_COMPILE_FEATURES "@CMAKE_CUDA_COMPILE_FEATURES@")
+set(CMAKE_CUDA03_COMPILE_FEATURES "@CMAKE_CUDA03_COMPILE_FEATURES@")
+set(CMAKE_CUDA11_COMPILE_FEATURES "@CMAKE_CUDA11_COMPILE_FEATURES@")
+set(CMAKE_CUDA14_COMPILE_FEATURES "@CMAKE_CUDA14_COMPILE_FEATURES@")
+set(CMAKE_CUDA17_COMPILE_FEATURES "@CMAKE_CUDA17_COMPILE_FEATURES@")
+set(CMAKE_CUDA20_COMPILE_FEATURES "@CMAKE_CUDA20_COMPILE_FEATURES@")
+set(CMAKE_CUDA23_COMPILE_FEATURES "@CMAKE_CUDA23_COMPILE_FEATURES@")
+set(CMAKE_CUDA26_COMPILE_FEATURES "@CMAKE_CUDA26_COMPILE_FEATURES@")
+
+set(CMAKE_CUDA_PLATFORM_ID "@CMAKE_CUDA_PLATFORM_ID@")
+set(CMAKE_CUDA_SIMULATE_ID "@CMAKE_CUDA_SIMULATE_ID@")
+set(CMAKE_CUDA_COMPILER_FRONTEND_VARIANT "@CMAKE_CUDA_COMPILER_FRONTEND_VARIANT@")
+set(CMAKE_CUDA_SIMULATE_VERSION "@CMAKE_CUDA_SIMULATE_VERSION@")
+@SET_MSVC_CUDA_ARCHITECTURE_ID@
+@_SET_CMAKE_CUDA_COMPILER_SYSROOT@
+
+set(CMAKE_CUDA_COMPILER_ENV_VAR "CUDACXX")
+set(CMAKE_CUDA_HOST_COMPILER_ENV_VAR "CUDAHOSTCXX")
+
+set(CMAKE_CUDA_COMPILER_LOADED 1)
+set(CMAKE_CUDA_COMPILER_ID_RUN 1)
+set(CMAKE_CUDA_SOURCE_FILE_EXTENSIONS cu)
+set(CMAKE_CUDA_LINKER_PREFERENCE 15)
+set(CMAKE_CUDA_LINKER_PREFERENCE_PROPAGATES 1)
+set(CMAKE_CUDA_LINKER_DEPFILE_SUPPORTED @CMAKE_CUDA_LINKER_DEPFILE_SUPPORTED@)
+
+set(CMAKE_CUDA_SIZEOF_DATA_PTR "@CMAKE_CUDA_SIZEOF_DATA_PTR@")
+set(CMAKE_CUDA_COMPILER_ABI "@CMAKE_CUDA_COMPILER_ABI@")
+set(CMAKE_CUDA_BYTE_ORDER "@CMAKE_CUDA_BYTE_ORDER@")
+set(CMAKE_CUDA_LIBRARY_ARCHITECTURE "@CMAKE_CUDA_LIBRARY_ARCHITECTURE@")
+
+if(CMAKE_CUDA_SIZEOF_DATA_PTR)
+  set(CMAKE_SIZEOF_VOID_P "${CMAKE_CUDA_SIZEOF_DATA_PTR}")
+endif()
+
+if(CMAKE_CUDA_COMPILER_ABI)
+  set(CMAKE_INTERNAL_PLATFORM_ABI "${CMAKE_CUDA_COMPILER_ABI}")
+endif()
+
+if(CMAKE_CUDA_LIBRARY_ARCHITECTURE)
+  set(CMAKE_LIBRARY_ARCHITECTURE "@CMAKE_CUDA_LIBRARY_ARCHITECTURE@")
+endif()
+
+set(CMAKE_CUDA_COMPILER_TOOLKIT_ROOT "@CMAKE_CUDA_COMPILER_TOOLKIT_ROOT@")
+set(CMAKE_CUDA_COMPILER_TOOLKIT_LIBRARY_ROOT "@CMAKE_CUDA_COMPILER_TOOLKIT_LIBRARY_ROOT@")
+set(CMAKE_CUDA_COMPILER_TOOLKIT_VERSION "@CMAKE_CUDA_COMPILER_TOOLKIT_VERSION@")
+set(CMAKE_CUDA_COMPILER_LIBRARY_ROOT "@CMAKE_CUDA_COMPILER_LIBRARY_ROOT@")
+
+set(CMAKE_CUDA_ARCHITECTURES_ALL "@CMAKE_CUDA_ARCHITECTURES_ALL@")
+set(CMAKE_CUDA_ARCHITECTURES_ALL_MAJOR "@CMAKE_CUDA_ARCHITECTURES_ALL_MAJOR@")
+set(CMAKE_CUDA_ARCHITECTURES_NATIVE "@CMAKE_CUDA_ARCHITECTURES_NATIVE@")
+
+set(CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES "@CMAKE_CUDA_TOOLKIT_INCLUDE_DIRECTORIES@")
+
+set(CMAKE_CUDA_HOST_IMPLICIT_LINK_LIBRARIES "@CMAKE_CUDA_HOST_IMPLICIT_LINK_LIBRARIES@")
+set(CMAKE_CUDA_HOST_IMPLICIT_LINK_DIRECTORIES "@CMAKE_CUDA_HOST_IMPLICIT_LINK_DIRECTORIES@")
+set(CMAKE_CUDA_HOST_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES "@CMAKE_CUDA_HOST_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES@")
+
+set(CMAKE_CUDA_IMPLICIT_INCLUDE_DIRECTORIES "@CMAKE_CUDA_IMPLICIT_INCLUDE_DIRECTORIES@")
+set(CMAKE_CUDA_IMPLICIT_LINK_LIBRARIES "@CMAKE_CUDA_IMPLICIT_LINK_LIBRARIES@")
+set(CMAKE_CUDA_IMPLICIT_LINK_DIRECTORIES "@CMAKE_CUDA_IMPLICIT_LINK_DIRECTORIES@")
+set(CMAKE_CUDA_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES "@CMAKE_CUDA_IMPLICIT_LINK_FRAMEWORK_DIRECTORIES@")
+
+@_SET_CMAKE_CUDA_RUNTIME_LIBRARY_DEFAULT@
+
+set(CMAKE_LINKER "@CMAKE_LINKER@")
+set(CMAKE_LINKER_LINK "@CMAKE_LINKER_LINK@")
+set(CMAKE_LINKER_LLD "@CMAKE_LINKER_LLD@")
+set(CMAKE_CUDA_COMPILER_LINKER "@CMAKE_CUDA_COMPILER_LINKER@")
+set(CMAKE_CUDA_COMPILER_LINKER_ID "@CMAKE_CUDA_COMPILER_LINKER_ID@")
+set(CMAKE_CUDA_COMPILER_LINKER_VERSION @CMAKE_CUDA_COMPILER_LINKER_VERSION@)
+set(CMAKE_CUDA_COMPILER_LINKER_FRONTEND_VARIANT @CMAKE_CUDA_COMPILER_LINKER_FRONTEND_VARIANT@)
+set(CMAKE_AR "@CMAKE_AR@")
+set(CMAKE_RANLIB "@CMAKE_RANLIB@")
+set(CMAKE_MT "@CMAKE_MT@")

cmake/share/cmake-3.31/Modules/CMakeCUDACompilerABI.cu

@@ -0,0 +1,26 @@
+#ifndef __CUDACC__
+#  error "A C or C++ compiler has been selected for CUDA"
+#endif
+
+#include "CMakeCompilerABI.h"
+#include "CMakeCompilerCUDAArch.h"
+
+int main(int argc, char* argv[])
+{
+  int require = 0;
+  require += info_sizeof_dptr[argc];
+  require += info_byte_order_big_endian[argc];
+  require += info_byte_order_little_endian[argc];
+#if defined(ABI_ID)
+  require += info_abi[argc];
+#endif
+  static_cast<void>(argv);
+
+  if (!cmakeCompilerCUDAArch()) {
+    // Convince the compiler that the non-zero return value depends
+    // on the info strings so they are not optimized out.
+    return require ? -1 : 1;
+  }
+
+  return 0;
+}

cmake/share/cmake-3.31/Modules/CMakeCUDACompilerId.cu.in

@@ -0,0 +1,110 @@
+#ifndef __CUDACC__
+# error "A C or C++ compiler has been selected for CUDA"
+#endif
+
+@CMAKE_CUDA_COMPILER_ID_CONTENT@
+
+/* Construct the string literal in pieces to prevent the source from
+   getting matched.  Store it in a pointer rather than an array
+   because some compilers will just produce instructions to fill the
+   array rather than assigning a pointer to a static array.  */
+char const* info_compiler = "INFO" ":" "compiler[" COMPILER_ID "]";
+#ifdef SIMULATE_ID
+char const* info_simulate = "INFO" ":" "simulate[" SIMULATE_ID "]";
+#endif
+
+@CMAKE_CUDA_COMPILER_ID_PLATFORM_CONTENT@
+@CMAKE_CUDA_COMPILER_ID_ERROR_FOR_TEST@
+
+#ifdef HOST_COMPILER_ID
+char const* info_host_compiler = "INFO" ":" "host_compiler[" HOST_COMPILER_ID "]";
+#endif
+#ifdef HOST_COMPILER_VERSION
+char const* info_host_compiler_version = "INFO" ":" "host_compiler_version[" HOST_COMPILER_VERSION "]";
+#elif defined(HOST_COMPILER_VERSION_MAJOR)
+char const info_host_compiler_version[] = {
+  'I', 'N', 'F', 'O', ':','h','o','s','t','_',
+  'c','o','m','p','i','l','e','r','_','v','e','r','s','i','o','n','[',
+  HOST_COMPILER_VERSION_MAJOR,
+# ifdef HOST_COMPILER_VERSION_MINOR
+  '.', HOST_COMPILER_VERSION_MINOR,
+#  ifdef HOST_COMPILER_VERSION_PATCH
+   '.', HOST_COMPILER_VERSION_PATCH,
+#   ifdef HOST_COMPILER_VERSION_TWEAK
+    '.', HOST_COMPILER_VERSION_TWEAK,
+#   endif
+#  endif
+# endif
+  ']','\0'};
+#endif
+
+#define CXX_STD_11 201103L
+#define CXX_STD_14 201402L
+#define CXX_STD_17 201703L
+#define CXX_STD_20 202002L
+#define CXX_STD_23 202302L
+
+#if defined(_MSC_VER) && defined(_MSVC_LANG)
+#  if _MSVC_LANG > __cplusplus
+#    define CXX_STD _MSVC_LANG
+#  else
+#    define CXX_STD __cplusplus
+#  endif
+#else
+#  define CXX_STD __cplusplus
+#endif
+
+const char* info_language_standard_default = "INFO" ":" "standard_default["
+#if CXX_STD > CXX_STD_23
+  "26"
+#elif CXX_STD > CXX_STD_20
+  "23"
+#elif CXX_STD > CXX_STD_17
+  "20"
+#elif CXX_STD > CXX_STD_14
+  "17"
+#elif CXX_STD > CXX_STD_11
+  "14"
+#elif CXX_STD >= CXX_STD_11
+  "11"
+#else
+  "03"
+#endif
+"]";
+
+const char* info_language_extensions_default = "INFO" ":" "extensions_default["
+#if (defined(__clang__) || defined(__GNUC__)) &&                              \
+  !defined(__STRICT_ANSI__)
+  "ON"
+#else
+  "OFF"
+#endif
+"]";
+
+/*--------------------------------------------------------------------------*/
+
+int main(int argc, char* argv[])
+{
+  int require = 0;
+  require += info_compiler[argc];
+  require += info_platform[argc];
+#ifdef COMPILER_VERSION_MAJOR
+  require += info_version[argc];
+#endif
+#ifdef SIMULATE_ID
+  require += info_simulate[argc];
+#endif
+#ifdef SIMULATE_VERSION_MAJOR
+  require += info_simulate_version[argc];
+#endif
+#ifdef HOST_COMPILER_ID
+  require += info_host_compiler[argc];
+#endif
+#ifdef HOST_COMPILER_VERSION_MAJOR
+  require += info_host_compiler_version[argc];
+#endif
+  require += info_language_standard_default[argc];
+  require += info_language_extensions_default[argc];
+  (void)argv;
+  return require;
+}

cmake/share/cmake-3.31/Modules/CMakeCUDAInformation.cmake

@@ -0,0 +1,155 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+if(UNIX)
+  set(CMAKE_CUDA_OUTPUT_EXTENSION .o)
+else()
+  set(CMAKE_CUDA_OUTPUT_EXTENSION .obj)
+endif()
+set(CMAKE_INCLUDE_FLAG_CUDA "-I")
+
+# Set implicit links early so compiler-specific modules can use them.
+set(__IMPLICIT_LINKS)
+foreach(dir ${CMAKE_CUDA_HOST_IMPLICIT_LINK_DIRECTORIES})
+  string(APPEND __IMPLICIT_LINKS " -L\"${dir}\"")
+endforeach()
+foreach(lib ${CMAKE_CUDA_HOST_IMPLICIT_LINK_LIBRARIES})
+  if(${lib} MATCHES "/")
+    string(APPEND __IMPLICIT_LINKS " \"${lib}\"")
+  else()
+    string(APPEND __IMPLICIT_LINKS " -l${lib}")
+  endif()
+endforeach()
+
+# Load compiler-specific information.
+if(CMAKE_CUDA_COMPILER_ID)
+  include(Compiler/${CMAKE_CUDA_COMPILER_ID}-CUDA OPTIONAL)
+endif()
+
+# load the system- and compiler specific files
+if(CMAKE_CUDA_COMPILER_ID)
+  # load a hardware specific file, mostly useful for embedded compilers
+  if(CMAKE_SYSTEM_PROCESSOR)
+    include(Platform/${CMAKE_EFFECTIVE_SYSTEM_NAME}-${CMAKE_CUDA_COMPILER_ID}-CUDA-${CMAKE_SYSTEM_PROCESSOR} OPTIONAL)
+  endif()
+  include(Platform/${CMAKE_EFFECTIVE_SYSTEM_NAME}-${CMAKE_CUDA_COMPILER_ID}-CUDA OPTIONAL)
+endif()
+
+
+# This should be included before the _INIT variables are
+# used to initialize the cache.  Since the rule variables
+# have if blocks on them, users can still define them here.
+# But, it should still be after the platform file so changes can
+# be made to those values.
+
+if(CMAKE_USER_MAKE_RULES_OVERRIDE)
+  # Save the full path of the file so try_compile can use it.
+  include(${CMAKE_USER_MAKE_RULES_OVERRIDE} RESULT_VARIABLE _override)
+  set(CMAKE_USER_MAKE_RULES_OVERRIDE "${_override}")
+endif()
+
+if(CMAKE_USER_MAKE_RULES_OVERRIDE_CUDA)
+  # Save the full path of the file so try_compile can use it.
+  include(${CMAKE_USER_MAKE_RULES_OVERRIDE_CUDA} RESULT_VARIABLE _override)
+  set(CMAKE_USER_MAKE_RULES_OVERRIDE_CUDA "${_override}")
+endif()
+
+
+
+# add the flags to the cache based
+# on the initial values computed in the platform/*.cmake files
+# use _INIT variables so that this only happens the first time
+# and you can set these flags in the cmake cache
+set(CMAKE_CUDA_FLAGS_INIT "$ENV{CUDAFLAGS} ${CMAKE_CUDA_FLAGS_INIT}")
+
+cmake_initialize_per_config_variable(CMAKE_CUDA_FLAGS "Flags used by the CUDA compiler")
+
+if(CMAKE_CUDA_STANDARD_LIBRARIES_INIT)
+  set(CMAKE_CUDA_STANDARD_LIBRARIES "${CMAKE_CUDA_STANDARD_LIBRARIES_INIT}"
+    CACHE STRING "Libraries linked by default with all CUDA applications.")
+  mark_as_advanced(CMAKE_CUDA_STANDARD_LIBRARIES)
+endif()
+
+if(NOT CMAKE_CUDA_COMPILER_LAUNCHER AND DEFINED ENV{CMAKE_CUDA_COMPILER_LAUNCHER})
+  set(CMAKE_CUDA_COMPILER_LAUNCHER "$ENV{CMAKE_CUDA_COMPILER_LAUNCHER}"
+    CACHE STRING "Compiler launcher for CUDA.")
+endif()
+
+include(CMakeCommonLanguageInclude)
+_cmake_common_language_platform_flags(CUDA)
+
+# now define the following rules:
+# CMAKE_CUDA_CREATE_SHARED_LIBRARY
+# CMAKE_CUDA_CREATE_SHARED_MODULE
+# CMAKE_CUDA_COMPILE_WHOLE_COMPILATION
+# CMAKE_CUDA_COMPILE_SEPARABLE_COMPILATION
+# CMAKE_CUDA_LINK_EXECUTABLE
+
+# create a shared library
+if(NOT CMAKE_CUDA_CREATE_SHARED_LIBRARY)
+  set(CMAKE_CUDA_CREATE_SHARED_LIBRARY
+      "<CMAKE_CUDA_HOST_LINK_LAUNCHER> <CMAKE_SHARED_LIBRARY_CUDA_FLAGS> <LINK_FLAGS> <CMAKE_SHARED_LIBRARY_CREATE_CUDA_FLAGS> <SONAME_FLAG><TARGET_SONAME> -o <TARGET> <OBJECTS> <LINK_LIBRARIES>${__IMPLICIT_LINKS}")
+endif()
+
+# create a shared module copy the shared library rule by default
+if(NOT CMAKE_CUDA_CREATE_SHARED_MODULE)
+  set(CMAKE_CUDA_CREATE_SHARED_MODULE ${CMAKE_CUDA_CREATE_SHARED_LIBRARY})
+endif()
+
+# Create a static archive incrementally for large object file counts.
+if(NOT DEFINED CMAKE_CUDA_ARCHIVE_CREATE)
+  set(CMAKE_CUDA_ARCHIVE_CREATE "<CMAKE_AR> qc <TARGET> <LINK_FLAGS> <OBJECTS>")
+endif()
+if(NOT DEFINED CMAKE_CUDA_ARCHIVE_APPEND)
+  set(CMAKE_CUDA_ARCHIVE_APPEND "<CMAKE_AR> q <TARGET> <LINK_FLAGS> <OBJECTS>")
+endif()
+if(NOT DEFINED CMAKE_CUDA_ARCHIVE_FINISH)
+  set(CMAKE_CUDA_ARCHIVE_FINISH "<CMAKE_RANLIB> <TARGET>")
+endif()
+
+if(NOT CMAKE_CUDA_COMPILE_OBJECT)
+  set(CMAKE_CUDA_COMPILE_OBJECT
+    "<CMAKE_CUDA_COMPILER> ${_CMAKE_CUDA_EXTRA_FLAGS} <DEFINES> <INCLUDES> <FLAGS> ${_CMAKE_COMPILE_AS_CUDA_FLAG} <CUDA_COMPILE_MODE> <SOURCE> -o <OBJECT>")
+endif()
+
+# compile a cu file into an executable
+if(NOT CMAKE_CUDA_LINK_EXECUTABLE)
+  set(CMAKE_CUDA_LINK_EXECUTABLE
+    "<CMAKE_CUDA_HOST_LINK_LAUNCHER> <LINK_FLAGS> <OBJECTS> -o <TARGET> <LINK_LIBRARIES>${__IMPLICIT_LINKS}")
+endif()
+
+# Add implicit host link directories that contain device libraries
+# to the device link line.
+set(__IMPLICIT_DLINK_DIRS ${CMAKE_CUDA_IMPLICIT_LINK_DIRECTORIES})
+if(__IMPLICIT_DLINK_DIRS)
+  list(REMOVE_ITEM __IMPLICIT_DLINK_DIRS ${CMAKE_CUDA_HOST_IMPLICIT_LINK_DIRECTORIES})
+endif()
+set(__IMPLICIT_DLINK_FLAGS)
+foreach(dir ${__IMPLICIT_DLINK_DIRS})
+  if(EXISTS "${dir}/libcurand_static.a")
+    string(APPEND __IMPLICIT_DLINK_FLAGS " -L\"${dir}\"")
+  endif()
+endforeach()
+unset(__IMPLICIT_DLINK_DIRS)
+
+
+#These are used when linking relocatable (dc) cuda code
+if(NOT CMAKE_CUDA_DEVICE_LINK_LIBRARY)
+  set(CMAKE_CUDA_DEVICE_LINK_LIBRARY
+    "<CMAKE_CUDA_COMPILER> ${_CMAKE_CUDA_EXTRA_FLAGS} <LANGUAGE_COMPILE_FLAGS> <LINK_FLAGS> ${CMAKE_CUDA_COMPILE_OPTIONS_PIC} ${_CMAKE_CUDA_EXTRA_DEVICE_LINK_FLAGS} -shared -dlink <OBJECTS> -o <TARGET> <LINK_LIBRARIES>${__IMPLICIT_DLINK_FLAGS}")
+endif()
+if(NOT CMAKE_CUDA_DEVICE_LINK_EXECUTABLE)
+  set(CMAKE_CUDA_DEVICE_LINK_EXECUTABLE
+    "<CMAKE_CUDA_COMPILER> ${_CMAKE_CUDA_EXTRA_FLAGS} <LANGUAGE_COMPILE_FLAGS> <LINK_FLAGS> ${CMAKE_CUDA_COMPILE_OPTIONS_PIC} ${_CMAKE_CUDA_EXTRA_DEVICE_LINK_FLAGS} -shared -dlink <OBJECTS> -o <TARGET> <LINK_LIBRARIES>${__IMPLICIT_DLINK_FLAGS}")
+endif()
+
+# Used when device linking is handled by CMake.
+if(NOT CMAKE_CUDA_DEVICE_LINK_COMPILE)
+  set(CMAKE_CUDA_DEVICE_LINK_COMPILE "<CMAKE_CUDA_COMPILER> ${_CMAKE_CUDA_EXTRA_FLAGS} <FLAGS> <LINK_FLAGS> -D__CUDA_INCLUDE_COMPILER_INTERNAL_HEADERS__ -D__NV_EXTRA_INITIALIZATION=\"\" -D__NV_EXTRA_FINALIZATION=\"\" -DREGISTERLINKBINARYFILE=\\\"<REGISTER_FILE>\\\" -DFATBINFILE=\\\"<FATBINARY>\\\" ${_CMAKE_COMPILE_AS_CUDA_FLAG} -c \"${CMAKE_CUDA_COMPILER_TOOLKIT_LIBRARY_ROOT}/bin/crt/link.stub\" -o <OBJECT>")
+endif()
+
+unset(__IMPLICIT_DLINK_FLAGS)
+
+set(CMAKE_CUDA_USE_LINKER_INFORMATION TRUE)
+
+set(CMAKE_CUDA_INFORMATION_LOADED 1)

cmake/share/cmake-3.31/Modules/CMakeCXXCompilerABI.cpp

@@ -0,0 +1,18 @@
+#ifndef __cplusplus
+#  error "A C compiler has been selected for C++."
+#endif
+
+#include "CMakeCompilerABI.h"
+
+int main(int argc, char* argv[])
+{
+  int require = 0;
+  require += info_sizeof_dptr[argc];
+  require += info_byte_order_big_endian[argc];
+  require += info_byte_order_little_endian[argc];
+#if defined(ABI_ID)
+  require += info_abi[argc];
+#endif
+  (void)argv;
+  return require;
+}

cmake/share/cmake-3.31/Modules/CMakeCompilerIdDetection.cmake

@@ -0,0 +1,162 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+
+function(_readFile file)
+  include(${file})
+  get_filename_component(name ${file} NAME_WE)
+  string(REGEX REPLACE "-.*" "" CompilerId ${name})
+  set(_compiler_id_version_compute_${CompilerId} ${_compiler_id_version_compute} PARENT_SCOPE)
+  set(_compiler_id_simulate_${CompilerId} ${_compiler_id_simulate} PARENT_SCOPE)
+  set(_compiler_id_pp_test_${CompilerId} ${_compiler_id_pp_test} PARENT_SCOPE)
+endfunction()
+
+function(compiler_id_detection outvar lang)
+
+  if (NOT "x${lang}" STREQUAL "xFortran" AND NOT "x${lang}" STREQUAL "xCSharp"
+      AND NOT "x${lang}" STREQUAL "xISPC")
+    file(GLOB lang_files
+      "${CMAKE_ROOT}/Modules/Compiler/*-DetermineCompiler.cmake")
+    set(nonlang CXX)
+    if ("x${lang}" STREQUAL "xCXX")
+      set(nonlang C)
+    endif()
+
+    file(GLOB nonlang_files
+      "${CMAKE_ROOT}/Modules/Compiler/*-${nonlang}-DetermineCompiler.cmake")
+    list(REMOVE_ITEM lang_files ${nonlang_files})
+  endif()
+
+  set(files ${lang_files})
+  if (files)
+    foreach(file ${files})
+      _readFile(${file})
+    endforeach()
+
+    set(options ID_STRING VERSION_STRINGS ID_DEFINE PLATFORM_DEFAULT_COMPILER)
+    set(oneValueArgs PREFIX)
+    cmake_parse_arguments(CID "${options}" "${oneValueArgs}" "${multiValueArgs}"  ${ARGN})
+    if (CID_UNPARSED_ARGUMENTS)
+      message(FATAL_ERROR "Unrecognized arguments: \"${CID_UNPARSED_ARGUMENTS}\"")
+    endif()
+
+    # Order is relevant here. For example, compilers which pretend to be
+    # GCC must appear before the actual GCC.
+    list(APPEND ordered_compilers
+      Intel
+      IntelLLVM
+      PathScale
+      Embarcadero
+      Borland
+      Watcom
+      OpenWatcom
+      SunPro
+      HP
+      Compaq
+      zOS
+      IBMClang
+      XLClang
+      XL
+      VisualAge
+      NVHPC
+      PGI
+      CrayClang
+      Cray
+      TI
+      FujitsuClang
+      Fujitsu
+      GHS
+      Tasking
+      OrangeC
+    )
+    if ("x${lang}" STREQUAL "xC")
+      list(APPEND ordered_compilers
+        TinyCC
+        Bruce
+      )
+    endif()
+    list(APPEND ordered_compilers
+      SCO
+      ARMCC
+      AppleClang
+      ARMClang
+      TIClang
+    )
+    list(APPEND ordered_compilers
+      Clang
+      LCC
+      GNU
+      MSVC
+      ADSP
+      IAR
+    )
+    if ("x${lang}" STREQUAL "xC")
+      list(APPEND ordered_compilers
+        SDCC
+      )
+    endif()
+
+    if("x${lang}" STREQUAL "xCUDA")
+      set(ordered_compilers NVIDIA Clang)
+    endif()
+
+    if("x${lang}" STREQUAL "xHIP")
+      set(ordered_compilers NVIDIA Clang)
+    endif()
+
+    if(CID_ID_DEFINE)
+      foreach(Id ${ordered_compilers})
+        string(APPEND CMAKE_${lang}_COMPILER_ID_CONTENT "# define ${CID_PREFIX}COMPILER_IS_${Id} 0\n")
+      endforeach()
+      # Hard-code definitions for compilers that are no longer supported.
+      string(APPEND CMAKE_${lang}_COMPILER_ID_CONTENT "# define ${CID_PREFIX}COMPILER_IS_MIPSpro 0\n")
+    endif()
+
+    set(pp_if "#if")
+    if (CID_VERSION_STRINGS)
+      string(APPEND CMAKE_${lang}_COMPILER_ID_CONTENT "\n/* Version number components: V=Version, R=Revision, P=Patch
+   Version date components:   YYYY=Year, MM=Month,   DD=Day  */\n")
+    endif()
+
+    foreach(Id ${ordered_compilers})
+      if (NOT _compiler_id_pp_test_${Id})
+        message(FATAL_ERROR "No preprocessor test for \"${Id}\"")
+      endif()
+      set(id_content "${pp_if} ${_compiler_id_pp_test_${Id}}\n")
+      if (CID_ID_STRING)
+        set(PREFIX ${CID_PREFIX})
+        string(CONFIGURE "${_compiler_id_simulate_${Id}}" SIMULATE_BLOCK @ONLY)
+        string(APPEND id_content "# define ${CID_PREFIX}COMPILER_ID \"${Id}\"${SIMULATE_BLOCK}")
+      endif()
+      if (CID_ID_DEFINE)
+        string(APPEND id_content "# undef ${CID_PREFIX}COMPILER_IS_${Id}\n")
+        string(APPEND id_content "# define ${CID_PREFIX}COMPILER_IS_${Id} 1\n")
+      endif()
+      if (CID_VERSION_STRINGS)
+        set(PREFIX ${CID_PREFIX})
+        set(MACRO_DEC DEC)
+        set(MACRO_HEX HEX)
+        string(CONFIGURE "${_compiler_id_version_compute_${Id}}" VERSION_BLOCK @ONLY)
+        string(APPEND id_content "${VERSION_BLOCK}\n")
+      endif()
+      string(APPEND CMAKE_${lang}_COMPILER_ID_CONTENT "\n${id_content}")
+      set(pp_if "#elif")
+    endforeach()
+
+    if (CID_PLATFORM_DEFAULT_COMPILER)
+      set(platform_compiler_detection "
+/* These compilers are either not known or too old to define an
+  identification macro.  Try to identify the platform and guess that
+  it is the native compiler.  */
+#elif defined(__hpux) || defined(__hpua)
+# define ${CID_PREFIX}COMPILER_ID \"HP\"
+
+#else /* unknown compiler */
+# define ${CID_PREFIX}COMPILER_ID \"\"")
+    endif()
+
+    string(APPEND CMAKE_${lang}_COMPILER_ID_CONTENT "\n${platform_compiler_detection}\n#endif")
+  endif()
+
+  set(${outvar} ${CMAKE_${lang}_COMPILER_ID_CONTENT} PARENT_SCOPE)
+endfunction()

cmake/share/cmake-3.31/Modules/CMakeConfigurableFile.in

@@ -0,0 +1 @@
+@CMAKE_CONFIGURABLE_FILE_CONTENT@

cmake/share/cmake-3.31/Modules/CheckCCompilerFlag.cmake

@@ -0,0 +1,61 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+#[=======================================================================[.rst:
+CheckCCompilerFlag
+------------------
+
+Check once whether the C compiler supports a given flag.
+
+.. command:: check_c_compiler_flag
+
+  .. code-block:: cmake
+
+    check_c_compiler_flag(<flag> <resultVar>)
+
+Check once that the ``<flag>`` is accepted by the compiler without a diagnostic.
+The result is stored in the internal cache variable specified by
+``<resultVar>``, with boolean ``true`` for success and boolean ``false`` for
+failure.
+
+``true`` indicates only that the compiler did not issue a diagnostic message
+when given the flag. Whether the flag has any effect is beyond the scope of
+this module.
+
+Internally, :command:`try_compile` is used to perform the check. If
+:variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` is set to ``EXECUTABLE`` (default),
+the check compiles and links an executable program. If set to
+``STATIC_LIBRARY``, the check is compiled but not linked.
+
+See also :command:`check_compiler_flag` for a more general command syntax.
+
+The compile and link commands can be influenced by setting any of the
+following variables prior to calling ``check_c_compiler_flag()``. Unknown flags
+in these variables can case a false negative result.
+
+.. include:: /module/CMAKE_REQUIRED_FLAGS.txt
+
+.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt
+
+.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt
+
+.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt
+
+.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt
+
+.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt
+
+.. include:: /module/CMAKE_REQUIRED_QUIET.txt
+
+#]=======================================================================]
+
+include_guard(GLOBAL)
+include(Internal/CheckCompilerFlag)
+
+macro (CHECK_C_COMPILER_FLAG _FLAG _RESULT)
+  cmake_check_compiler_flag(C "${_FLAG}" ${_RESULT})
+endmacro ()
+
+# FIXME(#24994): The following module is included only for compatibility
+# with projects that accidentally relied on it with CMake 3.26 and below.
+include(CheckCSourceCompiles)

cmake/share/cmake-3.31/Modules/CheckCSourceCompiles.cmake

@@ -0,0 +1,59 @@
+# Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
+# file Copyright.txt or https://cmake.org/licensing for details.
+
+#[=======================================================================[.rst:
+CheckCSourceCompiles
+--------------------
+
+Check once if C source code can be built.
+
+.. command:: check_c_source_compiles
+
+  .. code-block:: cmake
+
+    check_c_source_compiles(<code> <resultVar>
+                            [FAIL_REGEX <regex1> [<regex2>...]])
+
+  Check once that the source supplied in ``<code>`` can be built. The result is
+  stored in the internal cache variable specified by ``<resultVar>``, with
+  boolean ``true`` for success and boolean ``false`` for failure.
+
+  If ``FAIL_REGEX`` is provided, then failure is determined by checking
+  if anything in the compiler output matches any of the specified regular
+  expressions.
+
+  Internally, :command:`try_compile` is used to compile the source. If
+  :variable:`CMAKE_TRY_COMPILE_TARGET_TYPE` is set to ``EXECUTABLE`` (default),
+  the source is compiled and linked as an executable program. If set to
+  ``STATIC_LIBRARY``, the source is compiled but not linked. In any case, all
+  functions must be declared as usual.
+
+  See also :command:`check_source_compiles` for a more general command syntax.
+
+  See also :command:`check_source_runs` to run compiled source.
+
+  The compile and link commands can be influenced by setting any of the
+  following variables prior to calling ``check_c_source_compiles()``:
+
+.. include:: /module/CMAKE_REQUIRED_FLAGS.txt
+
+.. include:: /module/CMAKE_REQUIRED_DEFINITIONS.txt
+
+.. include:: /module/CMAKE_REQUIRED_INCLUDES.txt
+
+.. include:: /module/CMAKE_REQUIRED_LINK_OPTIONS.txt
+
+.. include:: /module/CMAKE_REQUIRED_LIBRARIES.txt
+
+.. include:: /module/CMAKE_REQUIRED_LINK_DIRECTORIES.txt
+
+.. include:: /module/CMAKE_REQUIRED_QUIET.txt
+
+#]=======================================================================]
+
+include_guard(GLOBAL)
+include(Internal/CheckSourceCompiles)
+
+macro(CHECK_C_SOURCE_COMPILES SOURCE VAR)
+  cmake_check_source_compiles(C "${SOURCE}" ${VAR} ${ARGN})
+endmacro()