kloenk/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity
lix/doc/manual/src/command-ref/env-common.md

121 lines
4.6 KiB
Markdown
Raw Normal View History

Reconvert
2020-07-23 08:44:54 +00:00
# Common Environment Variables
Most Nix commands interpret the following environment variables:
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `IN_NIX_SHELL`\
Reconvert
2020-07-23 08:44:54 +00:00
Indicator that tells if the current environment was set up by
`nix-shell`. Since Nix 2.0 the values are `"pure"` and `"impure"`
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_PATH`\
Reconvert
2020-07-23 08:44:54 +00:00
A colon-separated list of directories used to look up Nix
expressions enclosed in angle brackets (i.e., `<path>`). For
instance, the value
/home/eelco/Dev:/etc/nixos
will cause Nix to look for paths relative to `/home/eelco/Dev` and
`/etc/nixos`, in this order. It is also possible to match paths
against a prefix. For example, the value
nixpkgs=/home/eelco/Dev/nixpkgs-branch:/etc/nixos
will cause Nix to search for `<nixpkgs/path>` in
`/home/eelco/Dev/nixpkgs-branch/path` and `/etc/nixos/nixpkgs/path`.
If a path in the Nix search path starts with `http://` or
`https://`, it is interpreted as the URL of a tarball that will be
downloaded and unpacked to a temporary location. The tarball must
consist of a single top-level directory. For example, setting
`NIX_PATH` to
nixpkgs=https://github.com/NixOS/nixpkgs/archive/nixos-15.09.tar.gz
tells Nix to download the latest revision in the Nixpkgs/NixOS 15.09
channel.
A following shorthand can be used to refer to the official channels:
nixpkgs=channel:nixos-15.09
The search path can be extended using the `-I` option, which takes
precedence over `NIX_PATH`.
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_IGNORE_SYMLINK_STORE`\
Reconvert
2020-07-23 08:44:54 +00:00
Normally, the Nix store directory (typically `/nix/store`) is not
allowed to contain any symlink components. This is to prevent
“impure” builds. Builders sometimes “canonicalise” paths by
resolving all symlink components. Thus, builds on different machines
(with `/nix/store` resolving to different locations) could yield
different results. This is generally not a problem, except when
builds are deployed to machines where `/nix/store` resolves
differently. If you are sure that you’re not going to do that, you
can set `NIX_IGNORE_SYMLINK_STORE` to `1`.
Note that if you’re symlinking the Nix store so that you can put it
on another file system than the root file system, on Linux you’re
better off using `bind` mount points, e.g.,
Enable syntax highlighting
2020-07-31 13:43:25 +00:00
```console
$ mkdir /nix
$ mount -o bind /mnt/otherdisk/nix /nix
```
Reconvert
2020-07-23 08:44:54 +00:00
Consult the mount 8 manual page for details.
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_STORE_DIR`\
Reconvert
2020-07-23 08:44:54 +00:00
Overrides the location of the Nix store (default `prefix/store`).
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_DATA_DIR`\
Reconvert
2020-07-23 08:44:54 +00:00
Overrides the location of the Nix static data directory (default
`prefix/share`).
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_LOG_DIR`\
Reconvert
2020-07-23 08:44:54 +00:00
Overrides the location of the Nix log directory (default
`prefix/var/log/nix`).
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_STATE_DIR`\
Reconvert
2020-07-23 08:44:54 +00:00
Overrides the location of the Nix state directory (default
`prefix/var/nix`).
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_CONF_DIR`\
Reconvert
2020-07-23 08:44:54 +00:00
Overrides the location of the system Nix configuration directory
(default `prefix/etc/nix`).
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_CONFIG`\
Add NIX_CONFIG env var for applying nix.conf overrides
2020-10-19 21:08:50 +00:00
Applies settings from Nix configuration from the environment.
The content is treated as if it was read from a Nix configuration file.
Settings are separated by the newline character.
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_USER_CONF_FILES`\
Reconvert
2020-07-23 08:44:54 +00:00
Overrides the location of the user Nix configuration files to load
from (defaults to the XDG spec locations). The variable is treated
as a list separated by the `:` token.
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `TMPDIR`\
Reconvert
2020-07-23 08:44:54 +00:00
Use the specified directory to store temporary files. In particular,
this includes temporary build directories; these can take up
substantial amounts of disk space. The default is `/tmp`.
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_REMOTE`\
Reconvert
2020-07-23 08:44:54 +00:00
This variable should be set to `daemon` if you want to use the Nix
daemon to execute Nix operations. This is necessary in [multi-user
Fix internal links
2020-07-24 13:46:16 +00:00
Nix installations](../installation/multi-user.md). If the Nix
daemon's Unix socket is at some non-standard path, this variable
should be set to `unix://path/to/socket`. Otherwise, it should be
left unset.
Reconvert
2020-07-23 08:44:54 +00:00
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_SHOW_STATS`\
Reconvert
2020-07-23 08:44:54 +00:00
If set to `1`, Nix will print some evaluation statistics, such as
the number of values allocated.
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `NIX_COUNT_CALLS`\
Reconvert
2020-07-23 08:44:54 +00:00
If set to `1`, Nix will print how often functions were called during
Nix expression evaluation. This is useful for profiling your Nix
expressions.
Replace the trailing markdown spaces by a backslash They are equivalent according to <https://spec.commonmark.org/0.29/#hard-line-breaks>, and the trailing spaces tend to be a pain (because the make git complain, editors tend to want to remove them − the `.editorconfig` actually specifies that − etc..).
2021-04-23 12:30:42 +00:00
- `GC_INITIAL_HEAP_SIZE`\
Reconvert
2020-07-23 08:44:54 +00:00
If Nix has been configured to use the Boehm garbage collector, this
variable sets the initial size of the heap in bytes. It defaults to
384 MiB. Setting it to a low value reduces memory consumption, but
will increase runtime due to the overhead of garbage collection.
Copy permalink