From 12346bff3d1bba2ed7d572fd395ec50eca8ad107 Mon Sep 17 00:00:00 2001 From: William Beuil Date: Mon, 1 Feb 2021 21:09:25 +0100 Subject: [PATCH] Add environment variables section --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 8b87683..47a83b2 100644 --- a/README.md +++ b/README.md @@ -204,3 +204,13 @@ $ cp completions/dctlenv.fish ~/.config/fish/completions/dctlenv.fish Remember to create the directory if it's not already there `mkdir -p ~/.config/fish/completions/`. Remember to open a new shell to test the functionality. + +## Environment variables + +You can configure how `dctlenv` operates with the following settings: + +| name | default | description | +| --------------- | ------- | ------------------------------------------------------------------------------------------- | +| `DCTLENV_ROOT` | | Defines the directory under which dctlenv resides
Current value shown by `dctlenv root` | +| `DCTLENV_ARCH` | `amd64` | Architecture other than the default amd64 can be specified | +| `DCTLENV_DEBUG` | `0` | Outputs debug information |