about summary refs log tree commit diff
path: root/doc/manual
diff options
context:
space:
mode:
authorEelco Dolstra <e.dolstra@tudelft.nl>2004-11-12T23·22+0000
committerEelco Dolstra <e.dolstra@tudelft.nl>2004-11-12T23·22+0000
commitc2b0d6b02ffaaa6e47eb24c3dca30beeea387aff (patch)
tree507eb77247f02981b6720c9f63d4b585b900f0e3 /doc/manual
parent32c73268502e35af54953e23038018edb8ce5685 (diff)
* Document --eval-only and --parse-only options in nix-instantiate.
Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/nix-instantiate.xml25
-rw-r--r--doc/manual/opt-common-syn.xml1
-rw-r--r--doc/manual/opt-common.xml11
3 files changed, 37 insertions, 0 deletions
diff --git a/doc/manual/nix-instantiate.xml b/doc/manual/nix-instantiate.xml
index 69630cb552ec..dc72ab83bcd2 100644
--- a/doc/manual/nix-instantiate.xml
+++ b/doc/manual/nix-instantiate.xml
@@ -8,6 +8,10 @@
     <cmdsynopsis>
       <command>nix-instantiate</command>
       &opt-common-syn;
+      <group choice='opt'>
+        <arg choice='plain'><option>--parse-only</option></arg>
+        <arg choice='plain'><option>--eval-only</option></arg>
+      </group>
       <arg choice='plain' rep='repeat'><replaceable>files</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
@@ -39,6 +43,27 @@
 
       &opt-common;
 
+      <varlistentry>
+        <term><option>--parse-only</option></term>
+        <listitem>
+          <para>
+            Just parse the input files, and print their abstract
+            syntax trees on standard output in ATerm format.
+          </para>
+        </listitem>
+      </varlistentry>
+      
+      <varlistentry>
+        <term><option>--eval-only</option></term>
+        <listitem>
+          <para>
+            Just parse and evaluate the input files, and print the
+            resulting values on standard output.  No instantiation of
+            store expressions takes place.
+          </para>
+        </listitem>
+      </varlistentry>
+
     </variablelist>
 
   </refsection>
diff --git a/doc/manual/opt-common-syn.xml b/doc/manual/opt-common-syn.xml
index 033189d0b919..50f8f043dbbb 100644
--- a/doc/manual/opt-common-syn.xml
+++ b/doc/manual/opt-common-syn.xml
@@ -16,3 +16,4 @@
 <arg><option>--keep-failed</option></arg>
 <arg><option>-K</option></arg>
 <arg><option>--fallback</option></arg>
+<arg><option>--readonly-mode</option></arg>
diff --git a/doc/manual/opt-common.xml b/doc/manual/opt-common.xml
index 0cfd6ba215d2..7650d62e51ae 100644
--- a/doc/manual/opt-common.xml
+++ b/doc/manual/opt-common.xml
@@ -171,3 +171,14 @@
   </listitem>
 </varlistentry>
 
+
+<varlistentry>
+  <term><option>--readonly-mode</option></term>
+  <listitem>
+    <para>
+      When this option is used, no attempt is made to open the Nix
+      database.  Most Nix operations do need database access, so those
+      operations will fail.
+    </para>
+  </listitem>
+</varlistentry>