path: root/src/nix-store/help.txt

Usage: nix-store [OPTIONS...] [ARGUMENTS...]

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

Operations:

  --realise / -r: ensure path validity; if a derivation, ensure the
      validity of the outputs
  --add / -A: copy a path to the Nix store
  --delete: safely delete paths from the Nix store
  --query / -q: query information
  --read-log / -l: print build log of given store paths

  --register-validity: register path validity (dangerous!)
  --check-validity: check path validity

  --gc: run the garbage collector

  --dump: dump a path as a Nix archive, forgetting dependencies
  --restore: restore a path from a Nix archive, without
      registering validity

  --export: export a path as a Nix archive, marking dependencies
  --import: import a path from a Nix archive, and register as 
      valid

  --verify: verify Nix structures
  --optimise: optimise the Nix store by hard-linking identical files

  --query-failed-paths: list paths that failed to build (if enabled)
  --clear-failed-paths: clear the failed status of the given paths

  --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 the path
  --references: print all paths referenced by the path
  --referrers: print all paths directly refering to the path
  --referrers-closure: print all paths (in)directly refering to the path
  --tree: print a tree showing the dependency graph of the path
  --graph: print a dot graph rooted at given path
  --xml: emit an XML representation of the graph rooted at the given path
  --hash: print the SHA-256 hash of the contents of the path
  --roots: print the garbage collector roots that point to the path

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

Garbage collector options:

  --print-roots: print GC roots and exit
  --print-live: print live paths and exit
  --print-dead: print dead paths and exit
  --delete: delete dead paths (default)
    
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