cmake¶
Bases: Tool[_R]
__call__(
*args: str | PathLike[str],
A: Value = ...,
B: Value = ...,
C: Value = ...,
D: Value = ...,
E: Flag = ...,
G: Value = ...,
L: Flag = ...,
LR: Flag = ...,
N: Flag = ...,
P: Value = ...,
S: Value = ...,
T: Value = ...,
U: Value = ...,
W: Flag = ...,
Wdeprecated: Flag = ...,
Wdev: Flag = ...,
Werror: Value = ...,
Wno_: Flag = ...,
Wno_deprecated: Flag = ...,
Wno_dev: Flag = ...,
Wno_error: Value = ...,
build: Value = ...,
check_system_vars: Flag = ...,
compile_no_warning_as_error: Flag = ...,
debug_find: Flag = ...,
debug_find_pkg: Value = ...,
debug_find_var: Value = ...,
debug_output: Flag = ...,
debug_trycompile: Flag = ...,
find_package: Flag = ...,
fresh: Flag = ...,
graphviz: Value = ...,
help_command: Value = ...,
help_command_list: Value = ...,
help_commands: Value = ...,
help_diagnostic: Value = ...,
help_diagnostic_list: Value = ...,
help_diagnostics: Value = ...,
help_full: Value = ...,
help_manual: Value = ...,
help_manual_list: Value = ...,
help_module: Value = ...,
help_module_list: Value = ...,
help_modules: Value = ...,
help_policies: Value = ...,
help_policy: Value = ...,
help_policy_list: Value = ...,
help_properties: Value = ...,
help_property: Value = ...,
help_property_list: Value = ...,
help_variable: Value = ...,
help_variable_list: Value = ...,
help_variables: Value = ...,
install: Value = ...,
install_prefix: Value = ...,
link_no_warning_as_error: Flag = ...,
list_presets: ValuedFlag = ...,
log_context: Flag = ...,
log_level: Value = ...,
no_warn_unused_cli: Flag = ...,
open: Value = ...,
preset: Value = ...,
presets_file: Value = ...,
print_config_dir: Flag = ...,
profiling_format: Value = ...,
profiling_output: Value = ...,
project_file: Value = ...,
system_information: Value = ...,
toolchain: Value = ...,
trace: Flag = ...,
trace_expand: Flag = ...,
trace_format: Value = ...,
trace_redirect: Value = ...,
trace_source: Value = ...,
warn_uninitialized: Flag = ...,
workflow: Value = ...,
**flags: Any,
) -> _R
cmake [options]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
A
|
Value
|
= Specify platform name if supported by generator. |
...
|
B
|
Value
|
= Explicitly specify a build directory. |
...
|
C
|
Value
|
= Pre-load a script to populate the cache. |
...
|
D
|
Value
|
= Create or update a cmake cache entry. |
...
|
E
|
Flag
|
= CMake command mode. |
...
|
G
|
Value
|
= Specify a build system generator. |
...
|
L
|
Flag
|
= List non-advanced cached variables. |
...
|
LR
|
Flag
|
= Show cached variables that match the regex. |
...
|
N
|
Flag
|
= View mode only. |
...
|
P
|
Value
|
= Process script mode. |
...
|
S
|
Value
|
= Explicitly specify a source directory. |
...
|
T
|
Value
|
= Specify toolset name if supported by generator. |
...
|
U
|
Value
|
= Remove matching entries from CMake cache. |
...
|
W
|
Flag
|
= Enable the specified category of warnings. Added in 4.4.0. |
...
|
Wdeprecated
|
Flag
|
= Enable deprecation warnings. Gone since 4.4.0. |
...
|
Wdev
|
Flag
|
= Enable developer warnings. Gone since 4.4.0. |
...
|
Werror
|
Value
|
= Make the specified category of warnings errors. |
...
|
Wno_
|
Flag
|
= Suppress the specified category of warnings. Added in 4.4.0. |
...
|
Wno_deprecated
|
Flag
|
= Suppress deprecation warnings. Gone since 4.4.0. |
...
|
Wno_dev
|
Flag
|
= Suppress developer warnings. Gone since 4.4.0. |
...
|
Wno_error
|
Value
|
= Make the specified category of warnings not errors. |
...
|
build
|
Value
|
= Build a CMake-generated project binary tree. |
...
|
check_system_vars
|
Flag
|
= Find problems with variable usage in system files. |
...
|
compile_no_warning_as_error
|
Flag
|
CMAKE_COMPILE_WARNING_AS_ERROR variable. |
...
|
debug_find
|
Flag
|
= Put cmake find in a debug mode. |
...
|
debug_find_pkg
|
Value
|
= Limit cmake debug-find to the comma-separated list of packages. |
...
|
debug_find_var
|
Value
|
= Limit cmake debug-find to the comma-separated list of result variables. |
...
|
debug_output
|
Flag
|
= Put cmake in a debug mode. |
...
|
debug_trycompile
|
Flag
|
= Do not delete the try_compile build tree. |
...
|
find_package
|
Flag
|
= Legacy pkg-config like mode. |
...
|
fresh
|
Flag
|
= Configure a fresh build tree, removing any existing cache file. |
...
|
graphviz
|
Value
|
= Generate graphviz of dependencies, see CMakeGraphVizOptions.cmake for more. |
...
|
help_commands
|
Value
|
= Print cmake-commands manual and exit. |
...
|
help_diagnostic
|
Value
|
= Print help for one diagnostic and exit. Added in 4.4.0. |
...
|
help_diagnostic_list
|
Value
|
= List diagnostics with help available and exit. Added in 4.4.0. |
...
|
help_diagnostics
|
Value
|
= Print cmake-diagnostics manual and exit. Added in 4.4.0. |
...
|
help_full
|
Value
|
= Print all help manuals and exit. |
...
|
help_manual_list
|
Value
|
= List help manuals available and exit. |
...
|
help_module_list
|
Value
|
= List modules with help available and exit. |
...
|
help_modules
|
Value
|
= Print cmake-modules manual and exit. |
...
|
help_policies
|
Value
|
= Print cmake-policies manual and exit. |
...
|
help_policy_list
|
Value
|
= List policies with help available and exit. |
...
|
help_properties
|
Value
|
= Print cmake-properties manual and exit. |
...
|
help_property
|
Value
|
= Print help for one property and exit. |
...
|
help_property_list
|
Value
|
exit. |
...
|
help_variables
|
Value
|
= Print cmake-variables manual and exit. |
...
|
install
|
Value
|
= Install a CMake-generated project binary tree. |
...
|
install_prefix
|
Value
|
[CMAKE_INSTALL_PREFIX]. |
...
|
link_no_warning_as_error
|
Flag
|
= Ignore LINK_WARNING_AS_ERROR property and CMAKE_LINK_WARNING_AS_ERROR variable. |
...
|
list_presets
|
ValuedFlag
|
= List available presets. Value optional: |
...
|
log_context
|
Flag
|
= Prepend log messages with context, if given. |
...
|
log_level
|
Value
|
= Set the verbosity of messages from CMake files. |
...
|
no_warn_unused_cli
|
Flag
|
= Don't warn about command line options. Gone since 4.4.0. |
...
|
open
|
Value
|
= Open generated project in the associated application. |
...
|
preset
|
Value
|
= Specify a configure preset. |
...
|
presets_file
|
Value
|
= Specify the path to a presets file. Added in 4.4.0. |
...
|
print_config_dir
|
Flag
|
= Print CMake config directory for user-wide FileAPI queries. |
...
|
profiling_format
|
Value
|
= Output data for profiling CMake scripts. |
...
|
profiling_output
|
Value
|
= Select an output path for the profiling data enabled through --profiling-format. |
...
|
project_file
|
Value
|
= Specify an alternate project file name. |
...
|
system_information
|
Value
|
= Dump information about this system. |
...
|
toolchain
|
Value
|
= Specify toolchain file [CMAKE_TOOLCHAIN_FILE]. |
...
|
trace
|
Flag
|
= Put cmake in trace mode. |
...
|
trace_expand
|
Flag
|
= Put cmake in trace mode with variable expansion. |
...
|
trace_format
|
Value
|
= Set the output format of the trace. |
...
|
trace_redirect
|
Value
|
= Redirect trace output to a file instead of stderr. |
...
|
trace_source
|
Value
|
= Trace only this CMake file/module. |
...
|
warn_uninitialized
|
Flag
|
= Warn about uninitialized values. Gone since 4.4.0. |
...
|
workflow
|
Value
|
= Run a workflow preset. |
...
|