From 1d5e22919fcfeba3fe513248e73395c42ac18ae4 Mon Sep 17 00:00:00 2001 From: Robert Schumacher Date: Wed, 12 Dec 2018 09:22:16 -0800 Subject: [PATCH] [docs] Add config-environment.md --- docs/users/config-environment.md | 42 ++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 docs/users/config-environment.md diff --git a/docs/users/config-environment.md b/docs/users/config-environment.md new file mode 100644 index 0000000000..103c1c5475 --- /dev/null +++ b/docs/users/config-environment.md @@ -0,0 +1,42 @@ +## Environment and Configuration + +### Environment Variables + +#### VCPKG_DOWNLOADS + +This environment variable can be set to an existing directory to use for storing downloads instead of the internal +`downloads/` directory. It should always be set to an absolute path. + +#### VCPKG_FEATURE_FLAGS + +This environment variable can be set to a comma-separated list of off-by-default features in vcpkg. These features are +subject to change without notice and should be considered highly unstable. + +Non-exhaustive list of off-by-default features: + +- `binarycaching` + +#### EDITOR + +This environment variable can be set to the full path of an executable to be used for `vcpkg edit`. Please see +`vcpkg help edit` for command-specific help. + +#### VCPKG_ROOT + +This environment variable can be set to a directory to use as the root of the vcpkg instance. Note that mixing vcpkg +repo versions and executable versions can cause issues. + +#### VCPKG_DEFAULT_VS_PATH + +This environment variable can be set to the full path to a Visual Studio instance on the machine. This Visual Studio instance +will be used if the triplet does not override it via the [`VCPKG_VISUAL_STUDIO_PATH` triplet setting](triplets.md#VCPKG_VISUAL_STUDIO_PATH). + +Example: `D:\2017` + +#### VCPKG_DEFAULT_TRIPLET + +This environment variable can be set to a triplet name which will be used for unqualified triplet references in command lines. + +#### VCPKG_FORCE_SYSTEM_BINARIES + +This environment variable, if set, suppresses the downloading of CMake and Ninja and forces the use of the system binaries.