about summary refs log tree commit diff
path: root/src/nix-env/help.txt
diff options
context:
space:
mode:
authorEelco Dolstra <e.dolstra@tudelft.nl>2003-12-01T15·55+0000
committerEelco Dolstra <e.dolstra@tudelft.nl>2003-12-01T15·55+0000
commit078e20885e0805e04669f9b334a516a6d8d12763 (patch)
treef16741a27866a46806c99ec8d5c8371ae5298046 /src/nix-env/help.txt
parent905d5b91fa6fa64e549f9019f9fab4150f00c13a (diff)
* Help text for all (non-script) programs, so no more:
$ nix-instantiate --help
error: unknown flag `--help`
Try `nix-instantiate --help' for more information.

:-)

Diffstat (limited to 'src/nix-env/help.txt')
-rw-r--r--src/nix-env/help.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/src/nix-env/help.txt b/src/nix-env/help.txt
new file mode 100644
index 000000000000..69c4742944fd
--- /dev/null
+++ b/src/nix-env/help.txt
@@ -0,0 +1,31 @@
+nix-env [OPTIONS...] [ARGUMENTS...]
+
+`nix-env' is a tool to manipulate Nix user environments.
+
+Operations:
+
+  --install / -i FILE: add a derivation to the user environment
+  --uninstall / -u: remove a derivation to the user environment
+  --query / -q: perform a query on an environment or Nix expression
+
+The previous operations take a list of derivation names.  The special
+name `*' may be used to indicate all derivations.
+
+  --version: output version information
+  --help: display help
+
+Query types:
+
+  --name: print derivation names (default)
+  --expr / -e: print derivation store expression
+  --status / -s: print installed/present status
+
+Query sources:
+
+  --installed: use installed derivations (default)
+  --available / -f FILE: use derivations available in expression FILE
+
+Options:
+
+  --verbose / -v: verbose operation (may be repeated)
+  --keep-failed / -K: keep temporary directories of failed builds