You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

58 lines
1.4 KiB

  1. .. cmake-manual-description: CMake GUI Command-Line Reference
  2. cmake-gui(1)
  3. ************
  4. Synopsis
  5. ========
  6. .. parsed-literal::
  7. cmake-gui [<options>]
  8. cmake-gui [<options>] <path-to-source | path-to-existing-build>
  9. cmake-gui [<options>] -S <path-to-source> -B <path-to-build>
  10. cmake-gui [<options>] --browse-manual
  11. Description
  12. ===========
  13. The **cmake-gui** executable is the CMake GUI. Project configuration
  14. settings may be specified interactively. Brief instructions are
  15. provided at the bottom of the window when the program is running.
  16. CMake is a cross-platform build system generator. Projects specify
  17. their build process with platform-independent CMake listfiles included
  18. in each directory of a source tree with the name ``CMakeLists.txt``.
  19. Users build a project by using CMake to generate a build system for a
  20. native tool on their platform.
  21. Options
  22. =======
  23. .. program:: cmake-gui
  24. .. option:: -S <path-to-source>
  25. Path to root directory of the CMake project to build.
  26. .. option:: -B <path-to-build>
  27. Path to directory which CMake will use as the root of build directory.
  28. If the directory doesn't already exist CMake will make it.
  29. .. option:: --preset=<preset-name>
  30. Name of the preset to use from the project's
  31. :manual:`presets <cmake-presets(7)>` files, if it has them.
  32. .. option:: --browse-manual
  33. Open the CMake reference manual in a browser and immediately exit.
  34. .. include:: OPTIONS_HELP.txt
  35. See Also
  36. ========
  37. .. include:: LINKS.txt