lix-project/lix
20
57
Fork 31
Code Issues 349 Code Review (Gerrit) Projects 3 Releases Wiki Activity

Update .nixpkg description

Browse source
This commit is contained in:
Eelco Dolstra 2014-12-13 23:27:22 +01:00
parent be79773542
commit 4c4e891652
1 changed files with 19 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
doc/manual/command-ref/nix-install-package.xml
View file

@ -3,7 +3,7 @@
xmlns:xi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude"
version="5.0" version="5.0"
xml:id="sec-nix-install-package"> xml:id="sec-nix-install-package">
<refmeta> <refmeta>
<refentrytitle>nix-install-package</refentrytitle> <refentrytitle>nix-install-package</refentrytitle>
<manvolnum>1</manvolnum> <manvolnum>1</manvolnum>
@ -47,8 +47,7 @@
<para>The command <command>nix-install-package</command> interactively <para>The command <command>nix-install-package</command> interactively
installs a Nix Package file (<filename>*.nixpkg</filename>), which is installs a Nix Package file (<filename>*.nixpkg</filename>), which is
a small file that contains a store path to be installed along with the 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> URL of a binary cache. The Nix Package file is either
manifest</link>. The Nix Package file is either
<replaceable>file</replaceable>, or automatically downloaded from <replaceable>file</replaceable>, or automatically downloaded from
<replaceable>url</replaceable> if the <option>--url</option> switch is <replaceable>url</replaceable> if the <option>--url</option> switch is
used.</para> used.</para>
@ -76,7 +75,7 @@ to restart itself with <command>xterm</command>,
<refsection><title>Options</title> <refsection><title>Options</title>
<variablelist> <variablelist>
<varlistentry><term><option>--non-interactive</option></term> <varlistentry><term><option>--non-interactive</option></term>
<listitem><para>Do not open a new terminal window and do not ask <listitem><para>Do not open a new terminal window and do not ask
@ -139,14 +138,14 @@ The elements are as follows:
<variablelist> <variablelist>
<varlistentry><term><literal>NIXPKG1</literal></term> <varlistentry><term><literal>NIXPKG1</literal></term>
<listitem><para>The version of the Nix Package <listitem><para>The version of the Nix Package
file.</para></listitem> file.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry><term><replaceable>manifestURL</replaceable></term> <varlistentry><term><replaceable>manifestURL</replaceable></term>
<listitem><para>The manifest to be pulled by <listitem><para>The manifest to be pulled by
<command>nix-pull</command>. The manifest must contain <command>nix-pull</command>. The manifest must contain
<replaceable>outPath</replaceable>.</para></listitem> <replaceable>outPath</replaceable>.</para></listitem>
@ -154,21 +153,21 @@ The elements are as follows:
</varlistentry> </varlistentry>
<varlistentry><term><replaceable>name</replaceable></term> <varlistentry><term><replaceable>name</replaceable></term>
<listitem><para>The symbolic name and version of the <listitem><para>The symbolic name and version of the
package.</para></listitem> package.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry><term><replaceable>system</replaceable></term> <varlistentry><term><replaceable>system</replaceable></term>
<listitem><para>The platform identifier of the platform for which <listitem><para>The platform identifier of the platform for which
this binary package is intended.</para></listitem> this binary package is intended.</para></listitem>
</varlistentry> </varlistentry>
<varlistentry><term><replaceable>drvPath</replaceable></term> <varlistentry><term><replaceable>drvPath</replaceable></term>
<listitem><para>The path in the Nix store of the derivation from <listitem><para>The path in the Nix store of the derivation from
which <replaceable>outPath</replaceable> was built. Not currently which <replaceable>outPath</replaceable> was built. Not currently
used.</para></listitem> used.</para></listitem>
@ -176,17 +175,21 @@ The elements are as follows:
</varlistentry> </varlistentry>
<varlistentry><term><replaceable>outPath</replaceable></term> <varlistentry><term><replaceable>outPath</replaceable></term>
<listitem><para>The path in the Nix store of the package. After <listitem><para>The path in the Nix store of the
<command>nix-install-package</command> has obtained the manifest package.</para></listitem>
from <replaceable>manifestURL</replaceable>, it performs a
<literal>nix-env -i</literal> <replaceable>outPath</replaceable> </varlistentry>
to install the binary package.</para></listitem>
<varlistentry><term><replaceable>binaryCacheURL</replaceable></term>
<listitem><para>The URL of a binary cache containing the closure
of <replaceable>outPath</replaceable>.</para></listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para> </para>
<para>An example follows: <para>An example follows: