lehmanator/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity
lix/src/nix-env/help.txt

78 lines
3 KiB
Plaintext
Raw Normal View History

* Regularise help text a bit.
2006-03-06 11:04:39 +00:00
Usage: nix-env [OPTIONS...] [ARGUMENTS...]
* Help text for all (non-script) programs, so no more: $ nix-instantiate --help error: unknown flag `--help` Try `nix-instantiate --help' for more information. :-)
2003-12-01 15:55:05 +00:00
`nix-env' is a tool to manipulate Nix user environments.
Operations:
* Implemented Eelco V.'s `nix-env -I' command to specify the default path of the Nix expression to be used with the import, upgrade, and query commands. For instance, $ nix-env -I ~/nixpkgs/pkgs/system/i686-linux.nix $ nix-env --query --available [aka -qa] sylpheed-0.9.7 bison-1.875 pango-1.2.5 subversion-0.35.1 ... $ nix-env -i sylpheed $ nix-env -u subversion There can be only one default at a time. * If the path to a Nix expression is a symlink, follow the symlink prior to resolving relative path references in the expression.
2004-01-05 16:26:43 +00:00
--install / -i: add derivations to the user environment
--upgrade / -u: upgrade derivation in the user environment
* New operation `nix-env --set' which sets a user environment to a single derivation specified by the argument. This is useful when we want to have a profile for a single derivation, such as a server configuration. Then we can just say (e.g.) $ nix-env -p /.../server-profile -f server.nix --set -A server We can't do queries or upgrades on such a profile, but we can do rollbacks. The advantage over -i is that we don't have to worry about other packages having been installed in the profile previously; --set gets rid of them.
2006-12-12 19:06:02 +00:00
--set: create a user environment containing a single derivation
* Version numbers can be omitted in install/uninstall. E.g., nix-env -i foo.nix subversion The version number part of a derivation name is defined as everything following the first dash not followed by a letter.
2003-12-21 23:58:56 +00:00
--uninstall / -e: remove derivations from the user environment
* Help text for all (non-script) programs, so no more: $ nix-instantiate --help error: unknown flag `--help` Try `nix-instantiate --help' for more information. :-)
2003-12-01 15:55:05 +00:00
--query / -q: perform a query on an environment or Nix expression
* More documentation.
2007-12-31 02:52:17 +00:00
--set-flag NAME VALUE: set derivation meta-attribute to given value
* Help text for all (non-script) programs, so no more: $ nix-instantiate --help error: unknown flag `--help` Try `nix-instantiate --help' for more information. :-)
2003-12-01 15:55:05 +00:00
The previous operations take a list of derivation names. The special
name `*' may be used to indicate all derivations.
* Improvements to profiles. Generations are now per-profile, e.g., default -> default-94-link default-82-link -> /nix/store/cc4480... default-83-link -> /nix/store/caeec8... ... default-94-link -> /nix/store/2896ca... experimental -> experimental-2-link experimental-1-link -> /nix/store/cc4480... experimental-2-link -> /nix/store/a3148f... * `--profile' / `-p' -> `--switch-profile' / `-S' * `--link' / `-l' -> `--profile' / `-p' * The default profile is stored in $prefix/var/nix/profiles. $prefix/var/nix/links is gone. Profiles can be stored anywhere. * The current profile is now referenced from ~/.nix-profile, not ~/.nix-userenv. * The roots to the garbage collector now have extension `.gcroot', not `.id'.
2004-02-06 10:30:20 +00:00
--switch-profile / -S [FILE]: switch to specified profile
* A command `--switch-generation' to switch to a specific generation of the current profile, e.g., $ nix-env --list-generations ... 39 2004-02-02 17:53:53 40 2004-02-02 17:55:18 41 2004-02-02 17:55:41 42 2004-02-02 17:55:50 (current) $ nix-env --switch-generation 39 $ ls -l /nix/var/nix/profiles/default ... default -> default-39-link * Also a command `--rollback' which is just a convenience operation to rollback to the oldest generation younger than the current one. Note that generations properly form a tree. E.g., if after switching to generation 39, we perform an installation action, a generation 43 is created which is a descendant of 39, not 42. So a rollback from 43 ought to go back to 39. This is not currently implemented; generations form a linear sequence.
2004-02-08 14:07:43 +00:00
--switch-generation / -G NUMBER: switch to specified generation of profile
--rollback: switch to the previous generation
--list-generations: list available generations of a profile
* Document --delete-generations and other nix-env options.
2004-11-12 23:56:37 +00:00
--delete-generations GENERATIONS...: deleted listed generations,
`old' for all non-current generations
* A command `--switch-generation' to switch to a specific generation of the current profile, e.g., $ nix-env --list-generations ... 39 2004-02-02 17:53:53 40 2004-02-02 17:55:18 41 2004-02-02 17:55:41 42 2004-02-02 17:55:50 (current) $ nix-env --switch-generation 39 $ ls -l /nix/var/nix/profiles/default ... default -> default-39-link * Also a command `--rollback' which is just a convenience operation to rollback to the oldest generation younger than the current one. Note that generations properly form a tree. E.g., if after switching to generation 39, we perform an installation action, a generation 43 is created which is a descendant of 39, not 42. So a rollback from 43 ought to go back to 39. This is not currently implemented; generations form a linear sequence.
2004-02-08 14:07:43 +00:00
* Help text for all (non-script) programs, so no more: $ nix-instantiate --help error: unknown flag `--help` Try `nix-instantiate --help' for more information. :-)
2003-12-01 15:55:05 +00:00
--version: output version information
--help: display help
* In `--upgrade': added flags `--lt', `--leq', `--always' to specify whether we want to upgrade if the current version is less than the available version (default), when it is less or equal, or always. * Added a flag `--dry-run' to show what would happen in `--install', `--uninstall', and `--upgrade', without actually performing the operation.
2004-02-09 11:59:39 +00:00
Install / upgrade / uninstall flags:
--dry-run: show what would be done, but don't do it
* Support the --attr / -A flag in nix-env as well. So now we can do, e.g., $ nix-env -i -A subversion xorg.xorgserver The main advantage over using symbolic names is that using attribute names is unambiguous and much, much faster.
2006-07-25 11:53:22 +00:00
Installation sources:
--from-expression / -E EXPR...: evaluate expressions specified on
the command line; expressions should be functions that take the
default Nix expression as an argument
--from-profile PROFILE NAMES...: copy named packages from PROFILE
--attr / -A ATTRS...: select attributes by name from the default Nix
expression
* In `--upgrade': added flags `--lt', `--leq', `--always' to specify whether we want to upgrade if the current version is less than the available version (default), when it is less or equal, or always. * Added a flag `--dry-run' to show what would happen in `--install', `--uninstall', and `--upgrade', without actually performing the operation.
2004-02-09 11:59:39 +00:00
Upgrade flags:
* Documentation fixes.
2005-12-24 23:22:05 +00:00
--lt: upgrade if the current version is older (default)
* `nix-env --upgrade --eq': only upgrade if the old version is equal to the new version. This is actually useful.
2006-06-27 12:17:25 +00:00
--leq: upgrade if the current version is older or equal
--eq: "upgrade" if the current version is equal
* In `--upgrade': added flags `--lt', `--leq', `--always' to specify whether we want to upgrade if the current version is less than the available version (default), when it is less or equal, or always. * Added a flag `--dry-run' to show what would happen in `--install', `--uninstall', and `--upgrade', without actually performing the operation.
2004-02-09 11:59:39 +00:00
--always: upgrade regardless of current version
* nix-env -q now has a flag --prebuilt-only (-b<) that causes nix-env to show only those derivations whose output is already in the Nix store or that can be substituted (i.e., downloaded from somewhere). In other words, it shows the packages that can be installed “quickly”, i.e., don’t need to be built from source.
2007-04-26 14:20:31 +00:00
Query sources:
--installed: use installed derivations (default)
--available / -a: use derivations available in Nix expression
Query flags:
* Help text for all (non-script) programs, so no more: $ nix-instantiate --help error: unknown flag `--help` Try `nix-instantiate --help' for more information. :-)
2003-12-01 15:55:05 +00:00
* `nix-env -q --xml --meta' to show all meta attributes.
2007-05-01 11:30:52 +00:00
--xml: show output in XML format
* New query option: `--compare-versions' or `-c' to compare installed versions to available versions, or vice versa. For example, the following compares installed versions to available versions: $ nix-env -qc autoconf-2.59 = 2.59 automake-1.9.4 < 1.9.6 f-spot-0.0.10 - ? firefox-1.0.4 < 1.0.7 ... I.e., there are newer versions available (in the current default Nix expression) for Automake and Firefox, but not for Autoconf, and F-Spot is missing altogether. Conversely, the available versions can be compared to the installed versions: $ nix-env -qac autoconf-2.59 = 2.59 automake-1.9.6 > 1.9.4 bash-3.0 - ? firefox-1.0.7 > 1.0.4 ... Note that bash is available but no version of it is installed. If multiple versions are available for comparison, then the highest is used. E.g., if Subversion 1.2.0 is installed, and Subversion 1.1.4 and 1.2.3 are available, then `nix-env -qc' will print `< 1.2.3', not `> 1.1.4'. If higher versions are available, the version column is printed in red (using ANSI escape codes).
2005-10-06 14:44:54 +00:00
--status / -s: print installed/present status
--no-name: hide derivation names
2007-10-22 12:05:30 +00:00
--attr-path / -P: shows the unambiguous attribute name of the
* Applied rbroek's patch from the branch at https://svn.cs.uu.nl:12443/repos/trace/buildfarm-control/trunk/ext/nix/, with some modifications. This allows `nix-env -qa' to show the attribute path that can be used to unambiguously install a package using `nix-env -i -A'. Example: $ nix-env -f top-level/all-packages.nix -qaA subversion xorg-server subversionWithJava subversion-1.2.3 subversion subversion-1.3.2 subversion14 subversion-1.4.0pre-rc1 xorg.xorgserver xorg-server-1.1.0
2006-07-25 16:40:38 +00:00
derivation which can be used when installing with -A
* New query option: `--compare-versions' or `-c' to compare installed versions to available versions, or vice versa. For example, the following compares installed versions to available versions: $ nix-env -qc autoconf-2.59 = 2.59 automake-1.9.4 < 1.9.6 f-spot-0.0.10 - ? firefox-1.0.4 < 1.0.7 ... I.e., there are newer versions available (in the current default Nix expression) for Automake and Firefox, but not for Autoconf, and F-Spot is missing altogether. Conversely, the available versions can be compared to the installed versions: $ nix-env -qac autoconf-2.59 = 2.59 automake-1.9.6 > 1.9.4 bash-3.0 - ? firefox-1.0.7 > 1.0.4 ... Note that bash is available but no version of it is installed. If multiple versions are available for comparison, then the highest is used. E.g., if Subversion 1.2.0 is installed, and Subversion 1.1.4 and 1.2.3 are available, then `nix-env -qc' will print `< 1.2.3', not `> 1.1.4'. If higher versions are available, the version column is printed in red (using ANSI escape codes).
2005-10-06 14:44:54 +00:00
--system: print the platform type of the derivation
--compare-versions / -c: compare version to available or installed
* Refactoring to support different installation sources in nix-env. * Set the references for the user environment manifest properly. * Don't copy the manifest (this was accidental). * Don't store derivation paths in the manifest (maybe this should be made optional). This cleans up the semantics of nix-env, which were weird. * Hash on the output paths of activated components, not on derivation paths. This is because we don't know the derivation path of already installed components anymore, and it allows the installation of components by store path (skipping Nix expressions entirely). * Query options `--out-path' and `--drv-path' to show the output and derivation paths of components, respectively (the latter replaces the `--expr' query).
2005-02-11 16:56:45 +00:00
--drv-path: print path of derivation
--out-path: print path of derivation output
* `nix-env -q --xml --meta' to show all meta attributes.
2007-05-01 11:30:52 +00:00
--description: print description
--meta: print all meta attributes (only with --xml)
* Help text for all (non-script) programs, so no more: $ nix-instantiate --help error: unknown flag `--help` Try `nix-instantiate --help' for more information. :-)
2003-12-01 15:55:05 +00:00
Options:
* Improvements to profiles. Generations are now per-profile, e.g., default -> default-94-link default-82-link -> /nix/store/cc4480... default-83-link -> /nix/store/caeec8... ... default-94-link -> /nix/store/2896ca... experimental -> experimental-2-link experimental-1-link -> /nix/store/cc4480... experimental-2-link -> /nix/store/a3148f... * `--profile' / `-p' -> `--switch-profile' / `-S' * `--link' / `-l' -> `--profile' / `-p' * The default profile is stored in $prefix/var/nix/profiles. $prefix/var/nix/links is gone. Profiles can be stored anywhere. * The current profile is now referenced from ~/.nix-profile, not ~/.nix-userenv. * The roots to the garbage collector now have extension `.gcroot', not `.id'.
2004-02-06 10:30:20 +00:00
--profile / -p LINK: use specified profile instead of target of ~/.nix-profile
* Implemented Eelco V.'s `nix-env -I' command to specify the default path of the Nix expression to be used with the import, upgrade, and query commands. For instance, $ nix-env -I ~/nixpkgs/pkgs/system/i686-linux.nix $ nix-env --query --available [aka -qa] sylpheed-0.9.7 bison-1.875 pango-1.2.5 subversion-0.35.1 ... $ nix-env -i sylpheed $ nix-env -u subversion There can be only one default at a time. * If the path to a Nix expression is a symlink, follow the symlink prior to resolving relative path references in the expression.
2004-01-05 16:26:43 +00:00
--file / -f FILE: use Nix expression FILE for installation, etc.
* Help text for all (non-script) programs, so no more: $ nix-instantiate --help error: unknown flag `--help` Try `nix-instantiate --help' for more information. :-)
2003-12-01 15:55:05 +00:00
--verbose / -v: verbose operation (may be repeated)
--keep-failed / -K: keep temporary directories of failed builds
Include --keep-going in --help
2012-04-04 14:22:32 +00:00
--keep-going / -k: build as many dependencies as possible, even if
some dependencies fail to build
* Document --delete-generations and other nix-env options.
2004-11-12 23:56:37 +00:00
--preserve-installed: do not replace currently installed versions in `-i'
--system-filter SYSTEM: only use derivations for specified platform
* Make the `--prebuilt-only' / `-b' option work not just for queries but installations/upgrades as well. So `nix-env -ub \*' will upgrade only those packages for which a substitute is available (or to be precise, it will upgrade each package to the highest version for which a substitute is available).
2007-10-29 14:31:45 +00:00
--prebuilt-only / -b: only use derivations whose prebuilt binaries are
available on this machine or are downloadable
Copy permalink