aboutsummaryrefslogtreecommitdiff
path: root/doc/manual
diff options
context:
space:
mode:
authorEelco Dolstra <eelco.dolstra@logicblox.com>2014-12-13 23:27:22 +0100
committerEelco Dolstra <eelco.dolstra@logicblox.com>2014-12-13 23:27:22 +0100
commit4c4e89165227d92f9e11fc18082e50006a04ffd0 (patch)
treea1fd17fa75951b00c26aa8f3396c21280c547b57 /doc/manual
parentbe797735423ad6cb37e97ee4050d6d1667b1e84c (diff)
Update .nixpkg description
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/command-ref/nix-install-package.xml35
1 files changed, 19 insertions, 16 deletions
diff --git a/doc/manual/command-ref/nix-install-package.xml b/doc/manual/command-ref/nix-install-package.xml
index 7d5cd996e..f7802a95d 100644
--- a/doc/manual/command-ref/nix-install-package.xml
+++ b/doc/manual/command-ref/nix-install-package.xml
@@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0"
xml:id="sec-nix-install-package">
-
+
<refmeta>
<refentrytitle>nix-install-package</refentrytitle>
<manvolnum>1</manvolnum>
@@ -47,8 +47,7 @@
<para>The command <command>nix-install-package</command> interactively
installs a Nix Package file (<filename>*.nixpkg</filename>), which is
a small file that contains a store path to be installed along with the
-URL of a <link linkend="sec-nix-push"><command>nix-push</command>
-manifest</link>. The Nix Package file is either
+URL of a binary cache. The Nix Package file is either
<replaceable>file</replaceable>, or automatically downloaded from
<replaceable>url</replaceable> if the <option>--url</option> switch is
used.</para>
@@ -76,7 +75,7 @@ to restart itself with <command>xterm</command>,
<refsection><title>Options</title>
<variablelist>
-
+
<varlistentry><term><option>--non-interactive</option></term>
<listitem><para>Do not open a new terminal window and do not ask
@@ -139,14 +138,14 @@ The elements are as follows:
<variablelist>
<varlistentry><term><literal>NIXPKG1</literal></term>
-
+
<listitem><para>The version of the Nix Package
file.</para></listitem>
</varlistentry>
<varlistentry><term><replaceable>manifestURL</replaceable></term>
-
+
<listitem><para>The manifest to be pulled by
<command>nix-pull</command>. The manifest must contain
<replaceable>outPath</replaceable>.</para></listitem>
@@ -154,21 +153,21 @@ The elements are as follows:
</varlistentry>
<varlistentry><term><replaceable>name</replaceable></term>
-
+
<listitem><para>The symbolic name and version of the
package.</para></listitem>
</varlistentry>
<varlistentry><term><replaceable>system</replaceable></term>
-
+
<listitem><para>The platform identifier of the platform for which
this binary package is intended.</para></listitem>
</varlistentry>
<varlistentry><term><replaceable>drvPath</replaceable></term>
-
+
<listitem><para>The path in the Nix store of the derivation from
which <replaceable>outPath</replaceable> was built. Not currently
used.</para></listitem>
@@ -176,17 +175,21 @@ The elements are as follows:
</varlistentry>
<varlistentry><term><replaceable>outPath</replaceable></term>
-
- <listitem><para>The path in the Nix store of the package. After
- <command>nix-install-package</command> has obtained the manifest
- from <replaceable>manifestURL</replaceable>, it performs a
- <literal>nix-env -i</literal> <replaceable>outPath</replaceable>
- to install the binary package.</para></listitem>
+
+ <listitem><para>The path in the Nix store of the
+ package.</para></listitem>
+
+ </varlistentry>
+
+ <varlistentry><term><replaceable>binaryCacheURL</replaceable></term>
+
+ <listitem><para>The URL of a binary cache containing the closure
+ of <replaceable>outPath</replaceable>.</para></listitem>
</varlistentry>
</variablelist>
-
+
</para>
<para>An example follows: