about summary refs log tree commit diff
path: root/doc/manual/conf-file.xml
diff options
context:
space:
mode:
authorEelco Dolstra <e.dolstra@tudelft.nl>2006-10-05T08·21+0000
committerEelco Dolstra <e.dolstra@tudelft.nl>2006-10-05T08·21+0000
commit6f2bfd92b695a31b35d8d515cd4ee12f9fc2c786 (patch)
tree55b71007d01afdde96191baca48b887120796856 /doc/manual/conf-file.xml
parentd98f750fd8de5a0546903061e94b9bda3f68681f (diff)
* Manual.
Diffstat (limited to 'doc/manual/conf-file.xml')
-rw-r--r--doc/manual/conf-file.xml20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/manual/conf-file.xml b/doc/manual/conf-file.xml
index 17603524887b..79faa05fd274 100644
--- a/doc/manual/conf-file.xml
+++ b/doc/manual/conf-file.xml
@@ -118,6 +118,26 @@ env-keep-derivations = false
   </varlistentry>
 
 
+  <varlistentry><term><literal>system</literal></term>
+
+    <listitem><para>This option specifies the canonical Nix system
+    name of the current installation, such as
+    <literal>i686-linux</literal> or
+    <literal>powerpc-darwin</literal>.  Nix can only build derivations
+    whose <literal>system</literal> attribute equals the value
+    specified here.  In general, it never makes sense to modify this
+    value from its default, since you can use it to ‘lie’ about the
+    platform you are building on (e.g., perform a Mac OS build on a
+    Linux machine; the result would obviously be wrong).  It only
+    makes sense if the Nix binaries can run on multiple platforms,
+    e.g., ‘universal binaries’ that run on <literal>powerpc-darwin</literal> and
+    <literal>i686-darwin</literal>.</para>
+
+    <para>It defaults to the canonical Nix system name detected by
+    <filename>configure</filename> at build time.</para></listitem>
+
+  </varlistentry>
+  
     
 </variablelist>