wroclaw-git-backups/nix
1
0
Fork 0
mirror of https://github.com/NixOS/nix synced 2025-07-10 04:43:53 +02:00
Code Activity

<replaceable> -> <emphasis>

Browse source 
Pandoc doesn't know <replaceable> so let's force it to be rendered as
italics.
This commit is contained in:
Eelco Dolstra 2020-07-23 14:28:05 +02:00
parent ee05108472
commit 802150f987
No known key found for this signature in database
GPG key ID: 8170B4726D7198DE
76 changed files with 1029 additions and 1020 deletions
Download patch file Download diff file Expand all files Collapse all files

34
doc/manual/command-ref/conf-file.xml
View file

@ -26,7 +26,7 @@
<listitem>
<para>
The system-wide configuration file
<filename><replaceable>sysconfdir</replaceable>/nix/nix.conf</filename>
<filename><emphasis>sysconfdir</emphasis>/nix/nix.conf</filename>
(i.e. <filename>/etc/nix/nix.conf</filename> on most systems),
or <filename>$NIX_CONF_DIR/nix.conf</filename> if
<literal>NIX_CONF_DIR</literal> is set. Values loaded in this
@ -52,11 +52,11 @@
</itemizedlist>
<para>The configuration files consist of
<literal><replaceable>name</replaceable> =
<replaceable>value</replaceable></literal> pairs, one per line. Other
<literal><emphasis>name</emphasis> =
<emphasis>value</emphasis></literal> pairs, one per line. Other
files can be included with a line like <literal>include
<replaceable>path</replaceable></literal>, where
<replaceable>path</replaceable> is interpreted relative to the current
<emphasis>path</emphasis></literal>, where
<emphasis>path</emphasis> is interpreted relative to the current
conf file and a missing file is an error unless
<literal>!include</literal> is used instead.
Comments start with a <literal>#</literal> character. Here is an
@ -244,7 +244,7 @@ false</literal>.</para>
instance, in Nixpkgs, if the derivation attribute
<varname>enableParallelBuilding</varname> is set to
<literal>true</literal>, the builder passes the
<option>-j<replaceable>N</replaceable></option> flag to GNU Make.
<option>-j<emphasis>N</emphasis></option> flag to GNU Make.
It can be overridden using the <option
linkend='opt-cores'>--cores</option> command line switch and
defaults to <literal>1</literal>. The value <literal>0</literal>
@ -383,10 +383,10 @@ false</literal>.</para>
<function>builtins.fetchurl</function> to obtain files by
hash. The default is
<literal>http://tarballs.nixos.org/</literal>. Given a hash type
<replaceable>ht</replaceable> and a base-16 hash
<replaceable>h</replaceable>, Nix will try to download the file
<emphasis>ht</emphasis> and a base-16 hash
<emphasis>h</emphasis>, Nix will try to download the file
from
<literal>hashed-mirror/<replaceable>ht</replaceable>/<replaceable>h</replaceable></literal>.
<literal>hashed-mirror/<emphasis>ht</emphasis>/<emphasis>h</emphasis></literal>.
This allows files to be downloaded even if they have disappeared
from their original URI. For example, given the default mirror
<literal>http://tarballs.nixos.org/</literal>, when building the derivation
@ -421,7 +421,7 @@ builtins.fetchurl {
output and error of its builder) to the directory
<filename>/nix/var/log/nix/drvs</filename>. The build log can be
retrieved using the command <command>nix-store -l
<replaceable>path</replaceable></command>.</para></listitem>
<emphasis>path</emphasis></command>.</para></listitem>
</varlistentry>
@ -592,9 +592,9 @@ builtins.fetchurl {
accounts in the following format:
<screen>
machine <replaceable>my-machine</replaceable>
login <replaceable>my-username</replaceable>
password <replaceable>my-password</replaceable>
machine <emphasis>my-machine</emphasis>
login <emphasis>my-username</emphasis>
password <emphasis>my-password</emphasis>
</screen>
For the exact syntax, see <link
@ -837,13 +837,13 @@ password <replaceable>my-password</replaceable>
<listitem><para>A list of paths bind-mounted into Nix sandbox
environments. You can use the syntax
<literal><replaceable>target</replaceable>=<replaceable>source</replaceable></literal>
<literal><emphasis>target</emphasis>=<emphasis>source</emphasis></literal>
to mount a path in a different location in the sandbox; for
instance, <literal>/bin=/nix-bin</literal> will mount the path
<literal>/nix-bin</literal> as <literal>/bin</literal> inside the
sandbox. If <replaceable>source</replaceable> is followed by
sandbox. If <emphasis>source</emphasis> is followed by
<literal>?</literal>, then it is not an error if
<replaceable>source</replaceable> does not exist; for example,
<emphasis>source</emphasis> does not exist; for example,
<literal>/dev/nvidiactl?</literal> specifies that
<filename>/dev/nvidiactl</filename> will only be mounted in the
sandbox if it exists in the host filesystem.</para>
@ -1035,7 +1035,7 @@ function-trace exited /nix/store/.../example.nix:226:41 at 1565795253249941684
<listitem><para>A list of URLs of substituters, separated by
whitespace. These are not used by default, but can be enabled by
users of the Nix daemon by specifying <literal>--option
substituters <replaceable>urls</replaceable></literal> on the
substituters <emphasis>urls</emphasis></literal> on the
command line. Unprivileged users are only allowed to pass a
subset of the URLs listed in <literal>substituters</literal> and
<literal>trusted-substituters</literal>.</para></listitem>

18
doc/manual/command-ref/env-common.xml
View file

@ -25,7 +25,7 @@
<para>A colon-separated list of directories used to look up Nix
expressions enclosed in angle brackets (i.e.,
<literal>&lt;<replaceable>path</replaceable>></literal>). For
<literal>&lt;<emphasis>path</emphasis>></literal>). For
instance, the value
<screen>
@ -40,10 +40,10 @@
nixpkgs=/home/eelco/Dev/nixpkgs-branch:/etc/nixos</screen>
will cause Nix to search for
<literal>&lt;nixpkgs/<replaceable>path</replaceable>></literal> in
<filename>/home/eelco/Dev/nixpkgs-branch/<replaceable>path</replaceable></filename>
<literal>&lt;nixpkgs/<emphasis>path</emphasis>></literal> in
<filename>/home/eelco/Dev/nixpkgs-branch/<emphasis>path</emphasis></filename>
and
<filename>/etc/nixos/nixpkgs/<replaceable>path</replaceable></filename>.</para>
<filename>/etc/nixos/nixpkgs/<emphasis>path</emphasis></filename>.</para>
<para>If a path in the Nix search path starts with
<literal>http://</literal> or <literal>https://</literal>, it is
@ -105,7 +105,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
<varlistentry><term><literal>NIX_STORE_DIR</literal></term>
<listitem><para>Overrides the location of the Nix store (default
<filename><replaceable>prefix</replaceable>/store</filename>).</para></listitem>
<filename><emphasis>prefix</emphasis>/store</filename>).</para></listitem>
</varlistentry>
@ -114,7 +114,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
<listitem><para>Overrides the location of the Nix static data
directory (default
<filename><replaceable>prefix</replaceable>/share</filename>).</para></listitem>
<filename><emphasis>prefix</emphasis>/share</filename>).</para></listitem>
</varlistentry>
@ -122,7 +122,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
<varlistentry><term><literal>NIX_LOG_DIR</literal></term>
<listitem><para>Overrides the location of the Nix log directory
(default <filename><replaceable>prefix</replaceable>/var/log/nix</filename>).</para></listitem>
(default <filename><emphasis>prefix</emphasis>/var/log/nix</filename>).</para></listitem>
</varlistentry>
@ -130,7 +130,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
<varlistentry><term><literal>NIX_STATE_DIR</literal></term>
<listitem><para>Overrides the location of the Nix state directory
(default <filename><replaceable>prefix</replaceable>/var/nix</filename>).</para></listitem>
(default <filename><emphasis>prefix</emphasis>/var/nix</filename>).</para></listitem>
</varlistentry>
@ -139,7 +139,7 @@ $ mount -o bind /mnt/otherdisk/nix /nix</screen>
<listitem><para>Overrides the location of the system Nix configuration
directory (default
<filename><replaceable>prefix</replaceable>/etc/nix</filename>).</para></listitem>
<filename><emphasis>prefix</emphasis>/etc/nix</filename>).</para></listitem>
</varlistentry>

24
doc/manual/command-ref/nix-build.xml
View file

