Help/manual/cmake-commands.7.rst

   1 .. cmake-manual-description: CMake Language Command Reference
   2
   3 cmake-commands(7)
   4 *****************
   5
   6 .. only:: html
   7
   8    .. contents::
   9
  10 Scripting Commands
  11 ==================
  12
  13 These commands are always available.
  14
  15 .. toctree::
  16    :maxdepth: 1
  17
  18    /command/break
  19    /command/cmake_host_system_information
  20    /command/cmake_language
  21    /command/cmake_minimum_required
  22    /command/cmake_parse_arguments
  23    /command/cmake_path
  24    /command/cmake_policy
  25    /command/configure_file
  26    /command/continue
  27    /command/else
  28    /command/elseif
  29    /command/endforeach
  30    /command/endfunction
  31    /command/endif
  32    /command/endmacro
  33    /command/endwhile
  34    /command/execute_process
  35    /command/file
  36    /command/find_file
  37    /command/find_library
  38    /command/find_package
  39    /command/find_path
  40    /command/find_program
  41    /command/foreach
  42    /command/function
  43    /command/get_cmake_property
  44    /command/get_directory_property
  45    /command/get_filename_component
  46    /command/get_property
  47    /command/if
  48    /command/include
  49    /command/include_guard
  50    /command/list
  51    /command/macro
  52    /command/mark_as_advanced
  53    /command/math
  54    /command/message
  55    /command/option
  56    /command/return
  57    /command/separate_arguments
  58    /command/set
  59    /command/set_directory_properties
  60    /command/set_property
  61    /command/site_name
  62    /command/string
  63    /command/unset
  64    /command/variable_watch
  65    /command/while
  66
  67 Project Commands
  68 ================
  69
  70 These commands are available only in CMake projects.
  71
  72 .. toctree::
  73    :maxdepth: 1
  74
  75    /command/add_compile_definitions
  76    /command/add_compile_options
  77    /command/add_custom_command
  78    /command/add_custom_target
  79    /command/add_definitions
  80    /command/add_dependencies
  81    /command/add_executable
  82    /command/add_library
  83    /command/add_link_options
  84    /command/add_subdirectory
  85    /command/add_test
  86    /command/aux_source_directory
  87    /command/build_command
  88    /command/create_test_sourcelist
  89    /command/define_property
  90    /command/enable_language
  91    /command/enable_testing
  92    /command/export
  93    /command/fltk_wrap_ui
  94    /command/get_source_file_property
  95    /command/get_target_property
  96    /command/get_test_property
  97    /command/include_directories
  98    /command/include_external_msproject
  99    /command/include_regular_expression
 100    /command/install
 101    /command/link_directories
 102    /command/link_libraries
 103    /command/load_cache
 104    /command/project
 105    /command/remove_definitions
 106    /command/set_source_files_properties
 107    /command/set_target_properties
 108    /command/set_tests_properties
 109    /command/source_group
 110    /command/target_compile_definitions
 111    /command/target_compile_features
 112    /command/target_compile_options
 113    /command/target_include_directories
 114    /command/target_link_directories
 115    /command/target_link_libraries
 116    /command/target_link_options
 117    /command/target_precompile_headers
 118    /command/target_sources
 119    /command/try_compile
 120    /command/try_run
 121
 122 .. _`CTest Commands`:
 123
 124 CTest Commands
 125 ==============
 126
 127 These commands are available only in CTest scripts.
 128
 129 .. toctree::
 130    :maxdepth: 1
 131
 132    /command/ctest_build
 133    /command/ctest_configure
 134    /command/ctest_coverage
 135    /command/ctest_empty_binary_directory
 136    /command/ctest_memcheck
 137    /command/ctest_read_custom_files
 138    /command/ctest_run_script
 139    /command/ctest_sleep
 140    /command/ctest_start
 141    /command/ctest_submit
 142    /command/ctest_test
 143    /command/ctest_update
 144    /command/ctest_upload
 145
 146 Deprecated Commands
 147 ===================
 148
 149 These commands are deprecated and are only made available to maintain
 150 backward compatibility.  The documentation of each command states the
 151 CMake version in which it was deprecated.  Do not use these commands
 152 in new code.
 153
 154 .. toctree::
 155    :maxdepth: 1
 156
 157    /command/build_name
 158    /command/exec_program
 159    /command/export_library_dependencies
 160    /command/install_files
 161    /command/install_programs
 162    /command/install_targets
 163    /command/load_command
 164    /command/make_directory
 165    /command/output_required_files
 166    /command/qt_wrap_cpp
 167    /command/qt_wrap_ui
 168    /command/remove
 169    /command/subdir_depends
 170    /command/subdirs
 171    /command/use_mangled_mesa
 172    /command/utility_source
 173    /command/variable_requires
 174    /command/write_file