pyrox.dev
Improved nixos-option manpage
authored by
Remy Goldschmidt
and committed by
Robin Gloster
7fa034de
b5152867
+46
-2
nixos/doc/manual/man-nixos-option.xml
+46
-2
nixos/doc/manual/man-nixos-option.xml
···
17
<refsynopsisdiv>
18
<cmdsynopsis>
19
<command>nixos-option</command>
20
-
<arg choice='plain'><replaceable>option.name</replaceable></arg>
21
</cmdsynopsis>
22
</refsynopsisdiv>
23
-
24
25
<refsection><title>Description</title>
26
···
30
31
<para>When the option name is not an option, the command prints the list of
32
attributes contained in the attribute set.</para>
33
34
</refsection>
35
···
17
<refsynopsisdiv>
18
<cmdsynopsis>
19
<command>nixos-option</command>
20
+
<arg>
21
+
<option>-I</option>
22
+
<replaceable>path</replaceable>
23
+
</arg>
24
+
<arg><option>--verbose</option></arg>
25
+
<arg><option>--xml</option></arg>
26
+
<arg choice="plain"><replaceable>option.name</replaceable></arg>
27
</cmdsynopsis>
28
</refsynopsisdiv>
29
30
<refsection><title>Description</title>
31
···
35
36
<para>When the option name is not an option, the command prints the list of
37
attributes contained in the attribute set.</para>
38
+
39
+
</refsection>
40
+
41
+
<refsection><title>Options</title>
42
+
43
+
<para>This command accepts the following options:</para>
44
+
45
+
<variablelist>
46
+
47
+
<varlistentry>
48
+
<term><option>-I</option> <replaceable>path</replaceable></term>
49
+
<listitem>
50
+
<para>
51
+
This option is passed to the underlying
52
+
<command>nix-instantiate</command> invocation.
53
+
</para>
54
+
</listitem>
55
+
</varlistentry>
56
+
57
+
<varlistentry>
58
+
<term><option>--verbose</option></term>
59
+
<listitem>
60
+
<para>
61
+
This option enables verbose mode, which currently is just
62
+
the Bash <command>set</command> <option>-x</option> debug mode.
63
+
</para>
64
+
</listitem>
65
+
</varlistentry>
66
+
67
+
<varlistentry>
68
+
<term><option>--xml</option></term>
69
+
<listitem>
70
+
<para>
71
+
This option causes the output to be rendered as XML.
72
+
</para>
73
+
</listitem>
74
+
</varlistentry>
75
+
76
+
</variablelist>
77
78
</refsection>
79