cmake.1.rst 10.4 KB
Newer Older
1 2
.. cmake-manual-description: CMake Command-Line Reference

3 4 5
cmake(1)
********

6 7
Synopsis
========
8

9
.. parsed-literal::
10

11
 cmake [<options>] (<path-to-source> | <path-to-existing-build>)
12
 cmake [(-D <var>=<value>)...] -P <cmake-script-file>
13
 cmake --build <dir> [<options>...] [-- <build-tool-options>...]
14
 cmake -E <command> [<options>...]
15
 cmake --find-package <options>...
16

17 18 19
Description
===========

20 21
The "cmake" executable is the CMake command-line interface.  It may be
used to configure projects in scripts.  Project configuration settings
22
may be specified on the command line with the -D option.
23 24 25 26 27 28 29

CMake is a cross-platform build system generator.  Projects specify
their build process with platform-independent CMake listfiles included
in each directory of a source tree with the name CMakeLists.txt.
Users build a project by using CMake to generate a build system for a
native tool on their platform.

30 31
.. _`CMake Options`:

32 33 34
Options
=======

35
.. include:: OPTIONS_BUILD.txt
36

37 38
``-E <command> [<options>...]``
 See `Command-Line Tool Mode`_.
39

40 41
``-L[A][H]``
 List non-advanced cached variables.
42

43 44 45 46 47 48 49
 List cache variables will run CMake and list all the variables from
 the CMake cache that are not marked as INTERNAL or ADVANCED.  This
 will effectively display current CMake settings, which can then be
 changed with -D option.  Changing some of the variables may result
 in more variables being created.  If A is specified, then it will
 display also advanced variables.  If H is specified, it will also
 display help for each variable.
50

51
``--build <dir>``
52
 See `Build Tool Mode`_.
53

54 55
``-N``
 View mode only.
56

57 58
 Only load the cache.  Do not actually run configure and generate
 steps.
59

60 61
``-P <file>``
 Process script mode.
62

63 64 65 66
 Process the given cmake file as a script written in the CMake
 language.  No configure or generate step is performed and the cache
 is not modified.  If variables are defined using -D, this must be
 done before the -P argument.
67

68
``--find-package``
69
 See `Find-Package Tool Mode`_.
70

71 72
``--graphviz=[file]``
 Generate graphviz of dependencies, see CMakeGraphVizOptions.cmake for more.
73

74 75 76
 Generate a graphviz input file that will contain all the library and
 executable dependencies in the project.  See the documentation for
 CMakeGraphVizOptions.cmake for more details.
77

78 79
``--system-information [file]``
 Dump information about this system.
80

81 82 83
 Dump a wide range of information about the current system.  If run
 from the top of a binary tree for a CMake project it will dump
 additional information such as the cache, log files etc.
84

85 86
``--debug-trycompile``
 Do not delete the try_compile build tree. Only useful on one try_compile at a time.
87

88 89 90 91 92 93
 Do not delete the files and directories created for try_compile
 calls.  This is useful in debugging failed try_compiles.  It may
 however change the results of the try-compiles as old junk from a
 previous try-compile may cause a different test to either pass or
 fail incorrectly.  This option is best used for one try-compile at a
 time, and only when debugging.
94

95 96
``--debug-output``
 Put cmake in a debug mode.
97

Ben Boeckel's avatar
Ben Boeckel committed
98
 Print extra information during the cmake run like stack traces with
99
 message(send_error ) calls.
100

101 102
``--trace``
 Put cmake in trace mode.
103

Ben Boeckel's avatar
Ben Boeckel committed
104 105 106 107 108 109
 Print a trace of all calls made and from where.

``--trace-expand``
 Put cmake in trace mode.

 Like ``--trace``, but with variables expanded.
110

111 112 113 114 115
``--trace-source=<file>``
 Put cmake in trace mode, but output only lines of a specified file.

 Multiple options are allowed.

116 117
``--warn-uninitialized``
 Warn about uninitialized values.
118

119
 Print a warning when an uninitialized variable is used.
120

121 122
``--warn-unused-vars``
 Warn about unused variables.
123

124
 Find variables that are declared or set, but not used.
125

126 127
``--no-warn-unused-cli``
 Don't warn about command line options.
128

129 130
 Don't find variables that are declared on the command line, but not
 used.
131

132 133
``--check-system-vars``
 Find problems with variable usage in system files.
134

135 136 137
 Normally, unused and uninitialized variables are searched for only
 in CMAKE_SOURCE_DIR and CMAKE_BINARY_DIR.  This flag tells CMake to
 warn about other files as well.
138

139
.. include:: OPTIONS_HELP.txt
140

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
Build Tool Mode
===============

CMake provides a command-line signature to build an already-generated
project binary tree::

 cmake --build <dir> [<options>...] [-- <build-tool-options>...]

This abstracts a native build tool's command-line interface with the
following options:

``--build <dir>``
  Project binary directory to be built.  This is required and must be first.

``--target <tgt>``
  Build ``<tgt>`` instead of default targets.  May only be specified once.

``--config <cfg>``
  For multi-configuration tools, choose configuration ``<cfg>``.

``--clean-first``
  Build target ``clean`` first, then build.
  (To clean only, use ``--target clean``.)

``--use-stderr``
  Ignored.  Behavior is default in CMake >= 3.0.

``--``
  Pass remaining options to the native tool.

Run ``cmake --build`` with no options for quick help.

173 174 175 176 177 178 179 180 181 182
Command-Line Tool Mode
======================

CMake provides builtin command-line tools through the signature::

 cmake -E <command> [<options>...]

