about summary refs log tree commit diff
path: root/src/nix-store/help.txt
blob: b7d71ec4828f365c7781e687622e9d07e34595d0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
nix-store [OPTIONS...] [ARGUMENTS...]

`nix-store' is a tool to manipulate the Nix store.

Operations:

  --realise / -r: ensure path validity; if a derivation, ensure that
      validity of the outputs
  --add / -A: copy a path to the Nix store
  --query / -q: query information

  --substitute: register a substitute expression (dangerous!)
  --clear-substitutes: clear all substitutes
  --validpath: register path validity (dangerous!)
  --isvalid: check path validity

  --dump: dump a path as a Nix archive
  --restore: restore a path from a Nix archive

  --init: initialise the Nix database
  --verify: verify Nix structures

  --version: output version information
  --help: display help

Query flags:

  --outputs: query the output paths of a Nix derivation (default)
  --requisites / -R: print all paths necessary to realise a path
  --references: print all paths referenced by the given path
  --referers: print all paths directly refering to the given path
  --referers-closure: print all paths (in)directly refering to the given path
  --tree: print a tree showing the dependency graph of the given paths
  --graph: print a dot graph rooted at given paths

Query switches (not applicable to all queries):

  --use-output: perform query on output of derivation, not derivation itself
  --force-realise: realise the path before performing the query
  --include-outputs: in `-R' on a derivation, include requisites of outputs
  
Options:

  --verbose / -v: verbose operation (may be repeated)
  --keep-failed / -K: keep temporary directories of failed builds

  --add-root: add garbage collector roots for the result