aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/command-ref/nix-build.xml
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2020-07-23 14:28:05 +0200
committerEelco Dolstra <edolstra@gmail.com>2020-07-23 18:27:20 +0200
commit802150f987e720452920a3d1993c3b4b36861116 (patch)
tree25deb10e810a2b3e92ce82af72e39140226b1388 /doc/manual/command-ref/nix-build.xml
parentee051084723333fc5889c604c829669800e8b43c (diff)
<replaceable> -> <emphasis>
Pandoc doesn't know <replaceable> so let's force it to be rendered as italics.
Diffstat (limited to 'doc/manual/command-ref/nix-build.xml')
-rw-r--r--doc/manual/command-ref/nix-build.xml24
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/manual/command-ref/nix-build.xml b/doc/manual/command-ref/nix-build.xml
index 886d25910..ec9145143 100644
--- a/doc/manual/command-ref/nix-build.xml
+++ b/doc/manual/command-ref/nix-build.xml
@@ -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>,