vcpkg/docs/maintainers/vcpkg_find_acquire_program.md

# vcpkg_find_acquire_program

The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_find_acquire_program.md).

Download or find a well-known tool.

## Usage
```cmake
vcpkg_find_acquire_program(<VAR>)
```
## Parameters
### VAR
This variable specifies both the program to be acquired as well as the out parameter that will be set to the path of the program executable.

## Notes
The current list of programs includes:

* 7Z
* ARIA2 (Downloader)
* BISON
* CLANG
* DARK
* DOXYGEN
* FLEX
* GASPREPROCESSOR
* GPERF
* PERL
* PYTHON2
* PYTHON3
* GIT
* GN
* GO
* JOM
* MESON
* NASM
* NINJA
* NUGET
* SCONS
* SWIG
* YASM

Note that msys2 has a dedicated helper function: [`vcpkg_acquire_msys`](vcpkg_acquire_msys.md).

## Examples

* [ffmpeg](https://github.com/Microsoft/vcpkg/blob/master/ports/ffmpeg/portfile.cmake)
* [openssl](https://github.com/Microsoft/vcpkg/blob/master/ports/openssl/portfile.cmake)
* [qt5](https://github.com/Microsoft/vcpkg/blob/master/ports/qt5/portfile.cmake)

## Source
[scripts/cmake/vcpkg\_find\_acquire\_program.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_find_acquire_program.cmake)
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00			`# vcpkg_find_acquire_program`

[docs] Fix the automatically generated document URL (#16611) * [document] Fix the automatically generated document URL * [docs] Format all documents 2021-03-11 01:56:07 +08:00			`The latest version of this document lives in the [vcpkg repo](https://github.com/Microsoft/vcpkg/blob/master/docs/maintainers/vcpkg_find_acquire_program.md).`
[scripts-audit] Rollup PR 2021-02-26 (#16440) * [scripts-audit rollup] PR #16419 * pull the cmake doc comment parsing out into its own function * support cmake helper ports * add real support for deprecation, as opposed to ad-hoc * [scripts-audit rollup] PR #16192 * add a z_ in front of internal functions * move internal functions out set feature_vars again in parent scope * [scripts-audit rollup] PR #16309 Audit vcpkg_copy_pdbs * [scripts-audit rollup] PR #16304 * Fix usage, documentation * [scripts-audit rollup] PR #16393 * [scripts-audit rollup] PR #16377 Deprecate `vcpkg__cmake` in favor of `vcpkg_cmake_` from the `vcpkg-cmake` port, as well as `vcpkg_fixup_cmake_targets` in favor of `vcpkg_cmake_config_fixup` from the `vcpkg-cmake-config` port. 2021-03-01 05:17:19 +08:00
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00			`Download or find a well-known tool.`

			`## Usage`
			```cmake
			`vcpkg_find_acquire_program(<VAR>)`
			```
			`## Parameters`
			`### VAR`
			`This variable specifies both the program to be acquired as well as the out parameter that will be set to the path of the program executable.`

			`## Notes`
			`The current list of programs includes:`

[vcpkg docs] Check for documentation generation in CI (#14614) * [vcpkg docs] Change how documenting port functions works Instead of using `##`, use comment blocks for documentation. Also, add some minor docs and change RST -> MD so we actually get docs generated. * add CI stuff * regenerate docs * fix vcpkg_find_acquire_program to not use _execute_process 2020-12-02 05:37:26 +08:00			`* 7Z`
			`* ARIA2 (Downloader)`
			`* BISON`
			`* CLANG`
			`* DARK`
			`* DOXYGEN`
			`* FLEX`
			`* GASPREPROCESSOR`
			`* GPERF`
			`* PERL`
			`* PYTHON2`
			`* PYTHON3`
			`* GIT`
			`* GN`
			`* GO`
			`* JOM`
			`* MESON`
			`* NASM`
			`* NINJA`
			`* NUGET`
			`* SCONS`
			`* SWIG`
			`* YASM`
[vcpkg-docs] Rework documentation for compatibility with readthedocs.io and MkDocs. 2017-05-25 14:33:16 +08:00
			Note that msys2 has a dedicated helper function: [`vcpkg_acquire_msys`](vcpkg_acquire_msys.md).

			`## Examples`

			`* [ffmpeg](https://github.com/Microsoft/vcpkg/blob/master/ports/ffmpeg/portfile.cmake)`
			`* [openssl](https://github.com/Microsoft/vcpkg/blob/master/ports/openssl/portfile.cmake)`
			`* [qt5](https://github.com/Microsoft/vcpkg/blob/master/ports/qt5/portfile.cmake)`

			`## Source`
[scripts-audit] Rollup PR 2021-02-26 (#16440) * [scripts-audit rollup] PR #16419 * pull the cmake doc comment parsing out into its own function * support cmake helper ports * add real support for deprecation, as opposed to ad-hoc * [scripts-audit rollup] PR #16192 * add a z_ in front of internal functions * move internal functions out set feature_vars again in parent scope * [scripts-audit rollup] PR #16309 Audit vcpkg_copy_pdbs * [scripts-audit rollup] PR #16304 * Fix usage, documentation * [scripts-audit rollup] PR #16393 * [scripts-audit rollup] PR #16377 Deprecate `vcpkg__cmake` in favor of `vcpkg_cmake_` from the `vcpkg-cmake` port, as well as `vcpkg_fixup_cmake_targets` in favor of `vcpkg_cmake_config_fixup` from the `vcpkg-cmake-config` port. 2021-03-01 05:17:19 +08:00			`[scripts/cmake/vcpkg\_find\_acquire\_program.cmake](https://github.com/Microsoft/vcpkg/blob/master/scripts/cmake/vcpkg_find_acquire_program.cmake)`