* Document --delete-generations and other nix-env options.

This commit is contained in:
Eelco Dolstra 2004-11-12 23:56:37 +00:00
parent c2b0d6b02f
commit 54c7a870d5
2 changed files with 82 additions and 0 deletions

View File

@ -22,6 +22,11 @@
</group>
<replaceable>path</replaceable>
</arg>
<arg><option>--preserve-installed</option></arg>
<arg>
<arg choice='plain'><option>--system-filter</option></arg>
<replaceable>system</replaceable>
</arg>
<arg><option>--dry-run</option></arg>
<arg choice='plain'><replaceable>operation</replaceable></arg>
<arg rep='repeat'><replaceable>options</replaceable></arg>
@ -121,6 +126,38 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--preserve-installed</option></term>
<listitem>
<para>
By default, when you install a derivation with the
<option>--install</option> operation, it will replace
previously installed versions with the same derivation
name (regardless of the version number). This option
causes those previously installed versions to be kept in
the new generation of the profile. Note that this will
generally cause conflicts in the creation of the user
environment (since multiple versions of a package
typically contain the same programs).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--system-filter</option> <replaceable>system</replaceable></term>
<listitem>
<para>
By default, operations such as <option>--query
--available</option> only include derivations matching the
current platform. This option allows you to use
derivations for the specified platform
<replaceable>system</replaceable>. The special value
<literal>*</literal> causes derivations for any platform
to be included.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
@ -719,6 +756,47 @@ $ nix-env --list-generations
<!--######################################################################-->
<refsection>
<title>Operation <option>--delete-generations</option></title>
<refsection>
<title>Synopsis</title>
<cmdsynopsis>
<command>nix-env</command>
<arg choice='req'><option>--delete-generations</option></arg>
<arg choice='plain' rep='repeat'><replaceable>generations</replaceable></arg>
</cmdsynopsis>
</refsection>
<refsection>
<title>Description</title>
<para>
This operation deletes the specified generations of the
current profile. The generations can be a list of generation
numbers, or the special value <literal>old</literal> to delete
all non-current generations. Periodically deleting old
generations is important to make garbage collection effective.
</para>
</refsection>
<refsection>
<title>Examples</title>
<screen>
$ nix-env --delete-generations 3 4 8
$ nix-env -p other_profile --delete-generations old</screen>
</refsection>
</refsection>
<!--######################################################################-->
<refsection>

View File

@ -16,6 +16,8 @@ name `*' may be used to indicate all derivations.
--switch-generation / -G NUMBER: switch to specified generation of profile
--rollback: switch to the previous generation
--list-generations: list available generations of a profile
--delete-generations GENERATIONS...: deleted listed generations,
`old' for all non-current generations
--import / -I FILE: set default Nix expression
@ -49,3 +51,5 @@ Options:
--file / -f FILE: use Nix expression FILE for installation, etc.
--verbose / -v: verbose operation (may be repeated)
--keep-failed / -K: keep temporary directories of failed builds
--preserve-installed: do not replace currently installed versions in `-i'
--system-filter SYSTEM: only use derivations for specified platform