cmake-generators.7.rst 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. .. cmake-manual-description: CMake Generators Reference
  2. cmake-generators(7)
  3. *******************
  4. .. only:: html
  5. .. contents::
  6. Introduction
  7. ============
  8. A *CMake Generator* is responsible for writing the input files for
  9. a native build system. Exactly one of the `CMake Generators`_ must be
  10. selected for a build tree to determine what native build system is to
  11. be used. Optionally one of the `Extra Generators`_ may be selected
  12. as a variant of some of the `Command-Line Build Tool Generators`_ to
  13. produce project files for an auxiliary IDE.
  14. CMake Generators are platform-specific so each may be available only
  15. on certain platforms. The :manual:`cmake(1)` command-line tool ``--help``
  16. output lists available generators on the current platform. Use its ``-G``
  17. option to specify the generator for a new build tree.
  18. The :manual:`cmake-gui(1)` offers interactive selection of a generator
  19. when creating a new build tree.
  20. CMake Generators
  21. ================
  22. Command-Line Build Tool Generators
  23. ----------------------------------
  24. These generators support command-line build tools. In order to use them,
  25. one must launch CMake from a command-line prompt whose environment is
  26. already configured for the chosen compiler and build tool.
  27. .. _`Makefile Generators`:
  28. Makefile Generators
  29. ^^^^^^^^^^^^^^^^^^^
  30. .. toctree::
  31. :maxdepth: 1
  32. /generator/Borland Makefiles
  33. /generator/MSYS Makefiles
  34. /generator/MinGW Makefiles
  35. /generator/NMake Makefiles
  36. /generator/NMake Makefiles JOM
  37. /generator/Unix Makefiles
  38. /generator/Watcom WMake
  39. Ninja Generator
  40. ^^^^^^^^^^^^^^^
  41. .. toctree::
  42. :maxdepth: 1
  43. /generator/Ninja
  44. IDE Build Tool Generators
  45. -------------------------
  46. These generators support Integrated Development Environment (IDE)
  47. project files. Since the IDEs configure their own environment
  48. one may launch CMake from any environment.
  49. .. _`Visual Studio Generators`:
  50. Visual Studio Generators
  51. ^^^^^^^^^^^^^^^^^^^^^^^^
  52. .. toctree::
  53. :maxdepth: 1
  54. /generator/Visual Studio 6
  55. /generator/Visual Studio 7
  56. /generator/Visual Studio 7 .NET 2003
  57. /generator/Visual Studio 8 2005
  58. /generator/Visual Studio 9 2008
  59. /generator/Visual Studio 10 2010
  60. /generator/Visual Studio 11 2012
  61. /generator/Visual Studio 12 2013
  62. /generator/Visual Studio 14 2015
  63. /generator/Visual Studio 15 2017
  64. Other Generators
  65. ^^^^^^^^^^^^^^^^
  66. .. toctree::
  67. :maxdepth: 1
  68. /generator/Green Hills MULTI
  69. /generator/Xcode
  70. Extra Generators
  71. ================
  72. Some of the `CMake Generators`_ listed in the :manual:`cmake(1)`
  73. command-line tool ``--help`` output may have variants that specify
  74. an extra generator for an auxiliary IDE tool. Such generator
  75. names have the form ``<extra-generator> - <main-generator>``.
  76. The following extra generators are known to CMake.
  77. .. toctree::
  78. :maxdepth: 1
  79. /generator/CodeBlocks
  80. /generator/CodeLite
  81. /generator/Eclipse CDT4
  82. /generator/Kate
  83. /generator/Sublime Text 2