【汇总】CMake 命令说明

前言全局说明

CMake 命令说明

一、说明

cmake --version

cmake version 3.19.8

CMake suite maintained and supported by Kitware (kitware.com/cmake).

二、CMake 自带帮助说明

2.1 cmake --help

D:\Temp>cmake --help

Usage

cmake [options]

cmake [options] -S -B

Specify a source directory to (re-)generate a build system for it in the

current working directory. Specify an existing build directory to

re-generate its build system.

Options

-S = Explicitly specify a source directory.

-B = Explicitly specify a build directory.

-C = Pre-load a script to populate the cache.

-D [:]= = Create or update a cmake cache entry.

-U = Remove matching entries from CMake cache.

-G = Specify a build system generator.

-T = Specify toolset name if supported by generator.

-A = Specify platform name if supported by

generator.

-Wdev = Enable developer warnings.

-Wno-dev = Suppress developer warnings.

-Werror=dev = Make developer warnings errors.

-Wno-error=dev = Make developer warnings not errors.

-Wdeprecated = Enable deprecation warnings.

-Wno-deprecated = Suppress deprecation warnings.

-Werror=deprecated = Make deprecated macro and function warnings errors.

-Wno-error=deprecated = Make deprecated macro and function warnings not errors.

--preset= = Specify a configure preset.

--list-presets = List available presets.

-E = CMake command mode.

-L[A][H] = List non-advanced cached variables.

--build

= Build a CMake-generated project binary tree.

--install

= Install a CMake-generated project binary tree.

--open

= Open generated project in the associated application.

-N = View mode only.

-P = Process script mode.

--find-package = Legacy pkg-config like mode. Do not use.

--graphviz=[file] = Generate graphviz of dependencies, see

CMakeGraphVizOptions.cmake for more.

--system-information [file] = Dump information about this system.

--log-level=

= Set the verbosity of messages from CMake

files. --loglevel is also accepted for

backward compatibility reasons.

--log-context = Prepend log messages with context, if given

--debug-trycompile = Do not delete the try_compile build tree.

Only useful on one try_compile at a time.

--debug-output = Put cmake in a debug mode.

--debug-find = Put cmake find in a debug mode.

--trace = Put cmake in trace mode.

--trace-expand = Put cmake in trace mode with variable

expansion.

--trace-format=

= Set the output format of the trace.

--trace-source= = Trace only this CMake file/module. Multiple

options allowed.

--trace-redirect= = Redirect trace output to a file instead of

stderr.

--warn-uninitialized = Warn about uninitialized values.

--no-warn-unused-cli = Don't warn about command line options.

--check-system-vars = Find problems with variable usage in system

files.

--profiling-format= = Output data for profiling CMake scripts.

Supported formats: google-trace

--profiling-output= = Select an output path for the profiling data

enabled through --profiling-format.

--help,-help,-usage,-h,-H,/? = Print usage information and exit.

--version,-version,/V [] = Print version number and exit.

--help-full [] = Print all help manuals and exit.

--help-manual [] = Print one help manual and exit.

--help-manual-list [] = List help manuals available and exit.

--help-command [] = Print help for one command and exit.

--help-command-list [] = List commands with help available and exit.

--help-commands [] = Print cmake-commands manual and exit.

--help-module [] = Print help for one module and exit.

--help-module-list [] = List modules with help available and exit.

--help-modules [] = Print cmake-modules manual and exit.

--help-policy [] = Print help for one policy and exit.

--help-policy-list [] = List policies with help available and exit.

--help-policies [] = Print cmake-policies manual and exit.

--help-property [] = Print help for one property and exit.

--help-property-list [] = List properties with help available and

exit.

--help-properties [] = Print cmake-properties manual and exit.

--help-variable var [] = Print help for one variable and exit.

--help-variable-list [] = List variables with help available and exit.

--help-variables [] = Print cmake-variables manual and exit.

Generators

The following generators are available on this platform (* marks default):

Visual Studio 16 2019 = Generates Visual Studio 2019 project files.

Use -A option to specify architecture.

Visual Studio 15 2017 [arch] = Generates Visual Studio 2017 project files.

Optional [arch] can be "Win64" or "ARM".

Visual Studio 14 2015 [arch] = Generates Visual Studio 2015 project files.

Optional [arch] can be "Win64" or "ARM".

