cmake-commands.7.rst 4.01 KB
Newer Older
1 2
.. cmake-manual-description: CMake Language Command Reference

3 4 5
cmake-commands(7)
*****************

6
.. only:: html
7 8 9

   .. contents::

10 11
Scripting Commands
==================
12

13
These commands are always available.
14 15

.. toctree::
16 17
   :maxdepth: 1

18 19 20
   /command/break
   /command/cmake_host_system_information
   /command/cmake_minimum_required
21
   /command/cmake_parse_arguments
22 23
   /command/cmake_policy
   /command/configure_file
24
   /command/continue
25
   /command/else
26
   /command/elseif
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
   /command/endforeach
   /command/endfunction
   /command/endif
   /command/endmacro
   /command/endwhile
   /command/execute_process
   /command/file
   /command/find_file
   /command/find_library
   /command/find_package
   /command/find_path
   /command/find_program
   /command/foreach
   /command/function
   /command/get_cmake_property
   /command/get_directory_property
   /command/get_filename_component
   /command/get_property
45 46
   /command/if
   /command/include
47
   /command/include_guard
48 49 50 51 52 53 54 55
   /command/list
   /command/macro
   /command/mark_as_advanced
   /command/math
   /command/message
   /command/option
   /command/return
   /command/separate_arguments
56
   /command/set
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
   /command/set_directory_properties
   /command/set_property
   /command/site_name
   /command/string
   /command/unset
   /command/variable_watch
   /command/while

Project Commands
================

These commands are available only in CMake projects.

.. toctree::
   :maxdepth: 1

73
   /command/add_compile_definitions
74 75 76 77 78 79 80
   /command/add_compile_options
   /command/add_custom_command
   /command/add_custom_target
   /command/add_definitions
   /command/add_dependencies
   /command/add_executable
   /command/add_library
81
   /command/add_link_options
82 83 84 85 86 87 88 89 90 91
   /command/add_subdirectory
   /command/add_test
   /command/aux_source_directory
   /command/build_command
   /command/create_test_sourcelist
   /command/define_property
   /command/enable_language
   /command/enable_testing
   /command/export
   /command/fltk_wrap_ui
92 93 94 95 96 97 98 99
   /command/get_source_file_property
   /command/get_target_property
   /command/get_test_property
   /command/include_directories
   /command/include_external_msproject
   /command/include_regular_expression
   /command/install
   /command/link_directories
100
   /command/link_libraries
101 102 103 104 105 106 107 108
   /command/load_cache
   /command/project
   /command/remove_definitions
   /command/set_source_files_properties
   /command/set_target_properties
   /command/set_tests_properties
   /command/source_group
   /command/target_compile_definitions
109
   /command/target_compile_features
110 111
   /command/target_compile_options
   /command/target_include_directories
112
   /command/target_link_directories
113
   /command/target_link_libraries
114
   /command/target_link_options
115
   /command/target_precompile_headers
116
   /command/target_sources
117 118
   /command/try_compile
   /command/try_run
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142

.. _`CTest Commands`:

CTest Commands
==============

These commands are available only in CTest scripts.

.. toctree::
   :maxdepth: 1

   /command/ctest_build
   /command/ctest_configure
   /command/ctest_coverage
   /command/ctest_empty_binary_directory
   /command/ctest_memcheck
   /command/ctest_read_custom_files
   /command/ctest_run_script
   /command/ctest_sleep
   /command/ctest_start
   /command/ctest_submit
   /command/ctest_test
   /command/ctest_update
   /command/ctest_upload
143 144 145 146

Deprecated Commands
===================

147 148 149 150
These commands are deprecated and are only made available to maintain
backward compatibility.  The documentation of each command states the
CMake version in which it was deprecated.  Do not use these commands
in new code.
151 152

.. toctree::
153 154
   :maxdepth: 1

155 156 157 158 159 160
   /command/build_name
   /command/exec_program
   /command/export_library_dependencies
   /command/install_files
   /command/install_programs
   /command/install_targets
161
   /command/load_command
162 163
   /command/make_directory
   /command/output_required_files
164 165
   /command/qt_wrap_cpp
   /command/qt_wrap_ui
166 167 168 169 170 171 172
   /command/remove
   /command/subdir_depends
   /command/subdirs
   /command/use_mangled_mesa
   /command/utility_source
   /command/variable_requires
   /command/write_file