Execute one or more child processes.
execute_process(COMMAND <cmd1> [args1...]] [COMMAND <cmd2> [args2...] [...]] [WORKING_DIRECTORY <directory>] [TIMEOUT <seconds>] [RESULT_VARIABLE <variable>] [RESULTS_VARIABLE <variable>] [OUTPUT_VARIABLE <variable>] [ERROR_VARIABLE <variable>] [INPUT_FILE <file>] [OUTPUT_FILE <file>] [ERROR_FILE <file>] [OUTPUT_QUIET] [ERROR_QUIET] [OUTPUT_STRIP_TRAILING_WHITESPACE] [ERROR_STRIP_TRAILING_WHITESPACE] [ENCODING <name>])
Runs the given sequence of one or more commands in parallel with the standard output of each process piped to the standard input of the next. A single standard error pipe is used for all processes.
Options:
COMMAND
A child process command line.
CMake executes the child process using operating system APIs directly. All arguments are passed VERBATIM to the child process. No intermediate shell is used, so shell operators such as >
are treated as normal arguments. (Use the INPUT_*
, OUTPUT_*
, and ERROR_*
options to redirect stdin, stdout, and stderr.)
If a sequential execution of multiple commands is required, use multiple execute_process()
calls with a single COMMAND
argument.
WORKING_DIRECTORY
TIMEOUT
RESULT_VARIABLE
RESULTS_VARIABLE <variable>
COMMAND
arguments. Each entry will be an integer return code from the corresponding child or a string describing an error condition.OUTPUT_VARIABLE, ERROR_VARIABLE
INPUT_FILE, OUTPUT_FILE, ERROR_FILE
OUTPUT_QUIET, ERROR_QUIET
ENCODING <name>
On Windows, the encoding that is used to decode output from the process. Ignored on other platforms. Valid encoding names are:
NONE
AUTO
ANSI
OEM
UTF8 or UTF-8
UTF8
was accepted for this encoding. In CMake 3.11.0, UTF-8
was added for consistency with the UTF-8 RFC naming convention.If more than one OUTPUT_*
or ERROR_*
option is given for the same pipe the precedence is not specified. If no OUTPUT_*
or ERROR_*
options are given the output will be shared with the corresponding pipes of the CMake process itself.
The execute_process()
command is a newer more powerful version of exec_program()
, but the old command has been kept for compatibility. Both commands run while CMake is processing the project prior to build system generation. Use add_custom_target()
and add_custom_command()
to create custom commands that run at build time.
© 2000–2018 Kitware, Inc. and Contributors
Licensed under the BSD 3-clause License.
https://cmake.org/cmake/help/v3.12/command/execute_process.html