aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorfricklerhandwerk <valentin@fricklerhandwerk.de>2023-06-17 03:25:57 +0200
committerValentin Gagarin <valentin.gagarin@tweag.io>2023-06-20 12:11:01 +0200
commitf2b54e3b71891c29f951e46b00c6edc4807b3b63 (patch)
tree946b4813f4bfdfa1b90b3cfca432072d858373fa /doc
parent6ae35534b7b6e10a26a0f2b2a0e37d7f7cfe47dd (diff)
add links to environment variables documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/src/command-ref/conf-file-prefix.md25
1 files changed, 11 insertions, 14 deletions
diff --git a/doc/manual/src/command-ref/conf-file-prefix.md b/doc/manual/src/command-ref/conf-file-prefix.md
index 44b7ba86d..d2989ff20 100644
--- a/doc/manual/src/command-ref/conf-file-prefix.md
+++ b/doc/manual/src/command-ref/conf-file-prefix.md
@@ -6,28 +6,25 @@
By default Nix reads settings from the following places:
- - The system-wide configuration file `sysconfdir/nix/nix.conf` (i.e.
- `/etc/nix/nix.conf` on most systems), or `$NIX_CONF_DIR/nix.conf` if
- `NIX_CONF_DIR` is set. Values loaded in this file are not forwarded
- to the Nix daemon. The client assumes that the daemon has already
- loaded them.
+ - The system-wide configuration file `sysconfdir/nix/nix.conf` (i.e. `/etc/nix/nix.conf` on most systems), or `$NIX_CONF_DIR/nix.conf` if [`NIX_CONF_DIR`](./env-common.md#env-NIX_CONF_DIR) is set.
- - If `NIX_USER_CONF_FILES` is set, then each path separated by `:`
- will be loaded in reverse order.
+ Values loaded in this file are not forwarded to the Nix daemon.
+ The client assumes that the daemon has already loaded them.
- Otherwise it will look for `nix/nix.conf` files in `XDG_CONFIG_DIRS`
- and `XDG_CONFIG_HOME`. If unset, `XDG_CONFIG_DIRS` defaults to
- `/etc/xdg`, and `XDG_CONFIG_HOME` defaults to `$HOME/.config`
- as per [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html).
+ - If [`NIX_USER_CONF_FILES`](./env-common.md#env-NIX_USER_CONF_FILES) is set, then each path separated by `:` will be loaded in reverse order.
- - If `NIX_CONFIG` is set, its contents is treated as the contents of
- a configuration file.
+ Otherwise it will look for `nix/nix.conf` files in `XDG_CONFIG_DIRS` and [`XDG_CONFIG_HOME`](./env-common.md#env-XDG_CONFIG_HOME).
+ If unset, `XDG_CONFIG_DIRS` defaults to `/etc/xdg`, and `XDG_CONFIG_HOME` defaults to `$HOME/.config` as per [XDG Base Directory Specification](https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html).
+
+ - If [`NIX_CONFIG`](./env-common.md#env-NIX_CONFIG) is set, its contents are treated as the contents of a configuration file.
The configuration files consist of `name = value` pairs, one per
line. Other files can be included with a line like `include path`,
where *path* is interpreted relative to the current conf file and a
missing file is an error unless `!include` is used instead. Comments
-start with a `#` character. Here is an example configuration file:
+start with a `#` character.
+
+Here is an example configuration file:
keep-outputs = true # Nice for developers
keep-derivations = true # Idem