cmake/Help/command/exec_program.rst

27 lines
939 B
ReStructuredText
Raw Normal View History

2014-08-03 19:52:23 +02:00
exec_program
------------
2019-11-11 23:01:05 +01:00
.. deprecated:: 3.0
Use the :command:`execute_process` command instead.
2014-08-03 19:52:23 +02:00
Run an executable program during the processing of the CMakeList.txt
file.
::
exec_program(Executable [directory in which to run]
[ARGS <arguments to executable>]
[OUTPUT_VARIABLE <var>]
[RETURN_VALUE <var>])
The executable is run in the optionally specified directory. The
executable can include arguments if it is double quoted, but it is
2015-11-17 17:22:37 +01:00
better to use the optional ``ARGS`` argument to specify arguments to the
2014-08-03 19:52:23 +02:00
program. This is because cmake will then be able to escape spaces in
2015-11-17 17:22:37 +01:00
the executable path. An optional argument ``OUTPUT_VARIABLE`` specifies a
2014-08-03 19:52:23 +02:00
variable in which to store the output. To capture the return value of
2015-11-17 17:22:37 +01:00
the execution, provide a ``RETURN_VALUE``. If ``OUTPUT_VARIABLE`` is
2014-08-03 19:52:23 +02:00
specified, then no output will go to the stdout/stderr of the console
running cmake.