diff options
Diffstat (limited to 'share/cmake-3.17/Help/manual/cmake-gui.1.rst')
-rw-r--r-- | share/cmake-3.17/Help/manual/cmake-gui.1.rst | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/share/cmake-3.17/Help/manual/cmake-gui.1.rst b/share/cmake-3.17/Help/manual/cmake-gui.1.rst new file mode 100644 index 0000000..ff8311b --- /dev/null +++ b/share/cmake-3.17/Help/manual/cmake-gui.1.rst @@ -0,0 +1,44 @@ +.. cmake-manual-description: CMake GUI Command-Line Reference + +cmake-gui(1) +************ + +Synopsis +======== + +.. parsed-literal:: + + cmake-gui [<options>] + cmake-gui [<options>] {<path-to-source> | <path-to-existing-build>} + cmake-gui [<options>] -S <path-to-source> -B <path-to-build> + +Description +=========== + +The **cmake-gui** 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. + +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 ``CMakeLists.txt``. +Users build a project by using CMake to generate a build system for a +native tool on their platform. + +Options +======= + +``-S <path-to-source>`` + Path to root directory of the CMake project to build. + +``-B <path-to-build>`` + Path to directory which CMake will use as the root of build directory. + + If the directory doesn't already exist CMake will make it. + +.. include:: OPTIONS_HELP.txt + +See Also +======== + +.. include:: LINKS.txt |