@ -20,14 +20,14 @@
<cmdsynopsis>
<command>nix-build</command>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common-syn.xml#xmlns(db=http://docbook.org/ns/docbook)xpointer(/db:nop/*)" />
<arg><option>--arg</option> <replaceable>name</replaceable> <replaceable>value</replaceable></arg>
<arg><option>--argstr</option> <replaceable>name</replaceable> <replaceable>value</replaceable></arg>
<arg><option>--arg</option> <emphasis>name</emphasis> <emphasis>value</emphasis></arg>
<arg><option>--argstr</option> <emphasis>name</emphasis> <emphasis>value</emphasis></arg>
<arg>
<group choice='req'>
<arg choice='plain'><option>--attr</option></arg>
<arg choice='plain'><option>-A</option></arg>
</group>
<replaceable>attrPath</replaceable>
<emphasis>attrPath</emphasis>
</arg>
<arg><option>--no-out-link</option></arg>
<arg><option>--dry-run</option></arg>
@ -36,16 +36,16 @@
<arg choice='plain'><option>--out-link</option></arg>
<arg choice='plain'><option>-o</option></arg>
</group>
<replaceable>outlink</replaceable>
<emphasis>outlink</emphasis>
</arg>
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>paths</emphasis></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection><title>Description</title>
<para>The <command>nix-build</command> command builds the derivations
described by the Nix expressions in <replaceable>paths</replaceable>.
described by the Nix expressions in <emphasis>paths</emphasis>.
If the build succeeds, it places a symlink to the result in the
current directory. The symlink is called <filename>result</filename>.
If there are multiple Nix expressions, or the Nix expressions evaluate
@ -53,11 +53,11 @@ to multiple derivations, multiple sequentially numbered symlinks are
created (<filename>result</filename>, <filename>result-2</filename>,
and so on).</para>
<para>If no <replaceable>paths</replaceable> are specified, then
<para>If no <emphasis>paths</emphasis> are specified, then
<command>nix-build</command> will use <filename>default.nix</filename>
in the current directory, if it exists.</para>
<para>If an element of <replaceable>paths</replaceable> starts with
<para>If an element of <emphasis>paths</emphasis> starts with
<literal>http://</literal> or <literal>https://</literal>, it is
interpreted as the URL of a tarball that will be downloaded and
unpacked to a temporary location. The tarball must include a single
@ -104,11 +104,11 @@ also <xref linkend="sec-common-options" />.</phrase></para>
</varlistentry>
<varlistentry xml:id='opt-out-link'><term><option>--out-link</option> /
<option>-o</option> <replaceable>outlink</replaceable></term>
<option>-o</option> <emphasis>outlink</emphasis></term>
<listitem><para>Change the name of the symlink to the output path
created from <filename>result</filename> to
<replaceable>outlink</replaceable>.</para></listitem>
<emphasis>outlink</emphasis>.</para></listitem>
</varlistentry>
@ -131,7 +131,7 @@ store derivation is /nix/store/qybprl8sz2lc...-firefox-1.5.0.7.drv
/nix/store/d18hyl92g30l...-firefox-1.5.0.7
$ ls -l result
lrwxrwxrwx <replaceable>...</replaceable> result -> /nix/store/d18hyl92g30l...-firefox-1.5.0.7
lrwxrwxrwx <emphasis>...</emphasis> result -> /nix/store/d18hyl92g30l...-firefox-1.5.0.7
$ ls ./result/bin/
firefox firefox-config</screen>
@ -143,7 +143,7 @@ You can also build all outputs:
$ nix-build '&lt;nixpkgs>' -A openssl.all
</screen>
This will create a symlink for each output named
<filename>result-<replaceable>outputname</replaceable></filename>.
<filename>result-<emphasis>outputname</emphasis></filename>.
The suffix is omitted if the output name is <literal>out</literal>.
So if <literal>openssl</literal> has outputs <literal>out</literal>,
<literal>bin</literal> and <literal>man</literal>,

32
doc/manual/command-ref/nix-channel.xml
View file

@ -20,11 +20,11 @@
<cmdsynopsis>
<command>nix-channel</command>
<group choice='req'>
<arg choice='plain'><option>--add</option> <replaceable>url</replaceable> <arg choice='opt'><replaceable>name</replaceable></arg></arg>
<arg choice='plain'><option>--remove</option> <replaceable>name</replaceable></arg>
<arg choice='plain'><option>--add</option> <emphasis>url</emphasis> <arg choice='opt'><emphasis>name</emphasis></arg></arg>
<arg choice='plain'><option>--remove</option> <emphasis>name</emphasis></arg>
<arg choice='plain'><option>--list</option></arg>
<arg choice='plain'><option>--update</option> <arg rep='repeat'><replaceable>names</replaceable></arg></arg>
<arg choice='plain'><option>--rollback</option> <arg choice='opt'><replaceable>generation</replaceable></arg></arg>
<arg choice='plain'><option>--update</option> <arg rep='repeat'><emphasis>names</emphasis></arg></arg>
<arg choice='plain'><option>--rollback</option> <arg choice='opt'><emphasis>generation</emphasis></arg></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
@ -44,22 +44,22 @@ xlink:href="https://nixos.org/channels" />.</para>
<variablelist>
<varlistentry><term><option>--add</option> <replaceable>url</replaceable> [<replaceable>name</replaceable>]</term>
<varlistentry><term><option>--add</option> <emphasis>url</emphasis> [<emphasis>name</emphasis>]</term>
<listitem><para>Adds a channel named
<replaceable>name</replaceable> with URL
<replaceable>url</replaceable> to the list of subscribed channels.
If <replaceable>name</replaceable> is omitted, it defaults to the
last component of <replaceable>url</replaceable>, with the
<emphasis>name</emphasis> with URL
<emphasis>url</emphasis> to the list of subscribed channels.
If <emphasis>name</emphasis> is omitted, it defaults to the
last component of <emphasis>url</emphasis>, with the
suffixes <literal>-stable</literal> or
<literal>-unstable</literal> removed.</para></listitem>
</varlistentry>
<varlistentry><term><option>--remove</option> <replaceable>name</replaceable></term>
<varlistentry><term><option>--remove</option> <emphasis>name</emphasis></term>
<listitem><para>Removes the channel named
<replaceable>name</replaceable> from the list of subscribed
<emphasis>name</emphasis> from the list of subscribed
channels.</para></listitem>
</varlistentry>
@ -71,18 +71,18 @@ xlink:href="https://nixos.org/channels" />.</para>
</varlistentry>
<varlistentry><term><option>--update</option> [<replaceable>names</replaceable>…]</term>
<varlistentry><term><option>--update</option> [<emphasis>names</emphasis>…]</term>
<listitem><para>Downloads the Nix expressions of all subscribed
channels (or only those included in
<replaceable>names</replaceable> if specified) and makes them the
<emphasis>names</emphasis> if specified) and makes them the
default for <command>nix-env</command> operations (by symlinking
them from the directory
<filename>~/.nix-defexpr</filename>).</para></listitem>
</varlistentry>
<varlistentry><term><option>--rollback</option> [<replaceable>generation</replaceable>]</term>
<varlistentry><term><option>--rollback</option> [<emphasis>generation</emphasis>]</term>
<listitem><para>Reverts the previous call to <command>nix-channel
--update</command>. Optionally, you can specify a specific channel
@ -130,7 +130,7 @@ $ nix-instantiate --eval -E '(import &lt;nixpkgs> {}).lib.version'
<variablelist>
<varlistentry><term><filename>/nix/var/nix/profiles/per-user/<replaceable>username</replaceable>/channels</filename></term>
<varlistentry><term><filename>/nix/var/nix/profiles/per-user/<emphasis>username</emphasis>/channels</filename></term>
<listitem><para><command>nix-channel</command> uses a
<command>nix-env</command> profile to keep track of previous
@ -145,7 +145,7 @@ $ nix-instantiate --eval -E '(import &lt;nixpkgs> {}).lib.version'
<varlistentry><term><filename>~/.nix-defexpr/channels</filename></term>
<listitem><para>This is a symlink to
<filename>/nix/var/nix/profiles/per-user/<replaceable>username</replaceable>/channels</filename>. It
<filename>/nix/var/nix/profiles/per-user/<emphasis>username</emphasis>/channels</filename>. It
ensures that <command>nix-env</command> can find your channels. In
a multi-user installation, you may also have
<filename>~/.nix-defexpr/channels_root</filename>, which links to

6
doc/manual/command-ref/nix-collect-garbage.xml
View file

@ -21,8 +21,8 @@
<command>nix-collect-garbage</command>
<arg><option>--delete-old</option></arg>
<arg><option>-d</option></arg>
<arg><option>--delete-older-than</option> <replaceable>period</replaceable></arg>
<arg><option>--max-freed</option> <replaceable>bytes</replaceable></arg>
<arg><option>--delete-older-than</option> <emphasis>period</emphasis></arg>
<arg><option>--max-freed</option> <emphasis>bytes</emphasis></arg>
<arg><option>--dry-run</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -39,7 +39,7 @@ which deletes all old generations of all profiles in
<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> <replaceable>period</replaceable>,
<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

16
doc/manual/command-ref/nix-copy-closure.xml
View file

@ -33,9 +33,9 @@
</group>
<arg><option>-v</option></arg>
<arg choice='plain'>
<replaceable>user@</replaceable><replaceable>machine</replaceable>
<emphasis>user@</emphasis><emphasis>machine</emphasis>
</arg>
<arg choice='plain'><replaceable>paths</replaceable></arg>
<arg choice='plain'><emphasis>paths</emphasis></arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -44,13 +44,13 @@
<para><command>nix-copy-closure</command> gives you an easy and
efficient way to exchange software between machines. Given one or
more Nix store <replaceable>paths</replaceable> on the local
more Nix store <emphasis>paths</emphasis> on the local
machine, <command>nix-copy-closure</command> computes the closure of
those paths (i.e. all their dependencies in the Nix store), and copies
all paths in the closure to the remote machine via the
<command>ssh</command> (Secure Shell) command. With the
<option>--from</option>, the direction is reversed:
the closure of <replaceable>paths</replaceable> on a remote machine is
the closure of <emphasis>paths</emphasis> on a remote machine is
copied to the Nix store on the local machine.</para>
<para>This command is efficient because it only sends the store paths
@ -73,8 +73,8 @@ those paths. If this bothers you, use
<varlistentry><term><option>--to</option></term>
<listitem><para>Copy the closure of
<replaceable>paths</replaceable> from the local Nix store to the
Nix store on <replaceable>machine</replaceable>. This is the
<emphasis>paths</emphasis> from the local Nix store to the
Nix store on <emphasis>machine</emphasis>. This is the
default.</para></listitem>
</varlistentry>
@ -82,8 +82,8 @@ those paths. If this bothers you, use
<varlistentry><term><option>--from</option></term>
<listitem><para>Copy the closure of
<replaceable>paths</replaceable> from the Nix store on
<replaceable>machine</replaceable> to the local Nix
<emphasis>paths</emphasis> from the Nix store on
<emphasis>machine</emphasis> to the local Nix
store.</para></listitem>
</varlistentry>

120
doc/manual/command-ref/nix-env.xml
View file