* Visual Studio 12 2013 [arch] = Generates Visual Studio 2013 project files.

Optional [arch] can be "Win64" or "ARM".

Visual Studio 11 2012 [arch] = Generates Visual Studio 2012 project files.

Optional [arch] can be "Win64" or "ARM".

Visual Studio 10 2010 [arch] = Generates Visual Studio 2010 project files.

Optional [arch] can be "Win64" or "IA64".

Visual Studio 9 2008 [arch] = Generates Visual Studio 2008 project files.

Optional [arch] can be "Win64" or "IA64".

Borland Makefiles = Generates Borland makefiles.

NMake Makefiles = Generates NMake makefiles.

NMake Makefiles JOM = Generates JOM makefiles.

MSYS Makefiles = Generates MSYS makefiles.

MinGW Makefiles = Generates a make file for use with

mingw32-make.

Green Hills MULTI = Generates Green Hills MULTI files

(experimental, work-in-progress).

Unix Makefiles = Generates standard UNIX makefiles.

Ninja = Generates build.ninja files.

Ninja Multi-Config = Generates build-.ninja files.

Watcom WMake = Generates Watcom WMake makefiles.

CodeBlocks - MinGW Makefiles = Generates CodeBlocks project files.

CodeBlocks - NMake Makefiles = Generates CodeBlocks project files.

CodeBlocks - NMake Makefiles JOM

= Generates CodeBlocks project files.

CodeBlocks - Ninja = Generates CodeBlocks project files.

CodeBlocks - Unix Makefiles = Generates CodeBlocks project files.

CodeLite - MinGW Makefiles = Generates CodeLite project files.

CodeLite - NMake Makefiles = Generates CodeLite project files.

CodeLite - Ninja = Generates CodeLite project files.

CodeLite - Unix Makefiles = Generates CodeLite project files.

Eclipse CDT4 - NMake Makefiles

= Generates Eclipse CDT 4.0 project files.

Eclipse CDT4 - MinGW Makefiles

= Generates Eclipse CDT 4.0 project files.

Eclipse CDT4 - Ninja = Generates Eclipse CDT 4.0 project files.

Eclipse CDT4 - Unix Makefiles= Generates Eclipse CDT 4.0 project files.

Kate - MinGW Makefiles = Generates Kate project files.

Kate - NMake Makefiles = Generates Kate project files.

Kate - Ninja = Generates Kate project files.

Kate - Unix Makefiles = Generates Kate project files.

Sublime Text 2 - MinGW Makefiles

= Generates Sublime Text 2 project files.

Sublime Text 2 - NMake Makefiles

= Generates Sublime Text 2 project files.

Sublime Text 2 - Ninja = Generates Sublime Text 2 project files.

Sublime Text 2 - Unix Makefiles

= Generates Sublime Text 2 project files.

2.2 参数，表格版说明

参数

英文说明

中文说明

备注

-S

Explicitly specify a source directory.

选项用于指定源代码目录。这是你的项目的根目录，包含了 CMakeLists.txt 文件，这些文件描述了项目的配置和构建过程。

-B

Explicitly specify a build directory.

选项用于指定构建目录。这是 CMake 生成的 Makefile 和其他构建系统文件的输出目录。在这个目录中，你可以运行构建命令。

例如 make，来构建你的项目。

-C

Pre-load a script to populate the cache.

-D [:]=

Create or update a cmake cache entry.

用于设置 CMake 变量。

例如，-DVAR_NAME=VALUE 可以设置一个 CMake 变量的值

-U

Remove matching entries from CMake cache.

-G

Specify a build system generator.

用于指定生成器（generator）。生成器决定了 CMake 会生成哪种类型的构建系统文件。

例如，-G "Unix Makefiles" 可以指定使用 Unix Makefile 生成器。

-T

Specify toolset name if supported by generator.

-A

Specify platform name if supported by generator.

-Wdev

Enable developer warnings.

-Wno-dev

Suppress developer warnings.

-Werror=dev

Make developer warnings errors.

-Wno-error=dev

Make developer warnings not errors.

-Wdeprecated

Enable deprecation warnings.

-Wno-deprecated

Suppress deprecation warnings.

-Werror=deprecated

Make deprecated macro and function warnings errors.

-Wno-error=deprecated

Make deprecated macro and function warnings not errors.

--preset=

Specify a configure preset.

--list-presets

List available presets.

