From d9f30fe7c74ae8518a575c0d15ee00aa46a2229a Mon Sep 17 00:00:00 2001
From: Eelco Dolstra <e.dolstra@tudelft.nl>
Date: Mon, 2 Feb 2004 10:51:54 +0000
Subject: * Sort `nix-env -q' output by derivation name. * `--version' flag for
 all commands. * Manual updates.

---
 doc/manual/opt-common.xml | 122 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 122 insertions(+)
 create mode 100644 doc/manual/opt-common.xml

(limited to 'doc/manual/opt-common.xml')

diff --git a/doc/manual/opt-common.xml b/doc/manual/opt-common.xml
new file mode 100644
index 000000000000..6c8db2a72757
--- /dev/null
+++ b/doc/manual/opt-common.xml
@@ -0,0 +1,122 @@
+<varlistentry>
+  <term><option>--help</option></term>
+  <listitem>
+    <para>
+      Prints out a summary of the command syntax and exits.
+    </para>
+  </listitem>
+</varlistentry>
+
+
+<varlistentry>
+  <term><option>--version</option></term>
+  <listitem>
+    <para>
+      Prints out the Nix version number on standard output and exits.
+    </para>
+  </listitem>
+</varlistentry>
+
+
+<varlistentry>
+  <term><option>--verbose</option> / <option>-v</option></term>
+  <listitem>
+    <para>
+      Increases the level of verbosity of diagnostic messages printed
+      on standard error.  For each Nix operation, the information
+      printed on standard output is well-defined; any diagnostic
+      information is printed on standard error, never on standard
+      output.
+    </para>
+
+    <para>
+      This option may be specified repeatedly.  Currently, the
+      following verbosity levels exist:
+    </para>
+
+    <variablelist>
+      <varlistentry>
+        <term>0</term>
+        <listitem>
+          <para>
+            <quote>Errors only</quote>: only print messages explaining
+            why the Nix invocation failed.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>1</term>
+        <listitem>
+          <para>
+            <quote>Informational</quote>: print
+            <emphasis>useful</emphasis> messages about what Nix is
+            doing.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>2</term>
+        <listitem>
+          <para>
+            <quote>Talkative</quote>: print more informational messages.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>3</term>
+        <listitem>
+          <para>
+            <quote>Chatty</quote>: print even more informational messages.
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>4</term>
+        <listitem>
+          <para>
+            <quote>Debug</quote>: print debug information:
+          </para>
+        </listitem>
+      </varlistentry>
+      <varlistentry>
+        <term>5</term>
+        <listitem>
+          <para>
+            <quote>Vomit</quote>: print vast amounts of debug
+            information.
+          </para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+
+  </listitem>
+</varlistentry>
+
+
+<varlistentry>
+  <term><option>--build-output</option> / <option>-B</option></term>
+  <listitem>
+    <para>
+      Causes the output written by build actions to standard output
+      and standard error to be echoed to standard error, regardless of
+      verbosity level.  By default, it is only echoed at a verbosity
+      level of at least 4 (<quote>Debug</quote>), and is suppressed at
+      lower levels.  Note that it is always written to a log file in
+      <filename><replaceable>prefix</replaceable>/nix/var/log/nix</filename>.
+    </para>
+  </listitem>
+</varlistentry>
+
+
+<varlistentry>
+  <term><option>--keep-failed</option> / <option>-K</option></term>
+  <listitem>
+    <para>
+      Specifies that in case of a build failure, the temporary
+      directory (usually in <filename>/tmp</filename>) in which the
+      build takes place should not be deleted.  The path of the build
+      directory is printed as an informational message.
+    </para>
+  </listitem>
+</varlistentry>
+
-- 
cgit 1.4.1