2020-07-24 10:56:19 +00:00
|
|
|
|
# Name
|
2020-07-23 10:58:42 +00:00
|
|
|
|
|
2020-07-24 10:56:19 +00:00
|
|
|
|
`nix-build` - build a Nix expression
|
2020-07-23 10:58:42 +00:00
|
|
|
|
|
2020-07-24 10:56:19 +00:00
|
|
|
|
# Synopsis
|
2020-07-23 10:58:42 +00:00
|
|
|
|
|
2020-07-24 10:56:19 +00:00
|
|
|
|
`nix-build` [*paths…*]
|
|
|
|
|
|
[`--arg` *name* *value*]
|
|
|
|
|
|
[`--argstr` *name* *value*]
|
|
|
|
|
|
[{`--attr` | `-A`} *attrPath*]
|
|
|
|
|
|
[`--no-out-link`]
|
|
|
|
|
|
[`--dry-run`]
|
|
|
|
|
|
[{`--out-link` | `-o`} *outlink*]
|
2020-07-23 10:58:42 +00:00
|
|
|
|
|
|
|
|
|
|
# Description
|
|
|
|
|
|
|
|
|
|
|
|
The `nix-build` command builds the derivations described by the Nix
|
2020-07-23 12:28:05 +00:00
|
|
|
|
expressions in *paths*. If the build succeeds, it places a symlink to
|
|
|
|
|
|
the result in the current directory. The symlink is called `result`. If
|
2020-07-23 10:58:42 +00:00
|
|
|
|
there are multiple Nix expressions, or the Nix expressions evaluate to
|
|
|
|
|
|
multiple derivations, multiple sequentially numbered symlinks are
|
|
|
|
|
|
created (`result`, `result-2`, and so on).
|
|
|
|
|
|
|
2020-07-23 12:28:05 +00:00
|
|
|
|
If no *paths* are specified, then `nix-build` will use `default.nix` in
|
2020-07-23 10:58:42 +00:00
|
|
|
|
the current directory, if it exists.
|
|
|
|
|
|
|
2020-07-23 12:28:05 +00:00
|
|
|
|
If an element of *paths* starts with `http://` or `https://`, it is
|
2020-07-23 10:58:42 +00:00
|
|
|
|
interpreted as the URL of a tarball that will be downloaded and unpacked
|
|
|
|
|
|
to a temporary location. The tarball must include a single top-level
|
|
|
|
|
|
directory containing at least a file named `default.nix`.
|
|
|
|
|
|
|
|
|
|
|
|
`nix-build` is essentially a wrapper around
|
2020-07-24 13:46:16 +00:00
|
|
|
|
[`nix-instantiate`](nix-instantiate.md) (to translate a high-level Nix
|
2020-07-23 10:58:42 +00:00
|
|
|
|
expression to a low-level store derivation) and [`nix-store
|
2020-07-24 13:46:16 +00:00
|
|
|
|
--realise`](nix-store.md#operation---realise) (to build the store
|
|
|
|
|
|
derivation).
|
2020-07-23 10:58:42 +00:00
|
|
|
|
|
|
|
|
|
|
> **Warning**
|
2020-07-24 10:56:19 +00:00
|
|
|
|
>
|
2020-07-23 10:58:42 +00:00
|
|
|
|
> The result of the build is automatically registered as a root of the
|
|
|
|
|
|
> Nix garbage collector. This root disappears automatically when the
|
|
|
|
|
|
> `result` symlink is deleted or renamed. So don’t rename the symlink.
|
|
|
|
|
|
|
|
|
|
|
|
# Options
|
|
|
|
|
|
|
|
|
|
|
|
All options not listed here are passed to `nix-store
|
|
|
|
|
|
--realise`, except for `--arg` and `--attr` / `-A` which are passed to
|
2020-07-24 12:31:33 +00:00
|
|
|
|
`nix-instantiate`.
|
2020-07-23 10:58:42 +00:00
|
|
|
|
|
2021-04-23 12:30:42 +00:00
|
|
|
|
- `--no-out-link`\
|
2020-07-23 10:58:42 +00:00
|
|
|
|
Do not create a symlink to the output path. Note that as a result
|
|
|
|
|
|
the output does not become a root of the garbage collector, and so
|
|
|
|
|
|
might be deleted by `nix-store
|
|
|
|
|
|
--gc`.
|
|
|
|
|
|
|
2021-04-23 12:30:42 +00:00
|
|
|
|
- `--dry-run`\
|
2020-07-23 10:58:42 +00:00
|
|
|
|
Show what store paths would be built or downloaded.
|
|
|
|
|
|
|
2021-04-23 12:30:42 +00:00
|
|
|
|
- `--out-link` / `-o` *outlink*\
|
2020-07-23 10:58:42 +00:00
|
|
|
|
Change the name of the symlink to the output path created from
|
2020-07-23 12:28:05 +00:00
|
|
|
|
`result` to *outlink*.
|
2020-07-23 10:58:42 +00:00
|
|
|
|
|
|
|
|
|
|
The following common options are supported:
|
|
|
|
|
|
|
|
|
|
|
|
# Examples
|
|
|
|
|
|
|
2020-07-31 13:43:25 +00:00
|
|
|
|
```console
|
|
|
|
|
|
$ nix-build '<nixpkgs>' -A firefox
|
|
|
|
|
|
store derivation is /nix/store/qybprl8sz2lc...-firefox-1.5.0.7.drv
|
|
|
|
|
|
/nix/store/d18hyl92g30l...-firefox-1.5.0.7
|
2020-07-24 10:56:19 +00:00
|
|
|
|
|
2020-07-31 13:43:25 +00:00
|
|
|
|
$ ls -l result
|
|
|
|
|
|
lrwxrwxrwx ... result -> /nix/store/d18hyl92g30l...-firefox-1.5.0.7
|
2020-07-24 10:56:19 +00:00
|
|
|
|
|
2020-07-31 13:43:25 +00:00
|
|
|
|
$ ls ./result/bin/
|
|
|
|
|
|
firefox firefox-config
|
|
|
|
|
|
```
|
2020-07-23 10:58:42 +00:00
|
|
|
|
|
|
|
|
|
|
If a derivation has multiple outputs, `nix-build` will build the default
|
|
|
|
|
|
(first) output. You can also build all outputs:
|
|
|
|
|
|
|
2020-07-31 13:43:25 +00:00
|
|
|
|
```console
|
|
|
|
|
|
$ nix-build '<nixpkgs>' -A openssl.all
|
|
|
|
|
|
```
|
2020-07-23 10:58:42 +00:00
|
|
|
|
|
|
|
|
|
|
This will create a symlink for each output named `result-outputname`.
|
|
|
|
|
|
The suffix is omitted if the output name is `out`. So if `openssl` has
|
|
|
|
|
|
outputs `out`, `bin` and `man`, `nix-build` will create symlinks
|
|
|
|
|
|
`result`, `result-bin` and `result-man`. It’s also possible to build a
|
|
|
|
|
|
specific output:
|
|
|
|
|
|
|
2020-07-31 13:43:25 +00:00
|
|
|
|
```console
|
|
|
|
|
|
$ nix-build '<nixpkgs>' -A openssl.man
|
|
|
|
|
|
```
|
2020-07-23 10:58:42 +00:00
|
|
|
|
|
|
|
|
|
|
This will create a symlink `result-man`.
|
|
|
|
|
|
|
|
|
|
|
|
Build a Nix expression given on the command line:
|
|
|
|
|
|
|
2020-07-31 13:43:25 +00:00
|
|
|
|
```console
|
|
|
|
|
|
$ nix-build -E 'with import <nixpkgs> { }; runCommand "foo" { } "echo bar > $out"'
|
|
|
|
|
|
$ cat ./result
|
|
|
|
|
|
bar
|
|
|
|
|
|
```
|
2020-07-23 10:58:42 +00:00
|
|
|
|
|
|
|
|
|
|
Build the GNU Hello package from the latest revision of the master
|
|
|
|
|
|
branch of Nixpkgs:
|
|
|
|
|
|
|
2020-07-31 13:43:25 +00:00
|
|
|
|
```console
|
|
|
|
|
|
$ nix-build https://github.com/NixOS/nixpkgs/archive/master.tar.gz -A hello
|
|
|
|
|
|
```
|