-E [arguments...]

CMake command mode.

执行命令，比如新建文件

-L[A][H]

List non-advanced cached variables.

--build

Build a CMake-generated project binary tree.

用于执行构建过程。指定编译的目录。

例如，--build path_to_build_directory 可以执行构建操作。

--install

Install a CMake-generated project binary

--open

Open generated project in the associated application.

-N

View mode only.

-P

Process script mode.

--find-package

Legacy pkg-config like mode. Do not use.

--graphviz=[file]

Generate graphviz of dependencies, see CMakeGraphVizOptions.cmake for more.

--system-information [file]

Dump information about this system.

--log-level=

Set the verbosity of messages from CMake files. --loglevel is also accepted for backward compatibility reasons.

--log-context

Prepend log messages with context, if given

--debug-trycompile

Do not delete the try_compile build tree. Only useful on one try_compile at a time.

--debug-output

Put cmake in a debug mode.

--debug-find

Put cmake find in a debug mode.

--trace

Put cmake in trace mode.

--trace-expand

Put cmake in trace mode with variable expansion.

--trace-format=

Set the output format of the trace.

--trace-source=

Trace only this CMake file/module. Multiple tree. options allowed.

--trace-redirect=

Redirect trace output to a file instead of stderr.

--warn-uninitialized

Warn about uninitialized values.

--no-warn-unused-cli

Don't warn about command line options.

不警告在命令行声明但未使用的变量。

--check-system-vars

Find problems with variable usage in system files.

--profiling-format=

Output data for profiling CMake scripts. Supported formats: google-trace

--profiling-output=

Select an output path for the profiling data enabled through --profiling-format.

--help,-help,-usage,-h,-H,/?

Print usage information and exit.

--version,-version,/V []

Print version number and exit.

--help-full []

Print all help manuals and exit.

--help-manual []

Print one help manual and exit.

--help-manual-list []

List help manuals available and exit.

--help-command []

Print help for one command and exit.

--help-command-list []

List commands with help available and exit.

--help-commands []

Print cmake-commands manual and exit.

--help-module []

Print help for one module and exit.

--help-module-list []

List modules with help available and exit.

--help-modules []

Print cmake-modules manual and exit.

--help-policy []

Print help for one policy and exit.

--help-policy-list []

List policies with help available and exit.

--help-policies []

Print cmake-policies manual and exit.

--help-property []

Print help for one property and exit.

--help-property-list []

List properties with help available and exit.

--help-properties []

Print cmake-properties manual and exit.

--help-variable var []

Print help for one variable and exit.

--help-variable-list []

List variables with help available and exit.

--help-variables []

Print cmake-variables manual and exit.

2.2 生成，表格版说明

Generators

The following generators are available on this platform (* marks default):

参数

英文说明

中文说明

备注

Visual Studio 16 2019

Generates Visual Studio 2019 project files. Use -A option to specify architecture.

Visual Studio 15 2017 [arch]

Generates Visual Studio 2017 project files. Optional [arch] can be "Win64" or "ARM".

Visual Studio 14 2015 [arch]

Generates Visual Studio 2015 project files. Optional [arch] can be "Win64" or "ARM".

Visual Studio 12 2013 [arch]

Generates Visual Studio 2013 project files. Optional [arch] can be "Win64" or "ARM".

Visual Studio 11 2012 [arch]

Generates Visual Studio 2012 project files. Optional [arch] can be "Win64" or "ARM".

Visual Studio 10 2010 [arch]

Generates Visual Studio 2010 project files. Optional [arch] can be "Win64" or "IA64".

Visual Studio 9 2008 [arch]

Generates Visual Studio 2008 project files. Optional [arch] can be "Win64" or "IA64".

Borland Makefiles

Generates Borland makefiles.

NMake Makefiles

Generates NMake makefiles.

NMake Makefiles JOM

Generates JOM makefiles.

MSYS Makefiles

Generates MSYS makefiles.

MinGW Makefiles

Generates a make file for use with mingw32-make.

Green Hills MULTI

Generates Green Hills MULTI files (experimental, work-in-progress).

Unix Makefiles

Generates standard UNIX makefiles.

Ninja

Generates build.ninja files.

Ninja Multi-Config

Generates build-.ninja files.

Watcom WMake

Generates Watcom WMake makefiles.

CodeBlocks - MinGW Makefiles