diff --git a/doc/manual/env-common.xml b/doc/manual/env-common.xml index 7a436beba..cf84dd054 100644 --- a/doc/manual/env-common.xml +++ b/doc/manual/env-common.xml @@ -107,6 +107,17 @@ $ mount -o bind /mnt/otherdisk/nix /nix + +TMPDIR + + Use the specified directory to store temporary + files. In particular, this includes temporary build directories; + these can take up substantial amounts of disk space. The default is + /tmp. + + + + diff --git a/doc/manual/nix-store.xml b/doc/manual/nix-store.xml index 5eb70c4eb..82c55daba 100644 --- a/doc/manual/nix-store.xml +++ b/doc/manual/nix-store.xml @@ -1,133 +1,150 @@ - - nix-store - manipulate or query the Nix store - - - - nix-store - - operation - options - arguments - - + + nix-store + manipulate or query the Nix store + - - Description + + + nix-store + + path + + operation + options + arguments + + - - The command nix-store performs primitive - operations on the Nix store. You generally do not need to run - this command manually. - - - nix-store takes exactly one - operation flag which indicates the - subcommand to be performed. These are documented below. - +Description - +The command nix-store performs primitive +operations on the Nix store. You generally do not need to run this +command manually. + +nix-store takes exactly one +operation flag which indicates the subcommand to +be performed. These are documented below. + + - + - - Common options +Common options - - This section lists the options that are common to all - operations. These options are allowed for every subcommand, - though they may not always have an effect. See also . - +This section lists the options that are common to all +operations. These options are allowed for every subcommand, though +they may not always have an effect. See also . - + - + path - + Causes the result of a build action + ( and ) + to be registered as a root of the garbage collector (see ). The root is stored in + path, which must be inside a directory + that is scanned for roots by the garbage collector (i.e., + typically in a subdirectory of + /nix/var/nix/gcroots/) + unless the flag + is used. - - Environment variables + - - The following environment variables affect the behaviour of - nix-store. - + + + + + In conjunction with , this option + allows roots to be stored outside of the GC + roots directory. This is useful for commands such as + nix-build that place a symlink to the build + result in the current directory; such a build result should not be + garbage-collected unless the symlink is removed. + + The flag causes a uniquely named + symlink to path to be stored in + /nix/var/nix/gcroots/auto/. For instance, + + +$ nix-store --add-root /home/eelco/bla/result --indirect -r ... + +$ ls -l /nix/var/nix/gcroots/auto +lrwxrwxrwx 1 ... 2005-03-13 21:10 dn54lcypm8f8... -> /home/eelco/bla/result + +$ ls -l /home/eelco/bla/result +lrwxrwxrwx 1 ... 2005-03-13 21:10 /home/eelco/bla/result -> /nix/store/1r11343n6qd4...-f-spot-0.0.10 + + Thus, when /home/eelco/bla/result is removed, + the GC root in the auto directory becomes a + dangling symlink and will be ignored by the collector. + + Note that it is not possible to move or rename + indirect GC roots, since the symlink in the + auto directory will still point to the old + location. + + + + - + - - TMPDIR=path - - - Use the directory path to store - temporary files. In particular, this includes temporary - build directories; these can take up substantial amounts - of disk space. The default is /tmp. - - - - - - - + - + - - Operation <option>--realise</option> +Operation +<option>--realise</option> - - Synopsis - - nix-store - - - - - paths - - +Synopsis - - Description + + nix-store + + + + + paths + + + + +Description - - The operation realises in the file - system the store expressions stored in - paths. If these expressions are - derivation expressions, they are first - normalised into a closure expression. - This may happen in two ways. First, the corresponding closure - expression (the successor) may already - known (either because the build has already been performed, or - because a successor was explicitly registered through the - operation). Otherwise, the build - action described by the derivation is performed, and a closure - expression is computed by scanning the result of the build for - references to other paths in the store. - +The operation realises in the file +system the store expressions stored in +paths. If these expressions are derivation +expressions, they are first normalised into a +closure expression. This may happen in two ways. First, the +corresponding closure expression (the successor) +may already known (either because the build has already been +performed, or because a successor was explicitly registered through +the operation). Otherwise, the build +action described by the derivation is performed, and a closure +expression is computed by scanning the result of the build for +references to other paths in the store. - - The paths of the closure expression corresponding to each - expression in paths is printed on - standard output. - +The paths of the closure expression corresponding to each +expression in paths is printed on standard +output. - + - + - + Operation <option>--gc</option> diff --git a/doc/manual/opt-common-syn.xml b/doc/manual/opt-common-syn.xml index 85740ba79..8fa66e9be 100644 --- a/doc/manual/opt-common-syn.xml +++ b/doc/manual/opt-common-syn.xml @@ -19,5 +19,6 @@ + type diff --git a/doc/manual/package-management.xml b/doc/manual/package-management.xml index 57967b6d9..0b0e57504 100644 --- a/doc/manual/package-management.xml +++ b/doc/manual/package-management.xml @@ -379,7 +379,7 @@ $ nix-collect-garbage --print-dead Likewise, the option will show the paths that won’t be deleted. -Garbage collector roots +Garbage collector roots TODO diff --git a/doc/manual/style.css b/doc/manual/style.css index c97cb9cbf..544acb61e 100644 --- a/doc/manual/style.css +++ b/doc/manual/style.css @@ -154,7 +154,7 @@ a:hover { background: #ffffcd; } Special elements: ***************************************************************************/ -tt +tt, code { color: #400000; }