doc/packages/vcpkg: init

h7x4 cce9bb28 84547e5f

+25
+1
doc/packages/index.md
··· 24 24 steam.section.md 25 25 cataclysm-dda.section.md 26 26 urxvt.section.md 27 + vcpkg.section.md 27 28 weechat.section.md 28 29 xorg.section.md 29 30 ```
+24
doc/packages/vcpkg.section.md
··· 1 + # VCPKG {#sec-vcpkg} 2 + 3 + The `vcpkg-tool` package has a wrapper around the `vcpkg` executable to avoid writing to the nix store. 4 + The wrapper will also be present in `vcpkg`, unless you specify `vcpkg.override { vcpkg-tool = vcpkg-tool-unwrapped; }` 5 + 6 + The wrapper has been made in a way so that it will provide default cli arguments, but tries not to interfere if the user provides the same arguments. 7 + The arguments also have corresponding environment variables that can be used as an alternative way of overriding these paths. 8 + 9 + Run the wrapper with the environment variable `NIX_VCPKG_DEBUG_PRINT_ENVVARS=true` to get a full list of corresponding environment variables. 10 + 11 + ## Nix specific environment variables {#sec-vcpkg-nix-envvars} 12 + 13 + The wrapper also provides some new nix-specific environment variables that lets you control some of the wrapper functionality. 14 + 15 + - `NIX_VCPKG_WRITABLE_PATH = <path>` 16 + 17 + Set this environment variable to specify the path where `vcpkg` will store buildtime artifacts. 18 + This will become the base path for all of the other paths. 19 + 20 + - `NIX_VCPKG_DEBUG_PRINT_ENVVARS = true | false` 21 + 22 + Set this to `true` for the wrapper to print the corresponding environment variables for the arguments that will be provided to the unwrapped executable. 23 + The list of variables will be printed right before invoking `vcpkg`. 24 + This can be useful if you suspect that the wrapper for some reason was unable to prioritize user-provided cli args over its default ones, or for fixing other issues like typos or unexpanded environment variables.