nix-super/doc/manual/command-ref/nix-collect-garbage.xml

64 lines
2.1 KiB
XML
Raw Normal View History

<refentry xmlns="http://docbook.org/ns/docbook"
2014-08-27 19:41:09 +03:00
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0"
xml:id="sec-nix-collect-garbage">
2005-04-07 11:17:04 +03:00
2007-09-19 17:01:41 +03:00
<refmeta>
<refentrytitle>nix-collect-garbage</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="source">Nix</refmiscinfo>
2014-09-16 15:57:45 +03:00
<refmiscinfo class="version"><xi:include href="../version.txt" parse="text"/></refmiscinfo>
2007-09-19 17:01:41 +03:00
</refmeta>
2005-04-07 11:17:04 +03:00
<refnamediv>
<refname>nix-collect-garbage</refname>
<refpurpose>delete unreachable store paths</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>nix-collect-garbage</command>
2006-09-29 14:03:16 +03:00
<arg><option>--delete-old</option></arg>
<arg><option>-d</option></arg>
<arg><option>--delete-older-than</option> <emphasis>period</emphasis></arg>
<arg><option>--max-freed</option> <emphasis>bytes</emphasis></arg>
2012-09-14 01:09:20 +03:00
<arg><option>--dry-run</option></arg>
2005-04-07 11:17:04 +03:00
</cmdsynopsis>
</refsynopsisdiv>
<refsection><title>Description</title>
2006-09-29 14:03:16 +03:00
<para>The command <command>nix-collect-garbage</command> is mostly an
alias of <link linkend="rsec-nix-store-gc"><command>nix-store
--gc</command></link>, that is, it deletes all unreachable paths in
the Nix store to clean up your system. However, it provides two
additional options: <option>-d</option> (<option>--delete-old</option>),
which deletes all old generations of all profiles in
2006-09-29 14:03:16 +03:00
<filename>/nix/var/nix/profiles</filename> by invoking
<literal>nix-env --delete-generations old</literal> on all profiles
(of course, this makes rollbacks to previous configurations
impossible); and
<option>--delete-older-than</option> <emphasis>period</emphasis>,
where period is a value such as <literal>30d</literal>, which deletes
all generations older than the specified number of days in all profiles
in <filename>/nix/var/nix/profiles</filename> (except for the generations
that were active at that point in time).
</para>
2006-09-29 14:03:16 +03:00
</refsection>
<refsection><title>Example</title>
<para>To delete from the Nix store everything that is not used by the
current generations of each profile, do
<screen>
$ nix-collect-garbage -d</screen>
</para>
2005-04-07 11:17:04 +03:00
</refsection>
</refentry>