* Manual updates.
This commit is contained in:
Eelco Dolstra
parent
5346536b62
commit
b594215531
7 changed files with 346 additions and 254 deletions
|
|
@ -7,8 +7,8 @@ XSLTPROC = $(ENV) $(xsltproc) $(xmlflags) --catalogs \
|
||||||
--param html.stylesheet \'style.css\'
|
--param html.stylesheet \'style.css\'
|
||||||
|
|
||||||
SOURCES = manual.xml introduction.xml installation.xml overview.xml \
|
SOURCES = manual.xml introduction.xml installation.xml overview.xml \
|
||||||
common-options.xml nix-store.xml nix-instantiate.xml \
|
nix-store.xml nix-instantiate.xml \
|
||||||
troubleshooting.xml bugs.xml \
|
troubleshooting.xml bugs.xml opt-verbose.xml \
|
||||||
style.css images
|
style.css images
|
||||||
|
|
||||||
manual.is-valid: $(SOURCES) version.xml
|
manual.is-valid: $(SOURCES) version.xml
|
||||||
|
|
|
||||||
|
|
@ -5,24 +5,20 @@
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Nix should automatically remove Berkeley DB logfiles.
|
Unify the concepts of successors and substitutes into a
|
||||||
</para>
|
general notion of <emphasis>equivalent expressions</emphasis>.
|
||||||
</listitem>
|
Expressions are equivalent if they have the same target paths
|
||||||
|
with the same identifiers. However, even though they are
|
||||||
<listitem>
|
functionally equivalent, they may differ stronly with respect
|
||||||
<para>
|
to their <emphasis>performance characteristics</emphasis>.
|
||||||
Unify the concepts of successors and substitutes into a general notion
|
For example, realising a closure expression is more efficient
|
||||||
of <emphasis>equivalent expressions</emphasis>. Expressions are
|
that realising the derivation expression from which it was
|
||||||
equivalent if they have the same target paths with the same
|
|
||||||
identifiers. However, even though they are functionally equivalent,
|
|
||||||
they may differ stronly with respect to their <emphasis>performance
|
|
||||||
characteristics</emphasis>. For example, realising a slice is more
|
|
||||||
efficient that realising the derivation from which that slice was
|
|
||||||
produced. On the other hand, distributing sources may be more
|
produced. On the other hand, distributing sources may be more
|
||||||
efficient (storage- or bandwidth-wise) than distributing binaries. So
|
efficient (storage- or bandwidth-wise) than distributing
|
||||||
we need to be able to attach weigths or priorities or performance
|
binaries. So we need to be able to attach weigths or
|
||||||
annotations to expressions; Nix can then choose the most efficient
|
priorities or performance annotations to expressions; Nix can
|
||||||
expression dependent on the context.
|
then choose the most efficient expression dependent on the
|
||||||
|
context.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
<sect1>
|
|
||||||
<title>Common options</title>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
</para>
|
|
||||||
|
|
||||||
</sect1>
|
|
||||||
|
|
||||||
<!--
|
|
||||||
local variables:
|
|
||||||
sgml-parent-document: ("book.xml" "sect1")
|
|
||||||
end:
|
|
||||||
-->
|
|
||||||
|
|
@ -6,7 +6,7 @@
|
||||||
<!ENTITY introduction SYSTEM "introduction.xml">
|
<!ENTITY introduction SYSTEM "introduction.xml">
|
||||||
<!ENTITY installation SYSTEM "installation.xml">
|
<!ENTITY installation SYSTEM "installation.xml">
|
||||||
<!ENTITY overview SYSTEM "overview.xml">
|
<!ENTITY overview SYSTEM "overview.xml">
|
||||||
<!ENTITY common-options SYSTEM "common-options.xml">
|
<!ENTITY opt-verbose SYSTEM "opt-verbose.xml">
|
||||||
<!ENTITY nix-store SYSTEM "nix-store.xml">
|
<!ENTITY nix-store SYSTEM "nix-store.xml">
|
||||||
<!ENTITY nix-instantiate SYSTEM "nix-instantiate.xml">
|
<!ENTITY nix-instantiate SYSTEM "nix-instantiate.xml">
|
||||||
<!ENTITY troubleshooting SYSTEM "troubleshooting.xml">
|
<!ENTITY troubleshooting SYSTEM "troubleshooting.xml">
|
||||||
|
|
@ -36,7 +36,6 @@
|
||||||
|
|
||||||
<appendix>
|
<appendix>
|
||||||
<title>Command Reference</title>
|
<title>Command Reference</title>
|
||||||
&common-options;
|
|
||||||
<sect1>
|
<sect1>
|
||||||
<title>nix-store</title>
|
<title>nix-store</title>
|
||||||
&nix-store;
|
&nix-store;
|
||||||
|
|
|
||||||
|
|
@ -7,10 +7,6 @@
|
||||||
<refsynopsisdiv>
|
<refsynopsisdiv>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
<command>nix-store</command>
|
<command>nix-store</command>
|
||||||
<group choice='opt'>
|
|
||||||
<arg><option>--path</option></arg>
|
|
||||||
<arg><option>-p</option></arg>
|
|
||||||
</group>
|
|
||||||
<group choice='opt' rep='repeat'>
|
<group choice='opt' rep='repeat'>
|
||||||
<arg><option>--verbose</option></arg>
|
<arg><option>--verbose</option></arg>
|
||||||
<arg><option>-v</option></arg>
|
<arg><option>-v</option></arg>
|
||||||
|
|
@ -25,106 +21,36 @@
|
||||||
</cmdsynopsis>
|
</cmdsynopsis>
|
||||||
</refsynopsisdiv>
|
</refsynopsisdiv>
|
||||||
|
|
||||||
<refsect1>
|
<refsection>
|
||||||
<title>Description</title>
|
<title>Description</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The command <command>nix</command> provides access to the Nix store. This
|
The command <command>nix-store</command> performs primitive
|
||||||
is the (set of) path(s) where Nix expressions and the file system objects
|
operations on the Nix store. You generally do not need to run
|
||||||
built by them are stored.
|
this command manually.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
<command>nix</command> has many subcommands called
|
<command>nix-store</command> takes exactly one
|
||||||
<emphasis>operations</emphasis>. These are individually documented
|
<emphasis>operation</emphasis> flag which indicated the
|
||||||
below. Exactly one operation must always be provided.
|
subcommand to be performed. These are individually
|
||||||
|
documented below.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
</refsect1>
|
</refsection>
|
||||||
|
|
||||||
<refsect1>
|
<refsection>
|
||||||
<title>Common Options</title>
|
<title>Common options</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
In this section the options that are common to all Nix operations are
|
This section lists the options that are common to all Nix
|
||||||
listed. These options are allowed for every subcommand (although they
|
operations. These options are allowed for every subcommand,
|
||||||
may not always have an effect).
|
though they may not always have an effect.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<variablelist>
|
<variablelist>
|
||||||
|
|
||||||
<varlistentry>
|
&opt-verbose;
|
||||||
<term><option>--path</option></term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Indicates that any identifier arguments to the operation are paths
|
|
||||||
in the store rather than identifiers.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
<varlistentry>
|
|
||||||
<term><option>--verbose</option></term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Increases the level of verbosity of diagnostic messages printed on
|
|
||||||
standard error. For each Nix operation, the information printed on
|
|
||||||
standard output is well-defined and specified below in the
|
|
||||||
respective sections. Any diagnostic information is printed on
|
|
||||||
standard error, never on standard output.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
This option may be specified repeatedly. Currently, the following
|
|
||||||
verbosity levels exist:
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<variablelist>
|
|
||||||
<varlistentry>
|
|
||||||
<term>0</term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Print error messages only.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term>1</term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Print informational messages.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term>2</term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Print even more informational messages.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term>3</term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Print messages that should only be useful for debugging.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
<varlistentry>
|
|
||||||
<term>4</term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
<quote>Vomit mode</quote>: print vast amounts of debug
|
|
||||||
information.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
</variablelist>
|
|
||||||
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><option>--keep-failed</option></term>
|
<term><option>--keep-failed</option></term>
|
||||||
|
|
@ -140,65 +66,103 @@
|
||||||
|
|
||||||
</variablelist>
|
</variablelist>
|
||||||
|
|
||||||
</refsect1>
|
</refsection>
|
||||||
|
|
||||||
|
|
||||||
|
<refsection>
|
||||||
|
<title>Environment variables</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
The following environment variables affect the behaviour of
|
||||||
|
<command>nix-store</command>.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
|
||||||
|
<varlistentry>
|
||||||
|
<term><envar>TMPDIR</envar>=<replaceable>path</replaceable></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Use the directory <replaceable>path</replaceable> to store
|
||||||
|
temporary files. In particular, this includes temporary
|
||||||
|
build directories; these can take up substantial amounts
|
||||||
|
of disk space. The default is <filename>/tmp</filename>.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
||||||
|
</variablelist>
|
||||||
|
|
||||||
|
</refsection>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!--######################################################################-->
|
<!--######################################################################-->
|
||||||
|
|
||||||
<refsect1>
|
<refsection>
|
||||||
<title>Operation <option>--install</option></title>
|
<title>Operation <option>--realise</option></title>
|
||||||
|
|
||||||
<refsect2>
|
<refsection>
|
||||||
<title>Synopsis</title>
|
<title>Synopsis</title>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
<command>nix</command>
|
<command>nix-store</command>
|
||||||
<group>
|
<group>
|
||||||
<arg><option>--install</option></arg>
|
<arg><option>--realise</option></arg>
|
||||||
<arg><option>-i</option></arg>
|
<arg><option>-r</option></arg>
|
||||||
</group>
|
</group>
|
||||||
<arg choice='plain' rep='repeat'><replaceable>ids</replaceable></arg>
|
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
|
||||||
</cmdsynopsis>
|
</cmdsynopsis>
|
||||||
</refsect2>
|
</refsection>
|
||||||
|
|
||||||
<refsect2>
|
<refsection>
|
||||||
<title>Description</title>
|
<title>Description</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The operation <option>--install</option> realises the Nix expressions
|
The operation <option>--install</option> realises in the file
|
||||||
identified by <replaceable>ids</replaceable> in the file system. If
|
system the store expressions stored in
|
||||||
these expressions are derivation expressions, they are first
|
<replaceable>paths</replaceable>. If these expressions are
|
||||||
normalised. That is, their target paths are are built, unless a normal
|
derivation expressions, they are first
|
||||||
form is already known.
|
<emphasis>normalised</emphasis> into a closure expression.
|
||||||
|
This may happen in two ways. First, the corresponding closure
|
||||||
|
expression (the <emphasis>successor</emphasis>) may already
|
||||||
|
known (either because the build has already been performed, or
|
||||||
|
because a successor was explicitly registered through the
|
||||||
|
<option>--successor</option> 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.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The identifiers of the normal forms of the given Nix expressions are
|
The paths of the closure expression corresponding to each
|
||||||
printed on standard output.
|
expression in <replaceable>paths</replaceable> is printed on
|
||||||
|
standard output.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
</refsect2>
|
</refsection>
|
||||||
|
|
||||||
</refsect1>
|
</refsection>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!--######################################################################-->
|
<!--######################################################################-->
|
||||||
|
|
||||||
<refsect1>
|
<refsection>
|
||||||
<title>Operation <option>--delete</option></title>
|
<title>Operation <option>--delete</option></title>
|
||||||
|
|
||||||
<refsect2>
|
<refsection>
|
||||||
<title>Synopsis</title>
|
<title>Synopsis</title>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
<command>nix</command>
|
<command>nix-store</command>
|
||||||
<group>
|
<group>
|
||||||
<arg><option>--delete</option></arg>
|
<arg><option>--delete</option></arg>
|
||||||
<arg><option>-d</option></arg>
|
<arg><option>-d</option></arg>
|
||||||
</group>
|
</group>
|
||||||
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
|
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
|
||||||
</cmdsynopsis>
|
</cmdsynopsis>
|
||||||
</refsect2>
|
</refsection>
|
||||||
|
|
||||||
<refsect2>
|
<refsection>
|
||||||
<title>Description</title>
|
<title>Description</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
|
@ -215,24 +179,24 @@
|
||||||
inconsistent system. Deletion of paths in the store is done by the
|
inconsistent system. Deletion of paths in the store is done by the
|
||||||
garbage collector (which uses <option>--delete</option> to delete
|
garbage collector (which uses <option>--delete</option> to delete
|
||||||
unreferenced paths).
|
unreferenced paths).
|
||||||
|
|
||||||
</para>
|
</para>
|
||||||
</warning>
|
</warning>
|
||||||
|
|
||||||
</refsect2>
|
</refsection>
|
||||||
|
|
||||||
</refsect1>
|
</refsection>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<!--######################################################################-->
|
<!--######################################################################-->
|
||||||
|
|
||||||
<refsect1>
|
<refsection>
|
||||||
<title>Operation <option>--query</option></title>
|
<title>Operation <option>--query</option></title>
|
||||||
|
|
||||||
<refsect2>
|
<refsection>
|
||||||
<title>Synopsis</title>
|
<title>Synopsis</title>
|
||||||
<cmdsynopsis>
|
<cmdsynopsis>
|
||||||
<command>nix</command>
|
<command>nix-store</command>
|
||||||
<group>
|
<group>
|
||||||
<arg><option>--query</option></arg>
|
<arg><option>--query</option></arg>
|
||||||
<arg><option>-q</option></arg>
|
<arg><option>-q</option></arg>
|
||||||
|
|
@ -244,34 +208,28 @@
|
||||||
</group>
|
</group>
|
||||||
<group>
|
<group>
|
||||||
<arg><option>--requisites</option></arg>
|
<arg><option>--requisites</option></arg>
|
||||||
<arg><option>-r</option></arg>
|
<arg><option>-R</option></arg>
|
||||||
</group>
|
|
||||||
<group>
|
|
||||||
<arg><option>--expansion</option></arg>
|
|
||||||
<arg><option>-e</option></arg>
|
|
||||||
</group>
|
|
||||||
<group>
|
|
||||||
<arg><option>--graph</option></arg>
|
|
||||||
<arg><option>-g</option></arg>
|
|
||||||
</group>
|
</group>
|
||||||
|
<arg><option>--predecessors</option></arg>
|
||||||
|
<arg><option>--graph</option></arg>
|
||||||
</group>
|
</group>
|
||||||
<arg choice='plain' rep='repeat'><replaceable>args</replaceable></arg>
|
<arg choice='plain' rep='repeat'><replaceable>args</replaceable></arg>
|
||||||
</cmdsynopsis>
|
</cmdsynopsis>
|
||||||
</refsect2>
|
</refsection>
|
||||||
|
|
||||||
<refsect2>
|
<refsection>
|
||||||
<title>Description</title>
|
<title>Description</title>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The operation <option>--query</option> displays various bits of
|
The operation <option>--query</option> displays various bits of
|
||||||
information about Nix expressions or paths in the store. The queries
|
information about store expressions or store paths. The queries
|
||||||
are described in <xref linkend='nixref-queries' />. At most one query
|
are described in <xref linkend='nixref-queries' />. At most one query
|
||||||
can be specified; the default query is <option>--list</option>.
|
can be specified. The default query is <option>--list</option>.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
</refsect2>
|
</refsection>
|
||||||
|
|
||||||
<refsect2 id='nixref-queries'>
|
<refsection id='nixref-queries'>
|
||||||
<title>Queries</title>
|
<title>Queries</title>
|
||||||
|
|
||||||
<variablelist>
|
<variablelist>
|
||||||
|
|
@ -280,34 +238,15 @@
|
||||||
<term><option>--list</option></term>
|
<term><option>--list</option></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Prints out the target paths of the Nix expressions indicated by
|
Prints out the <emphasis>output paths</emphasis> of the
|
||||||
the identifiers <replaceable>args</replaceable>. In the case of
|
store expressions indicated by the identifiers
|
||||||
a derivation expression, these are the paths that will be
|
<replaceable>args</replaceable>. In the case of a
|
||||||
produced by the builder of the expression. In the case of a
|
derivation expression, these are the paths that will be
|
||||||
slice expression, these are the root paths (which are generally
|
produced when the derivation is realised. In the case
|
||||||
the paths that were produced by the builder of the derivation
|
of a closure expression, these are the paths that were
|
||||||
expression of which the slice is a normal form).
|
produced the derivation expression of which the closure
|
||||||
|
expression is a successor.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
|
||||||
This query has one option:
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<variablelist>
|
|
||||||
|
|
||||||
<varlistentry>
|
|
||||||
<term><option>--normalise</option></term>
|
|
||||||
<listitem>
|
|
||||||
<para>
|
|
||||||
Causes the target paths of the <emphasis>normal
|
|
||||||
forms</emphasis> of the expressions to be printed, rather
|
|
||||||
than the target paths of the expressions themselves.
|
|
||||||
</para>
|
|
||||||
</listitem>
|
|
||||||
</varlistentry>
|
|
||||||
|
|
||||||
</variablelist>
|
|
||||||
|
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
|
|
@ -315,40 +254,42 @@
|
||||||
<term><option>--requisites</option></term>
|
<term><option>--requisites</option></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Prints out the requisite paths of the Nix expressions indicated
|
Prints out the requisite paths of the store expressions
|
||||||
by the identifiers <replaceable>args</replaceable>. The
|
indicated by the identifiers
|
||||||
requisite paths of a Nix expression are the paths that need to be
|
<replaceable>args</replaceable>. The requisite paths of
|
||||||
present in the system to be able to realise the expression. That
|
a Nix expression are the paths that need to be present
|
||||||
is, they form the <emphasis>closure</emphasis> of the expression
|
in the system to be able to realise the expression.
|
||||||
in the file system (i.e., no path in the set of requisite paths
|
That is, they form the <emphasis>closure</emphasis> of
|
||||||
points to anything outside the set of requisite paths).
|
the expression in the file system (i.e., no path in the
|
||||||
|
set of requisite paths points to anything outside the
|
||||||
|
set of requisite paths).
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
The notion of requisite paths is very useful when one wants to
|
The notion of requisite paths is very useful when one
|
||||||
distribute Nix expressions. Since they form a closure, they are
|
wants to distribute store expressions. Since they form a
|
||||||
the only paths one needs to distribute to another system to be
|
closure, they are the only paths one needs to distribute
|
||||||
able to realise the expression on the other system.
|
to another system to be able to realise the expression
|
||||||
|
on the other system.
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
This query is generally used to implement various kinds of
|
This query is generally used to implement various kinds
|
||||||
distribution. A <emphasis>source distribution</emphasis> is
|
of deployment. A <emphasis>source deployment</emphasis>
|
||||||
obtained by distributing the requisite paths of a derivation
|
is obtained by distributing the requisite paths of a
|
||||||
expression. A <emphasis>binary distribution</emphasis> is
|
derivation expression. A <emphasis>binary
|
||||||
obtained by distributing the requisite paths of a slice
|
deployment</emphasis> is obtained by distributing the
|
||||||
expression (i.e., the normal form of a derivation expression; you
|
requisite paths of a closure expression. A
|
||||||
can directly specify the identifier of the slice expression, or
|
<emphasis>cache deployment</emphasis> is obtained by
|
||||||
use <option>--normalise</option> and specify the identifier of a
|
distributing the requisite paths of a derivation
|
||||||
derivation expression). A <emphasis>cache
|
expression and specifying the option
|
||||||
distribution</emphasis> is obtained by distributing the
|
<option>--include-successors</option>. This will
|
||||||
requisite paths of a derivation expression and specifying the
|
include not just the paths of a source and binary
|
||||||
option <option>--include-successors</option>. This will include
|
deployment, but also all expressions and paths of
|
||||||
not just the paths of a source and binary distribution, but also
|
subterms of the source. This is useful if one wants to
|
||||||
all expressions and paths of subterms of the source. This is
|
realise on the target system a Nix expression that is
|
||||||
useful if one wants to realise on the target system a Nix
|
similar but not quite the same as the one being
|
||||||
expression that is similar but not quite the same as the one
|
distributed, since any common subterms will be reused.
|
||||||
being distributed, since any common subterms will be reused.
|
|
||||||
</para>
|
</para>
|
||||||
|
|
||||||
<para>
|
<para>
|
||||||
|
|
@ -361,9 +302,10 @@
|
||||||
<term><option>--normalise</option></term>
|
<term><option>--normalise</option></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Causes the requisite paths of the <emphasis>normal
|
Causes the requisite paths of the
|
||||||
forms</emphasis> of the expressions to be printed, rather
|
<emphasis>successor</emphasis> of the given store
|
||||||
than the requisite paths of the expressions themselves.
|
expressions to be printed, rather than the
|
||||||
|
requisite paths of the expressions themselves.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
@ -372,9 +314,10 @@
|
||||||
<term><option>--exclude-exprs</option></term>
|
<term><option>--exclude-exprs</option></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Excludes the paths of Nix expressions. This causes the
|
Excludes the paths of store expressions. This
|
||||||
closure property to be lost, that is, the resulting set of
|
causes the closure property to be lost, that is,
|
||||||
paths is not enough to ensure realisibility.
|
the resulting set of paths is not enough to ensure
|
||||||
|
realisibility.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
@ -406,12 +349,16 @@
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
<varlistentry>
|
<varlistentry>
|
||||||
<term><option>--expansion</option></term>
|
<term><option>--predecessors</option></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
For each identifier in <replaceable>args</replaceable>, prints
|
For each store expression stored at paths
|
||||||
all expansions of that identifier, that is, all paths whose
|
<replaceable>args</replaceable>, prints its
|
||||||
current content matches the identifier.
|
<emphasis>predecessors</emphasis>. A derivation
|
||||||
|
expression <varname>p</varname> is a predecessor of a
|
||||||
|
store expression <varname>q</varname> iff
|
||||||
|
<varname>q</varname> is a successor of
|
||||||
|
<varname>p</varname>.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
@ -420,18 +367,121 @@
|
||||||
<term><option>--graph</option></term>
|
<term><option>--graph</option></term>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>
|
<para>
|
||||||
Prints a graph of the closure of the expressions identified by
|
Prints a graph of the closure of the store expressions
|
||||||
<replaceable>args</replaceable> in the format of the
|
identified by <replaceable>args</replaceable> in the
|
||||||
<command>dot</command> tool of AT&T's GraphViz package.
|
format of the <command>dot</command> tool of AT&T's
|
||||||
|
GraphViz package.
|
||||||
</para>
|
</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</varlistentry>
|
</varlistentry>
|
||||||
|
|
||||||
</variablelist>
|
</variablelist>
|
||||||
|
|
||||||
</refsect2>
|
</refsection>
|
||||||
|
|
||||||
|
</refsection>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!--######################################################################-->
|
||||||
|
|
||||||
|
<refsection>
|
||||||
|
<title>Operation <option>--successor</option></title>
|
||||||
|
|
||||||
|
<refsection>
|
||||||
|
<title>Synopsis</title>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>nix-store</command>
|
||||||
|
<group>
|
||||||
|
<arg><option>--successor</option></arg>
|
||||||
|
</group>
|
||||||
|
<arg choice='plain'
|
||||||
|
rep='repeat'><replaceable>srcpath</replaceable> <replaceable>sucpath</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</refsection>
|
||||||
|
|
||||||
|
<refsection>
|
||||||
|
<title>Description</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
The operation <option>--successor</option> registers that the
|
||||||
|
closure expression in <replaceable>sucpath</replaceable> is a
|
||||||
|
successor of the derivation expression in
|
||||||
|
<replaceable>srcpath</replaceable>. This is used to implement
|
||||||
|
binary deployment.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
</refsection>
|
||||||
|
|
||||||
|
</refsection>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!--######################################################################-->
|
||||||
|
|
||||||
|
<refsection>
|
||||||
|
<title>Operation <option>--substitute</option></title>
|
||||||
|
|
||||||
|
<refsection>
|
||||||
|
<title>Synopsis</title>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>nix-store</command>
|
||||||
|
<group>
|
||||||
|
<arg><option>--substitute</option></arg>
|
||||||
|
</group>
|
||||||
|
<arg choice='plain'
|
||||||
|
rep='repeat'><replaceable>srcpath</replaceable> <replaceable>subpath</replaceable></arg>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</refsection>
|
||||||
|
|
||||||
|
<refsection>
|
||||||
|
<title>Description</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
The operation <option>--substitute</option> registers that the
|
||||||
|
store path <replaceable>srcpath</replaceable> can be built by
|
||||||
|
realising the derivation expression in
|
||||||
|
<replaceable>subpath</replaceable>. This is used to implement
|
||||||
|
binary deployment.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
</refsection>
|
||||||
|
|
||||||
|
</refsection>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<!--######################################################################-->
|
||||||
|
|
||||||
|
<refsection>
|
||||||
|
<title>Operation <option>--verify</option></title>
|
||||||
|
|
||||||
|
<refsection>
|
||||||
|
<title>Synopsis</title>
|
||||||
|
<cmdsynopsis>
|
||||||
|
<command>nix-store</command>
|
||||||
|
<group>
|
||||||
|
<arg><option>--verify</option></arg>
|
||||||
|
</group>
|
||||||
|
</cmdsynopsis>
|
||||||
|
</refsection>
|
||||||
|
|
||||||
|
<refsection>
|
||||||
|
<title>Description</title>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
The operation <option>--verify</option> verifies the internal
|
||||||
|
consistency of the Nix database, and the consistency between
|
||||||
|
the Nix database and the Nix store. Any inconsistencies
|
||||||
|
encountered are automatically repaired. Inconsistencies are
|
||||||
|
generally the result of the Nix store or database being
|
||||||
|
modified by non-Nix tools, or of bugs in Nix itself.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
</refsection>
|
||||||
|
|
||||||
|
</refsection>
|
||||||
|
|
||||||
</refsect1>
|
|
||||||
|
|
||||||
|
|
||||||
</refentry>
|
</refentry>
|
||||||
|
|
|
||||||
73
doc/manual/opt-verbose.xml
Normal file
73
doc/manual/opt-verbose.xml
Normal file
|
|
@ -0,0 +1,73 @@
|
||||||
|
<varlistentry>
|
||||||
|
<term><option>--verbose</option></term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
Increases the level of verbosity of diagnostic messages printed
|
||||||
|
on standard error. For each Nix operation, the information
|
||||||
|
printed on standard output is well-defined; any diagnostic
|
||||||
|
information is printed on standard error, never on standard
|
||||||
|
output.
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<para>
|
||||||
|
This option may be specified repeatedly. Currently, the
|
||||||
|
following verbosity levels exist:
|
||||||
|
</para>
|
||||||
|
|
||||||
|
<variablelist>
|
||||||
|
<varlistentry>
|
||||||
|
<term>0</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<quote>Errors only</quote>: only print messages explaining
|
||||||
|
why the Nix invocation failed.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term>1</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<quote>Informational</quote>: print
|
||||||
|
<emphasis>useful</emphasis> messages about what Nix is
|
||||||
|
doing.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term>2</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<quote>Talkative</quote>: print more informational messages.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term>3</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<quote>Chatty</quote>: print even more informational messages.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term>4</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<quote>Debug</quote>: print debug information:
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
<varlistentry>
|
||||||
|
<term>5</term>
|
||||||
|
<listitem>
|
||||||
|
<para>
|
||||||
|
<quote>Vomit</quote>: print vast amounts of debug
|
||||||
|
information.
|
||||||
|
</para>
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
</variablelist>
|
||||||
|
|
||||||
|
</listitem>
|
||||||
|
</varlistentry>
|
||||||
|
|
@ -1,22 +1,9 @@
|
||||||
<appendix>
|
<appendix>
|
||||||
<title>Troubleshooting</title>
|
<title>Troubleshooting</title>
|
||||||
|
|
||||||
<sect1>
|
<para>
|
||||||
<title>Database logfile removal</title>
|
(Nothing.)
|
||||||
|
</para>
|
||||||
<para>
|
|
||||||
Every time a Nix database transaction takes place, Nix writes a record of
|
|
||||||
this transaction to a <emphasis>log</emphasis> in its database directory
|
|
||||||
to ensure that the operation can be replayed in case of a application or
|
|
||||||
system crash. However, without manual intervention, the log grows
|
|
||||||
indefinitely. Hence, unused log files should be deleted periodically.
|
|
||||||
This can be accomplished using the following command:
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<screen>
|
|
||||||
$ rm `db_archive -a -h <replaceable>prefix</replaceable>/var/nix/db`</screen>
|
|
||||||
|
|
||||||
</sect1>
|
|
||||||
|
|
||||||
</appendix>
|
</appendix>
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue