about summary refs log tree commit diff
path: root/nixos/doc/manual/man-nixos-option.xml
diff options
context:
space:
mode:
authorRemy Goldschmidt <remygoldschmidt@awakenetworks.com>2017-08-03 14:42:08 -0700
committerRobin Gloster <mail@glob.in>2017-08-04 03:30:35 +0200
commit7fa034de560aed5526af74f493107e694843772c (patch)
tree02ef613d64b8bb9a24436d6dad1e8e77c32212ed /nixos/doc/manual/man-nixos-option.xml
parentb51528671451cabac8600c1b0f2ba8d929ed921c (diff)
downloadnixlib-7fa034de560aed5526af74f493107e694843772c.tar
nixlib-7fa034de560aed5526af74f493107e694843772c.tar.gz
nixlib-7fa034de560aed5526af74f493107e694843772c.tar.bz2
nixlib-7fa034de560aed5526af74f493107e694843772c.tar.lz
nixlib-7fa034de560aed5526af74f493107e694843772c.tar.xz
nixlib-7fa034de560aed5526af74f493107e694843772c.tar.zst
nixlib-7fa034de560aed5526af74f493107e694843772c.zip
Improved nixos-option manpage
Diffstat (limited to 'nixos/doc/manual/man-nixos-option.xml')
-rw-r--r--nixos/doc/manual/man-nixos-option.xml48
1 files changed, 46 insertions, 2 deletions
diff --git a/nixos/doc/manual/man-nixos-option.xml b/nixos/doc/manual/man-nixos-option.xml
index 6be8bc780f13..d2b2d5b7965c 100644
--- a/nixos/doc/manual/man-nixos-option.xml
+++ b/nixos/doc/manual/man-nixos-option.xml
@@ -17,11 +17,16 @@
 <refsynopsisdiv>
   <cmdsynopsis>
     <command>nixos-option</command>
-    <arg choice='plain'><replaceable>option.name</replaceable></arg>
+    <arg>
+      <option>-I</option>
+      <replaceable>path</replaceable>
+    </arg>
+    <arg><option>--verbose</option></arg>
+    <arg><option>--xml</option></arg>
+    <arg choice="plain"><replaceable>option.name</replaceable></arg>
   </cmdsynopsis>
 </refsynopsisdiv>
 
-
 <refsection><title>Description</title>
 
 <para>This command evaluates the configuration specified in
@@ -33,6 +38,45 @@ attributes contained in the attribute set.</para>
 
 </refsection>
 
+<refsection><title>Options</title>
+
+<para>This command accepts the following options:</para>
+
+<variablelist>
+
+  <varlistentry>
+    <term><option>-I</option> <replaceable>path</replaceable></term>
+    <listitem>
+      <para>
+        This option is passed to the underlying
+        <command>nix-instantiate</command> invocation.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><option>--verbose</option></term>
+    <listitem>
+      <para>
+        This option enables verbose mode, which currently is just
+        the Bash <command>set</command> <option>-x</option> debug mode.
+      </para>
+    </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><option>--xml</option></term>
+    <listitem>
+      <para>
+        This option causes the output to be rendered as XML.
+      </para>
+    </listitem>
+  </varlistentry>
+
+</variablelist>
+
+</refsection>
+
 <refsection><title>Environment</title>
 
 <variablelist>