cmake-gui.1.rst 1.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  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. Description
  11. ===========
  12. The **cmake-gui** executable is the CMake GUI. Project configuration
  13. settings may be specified interactively. Brief instructions are
  14. provided at the bottom of the window when the program is running.
  15. CMake is a cross-platform build system generator. Projects specify
  16. their build process with platform-independent CMake listfiles included
  17. in each directory of a source tree with the name ``CMakeLists.txt``.
  18. Users build a project by using CMake to generate a build system for a
  19. native tool on their platform.
  20. Options
  21. =======
  22. ``-S <path-to-source>``
  23. Path to root directory of the CMake project to build.
  24. ``-B <path-to-build>``
  25. Path to directory which CMake will use as the root of build directory.
  26. If the directory doesn't already exist CMake will make it.
  27. .. include:: OPTIONS_HELP.txt
  28. See Also
  29. ========
  30. .. include:: LINKS.txt