Skip to content

Commit

Permalink
Improved nixos-option manpage
Browse files Browse the repository at this point in the history
  • Loading branch information
@taktoa @globin
taktoa authored and globin committed Aug 4, 2017
1 parent b515286 commit 7fa034d
Showing 1 changed file with 46 additions and 2 deletions.
48 changes: 46 additions & 2 deletions nixos/doc/manual/man-nixos-option.xml
View file
Expand Up @@ -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
Expand All @@ -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>
Expand Down

0 comments on commit 7fa034d

Please sign in to comment.