@ -20,30 +20,30 @@
<cmdsynopsis>
<command>nix-env</command>
<xi:include href="opt-common-syn.xml#xmlns(db=http://docbook.org/ns/docbook)xpointer(/db:nop/*)" />
<arg><option>--arg</option> <replaceable>name</replaceable> <replaceable>value</replaceable></arg>
<arg><option>--argstr</option> <replaceable>name</replaceable> <replaceable>value</replaceable></arg>
<arg><option>--arg</option> <emphasis>name</emphasis> <emphasis>value</emphasis></arg>
<arg><option>--argstr</option> <emphasis>name</emphasis> <emphasis>value</emphasis></arg>
<arg>
<group choice='req'>
<arg choice='plain'><option>--file</option></arg>
<arg choice='plain'><option>-f</option></arg>
</group>
<replaceable>path</replaceable>
<emphasis>path</emphasis>
</arg>
<arg>
<group choice='req'>
<arg choice='plain'><option>--profile</option></arg>
<arg choice='plain'><option>-p</option></arg>
</group>
<replaceable>path</replaceable>
<emphasis>path</emphasis>
</arg>
<arg>
<arg choice='plain'><option>--system-filter</option></arg>
<replaceable>system</replaceable>
<emphasis>system</emphasis>
</arg>
<arg><option>--dry-run</option></arg>
<arg choice='plain'><replaceable>operation</replaceable></arg>
<arg rep='repeat'><replaceable>options</replaceable></arg>
<arg rep='repeat'><replaceable>arguments</replaceable></arg>
<arg choice='plain'><emphasis>operation</emphasis></arg>
<arg rep='repeat'><emphasis>options</emphasis></arg>
<arg rep='repeat'><emphasis>arguments</emphasis></arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -146,7 +146,7 @@ also <xref linkend="sec-common-options" />.</phrase></para>
<variablelist>
<varlistentry><term><option>--file</option> / <option>-f</option> <replaceable>path</replaceable></term>
<varlistentry><term><option>--file</option> / <option>-f</option> <emphasis>path</emphasis></term>
<listitem><para>Specifies the Nix expression (designated below as
the <emphasis>active Nix expression</emphasis>) used by the
@ -165,7 +165,7 @@ also <xref linkend="sec-common-options" />.</phrase></para>
</varlistentry>
<varlistentry><term><option>--profile</option> / <option>-p</option> <replaceable>path</replaceable></term>
<varlistentry><term><option>--profile</option> / <option>-p</option> <emphasis>path</emphasis></term>
<listitem><para>Specifies the profile to be used by those
operations that operate on a profile (designated below as the
@ -194,12 +194,12 @@ also <xref linkend="sec-common-options" />.</phrase></para>
</varlistentry>
<varlistentry><term><option>--system-filter</option> <replaceable>system</replaceable></term>
<varlistentry><term><option>--system-filter</option> <emphasis>system</emphasis></term>
<listitem><para>By default, operations such as <option>--query
--available</option> show derivations matching any platform. This
option allows you to use derivations for the specified platform
<replaceable>system</replaceable>.</para></listitem>
<emphasis>system</emphasis>.</para></listitem>
</varlistentry>
@ -276,7 +276,7 @@ also <xref linkend="sec-common-options" />.</phrase></para>
<listitem><para>A symbolic link to the user's current profile. By
default, this symlink points to
<filename><replaceable>prefix</replaceable>/var/nix/profiles/default</filename>.
<filename><emphasis>prefix</emphasis>/var/nix/profiles/default</filename>.
The <literal>PATH</literal> environment variable should include
<filename>~/.nix-profile/bin</filename> for the user environment
to be visible to the user.</para></listitem>
@ -310,7 +310,7 @@ also <xref linkend="sec-common-options" />.</phrase></para>
<arg choice='plain'><option>--remove-all</option></arg>
<arg choice='plain'><option>-r</option></arg>
</group>
<arg choice='plain' rep='repeat'><replaceable>args</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>args</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -320,13 +320,13 @@ also <xref linkend="sec-common-options" />.</phrase></para>
<para>The install operation creates a new user environment, based on
the current generation of the active profile, to which a set of store
paths described by <replaceable>args</replaceable> is added. The
arguments <replaceable>args</replaceable> map to store paths in a
paths described by <emphasis>args</emphasis> is added. The
arguments <emphasis>args</emphasis> map to store paths in a
number of possible ways:
<itemizedlist>
<listitem><para>By default, <replaceable>args</replaceable> is a set
<listitem><para>By default, <emphasis>args</emphasis> is a set
of derivation names denoting derivations in the active Nix
expression. These are realised, and the resulting output paths are
installed. Currently installed derivations with a name equal to the
@ -335,7 +335,7 @@ number of possible ways:
specified.</para>
<para>If there are multiple derivations matching a name in
<replaceable>args</replaceable> that have the same name (e.g.,
<emphasis>args</emphasis> that have the same name (e.g.,
<literal>gcc-3.3.6</literal> and <literal>gcc-4.1.1</literal>), then
the derivation with the highest <emphasis>priority</emphasis> is
used. A derivation can define a priority by declaring the
@ -362,14 +362,14 @@ number of possible ways:
packages, use <literal>nix-env -qaP</literal>.</para></listitem>
<listitem><para>If <option>--from-profile</option>
<replaceable>path</replaceable> is given,
<replaceable>args</replaceable> is a set of names denoting installed
store paths in the profile <replaceable>path</replaceable>. This is
<emphasis>path</emphasis> is given,
<emphasis>args</emphasis> is a set of names denoting installed
store paths in the profile <emphasis>path</emphasis>. This is
an easy way to copy user environment elements from one profile to
another.</para></listitem>
<listitem><para>If <option>--from-expression</option> is given,
<replaceable>args</replaceable> are Nix <link
<emphasis>args</emphasis> are Nix <link
linkend="ss-functions">functions</link> that are called with the
active Nix expression as their single argument. The derivations
returned by those function calls are installed. This allows
@ -377,12 +377,12 @@ number of possible ways:
if there are multiple derivations with the same
name.</para></listitem>
<listitem><para>If <replaceable>args</replaceable> are store
<listitem><para>If <emphasis>args</emphasis> are store
derivations, then these are <link
linkend="rsec-nix-store-realise">realised</link>, and the resulting
output paths are installed.</para></listitem>
<listitem><para>If <replaceable>args</replaceable> are store paths
<listitem><para>If <emphasis>args</emphasis> are store paths
that are not store derivations, then these are <link
linkend="rsec-nix-store-realise">realised</link> and
installed.</para></listitem>
@ -518,7 +518,7 @@ $ nix-env -f '&lt;nixpkgs>' -iA hello --dry-run
installing ‘hello-2.10’
this path will be fetched (0.04 MiB download, 0.19 MiB unpacked):
/nix/store/wkhdf9jinag5750mqlax6z2zbwhqb76n-hello-2.10
<replaceable>...</replaceable></screen>
<emphasis>...</emphasis></screen>
</para>
@ -556,7 +556,7 @@ $ nix-env -f https://github.com/NixOS/nixpkgs/archive/nixos-14.12.tar.gz -iA fir
<arg choice='plain'><option>--eq</option></arg>
<arg choice='plain'><option>--always</option></arg>
</group>
<arg choice='plain' rep='repeat'><replaceable>args</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>args</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -566,15 +566,15 @@ $ nix-env -f https://github.com/NixOS/nixpkgs/archive/nixos-14.12.tar.gz -iA fir
<para>The upgrade operation creates a new user environment, based on
the current generation of the active profile, in which all store paths
are replaced for which there are newer versions in the set of paths
described by <replaceable>args</replaceable>. Paths for which there
described by <emphasis>args</emphasis>. Paths for which there
are no newer versions are left untouched; this is not an error. It is
also not an error if an element of <replaceable>args</replaceable>
also not an error if an element of <emphasis>args</emphasis>
matches no installed derivations.</para>
<para>For a description of how <replaceable>args</replaceable> is
<para>For a description of how <emphasis>args</emphasis> is
mapped to a set of store paths, see <link
linkend="rsec-nix-env-install"><option>--install</option></link>. If
<replaceable>args</replaceable> describes multiple store paths with
<emphasis>args</emphasis> describes multiple store paths with
the same symbolic name, only the one with the highest version is
installed.</para>
@ -711,7 +711,7 @@ lexicographically (i.e., using case-sensitive string comparison).</para>
<arg choice='plain'><option>--uninstall</option></arg>
<arg choice='plain'><option>-e</option></arg>
</group>
<arg choice='plain' rep='repeat'><replaceable>drvnames</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>drvnames</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -720,7 +720,7 @@ lexicographically (i.e., using case-sensitive string comparison).</para>
<para>The uninstall operation creates a new user environment, based on
the current generation of the active profile, from which the store
paths designated by the symbolic names
<replaceable>names</replaceable> are removed.</para>
<emphasis>names</emphasis> are removed.</para>
</refsection>
@ -745,7 +745,7 @@ $ nix-env -e '.*' <lineannotation>(remove everything)</lineannotation></screen>
<cmdsynopsis>
<command>nix-env</command>
<arg choice='plain'><option>--set</option></arg>
<arg choice='plain'><replaceable>drvname</replaceable></arg>
<arg choice='plain'><emphasis>drvname</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -783,9 +783,9 @@ $ nix-env -p /nix/var/nix/profiles/browser --set firefox</screen>
<cmdsynopsis>
<command>nix-env</command>
<arg choice='plain'><option>--set-flag</option></arg>
<arg choice='plain'><replaceable>name</replaceable></arg>
<arg choice='plain'><replaceable>value</replaceable></arg>
<arg choice='plain' rep='repeat'><replaceable>drvnames</replaceable></arg>
<arg choice='plain'><emphasis>name</emphasis></arg>
<arg choice='plain'><emphasis>value</emphasis></arg>
<arg choice='plain' rep='repeat'><emphasis>drvnames</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -848,8 +848,8 @@ firefox-2.0.0.9 <lineannotation>(the current one)</lineannotation>
$ nix-env --preserve-installed -i firefox-2.0.0.11
installing `firefox-2.0.0.11'
building path(s) `/nix/store/myy0y59q3ig70dgq37jqwg1j0rsapzsl-user-environment'
collision between `/nix/store/<replaceable>...</replaceable>-firefox-2.0.0.11/bin/firefox'
and `/nix/store/<replaceable>...</replaceable>-firefox-2.0.0.9/bin/firefox'.
collision between `/nix/store/<emphasis>...</emphasis>-firefox-2.0.0.11/bin/firefox'
and `/nix/store/<emphasis>...</emphasis>-firefox-2.0.0.9/bin/firefox'.
<lineannotation>(i.e., can’t have two active at the same time)</lineannotation>
$ nix-env --set-flag active false firefox
@ -940,12 +940,12 @@ $ nix-env --set-flag priority 10 gcc</screen>
<arg choice='plain'><option>--attr</option></arg>
<arg choice='plain'><option>-A</option></arg>
</group>
<replaceable>attribute-path</replaceable>
<emphasis>attribute-path</emphasis>
</arg>
<sbr />
<arg choice='plain' rep='repeat'><replaceable>names</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>names</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -959,7 +959,7 @@ profile (<option>--installed</option>), or the derivations that are
available for installation in the active Nix expression
(<option>--available</option>). It only prints information about
derivations whose symbolic name matches one of
<replaceable>names</replaceable>.</para>
<emphasis>names</emphasis>.</para>
<para>The derivations are sorted by their <literal>name</literal>
attributes.</para>
@ -1086,21 +1086,21 @@ user environment elements, etc. -->
<variablelist>
<varlistentry><term><literal>&lt;</literal> <replaceable>version</replaceable></term>
<varlistentry><term><literal>&lt;</literal> <emphasis>version</emphasis></term>
<listitem><para>A newer version of the package is available
or installed.</para></listitem>
</varlistentry>
<varlistentry><term><literal>=</literal> <replaceable>version</replaceable></term>
<varlistentry><term><literal>=</literal> <emphasis>version</emphasis></term>
<listitem><para>At most the same version of the package is
available or installed.</para></listitem>
</varlistentry>
<varlistentry><term><literal>></literal> <replaceable>version</replaceable></term>
<varlistentry><term><literal>></literal> <emphasis>version</emphasis></term>
<listitem><para>Only older versions of the package are
available or installed.</para></listitem>
@ -1174,7 +1174,7 @@ docbook-xml-4.2
firefox-1.0.4
MPlayer-1.0pre7
ORBit2-2.8.3
<replaceable>…</replaceable>
<emphasis>…</emphasis>
</screen>
</para>
@ -1187,7 +1187,7 @@ firefox-1.0.7
GConf-2.4.0.1
MPlayer-1.0pre7
ORBit2-2.8.3
<replaceable>…</replaceable>
<emphasis>…</emphasis>
</screen>
</para>
@ -1200,7 +1200,7 @@ $ nix-env -qas
--S GConf-2.4.0.1 <lineannotation>(not present, but there is a substitute for fast installation)</lineannotation>
--S MPlayer-1.0pre3 <lineannotation>(i.e., this is not the installed MPlayer, even though the version is the same!)</lineannotation>
IP- ORBit2-2.8.3 <lineannotation>(installed and by definition present)</lineannotation>
<replaceable>…</replaceable>
<emphasis>…</emphasis>
</screen>
</para>
@ -1218,11 +1218,11 @@ foo-1.2.3
<screen>
$ nix-env -qc
<replaceable>...</replaceable>
<emphasis>...</emphasis>
acrobat-reader-7.0 - ? <lineannotation>(package is not available at all)</lineannotation>
autoconf-2.59 = 2.59 <lineannotation>(same version)</lineannotation>
firefox-1.0.4 &lt; 1.0.7 <lineannotation>(a more recent version is available)</lineannotation>
<replaceable>...</replaceable>
<emphasis>...</emphasis>
</screen>
</para>
@ -1234,7 +1234,7 @@ $ nix-env -qa '.*zip.*'
bzip2-1.0.6
gzip-1.6
zip-3.0
<replaceable>…</replaceable>
<emphasis>…</emphasis>
</screen>
</para>
@ -1248,7 +1248,7 @@ chromium-37.0.2062.94
chromium-beta-38.0.2125.24
firefox-32.0.3
firefox-with-plugins-13.0.1
<replaceable>…</replaceable>
<emphasis>…</emphasis>
</screen>
</para>
@ -1280,7 +1280,7 @@ $ nix-env -f https://github.com/NixOS/nixpkgs/archive/master.tar.gz -qa
<arg choice='plain'><option>--switch-profile</option></arg>
<arg choice='plain'><option>-S</option></arg>
</group>
<arg choice='req'><replaceable>path</replaceable></arg>
<arg choice='req'><emphasis>path</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -1288,10 +1288,10 @@ $ nix-env -f https://github.com/NixOS/nixpkgs/archive/master.tar.gz -qa
<refsection><title>Description</title>
<para>This operation makes <replaceable>path</replaceable> the current
<para>This operation makes <emphasis>path</emphasis> the current
profile for the user. That is, the symlink
<filename>~/.nix-profile</filename> is made to point to
<replaceable>path</replaceable>.</para>
<emphasis>path</emphasis>.</para>
</refsection>
@ -1355,7 +1355,7 @@ $ nix-env --list-generations
<cmdsynopsis>
<command>nix-env</command>
<arg choice='plain'><option>--delete-generations</option></arg>
<arg choice='plain' rep='repeat'><replaceable>generations</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>generations</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -1407,7 +1407,7 @@ $ nix-env -p other_profile --delete-generations old</screen>
<arg choice='plain'><option>--switch-generation</option></arg>
<arg choice='plain'><option>-G</option></arg>
</group>
<arg choice='req'><replaceable>generation</replaceable></arg>
<arg choice='req'><emphasis>generation</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -1416,13 +1416,13 @@ $ nix-env -p other_profile --delete-generations old</screen>
<refsection><title>Description</title>
<para>This operation makes generation number
<replaceable>generation</replaceable> the current generation of the
<emphasis>generation</emphasis> the current generation of the
active profile. That is, if the
<filename><replaceable>profile</replaceable></filename> is the path to
<filename><emphasis>profile</emphasis></filename> is the path to
the active profile, then the symlink
<filename><replaceable>profile</replaceable></filename> is made to
<filename><emphasis>profile</emphasis></filename> is made to
point to
<filename><replaceable>profile</replaceable>-<replaceable>generation</replaceable>-link</filename>,
<filename><emphasis>profile</emphasis>-<emphasis>generation</emphasis>-link</filename>,
which is in turn a symlink to the actual user environment in the Nix
store.</para>

24
doc/manual/command-ref/nix-hash.xml
View file

@ -22,18 +22,18 @@
<arg><option>--flat</option></arg>
<arg><option>--base32</option></arg>
<arg><option>--truncate</option></arg>
<arg><option>--type</option> <replaceable>hashAlgo</replaceable></arg>
<arg choice='plain' rep='repeat'><replaceable>path</replaceable></arg>
<arg><option>--type</option> <emphasis>hashAlgo</emphasis></arg>
<arg choice='plain' rep='repeat'><emphasis>path</emphasis></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>nix-hash</command>
<arg choice='plain'><option>--to-base16</option></arg>
<arg choice='plain' rep='repeat'><replaceable>hash</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>hash</emphasis></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>nix-hash</command>
<arg choice='plain'><option>--to-base32</option></arg>
<arg choice='plain' rep='repeat'><replaceable>hash</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>hash</emphasis></arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -42,7 +42,7 @@
<para>The command <command>nix-hash</command> computes the
cryptographic hash of the contents of each
<replaceable>path</replaceable> and prints it on standard output. By
<emphasis>path</emphasis> and prints it on standard output. By
default, it computes an MD5 hash, but other hash algorithms are
available as well. The hash is printed in hexadecimal. To generate
the same hash as <command>nix-prefetch-url</command> you have to
@ -54,9 +54,9 @@ allows directories and symlinks to be hashed as well as regular files.
The dump is in the <emphasis>NAR format</emphasis> produced by <link
linkend="refsec-nix-store-dump"><command>nix-store</command>
<option>--dump</option></link>. Thus, <literal>nix-hash
<replaceable>path</replaceable></literal> yields the same
<emphasis>path</emphasis></literal> yields the same
cryptographic hash as <literal>nix-store --dump
<replaceable>path</replaceable> | md5sum</literal>.</para>
<emphasis>path</emphasis> | md5sum</literal>.</para>
</refsection>
@ -68,9 +68,9 @@ cryptographic hash as <literal>nix-store --dump
<varlistentry><term><option>--flat</option></term>
<listitem><para>Print the cryptographic hash of the contents of
each regular file <replaceable>path</replaceable>. That is, do
each regular file <emphasis>path</emphasis>. That is, do
not compute the hash over the dump of
<replaceable>path</replaceable>. The result is identical to that
<emphasis>path</emphasis>. The result is identical to that
produced by the GNU commands <command>md5sum</command> and
<command>sha1sum</command>.</para></listitem>
@ -92,7 +92,7 @@ cryptographic hash as <literal>nix-store --dump
</varlistentry>
<varlistentry><term><option>--type</option> <replaceable>hashAlgo</replaceable></term>
<varlistentry><term><option>--type</option> <emphasis>hashAlgo</emphasis></term>
<listitem><para>Use the specified cryptographic hash algorithm,
which can be one of <literal>md5</literal>,
@ -104,7 +104,7 @@ cryptographic hash as <literal>nix-store --dump
<varlistentry><term><option>--to-base16</option></term>
<listitem><para>Don’t hash anything, but convert the base-32 hash
representation <replaceable>hash</replaceable> to
representation <emphasis>hash</emphasis> to
hexadecimal.</para></listitem>
</varlistentry>
@ -112,7 +112,7 @@ cryptographic hash as <literal>nix-store --dump
<varlistentry><term><option>--to-base32</option></term>
<listitem><para>Don’t hash anything, but convert the hexadecimal
hash representation <replaceable>hash</replaceable> to
hash representation <emphasis>hash</emphasis> to
base-32.</para></listitem>
</varlistentry>

28
doc/manual/command-ref/nix-instantiate.xml
View file

@ -29,26 +29,26 @@
</arg>
</group>
<arg><option>--read-write-mode</option></arg>
<arg><option>--arg</option> <replaceable>name</replaceable> <replaceable>value</replaceable></arg>
<arg><option>--arg</option> <emphasis>name</emphasis> <emphasis>value</emphasis></arg>
<arg>
<group choice='req'>
<arg choice='plain'><option>--attr</option></arg>
<arg choice='plain'><option>-A</option></arg>
</group>
<replaceable>attrPath</replaceable>
<emphasis>attrPath</emphasis>
</arg>
<arg><option>--add-root</option> <replaceable>path</replaceable></arg>
<arg><option>--add-root</option> <emphasis>path</emphasis></arg>
<arg><option>--indirect</option></arg>
<group>
<arg choice='plain'><option>--expr</option></arg>
<arg choice='plain'><option>-E</option></arg>
</group>
<arg choice='plain' rep='repeat'><replaceable>files</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>files</emphasis></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>nix-instantiate</command>
<arg choice='plain'><option>--find-file</option></arg>
<arg choice='plain' rep='repeat'><replaceable>files</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>files</emphasis></arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -58,13 +58,13 @@
<para>The command <command>nix-instantiate</command> generates <link
linkend="gloss-derivation">store derivations</link> from (high-level)
Nix expressions. It evaluates the Nix expressions in each of
<replaceable>files</replaceable> (which defaults to
<replaceable>./default.nix</replaceable>). Each top-level expression
<emphasis>files</emphasis> (which defaults to
<emphasis>./default.nix</emphasis>). Each top-level expression
should evaluate to a derivation, a list of derivations, or a set of
derivations. The paths of the resulting store derivations are printed
on standard output.</para>
<para>If <replaceable>files</replaceable> is the character
<para>If <emphasis>files</emphasis> is the character
<literal>-</literal>, then a Nix expression will be read from standard
input.</para>
@ -79,7 +79,7 @@ input.</para>
<variablelist>
<varlistentry>
<term><option>--add-root</option> <replaceable>path</replaceable></term>
<term><option>--add-root</option> <emphasis>path</emphasis></term>
<term><option>--indirect</option></term>
<listitem><para>See the <link linkend="opt-add-root">corresponding
@ -181,7 +181,7 @@ $ nix-instantiate test.nix <lineannotation>(instantiate)</lineannotation>
/nix/store/cigxbmvy6dzix98dxxh9b6shg7ar5bvs-perl-BerkeleyDB-0.26.drv
$ nix-store -r $(nix-instantiate test.nix) <lineannotation>(build)</lineannotation>
<replaceable>...</replaceable>
<emphasis>...</emphasis>
/nix/store/qhqk4n8ci095g3sdp93x7rgwyh9rdvgk-perl-BerkeleyDB-0.26 <lineannotation>(output path)</lineannotation>
$ ls -l /nix/store/qhqk4n8ci095g3sdp93x7rgwyh9rdvgk-perl-BerkeleyDB-0.26
@ -226,28 +226,28 @@ $ nix-instantiate --eval --xml -E '1 + 2'
<screen>
$ nix-instantiate --eval --xml -E 'rec { x = "foo"; y = x; }'
<replaceable>...</replaceable><![CDATA[
<emphasis>...</emphasis><![CDATA[
<attr name="x">
<string value="foo" />
</attr>
<attr name="y">
<unevaluated />
</attr>]]>
<replaceable>...</replaceable></screen>
<emphasis>...</emphasis></screen>
Note that <varname>y</varname> is left unevaluated (the XML
representation doesn’t attempt to show non-normal forms).
<screen>
$ nix-instantiate --eval --xml --strict -E 'rec { x = "foo"; y = x; }'
<replaceable>...</replaceable><![CDATA[
<emphasis>...</emphasis><![CDATA[
<attr name="x">
<string value="foo" />
</attr>
<attr name="y">
<string value="foo" />
</attr>]]>
<replaceable>...</replaceable></screen>
<emphasis>...</emphasis></screen>
</para>

30
doc/manual/command-ref/nix-prefetch-url.xml
View file

@ -20,24 +20,24 @@
<cmdsynopsis>
<command>nix-prefetch-url</command>
<arg><option>--version</option></arg>
<arg><option>--type</option> <replaceable>hashAlgo</replaceable></arg>
<arg><option>--type</option> <emphasis>hashAlgo</emphasis></arg>
<arg><option>--print-path</option></arg>
<arg><option>--unpack</option></arg>
<arg><option>--name</option> <replaceable>name</replaceable></arg>
<arg choice='plain'><replaceable>url</replaceable></arg>
<arg><replaceable>hash</replaceable></arg>
<arg><option>--name</option> <emphasis>name</emphasis></arg>
<arg choice='plain'><emphasis>url</emphasis></arg>
<arg><emphasis>hash</emphasis></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection><title>Description</title>
<para>The command <command>nix-prefetch-url</command> downloads the
file referenced by the URL <replaceable>url</replaceable>, prints its
file referenced by the URL <emphasis>url</emphasis>, prints its
cryptographic hash, and copies it into the Nix store. The file name
in the store is
<filename><replaceable>hash</replaceable>-<replaceable>baseName</replaceable></filename>,
where <replaceable>baseName</replaceable> is everything following the
final slash in <replaceable>url</replaceable>.</para>
<filename><emphasis>hash</emphasis>-<emphasis>baseName</emphasis></filename>,
where <emphasis>baseName</emphasis> is everything following the
final slash in <emphasis>url</emphasis>.</para>
<para>This command is just a convenience for Nix expression writers.
Often a Nix expression fetches some source distribution from the
@ -50,7 +50,7 @@ download it again when you build your Nix expression. Since
as <command>nix-prefetch-url</command>, the redundant download can be
avoided.</para>
<para>If <replaceable>hash</replaceable> is specified, then a download
<para>If <emphasis>hash</emphasis> is specified, then a download
is not performed if the Nix store already contains a file with the
same hash and base name. Otherwise, the file is downloaded, and an
error is signaled if the actual hash of the file does not match the
@ -67,7 +67,7 @@ downloaded file in the Nix store is also printed.</para>
<variablelist>
<varlistentry><term><option>--type</option> <replaceable>hashAlgo</replaceable></term>
<varlistentry><term><option>--type</option> <emphasis>hashAlgo</emphasis></term>
<listitem><para>Use the specified cryptographic hash algorithm,
which can be one of <literal>md5</literal>,
@ -93,14 +93,14 @@ downloaded file in the Nix store is also printed.</para>
</varlistentry>
<varlistentry><term><option>--name</option> <replaceable>name</replaceable></term>
<varlistentry><term><option>--name</option> <emphasis>name</emphasis></term>
<listitem><para>Override the name of the file in the Nix store. By
default, this is
<literal><replaceable>hash</replaceable>-<replaceable>basename</replaceable></literal>,
where <replaceable>basename</replaceable> is the last component of
<replaceable>url</replaceable>. Overriding the name is necessary
when <replaceable>basename</replaceable> contains characters that
<literal><emphasis>hash</emphasis>-<emphasis>basename</emphasis></literal>,
where <emphasis>basename</emphasis> is the last component of
<emphasis>url</emphasis>. Overriding the name is necessary
when <emphasis>basename</emphasis> contains characters that
are not allowed in Nix store paths.</para></listitem>
</varlistentry>

48
doc/manual/command-ref/nix-shell.xml
View file

@ -19,20 +19,20 @@
<refsynopsisdiv>
<cmdsynopsis>
<command>nix-shell</command>
<arg><option>--arg</option> <replaceable>name</replaceable> <replaceable>value</replaceable></arg>
<arg><option>--argstr</option> <replaceable>name</replaceable> <replaceable>value</replaceable></arg>
<arg><option>--arg</option> <emphasis>name</emphasis> <emphasis>value</emphasis></arg>
<arg><option>--argstr</option> <emphasis>name</emphasis> <emphasis>value</emphasis></arg>
<arg>
<group choice='req'>
<arg choice='plain'><option>--attr</option></arg>
<arg choice='plain'><option>-A</option></arg>
</group>
<replaceable>attrPath</replaceable>
<emphasis>attrPath</emphasis>
</arg>
<arg><option>--command</option> <replaceable>cmd</replaceable></arg>
<arg><option>--run</option> <replaceable>cmd</replaceable></arg>
<arg><option>--exclude</option> <replaceable>regexp</replaceable></arg>
<arg><option>--command</option> <emphasis>cmd</emphasis></arg>
<arg><option>--run</option> <emphasis>cmd</emphasis></arg>
<arg><option>--exclude</option> <emphasis>regexp</emphasis></arg>
<arg><option>--pure</option></arg>
<arg><option>--keep</option> <replaceable>name</replaceable></arg>
<arg><option>--keep</option> <emphasis>name</emphasis></arg>
<group choice='req'>
<arg choice='plain'>
<group choice='req'>
@ -41,12 +41,12 @@
</group>
<arg choice='plain' rep='repeat'>
<group choice='req'>
<arg choice="plain"><replaceable>packages</replaceable></arg>
<arg choice="plain"><replaceable>expressions</replaceable></arg>
<arg choice="plain"><emphasis>packages</emphasis></arg>
<arg choice="plain"><emphasis>expressions</emphasis></arg>
</group>
</arg>
</arg>
<arg><replaceable>path</replaceable></arg>
<arg><emphasis>path</emphasis></arg>
</group>
</cmdsynopsis>
</refsynopsisdiv>
@ -57,17 +57,17 @@
dependencies of the specified derivation, but not the derivation
itself. It will then start an interactive shell in which all
environment variables defined by the derivation
<replaceable>path</replaceable> have been set to their corresponding
<emphasis>path</emphasis> have been set to their corresponding
values, and the script <literal>$stdenv/setup</literal> has been
sourced. This is useful for reproducing the environment of a
derivation for development.</para>
<para>If <replaceable>path</replaceable> is not given,
<para>If <emphasis>path</emphasis> is not given,
<command>nix-shell</command> defaults to
<filename>shell.nix</filename> if it exists, and
<filename>default.nix</filename> otherwise.</para>
<para>If <replaceable>path</replaceable> starts with
<para>If <emphasis>path</emphasis> starts with
<literal>http://</literal> or <literal>https://</literal>, it is
interpreted as the URL of a tarball that will be downloaded and
unpacked to a temporary location. The tarball must include a single
@ -103,10 +103,10 @@ also <xref linkend="sec-common-options" />.</phrase></para>
<variablelist>
<varlistentry><term><option>--command</option> <replaceable>cmd</replaceable></term>
<varlistentry><term><option>--command</option> <emphasis>cmd</emphasis></term>
<listitem><para>In the environment of the derivation, run the
shell command <replaceable>cmd</replaceable>. This command is
shell command <emphasis>cmd</emphasis>. This command is
executed in an interactive shell. (Use <option>--run</option> to
use a non-interactive shell instead.) However, a call to
<literal>exit</literal> is implicitly added to the command, so the
@ -118,7 +118,7 @@ also <xref linkend="sec-common-options" />.</phrase></para>
</varlistentry>
<varlistentry><term><option>--run</option> <replaceable>cmd</replaceable></term>
<varlistentry><term><option>--run</option> <emphasis>cmd</emphasis></term>
<listitem><para>Like <option>--command</option>, but executes the
command in a non-interactive shell. This means (among other
@ -127,10 +127,10 @@ also <xref linkend="sec-common-options" />.</phrase></para>
</varlistentry>
<varlistentry><term><option>--exclude</option> <replaceable>regexp</replaceable></term>
<varlistentry><term><option>--exclude</option> <emphasis>regexp</emphasis></term>
<listitem><para>Do not build any dependencies whose store path
matches the regular expression <replaceable>regexp</replaceable>.
matches the regular expression <emphasis>regexp</emphasis>.
This option may be specified multiple times.</para></listitem>
</varlistentry>
@ -150,7 +150,7 @@ also <xref linkend="sec-common-options" />.</phrase></para>
</varlistentry>
<varlistentry><term><option>--packages</option> / <option>-p</option> <replaceable>packages</replaceable>…</term>
<varlistentry><term><option>--packages</option> / <option>-p</option> <emphasis>packages</emphasis>…</term>
<listitem><para>Set up an environment in which the specified
packages are present. The command line arguments are interpreted
@ -162,7 +162,7 @@ also <xref linkend="sec-common-options" />.</phrase></para>
</varlistentry>
<varlistentry><term><option>-i</option> <replaceable>interpreter</replaceable></term>
<varlistentry><term><option>-i</option> <emphasis>interpreter</emphasis></term>
<listitem><para>The chained script interpreter to be invoked by
<command>nix-shell</command>. Only applicable in
@ -171,7 +171,7 @@ also <xref linkend="sec-common-options" />.</phrase></para>
</listitem></varlistentry>
<varlistentry><term><option>--keep</option> <replaceable>name</replaceable></term>
<varlistentry><term><option>--keep</option> <emphasis>name</emphasis></term>
<listitem><para>When a <option>--pure</option> shell is started,
keep the listed environment variables.</para></listitem>
@ -278,13 +278,13 @@ following lines:
<programlisting>
#! /usr/bin/env nix-shell
#! nix-shell -i <replaceable>real-interpreter</replaceable> -p <replaceable>packages</replaceable>
#! nix-shell -i <emphasis>real-interpreter</emphasis> -p <emphasis>packages</emphasis>
</programlisting>
where <replaceable>real-interpreter</replaceable> is the “real” script
where <emphasis>real-interpreter</emphasis> is the “real” script
interpreter that will be invoked by <command>nix-shell</command> after
it has obtained the dependencies and initialised the environment, and
<replaceable>packages</replaceable> are the attribute names of the
<emphasis>packages</emphasis> are the attribute names of the
dependencies in Nixpkgs.</para>
<para>The lines starting with <literal>#! nix-shell</literal> specify

122
doc/manual/command-ref/nix-store.xml
View file

@ -20,11 +20,11 @@
<cmdsynopsis>
<command>nix-store</command>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="opt-common-syn.xml#xmlns(db=http://docbook.org/ns/docbook)xpointer(/db:nop/*)" />
<arg><option>--add-root</option> <replaceable>path</replaceable></arg>
<arg><option>--add-root</option> <emphasis>path</emphasis></arg>
<arg><option>--indirect</option></arg>
<arg choice='plain'><replaceable>operation</replaceable></arg>
<arg rep='repeat'><replaceable>options</replaceable></arg>
<arg rep='repeat'><replaceable>arguments</replaceable></arg>
<arg choice='plain'><emphasis>operation</emphasis></arg>
<arg rep='repeat'><emphasis>options</emphasis></arg>
<arg rep='repeat'><emphasis>arguments</emphasis></arg>
</cmdsynopsis>
</refsynopsisdiv>
@ -55,14 +55,14 @@ options.</phrase></para>
<variablelist>
<varlistentry xml:id="opt-add-root"><term><option>--add-root</option> <replaceable>path</replaceable></term>
<varlistentry xml:id="opt-add-root"><term><option>--add-root</option> <emphasis>path</emphasis></term>
<listitem><para>Causes the result of a realisation
(<option>--realise</option> and <option>--force-realise</option>)
to be registered as a root of the garbage collector<phrase
condition="manual"> (see <xref linkend="ssec-gc-roots"
/>)</phrase>. The root is stored in
<replaceable>path</replaceable>, which must be inside a directory
<emphasis>path</emphasis>, which must be inside a directory
that is scanned for roots by the garbage collector (i.e.,
typically in a subdirectory of
<filename>/nix/var/nix/gcroots/</filename>)
@ -88,11 +88,11 @@ options.</phrase></para>
garbage-collected unless the symlink is removed.</para>
<para>The <option>--indirect</option> flag causes a uniquely named
symlink to <replaceable>path</replaceable> to be stored in
symlink to <emphasis>path</emphasis> to be stored in
<filename>/nix/var/nix/gcroots/auto/</filename>. For instance,
<screen>
$ nix-store --add-root /home/eelco/bla/result --indirect -r <replaceable>...</replaceable>
$ nix-store --add-root /home/eelco/bla/result --indirect -r <emphasis>...</emphasis>
$ ls -l /nix/var/nix/gcroots/auto
lrwxrwxrwx 1 ... 2005-03-13 21:10 dn54lcypm8f8... -> /home/eelco/bla/result
@ -135,7 +135,7 @@ lrwxrwxrwx 1 ... 2005-03-13 21:10 /home/eelco/bla/result -> /nix/store/1r1134
<arg choice='plain'><option>--realise</option></arg>
<arg choice='plain'><option>-r</option></arg>
</group>
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>paths</emphasis></arg>
<arg><option>--dry-run</option></arg>
</cmdsynopsis>
@ -204,7 +204,7 @@ printed.)</para>
with <option>-K</option>, if an output path is not identical to
the corresponding output from the previous build, the new output
path is left in
<filename>/nix/store/<replaceable>name</replaceable>.check.</filename></para>
<filename>/nix/store/<emphasis>name</emphasis>.check.</filename></para>
<para>See also the <option>build-repeat</option> configuration
option, which repeats a derivation a number of times and prevents
@ -361,7 +361,7 @@ EOF
<arg choice='plain'><option>--print-live</option></arg>
<arg choice='plain'><option>--print-dead</option></arg>
</group>
<arg><option>--max-freed</option> <replaceable>bytes</replaceable></arg>
<arg><option>--max-freed</option> <emphasis>bytes</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -413,11 +413,11 @@ options control what gets deleted and in what order:
<variablelist>
<varlistentry><term><option>--max-freed</option> <replaceable>bytes</replaceable></term>
<varlistentry><term><option>--max-freed</option> <emphasis>bytes</emphasis></term>
<listitem><para>Keep deleting paths until at least
<replaceable>bytes</replaceable> bytes have been deleted, then
stop. The argument <replaceable>bytes</replaceable> can be
<emphasis>bytes</emphasis> bytes have been deleted, then
stop. The argument <emphasis>bytes</emphasis> can be
followed by the multiplicative suffix <literal>K</literal>,
<literal>M</literal>, <literal>G</literal> or
<literal>T</literal>, denoting KiB, MiB, GiB or TiB
@ -450,7 +450,7 @@ be freed.</para>
<screen>
$ nix-store --gc
deleting `/nix/store/kq82idx6g0nyzsp2s14gfsc38npai7lf-cairo-1.0.4.tar.gz.drv'
<replaceable>...</replaceable>
<emphasis>...</emphasis>
8825586 bytes freed (8.42 MiB)</screen>
</para>
@ -479,7 +479,7 @@ $ nix-store --gc --max-freed $((100 * 1024 * 1024))</screen>
<command>nix-store</command>
<arg choice='plain'><option>--delete</option></arg>
<arg><option>--ignore-liveness</option></arg>
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>paths</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -487,7 +487,7 @@ $ nix-store --gc --max-freed $((100 * 1024 * 1024))</screen>
<refsection><title>Description</title>
<para>The operation <option>--delete</option> deletes the store paths
<replaceable>paths</replaceable> from the Nix store, but only if it is
<emphasis>paths</emphasis> from the Nix store, but only if it is
safe to do so; that is, when the path is not reachable from a root of
the garbage collector. This means that you can only delete paths that
would also be deleted by <literal>nix-store --gc</literal>. Thus,
@ -537,8 +537,8 @@ error: cannot delete path `/nix/store/zq0h41l75vlb4z45kzgjjmsjxvcv1qk7-mesa-6.4'
<arg choice='plain'><option>-d</option></arg>
<arg choice='plain'><option>--graph</option></arg>
<arg choice='plain'><option>--tree</option></arg>
<arg choice='plain'><option>--binding</option> <replaceable>name</replaceable></arg>
<arg choice='plain'><option>-b</option> <replaceable>name</replaceable></arg>
<arg choice='plain'><option>--binding</option> <emphasis>name</emphasis></arg>
<arg choice='plain'><option>-b</option> <emphasis>name</emphasis></arg>
<arg choice='plain'><option>--hash</option></arg>
<arg choice='plain'><option>--size</option></arg>
<arg choice='plain'><option>--roots</option></arg>
@ -547,7 +547,7 @@ error: cannot delete path `/nix/store/zq0h41l75vlb4z45kzgjjmsjxvcv1qk7-mesa-6.4'
<arg><option>-u</option></arg>
<arg><option>--force-realise</option></arg>
<arg><option>-f</option></arg>
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>paths</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -560,7 +560,7 @@ information about the store paths . The queries are described below. At
most one query can be specified. The default query is
<option>--outputs</option>.</para>
<para>The paths <replaceable>paths</replaceable> may also be symlinks
<para>The paths <emphasis>paths</emphasis> may also be symlinks
from outside of the Nix store, to the Nix store. In that case, the
query is applied to the target of the symlink.</para>
@ -603,7 +603,7 @@ query is applied to the target of the symlink.</para>
<listitem><para>Prints out the <link
linkend="gloss-output-path">output paths</link> of the store
derivations <replaceable>paths</replaceable>. These are the paths
derivations <emphasis>paths</emphasis>. These are the paths
that will be produced when the derivation is
built.</para></listitem>
@ -614,7 +614,7 @@ query is applied to the target of the symlink.</para>
<listitem><para>Prints out the <link
linkend="gloss-closure">closure</link> of the store path
<replaceable>paths</replaceable>.</para>
<emphasis>paths</emphasis>.</para>
<para>This query has one option:</para>
@ -647,7 +647,7 @@ query is applied to the target of the symlink.</para>
<listitem><para>Prints the set of <link
linkend="gloss-reference">references</link> of the store paths
<replaceable>paths</replaceable>, that is, their immediate
<emphasis>paths</emphasis>, that is, their immediate
dependencies. (For <emphasis>all</emphasis> dependencies, use
<option>--requisites</option>.)</para></listitem>
@ -656,9 +656,9 @@ query is applied to the target of the symlink.</para>
<varlistentry><term><option>--referrers</option></term>
<listitem><para>Prints the set of <emphasis>referrers</emphasis> of
the store paths <replaceable>paths</replaceable>, that is, the
the store paths <emphasis>paths</emphasis>, that is, the
store paths currently existing in the Nix store that refer to one
of <replaceable>paths</replaceable>. Note that contrary to the
of <emphasis>paths</emphasis>. Note that contrary to the
references, the set of referrers is not constant; it can change as
store paths are added or removed.</para></listitem>
@ -667,11 +667,11 @@ query is applied to the target of the symlink.</para>
<varlistentry><term><option>--referrers-closure</option></term>
<listitem><para>Prints the closure of the set of store paths
<replaceable>paths</replaceable> under the referrers relation; that
<emphasis>paths</emphasis> under the referrers relation; that
is, all store paths that directly or indirectly refer to one of
<replaceable>paths</replaceable>. These are all the path currently
<emphasis>paths</emphasis>. These are all the path currently
in the Nix store that are dependent on
<replaceable>paths</replaceable>.</para></listitem>
<emphasis>paths</emphasis>.</para></listitem>
</varlistentry>
@ -680,7 +680,7 @@ query is applied to the target of the symlink.</para>
<listitem><para>Prints the <link
linkend="gloss-deriver">deriver</link> of the store paths
<replaceable>paths</replaceable>. If the path has no deriver
<emphasis>paths</emphasis>. If the path has no deriver
(e.g., if it is a source file), or if the deriver is not known
(e.g., in the case of a binary-only deployment), the string
<literal>unknown-deriver</literal> is printed.</para></listitem>
@ -690,7 +690,7 @@ query is applied to the target of the symlink.</para>
<varlistentry><term><option>--graph</option></term>
<listitem><para>Prints the references graph of the store paths
<replaceable>paths</replaceable> in the format of the
<emphasis>paths</emphasis> in the format of the
<command>dot</command> tool of AT&amp;T's <link
xlink:href="http://www.graphviz.org/">Graphviz package</link>.
This can be used to visualise dependency graphs. To obtain a
@ -703,7 +703,7 @@ query is applied to the target of the symlink.</para>
<varlistentry><term><option>--tree</option></term>
<listitem><para>Prints the references graph of the store paths
<replaceable>paths</replaceable> as a nested ASCII tree.
<emphasis>paths</emphasis> as a nested ASCII tree.
References are ordered by descending closure size; this tends to
flatten the tree, making it more readable. The query only
recurses into a store path when it is first encountered; this
@ -715,7 +715,7 @@ query is applied to the target of the symlink.</para>
<varlistentry><term><option>--graphml</option></term>
<listitem><para>Prints the references graph of the store paths
<replaceable>paths</replaceable> in the <link
<emphasis>paths</emphasis> in the <link
xlink:href="http://graphml.graphdrawing.org/">GraphML</link> file format.
This can be used to visualise dependency graphs. To obtain a
build-time dependency graph, apply this to a store derivation. To
@ -724,12 +724,12 @@ query is applied to the target of the symlink.</para>
</varlistentry>
<varlistentry><term><option>--binding</option> <replaceable>name</replaceable></term>
<term><option>-b</option> <replaceable>name</replaceable></term>
<varlistentry><term><option>--binding</option> <emphasis>name</emphasis></term>
<term><option>-b</option> <emphasis>name</emphasis></term>
<listitem><para>Prints the value of the attribute
<replaceable>name</replaceable> (i.e., environment variable) of
the store derivations <replaceable>paths</replaceable>. It is an
<emphasis>name</emphasis> (i.e., environment variable) of
the store derivations <emphasis>paths</emphasis>. It is an
error for a derivation to not have the specified
attribute.</para></listitem>
@ -738,7 +738,7 @@ query is applied to the target of the symlink.</para>
<varlistentry><term><option>--hash</option></term>
<listitem><para>Prints the SHA-256 hash of the contents of the
store paths <replaceable>paths</replaceable> (that is, the hash of
store paths <emphasis>paths</emphasis> (that is, the hash of
the output of <command>nix-store --dump</command> on the given
paths). Since the hash is stored in the Nix database, this is a
fast operation.</para></listitem>
@ -748,7 +748,7 @@ query is applied to the target of the symlink.</para>
<varlistentry><term><option>--size</option></term>
<listitem><para>Prints the size in bytes of the contents of the
store paths <replaceable>paths</replaceable> — to be precise, the
store paths <emphasis>paths</emphasis> — to be precise, the
size of the output of <command>nix-store --dump</command> on the
given paths. Note that the actual disk space required by the
store paths may be higher, especially on filesystems with large
@ -760,7 +760,7 @@ query is applied to the target of the symlink.</para>
<listitem><para>Prints the garbage collector roots that point,
directly or indirectly, at the store paths
<replaceable>paths</replaceable>.</para></listitem>
<emphasis>paths</emphasis>.</para></listitem>
</varlistentry>
@ -778,7 +778,7 @@ query is applied to the target of the symlink.</para>
$ nix-store -qR $(which svn)
/nix/store/5mbglq5ldqld8sj57273aljwkfvj22mc-subversion-1.1.4
/nix/store/9lz9yc6zgmc0vlqmn2ipcpkjlmbi51vv-glibc-2.3.4
<replaceable>...</replaceable></screen>
<emphasis>...</emphasis></screen>
</para>
@ -789,7 +789,7 @@ $ nix-store -qR $(nix-store -qd $(which svn))
/nix/store/02iizgn86m42q905rddvg4ja975bk2i4-grep-2.5.1.tar.bz2.drv
/nix/store/07a2bzxmzwz5hp58nf03pahrv2ygwgs3-gcc-wrapper.sh
/nix/store/0ma7c9wsbaxahwwl04gbw3fcd806ski4-glibc-2.3.4.drv
<replaceable>... lots of other paths ...</replaceable></screen>
<emphasis>... lots of other paths ...</emphasis></screen>
The difference with the previous example is that we ask the closure of
the derivation (<option>-qd</option>), not the closure of the output
@ -804,7 +804,7 @@ $ nix-store -q --tree $(nix-store -qd $(which svn))
+---/nix/store/fmzxmpjx2lh849ph0l36snfj9zdibw67-bash-3.0.drv
| +---/nix/store/570hmhmx3v57605cqg9yfvvyh0nnb8k8-bash
| +---/nix/store/p3srsbd8dx44v2pg6nbnszab5mcwx03v-builder.sh
<replaceable>...</replaceable></screen>
<emphasis>...</emphasis></screen>
</para>
@ -827,7 +827,7 @@ $ nix-store -q --referrers $(nix-store -q --binding openssl $(nix-store -qd $(wh
$ nix-store -q --referrers-closure $(ldd $(which svn) | grep /libc.so | awk '{print $3}')
/nix/store/034a6h4vpz9kds5r6kzb9lhh81mscw43-libgnomeprintui-2.8.2
/nix/store/15l3yi0d45prm7a82pcrknxdh6nzmxza-gawk-3.1.4
<replaceable>...</replaceable></screen>
<emphasis>...</emphasis></screen>
Note that <command>ldd</command> is a command that prints out the
dynamic libraries used by an ELF executable.</para>
@ -893,7 +893,7 @@ $ nix-store -q --roots $(which svn)
<cmdsynopsis>
<command>nix-store</command>
<arg choice='plain'><option>--add</option></arg>
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>paths</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -926,8 +926,8 @@ $ nix-store --add ./foo.c
<command>nix-store</command>
<arg><option>--recursive</option></arg>
<arg choice='plain'><option>--add-fixed</option></arg>
<arg choice='plain'><replaceable>algorithm</replaceable></arg>
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
<arg choice='plain'><emphasis>algorithm</emphasis></arg>
<arg choice='plain' rep='repeat'><emphasis>paths</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -1039,7 +1039,7 @@ in Nix itself.</para>
<cmdsynopsis>
<command>nix-store</command>
<arg choice='plain'><option>--verify-path</option></arg>
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>paths</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -1077,7 +1077,7 @@ $ nix-store --verify-path $(nix-store -qR $(which svn))
<cmdsynopsis>
<command>nix-store</command>
<arg choice='plain'><option>--repair-path</option></arg>
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>paths</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -1123,7 +1123,7 @@ fetching path `/nix/store/d7a81wsm1ijwwpkks3725661h3263p5-glibc-2.13'...
<cmdsynopsis>
<command>nix-store</command>
<arg choice='plain'><option>--dump</option></arg>
<arg choice='plain'><replaceable>path</replaceable></arg>
<arg choice='plain'><emphasis>path</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -1131,7 +1131,7 @@ fetching path `/nix/store/d7a81wsm1ijwwpkks3725661h3263p5-glibc-2.13'...
<para>The operation <option>--dump</option> produces a NAR (Nix
ARchive) file containing the contents of the file system tree rooted
at <replaceable>path</replaceable>. The archive is written to
at <emphasis>path</emphasis>. The archive is written to
standard output.</para>
<para>A NAR archive is like a TAR or Zip archive, but it contains only
@ -1173,14 +1173,14 @@ links, but not other types of files (such as device nodes).</para>
<cmdsynopsis>
<command>nix-store</command>
<arg choice='plain'><option>--restore</option></arg>
<arg choice='plain'><replaceable>path</replaceable></arg>
<arg choice='plain'><emphasis>path</emphasis></arg>
</cmdsynopsis>
</refsection>
<refsection><title>Description</title>
<para>The operation <option>--restore</option> unpacks a NAR archive
to <replaceable>path</replaceable>, which must not already exist. The
to <emphasis>path</emphasis>, which must not already exist. The
archive is read from standard input.</para>
</refsection>
@ -1198,7 +1198,7 @@ archive is read from standard input.</para>
<cmdsynopsis>
<command>nix-store</command>
<arg choice='plain'><option>--export</option></arg>
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>paths</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -1220,7 +1220,7 @@ that are missing in the target Nix store, the import will fail. To
copy a whole closure, do something like:
<screen>
$ nix-store --export $(nix-store -qR <replaceable>paths</replaceable>) > out</screen>
$ nix-store --export $(nix-store -qR <emphasis>paths</emphasis>) > out</screen>
To import the whole closure again, run:
@ -1299,7 +1299,7 @@ progress indication.</para>
<screen>
$ nix-store --optimise
hashing files in `/nix/store/qhqx7l2f1kmwihc9bnxs7rc159hsxnf3-gcc-4.1.1'
<replaceable>...</replaceable>
<emphasis>...</emphasis>
541838819 bytes (516.74 MiB) freed by hard-linking 54143 files;
there are 114486 files with equal contents out of 215894 files in total
</screen>
@ -1322,7 +1322,7 @@ there are 114486 files with equal contents out of 215894 files in total
<arg choice='plain'><option>--read-log</option></arg>
<arg choice='plain'><option>-l</option></arg>
</group>
<arg choice='plain' rep='repeat'><replaceable>paths</replaceable></arg>
<arg choice='plain' rep='repeat'><emphasis>paths</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -1351,7 +1351,7 @@ unpacking sources
unpacking source archive /nix/store/p8n1jpqs27mgkjw07pb5269717nzf5f8-ktorrent-2.2.1.tar.gz
ktorrent-2.2.1/
ktorrent-2.2.1/NEWS
<replaceable>...</replaceable>
<emphasis>...</emphasis>
</screen>
</refsection>
@ -1369,7 +1369,7 @@ ktorrent-2.2.1/NEWS
<cmdsynopsis>
<command>nix-store</command>
<arg choice='plain'><option>--dump-db</option></arg>
<arg rep='repeat'><replaceable>paths</replaceable></arg>
<arg rep='repeat'><emphasis>paths</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -1424,7 +1424,7 @@ loads it into the Nix database.</para>
<cmdsynopsis>
<command>nix-store</command>
<arg choice='plain'><option>--print-env</option></arg>
<arg choice='plain'><replaceable>drvpath</replaceable></arg>
<arg choice='plain'><emphasis>drvpath</emphasis></arg>
</cmdsynopsis>
</refsection>
@ -1441,7 +1441,7 @@ variable <literal>_args</literal>.</para>
<screen>
$ nix-store --print-env $(nix-instantiate '&lt;nixpkgs>' -A firefox)
<replaceable>…</replaceable>
<emphasis>…</emphasis>
export src; src='/nix/store/plpj7qrwcz94z2psh6fchsi7s8yihc7k-firefox-12.0.source.tar.bz2'
export stdenv; stdenv='/nix/store/7c8asx3yfrg5dg1gzhzyq2236zfgibnn-stdenv'
export system; system='x86_64-linux'

16
doc/manual/command-ref/opt-common-syn.xml
View file

@ -13,7 +13,7 @@
</arg>
<arg>
<option>--log-format</option>
<replaceable>format</replaceable>
<emphasis>format</emphasis>
</arg>
<arg>
<group choice='plain'>
@ -26,19 +26,19 @@
<arg choice='plain'><option>--max-jobs</option></arg>
<arg choice='plain'><option>-j</option></arg>
</group>
<replaceable>number</replaceable>
<emphasis>number</emphasis>
</arg>
<arg>
<option>--cores</option>
<replaceable>number</replaceable>
<emphasis>number</emphasis>
</arg>
<arg>
<option>--max-silent-time</option>
<replaceable>number</replaceable>
<emphasis>number</emphasis>
</arg>
<arg>
<option>--timeout</option>
<replaceable>number</replaceable>
<emphasis>number</emphasis>
</arg>
<arg>
<group choice='plain'>
@ -56,12 +56,12 @@
<arg><option>--readonly-mode</option></arg>
<arg>
<option>-I</option>
<replaceable>path</replaceable>
<emphasis>path</emphasis>
</arg>
<arg>
<option>--option</option>
<replaceable>name</replaceable>
<replaceable>value</replaceable>
<emphasis>name</emphasis>
<emphasis>value</emphasis>
</arg>
<sbr />

46
doc/manual/command-ref/opt-common.xml
View file

@ -92,12 +92,12 @@
</varlistentry>
<varlistentry xml:id="opt-log-format"><term><option>--log-format</option> <replaceable>format</replaceable></term>
<varlistentry xml:id="opt-log-format"><term><option>--log-format</option> <emphasis>format</emphasis></term>
<listitem>
<para>This option can be used to change the output of the log format, with
<replaceable>format</replaceable> being one of:</para>
<emphasis>format</emphasis> being one of:</para>
<variablelist>
@ -130,13 +130,13 @@
error. This option suppresses this behaviour. Note that the
builder's standard output and error are always written to a log file
in
<filename><replaceable>prefix</replaceable>/nix/var/log/nix</filename>.</para></listitem>
<filename><emphasis>prefix</emphasis>/nix/var/log/nix</filename>.</para></listitem>
</varlistentry>
<varlistentry xml:id="opt-max-jobs"><term><option>--max-jobs</option> / <option>-j</option>
<replaceable>number</replaceable></term>
<emphasis>number</emphasis></term>
<listitem>
@ -166,7 +166,7 @@
of parallelism. For instance, in Nixpkgs, if the derivation
attribute <varname>enableParallelBuilding</varname> is set to
<literal>true</literal>, the builder passes the
<option>-j<replaceable>N</replaceable></option> flag to GNU Make.
<option>-j<emphasis>N</emphasis></option> flag to GNU Make.
It defaults to the value of the <link
linkend='conf-cores'><literal>cores</literal></link>
configuration setting, if set, or <literal>1</literal> otherwise.
@ -271,7 +271,7 @@
</varlistentry>
<varlistentry><term><option>--arg</option> <replaceable>name</replaceable> <replaceable>value</replaceable></term>
<varlistentry><term><option>--arg</option> <emphasis>name</emphasis> <emphasis>value</emphasis></term>
<listitem><para>This option is accepted by
<command>nix-env</command>, <command>nix-instantiate</command>,
@ -280,14 +280,14 @@
automatically try to call functions that
it encounters. It can automatically call functions for which every
argument has a <link linkend='ss-functions'>default value</link>
(e.g., <literal>{ <replaceable>argName</replaceable> ?
<replaceable>defaultValue</replaceable> }:
<replaceable>...</replaceable></literal>). With
(e.g., <literal>{ <emphasis>argName</emphasis> ?
<emphasis>defaultValue</emphasis> }:
<emphasis>...</emphasis></literal>). With
<option>--arg</option>, you can also call functions that have
arguments without a default value (or override a default value).
That is, if the evaluator encounters a function with an argument
named <replaceable>name</replaceable>, it will call it with value
<replaceable>value</replaceable>.</para>
named <emphasis>name</emphasis>, it will call it with value
<emphasis>value</emphasis>.</para>
<para>For instance, the top-level <literal>default.nix</literal> in
Nixpkgs is actually a function:
@ -295,23 +295,23 @@
<programlisting>
{ # The system (e.g., `i686-linux') for which to build the packages.
system ? builtins.currentSystem
<replaceable>...</replaceable>
}: <replaceable>...</replaceable></programlisting>
<emphasis>...</emphasis>
}: <emphasis>...</emphasis></programlisting>
So if you call this Nix expression (e.g., when you do
<literal>nix-env -i <replaceable>pkgname</replaceable></literal>),
<literal>nix-env -i <emphasis>pkgname</emphasis></literal>),
the function will be called automatically using the value <link
linkend='builtin-currentSystem'><literal>builtins.currentSystem</literal></link>
for the <literal>system</literal> argument. You can override this
using <option>--arg</option>, e.g., <literal>nix-env -i
<replaceable>pkgname</replaceable> --arg system
<emphasis>pkgname</emphasis> --arg system
\"i686-freebsd\"</literal>. (Note that since the argument is a Nix
string literal, you have to escape the quotes.)</para></listitem>
</varlistentry>
<varlistentry><term><option>--argstr</option> <replaceable>name</replaceable> <replaceable>value</replaceable></term>
<varlistentry><term><option>--argstr</option> <emphasis>name</emphasis> <emphasis>value</emphasis></term>
<listitem><para>This option is like <option>--arg</option>, only the
value is not a Nix expression but a string. So instead of
@ -323,17 +323,17 @@
<varlistentry xml:id="opt-attr"><term><option>--attr</option> / <option>-A</option>
<replaceable>attrPath</replaceable></term>
<emphasis>attrPath</emphasis></term>
<listitem><para>Select an attribute from the top-level Nix
expression being evaluated. (<command>nix-env</command>,
<command>nix-instantiate</command>, <command>nix-build</command> and
<command>nix-shell</command> only.) The <emphasis>attribute
path</emphasis> <replaceable>attrPath</replaceable> is a sequence of
path</emphasis> <emphasis>attrPath</emphasis> is a sequence of
attribute names separated by dots. For instance, given a top-level
Nix expression <replaceable>e</replaceable>, the attribute path
Nix expression <emphasis>e</emphasis>, the attribute path
<literal>xorg.xorgserver</literal> would cause the expression
<literal><replaceable>e</replaceable>.xorg.xorgserver</literal> to
<literal><emphasis>e</emphasis>.xorg.xorgserver</literal> to
be used. See <link
linkend='refsec-nix-env-install-examples'><command>nix-env
--install</command></link> for some concrete examples.</para>
@ -366,7 +366,7 @@
</varlistentry>
<varlistentry xml:id="opt-I"><term><option>-I</option> <replaceable>path</replaceable></term>
<varlistentry xml:id="opt-I"><term><option>-I</option> <emphasis>path</emphasis></term>
<listitem><para>Add a path to the Nix expression search path. This
option may be given multiple times. See the <envar
@ -378,10 +378,10 @@
</varlistentry>
<varlistentry><term><option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable></term>
<varlistentry><term><option>--option</option> <emphasis>name</emphasis> <emphasis>value</emphasis></term>
<listitem><para>Set the Nix configuration option
<replaceable>name</replaceable> to <replaceable>value</replaceable>.
<emphasis>name</emphasis> to <emphasis>value</emphasis>.
This overrides settings in the Nix configuration file (see
<citerefentry><refentrytitle>nix.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>).</para></listitem>

2
doc/manual/command-ref/opt-inst-syn.xml
View file

@ -17,6 +17,6 @@
<arg><option>--from-expression</option></arg>
<arg><option>-E</option></arg>
<arg><option>--from-profile</option> <replaceable>path</replaceable></arg>
<arg><option>--from-profile</option> <emphasis>path</emphasis></arg>
</nop>