Skip to content

Repository files navigation

node-addon

Name

Type

Default

Info

VCPKG_ROOT

PATH

${CMAKE_CURRENT_LIST_DIR}

Git repo root folder - must contain an empty file named .vcpkg-root!

This environment variable can be set to a directory to use as the root of the vcpkg instance. This will only be used if the vcpkg executable is not located within a valid root and the command line switch --vcpkg-root is unused.

VCPKG_BINARY_SOURCES

STRING

clear;default,readwrite

This environment variable adds or removes binary sources. See Binary Caching for more details.

VCPKG_DEFAULT_BINARY_CACHE

PATH

${VCPKG_ROOT}/archives

This environment variable redirects the default location to store binary packages.

VCPKG_DOWNLOADS

PATH

${VCPKG_ROOT}/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 an absolute path.

VCPKG_INSTALLED_DIR

PATH

${VCPKG_ROOT}/installed

The directory which contains the installed libraries for each triplet.

VCPKG_OVERLAY_PORTS

PATH

${VCPKG_ROOT}/ports

Overlay ports to use for vcpkg install in manifest mode.

VCPKG_OVERLAY_TRIPLETS

PATH

${VCPKG_ROOT}/triplets

Overlay triplets to use for vcpkg install in manifest mode.

VCPKG_VERBOSE

BOOL

ON

Enables messages from the VCPKG toolchain for debugging purposes.

VCPKG_USE_HOST_TOOLS

BOOL

OFF

Setup CMAKE_PROGRAM_PATH to use host tools.

VCPKG_SETUP_CMAKE_PROGRAM_PATH

BOOL

ON

Enable the setup of CMAKE_PROGRAM_PATH to vcpkg paths

VCPKG_PREFER_SYSTEM_LIBS

BOOL

OFF

Appends the vcpkg paths to CMAKE_PREFIX_PATH, CMAKE_LIBRARY_PATH and CMAKE_FIND_ROOT_PATH so that vcpkg libraries/packages are found after toolchain/system libraries/packages.

Deprecated!! Use empty overlay ports instead...

VCPKG_FORCE_SYSTEM_BINARIES

BOOL

This environment variable, if set, suppresses the downloading of CMake and Ninja and forces the use of the system binaries.

VCPKG_FORCE_DOWNLOADED_BINARIES

BOOL

This environment variable, if set, ignores the use of the system binaries and will always download and use the version defined by vcpkg.

VCPKG_LIBRARY_LINKAGE

STRING

dynamic

Specifies the preferred library linkage. Valid options are dynamic and static. Libraries can ignore this setting if they do not support the preferred linkage type.

VCPKG_CRT_LINKAGE

STRING

${VCPKG_LIBRARY_LINKAGE}

Specifies the desired CRT linkage (for MSVC). Valid options are dynamic and static.

VCPKG_BUILD_TYPE

STRING

${CMAKE_BUILD_TYPE}

You can set this value to Release to only build release versions of the ports. By default this value is empty and release and debug versions of a port are built.

VCPKG_CMAKE_SYSTEM_NAME

STRING

${CMAKE_HOST_SYSTEM_NAME}

Specifies the target platform. Valid options include any CMake system name, such as:

Empty - Windows Desktop for legacy reasons

WindowsStore - Universal Windows Platform

MinGW - Minimalist GNU for Windows

Darwin - Mac OSX

iOS - iOS

Linux - Linux

Emscripten - WebAssembly

VCPKG_CMAKE_SYSTEM_VERSION

STRING

${CMAKE_HOST_SYSTEM_VERSION}

Specifies the target platform system version. This field is optional and, if present, will be passed in as CMAKE_SYSTEM_VERSION.

VCPKG_HOST_TRIPLET

STRING

This variable controls which triplet host dependencies will be installed for.

If unset, vcpkg will automatically detect an appropriate native triplet (x64-windows, x64-osx, x64-linux).

See also Host dependencies.

VCPKG_TARGET_TRIPLET

STRING

This setting controls the triplet vcpkg will install and consume libraries from.

If unset, vcpkg will automatically detect an appropriate default triplet given the current compiler settings. If you change this CMake variable, you must delete your cache and reconfigure.

VCPKG_TARGET_ARCHITECTURE

STRING

Specifies the target machine architecture.

Valid options are x86, x64, arm, arm64 and wasm32.

PORT

STRING

The name of the port that is currently being built.

VERSION

STRING

The version of the port that is currently being built.

HOST_TRIPLET

STRING

The name of the triplet that matches the building system.

TARGET_TRIPLET

STRING

The name of the triplet being built for.

CURRENT_HOST_INSTALLED_DIR

STRING

The absolute path to the installed files for the host triplet.

CURRENT_INSTALLED_DIR

STRING

The absolute path to the installed files for the target triplet.

EDITOR

ENV

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.

AR

ENV

$ENV{PATH}/ar

Default archive compiler filepath and flags.

CC

ENV

$ENV{PATH}/c

Default C compiler filepath and flags.

CXX

ENV

$ENV{PATH}/c++

Default C++ compiler filepath and flags.

LD

ENV

$ENV{PATH}/ld

Default object linker filepath and flags.

RC

ENV

$ENV{PATH}/rc

Default resource compiler filepath and flags.

CFLAGS

ENV

CXXFLAGS

ENV

LDFLAGS

ENV

PKG_CONFIG_PATH

VSLANG

This environment variable sets the language vcpkg uses to display messages. It should be set to one of the 14 supported LCIDs (locale identifier, 4-byte value corresponding to a language).

For example: 1033 corresponds to the English (US) language. For a full list of supported LCIDs see Localization.

BUILD_BENCHMARKING

BUILD_FUZZING_TESTS

BUILD_SHARED_LIBS

BUILD_TESTS

PEDANTIC

Enable extra warnings and expensive tests.

VERBOSE

WERROR

Halt the compilation with an error on compiler warnings.

USE_FOLDERS

USE_X64

CMAKE_TOOLCHAIN_FILE

FILEPATH

When vcpkg executable is not found in 'VCPKG_ROOT' -
scripts/toolchains/${CMAKE_HOST_SYSTEM_NAME}.cmake

When vcpkg executable is found in 'VCPKG_ROOT' -
scripts/buildsystems/vcpkg.cmake

The CMake toolchain file.

VCPKG_CHAINLOAD_TOOLCHAIN_FILE

FILEPATH

scripts/toolchains/${CMAKE_HOST_SYSTEM_NAME}.cmake

Specifies an alternate CMake Toolchain file to use. This (if set) will override all other compiler detection logic. By default, a toolchain file is selected from scripts/toolchains/ appropriate to the platform.

VCPKG_INSTALL_OPTIONS

Clean buildtrees, packages and downloads after building each package:
--clean-after-build

Clean buildtrees after building each package:
--clean-buildtrees-after-build

Clean downloads after building each package:
--clean-downloads-after-build

Clean packages after building each package:
--clean-packages-after-build

This variable can be set to a list of additional command line parameters to pass to the vcpkg tool during automatic installation.

VCPKG_FEATURE_FLAGS

Specifies the vcpkg root folder:
--vcpkg-root=${VCPKG_ROOT}

This variable can be set to a list of additional command line parameters to pass to the vcpkg tool during automatic installation to opt in to experimental behaviour.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages