about summary refs log tree commit diff
path: root/doc/manual
diff options
context:
space:
mode:
authorEelco Dolstra <e.dolstra@tudelft.nl>2004-02-02T10·51+0000
committerEelco Dolstra <e.dolstra@tudelft.nl>2004-02-02T10·51+0000
commitd9f30fe7c74ae8518a575c0d15ee00aa46a2229a (patch)
tree14919393077b5cac95a3f76d78364cf38b4c05ba /doc/manual
parent47c003cb5999344aa2e4cb9f912551e33a94cd41 (diff)
* Sort `nix-env -q' output by derivation name.
* `--version' flag for all commands.
* Manual updates.

Diffstat (limited to 'doc/manual')
-rw-r--r--doc/manual/Makefile.am2
-rw-r--r--doc/manual/manual.xml3
-rw-r--r--doc/manual/nix-env.xml9
-rw-r--r--doc/manual/nix-instantiate.xml22
-rw-r--r--doc/manual/nix-store.xml21
-rw-r--r--doc/manual/opt-common-syn.xml8
-rw-r--r--doc/manual/opt-common.xml (renamed from doc/manual/opt-verbose.xml)35
7 files changed, 55 insertions, 45 deletions
diff --git a/doc/manual/Makefile.am b/doc/manual/Makefile.am
index b1f5c3f46560..8bf06cf2b468 100644
--- a/doc/manual/Makefile.am
+++ b/doc/manual/Makefile.am
@@ -8,7 +8,7 @@ XSLTPROC = $(ENV) $(xsltproc) $(xmlflags) --catalogs \
 
 SOURCES = manual.xml introduction.xml installation.xml overview.xml \
  nix-env.xml nix-store.xml nix-instantiate.xml \
- troubleshooting.xml bugs.xml opt-verbose.xml \
+ troubleshooting.xml bugs.xml opt-common.xml opt-common-syn.xml \
  quick-start.xml style.css images
 
 manual.is-valid: $(SOURCES) version.xml
diff --git a/doc/manual/manual.xml b/doc/manual/manual.xml
index d47e57123853..686ab612f29a 100644
--- a/doc/manual/manual.xml
+++ b/doc/manual/manual.xml
@@ -7,7 +7,8 @@
 <!ENTITY quick-start SYSTEM "quick-start.xml">
 <!ENTITY installation SYSTEM "installation.xml">
 <!ENTITY overview SYSTEM "overview.xml">
-<!ENTITY opt-verbose SYSTEM "opt-verbose.xml">
+<!ENTITY opt-common SYSTEM "opt-common.xml">
+<!ENTITY opt-common-syn SYSTEM "opt-common-syn.xml">
 <!ENTITY nix-env SYSTEM "nix-env.xml">
 <!ENTITY nix-store SYSTEM "nix-store.xml">
 <!ENTITY nix-instantiate SYSTEM "nix-instantiate.xml">
diff --git a/doc/manual/nix-env.xml b/doc/manual/nix-env.xml
index c73716381f4d..a943fd9760e3 100644
--- a/doc/manual/nix-env.xml
+++ b/doc/manual/nix-env.xml
@@ -7,12 +7,7 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>nix-env</command>
-      <arg rep='repeat'><option>--verbose</option></arg>
-      <arg rep='repeat'><option>-v</option></arg>
-      <arg><option>--build-output</option></arg>
-      <arg><option>-B</option></arg>
-      <arg><option>--keep-failed</option></arg>
-      <arg><option>-K</option></arg>
+      &opt-common-syn;
       <arg>
         <group choice='req'>
           <arg choice='plain'><option>--file</option></arg>
@@ -71,7 +66,7 @@
 
     <variablelist>
 
-      &opt-verbose;
+      &opt-common;
 
       <varlistentry>
         <term><option>--file</option> / <option>-f</option></term>