Run ``cmake -E`` or ``cmake -E help`` for a summary of commands.
Available commands are:

183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
``capabilities``
  Report cmake capabilities in JSON format. The output is a JSON object
  with the following keys:

  ``version``
    A JSON object with version information. Keys are:

    ``string``
      The full version string as displayed by cmake ``--version``.
    ``major``
      The major version number in integer form.
    ``minor``
      The minor version number in integer form.
    ``patch``
      The patch level in integer form.
    ``suffix``
      The cmake version suffix string.
    ``isDirty``
      A bool that is set if the cmake build is from a dirty tree.

  ``generators``
    A list available generators. Each generator is a JSON object with the
    following keys:

    ``name``
      A string containing the name of the generator.
    ``toolsetSupport``
      ``true`` if the generator supports toolsets and ``false`` otherwise.
    ``platformSupport``
      ``true`` if the generator supports platforms and ``false`` otherwise.
    ``extraGenerators``
      A list of strings with all the extra generators compatible with
      the generator.

  ``serverMode``
    ``true`` if cmake supports server-mode and ``false`` otherwise.

220 221 222 223
``chdir <dir> <cmd> [<arg>...]``
  Change the current working directory and run a command.

``compare_files <file1> <file2>``
224
  Check if ``<file1>`` is same as ``<file2>``. If files are the same,
225
  then returns 0, if not it returns 1.
226

227
``copy <file>... <destination>``
228 229 230
  Copy files to ``<destination>`` (either file or directory).
  If multiple files are specified, the ``<destination>`` must be
  directory and it must exist.
231

232 233 234
``copy_directory <dir>... <destination>``
  Copy directories to ``<destination>`` directory.
  If ``<destination>`` directory does not exist it will be created.
235

236
``copy_if_different <file>... <destination>``
237 238 239 240
  Copy files to ``<destination>`` (either file or directory) if
  they have changed.
  If multiple files are specified, the ``<destination>`` must be
  directory and it must exist.
241 242 243 244 245 246 247 248 249 250 251

``echo [<string>...]``
  Displays arguments as text.

``echo_append [<string>...]``
  Displays arguments as text but no new line.

``env [--unset=NAME]... [NAME=VALUE]... COMMAND [ARG]...``
  Run command in a modified environment.

``environment``
252
  Display the current environment variables.
253

254 255
``make_directory <dir>...``
  Create ``<dir>`` directories.  If necessary, create parent
256 257
  directories too.  If a directory already exists it will be
  silently ignored.
258

259
``md5sum <file>...``
260 261 262 263
  Create MD5 checksum of files in ``md5sum`` compatible format::

     351abe79cd3800b38cdfb25d45015a15  file1.txt
     052f86c15bbde68af55c7f7b340ab639  file2.txt
264

265
``remove [-f] <file>...``
266 267
  Remove the file(s), use ``-f`` to force it.  If a file does
  not exist it will be silently ignored.
268 269

``remove_directory <dir>``
270 271
  Remove a directory and its contents.  If a directory does
  not exist it will be silently ignored.
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291

``rename <oldname> <newname>``
  Rename a file or directory (on one volume).

``sleep <number>...``
  Sleep for given number of seconds.

``tar [cxt][vf][zjJ] file.tar [<options>...] [--] [<file>...]``
  Create or extract a tar or zip archive.  Options are:

  ``--``
    Stop interpreting options and treat all remaining arguments
    as file names even if they start in ``-``.
  ``--files-from=<file>``
    Read file names from the given file, one per line.
    Blank lines are ignored.  Lines may not start in ``-``
    except for ``--add-file=<name>`` to add files whose
    names start in ``-``.
  ``--mtime=<date>``
    Specify modification time recorded in tarball entries.
292 293 294 295
  ``--format=<format>``
    Specify the format of the archive to be created.
    Supported formats are: ``7zip``, ``gnutar``, ``pax``,
    ``paxr`` (restricted pax, default), and ``zip``.
296 297 298 299 300 301 302 303

``time <command> [<args>...]``
  Run command and return elapsed time.

``touch <file>``
  Touch a file.

``touch_nocreate <file>``
304 305
  Touch a file if it exists but do not create it.  If a file does
  not exist it will be silently ignored.
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333

UNIX-specific Command-Line Tools
--------------------------------

The following ``cmake -E`` commands are available only on UNIX:

``create_symlink <old> <new>``
  Create a symbolic link ``<new>`` naming ``<old>``.

Windows-specific Command-Line Tools
-----------------------------------

The following ``cmake -E`` commands are available only on Windows:

``delete_regv <key>``
  Delete Windows registry value.

``env_vs8_wince <sdkname>``
  Displays a batch file which sets the environment for the provided
  Windows CE SDK installed in VS2005.

``env_vs9_wince <sdkname>``
  Displays a batch file which sets the environment for the provided
  Windows CE SDK installed in VS2008.

``write_regv <key> <value>``
  Write Windows registry value.

334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
Find-Package Tool Mode
======================

CMake provides a helper for Makefile-based projects with the signature::

  cmake --find-package <options>...

This runs in a pkg-config like mode.

Search a package using :command:`find_package()` and print the resulting flags
to stdout.  This can be used to use cmake instead of pkg-config to find
installed libraries in plain Makefile-based projects or in autoconf-based
projects (via ``share/aclocal/cmake.m4``).

.. note::
  This mode is not well-supported due to some technical limitations.
  It is kept for compatibility but should not be used in new projects.

352 353
See Also
========
354

355
.. include:: LINKS.txt