mirror/vcpkg
1
0
Fork 0
mirror of https://github.com/microsoft/vcpkg.git synced 2024-12-19 06:47:49 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
5251291e16
vcpkg/docs/commands/common-options.md
Robert Schumacher c5ca6fd46b
[docs] Fix issues encountered during publishing 2022-09-01 (#26794) 
* [docs] Document 'host' field in manifests

* [docs] Assorted fixes found while regenerating website

* Update docs/users/manifests.md

Co-authored-by: Victor Romero <romerosanchezv@gmail.com>
2022-09-23 12:30:43 -07:00

4.0 KiB
Raw Blame History

Common Command Options

The latest version of this documentation is available on GitHub.

Most vcpkg commands accept a group of common options that control cross-cutting aspects of the tool. Not all options affect every command. For example, a command that does not download any files will be unaffected by changing the downloads directory.

--x-asset-sources=<config>

Experimental: will change or be removed at any time

Specify the cache configuration for Asset Caching.

--binarysource=<config>

Add a source for Binary Caching.

This option can be specified multiple times; see the Binary Caching documentation for how multiple binary sources interact.

--x-buildtrees-root=<path>

Experimental: will change or be removed at any time

Specifies the temporary path to store intermediate build files, such as objects or unpacked source code.

Defaults to buildtrees/ under the vcpkg root folder.

--downloads-root=<path>

Specify where downloaded tools and source code archives should be kept.

Defaults to the VCPKG_DOWNLOADS environment variable. If that is unset, defaults to downloads/ under the vcpkg root folder.

--host-triplet=<triplet>

Specify the host architecture triplet.

Defaults to the VCPKG_DEFAULT_HOST_TRIPLET environment variable. If that is unset, deduced based on the host architecture and operating system.

--x-install-root=<path>

Experimental: will change or be removed at any time

Specifies the path to lay out installed packages.

In Classic Mode, defaults to installed/ under the vcpkg root folder.

In Manifest Mode, defaults to vcpkg_installed/ under the manifest folder.

--x-manifest-root=<path>

Experimental: will change or be removed at any time

Specifies the directory containing vcpkg.json.

Defaults to searching upwards from the current working directory for the nearest vcpkg.json.

--overlay-ports=<path>

Specifies a directory containing overlay ports.

This option can be specified multiple times; ports will resolve to the first match.

--overlay-triplets=<path>

Specifies a directory containing overlay triplets.

This option can be specified multiple times; triplets will resolve to the first match.

--x-packages-root=<path>

Experimental: will change or be removed at any time

Specifies the temporary path to stage intermediate package files before final install.

Defaults to packages/ under the vcpkg root folder.

--triplet=<triplet>

Specify the target architecture triplet.

Defaults to the VCPKG_DEFAULT_TRIPLET environment variable. If that is unset, deduced based on the host architecture and operating system.

Note that on Windows operating systems, the architecture is always deduced as x86 for legacy reasons.

--vcpkg-root=<path>

Specifies the vcpkg root folder.

Defaults to the directory containing the vcpkg program. The directory must be a valid vcpkg instance, such as a git clone of https://github.com/microsoft/vcpkg. This option can be used to run a custom-built copy of the tool directly from the build folder.

Response Files (@<file>)

The vcpkg command line accepts text files containing newline-separated command line parameters.

The tool will act as though the items in the file were spliced into the command line in place of the @ reference. Response files cannot contain additional response files.