diff --git a/doc/manual/nix-instantiate.xml b/doc/manual/nix-instantiate.xml
index 2e2749e43441..ee073a17b7c6 100644
--- a/doc/manual/nix-instantiate.xml
+++ b/doc/manual/nix-instantiate.xml
@@ -1,16 +1,13 @@
 <refentry>
   <refnamediv>
     <refname>nix-instantiate</refname>
-    <refpurpose>generate Nix expressions from a high-level description</refpurpose>
+    <refpurpose>instantiate store expressions from Nix expressions</refpurpose>
   </refnamediv>
 
   <refsynopsisdiv>
     <cmdsynopsis>
-      <command>fix</command>
-      <group choice='opt' rep='repeat'>
-        <arg><option>--verbose</option></arg>
-        <arg><option>-v</option></arg>
-      </group>
+      <command>nix-instantiate</command>
+      &opt-common-syn;
       <arg rep='repeat'><replaceable>files</replaceable></arg>
     </cmdsynopsis>
   </refsynopsisdiv>
@@ -19,19 +16,10 @@
     <title>Description</title>
 
     <para>
-      The command <command>fix</command> generates Nix expressions from
-      expressions is Fix's own high-level language.  While Nix expressions are
-      very primitive and not intended to be written directly, Fix expressions
-      are quite easy to write.
+      The command <command>nix-instantiate</command> generates
+      (low-level) store expressions from (high-level) Nix expressions.
     </para>
 
   </refsect1>
 
 </refentry>
-
-
-<!--
-local variables:
-sgml-parent-document: ("book.xml" "refentry")
-end:
--->
diff --git a/doc/manual/nix-store.xml b/doc/manual/nix-store.xml
index 7758d04eacdf..a3fcad0631d0 100644
--- a/doc/manual/nix-store.xml
+++ b/doc/manual/nix-store.xml
@@ -7,12 +7,7 @@
   <refsynopsisdiv>
     <cmdsynopsis>
       <command>nix-store</command>
-      <arg rep='repeat'><option>--verbose</option></arg>
-      <arg rep='repeat'><option>-v</option></arg>
-      <arg><option>--build-output</option></arg>
-      <arg><option>-B</option></arg>
-      <arg><option>--keep-failed</option></arg>
-      <arg><option>-K</option></arg>
+      &opt-common-syn;
       <arg choice='plain'><replaceable>operation</replaceable></arg>
       <arg rep='repeat'><replaceable>options</replaceable></arg>
       <arg rep='repeat'><replaceable>arguments</replaceable></arg>
@@ -51,19 +46,7 @@
 
     <variablelist>
 
-      &opt-verbose;
-
-      <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>
+      &opt-common;
 
     </variablelist>
 
diff --git a/doc/manual/opt-common-syn.xml b/doc/manual/opt-common-syn.xml
new file mode 100644
index 000000000000..3a3e4ce87247
--- /dev/null
+++ b/doc/manual/opt-common-syn.xml
@@ -0,0 +1,8 @@
+<arg><option>--help</option></arg>
+<arg><option>--version</option></arg>
+<arg rep='repeat'><option>--verbose</option></arg>
+<arg rep='repeat'><option>-v</option></arg>
+<arg><option>--build-output</option></arg>
+<arg><option>-B</option></arg>
+<arg><option>--keep-failed</option></arg>
+<arg><option>-K</option></arg>
diff --git a/doc/manual/opt-verbose.xml b/doc/manual/opt-common.xml
index 53fe07ae76b8..6c8db2a72757 100644
--- a/doc/manual/opt-verbose.xml
+++ b/doc/manual/opt-common.xml
@@ -1,4 +1,24 @@
 <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>
@@ -72,6 +92,7 @@
   </listitem>
 </varlistentry>
 
+
 <varlistentry>
   <term><option>--build-output</option> / <option>-B</option></term>
   <listitem>
@@ -85,3 +106,17 @@
     </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>
+