nixos/doc: ran `make format`

With visual inspection that nothing got worse.

+10 -5
nixos/doc/manual/administration/boot-problems.xml
···
NixOS boot scripts or by systemd:
<variablelist>
<varlistentry>
-
<term><literal>boot.shell_on_fail</literal>
+
<term>
+
<literal>boot.shell_on_fail</literal>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><literal>boot.debug1</literal>
+
<term>
+
<literal>boot.debug1</literal>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><literal>boot.trace</literal>
+
<term>
+
<literal>boot.trace</literal>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><literal>single</literal>
+
<term>
+
<literal>single</literal>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><literal>systemd.log_level=debug systemd.log_target=console</literal>
+
<term>
+
<literal>systemd.log_level=debug systemd.log_target=console</literal>
</term>
<listitem>
<para>
+18 -6
nixos/doc/manual/configuration/config-file.xml
···
Options have various types of values. The most important are:
<variablelist>
<varlistentry>
-
<term>Strings</term>
+
<term>
+
Strings
+
</term>
<listitem>
<para>
Strings are enclosed in double quotes, e.g.
···
</listitem>
</varlistentry>
<varlistentry>
-
<term>Booleans</term>
+
<term>
+
Booleans
+
</term>
<listitem>
<para>
These can be <literal>true</literal> or <literal>false</literal>, e.g.
···
</listitem>
</varlistentry>
<varlistentry>
-
<term>Integers</term>
+
<term>
+
Integers
+
</term>
<listitem>
<para>
For example,
···
</listitem>
</varlistentry>
<varlistentry>
-
<term>Sets</term>
+
<term>
+
Sets
+
</term>
<listitem>
<para>
Sets were introduced above. They are name/value pairs enclosed in braces,
···
</listitem>
</varlistentry>
<varlistentry>
-
<term>Lists</term>
+
<term>
+
Lists
+
</term>
<listitem>
<para>
The important thing to note about lists is that list elements are
···
</listitem>
</varlistentry>
<varlistentry>
-
<term>Packages</term>
+
<term>
+
Packages
+
</term>
<listitem>
<para>
Usually, the packages you need are already part of the Nix Packages
+18 -9
nixos/doc/manual/development/building-parts.xml
···
include:
<variablelist>
<varlistentry>
-
<term><varname>system.build.toplevel</varname>
+
<term>
+
<varname>system.build.toplevel</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>system.build.manual.manual</varname>
+
<term>
+
<varname>system.build.manual.manual</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>system.build.etc</varname>
+
<term>
+
<varname>system.build.etc</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>system.build.initialRamdisk</varname>
+
<term>
+
<varname>system.build.initialRamdisk</varname>
</term>
-
<term><varname>system.build.kernel</varname>
+
<term>
+
<varname>system.build.kernel</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>system.build.nixos-rebuild</varname>
+
<term>
+
<varname>system.build.nixos-rebuild</varname>
</term>
-
<term><varname>system.build.nixos-install</varname>
+
<term>
+
<varname>system.build.nixos-install</varname>
</term>
-
<term><varname>system.build.nixos-generate-config</varname>
+
<term>
+
<varname>system.build.nixos-generate-config</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>systemd.units.<replaceable>unit-name</replaceable>.unit</varname>
+
<term>
+
<varname>systemd.units.<replaceable>unit-name</replaceable>.unit</varname>
</term>
<listitem>
<para>
+8 -4
nixos/doc/manual/development/option-declarations.xml
···
The function <varname>mkOption</varname> accepts the following arguments.
<variablelist>
<varlistentry>
-
<term><varname>type</varname>
+
<term>
+
<varname>type</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>default</varname>
+
<term>
+
<varname>default</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>example</varname>
+
<term>
+
<varname>example</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>description</varname>
+
<term>
+
<varname>description</varname>
</term>
<listitem>
<para>
+86 -43
nixos/doc/manual/development/option-types.xml
···
<variablelist>
<varlistentry>
-
<term><varname>types.attrs</varname>
+
<term>
+
<varname>types.attrs</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.bool</varname>
+
<term>
+
<varname>types.bool</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.path</varname>
+
<term>
+
<varname>types.path</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.package</varname>
+
<term>
+
<varname>types.package</varname>
</term>
<listitem>
<para>
···
<variablelist>
<varlistentry>
-
<term><varname>types.int</varname>
+
<term>
+
<varname>types.int</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.ints.{s8, s16, s32}</varname>
+
<term>
+
<varname>types.ints.{s8, s16, s32}</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.ints.unsigned</varname>
+
<term>
+
<varname>types.ints.unsigned</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.ints.{u8, u16, u32}</varname>
+
<term>
+
<varname>types.ints.{u8, u16, u32}</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.ints.positive</varname>
+
<term>
+
<varname>types.ints.positive</varname>
</term>
<listitem>
<para>
···
<variablelist>
<varlistentry>
-
<term><varname>types.str</varname>
+
<term>
+
<varname>types.str</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.lines</varname>
+
<term>
+
<varname>types.lines</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.commas</varname>
+
<term>
+
<varname>types.commas</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.envVar</varname>
+
<term>
+
<varname>types.envVar</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.strMatching</varname>
+
<term>
+
<varname>types.strMatching</varname>
</term>
<listitem>
<para>
···
<variablelist>
<varlistentry>
-
<term><varname>types.enum</varname><replaceable>l</replaceable>
+
<term>
+
<varname>types.enum</varname><replaceable>l</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.separatedString</varname><replaceable>sep</replaceable>
+
<term>
+
<varname>types.separatedString</varname><replaceable>sep</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.ints.between</varname><replaceable>lowest</replaceable><replaceable>highest</replaceable>
+
<term>
+
<varname>types.ints.between</varname><replaceable>lowest</replaceable><replaceable>highest</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.submodule</varname><replaceable>o</replaceable>
+
<term>
+
<varname>types.submodule</varname><replaceable>o</replaceable>
</term>
<listitem>
<para>
···
<variablelist>
<varlistentry>
-
<term><varname>types.listOf</varname><replaceable>t</replaceable>
+
<term>
+
<varname>types.listOf</varname><replaceable>t</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.attrsOf</varname><replaceable>t</replaceable>
+
<term>
+
<varname>types.attrsOf</varname><replaceable>t</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.loaOf</varname><replaceable>t</replaceable>
+
<term>
+
<varname>types.loaOf</varname><replaceable>t</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.nullOr</varname><replaceable>t</replaceable>
+
<term>
+
<varname>types.nullOr</varname><replaceable>t</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.uniq</varname><replaceable>t</replaceable>
+
<term>
+
<varname>types.uniq</varname><replaceable>t</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.either</varname><replaceable>t1</replaceable><replaceable>t2</replaceable>
+
<term>
+
<varname>types.either</varname><replaceable>t1</replaceable><replaceable>t2</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>types.coercedTo</varname><replaceable>from</replaceable><replaceable>f</replaceable><replaceable>to</replaceable>
+
<term>
+
<varname>types.coercedTo</varname><replaceable>from</replaceable><replaceable>f</replaceable><replaceable>to</replaceable>
</term>
<listitem>
<para>
···
<variablelist>
<varlistentry>
-
<term><varname>check</varname>
+
<term>
+
<varname>check</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>merge</varname>
+
<term>
+
<varname>merge</varname>
</term>
<listitem>
<para>
···
<variablelist>
<varlistentry>
-
<term><varname>name</varname>
+
<term>
+
<varname>name</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>definition</varname>
+
<term>
+
<varname>definition</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>check</varname>
+
<term>
+
<varname>check</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>merge</varname>
+
<term>
+
<varname>merge</varname>
</term>
<listitem>
<para>
···
</para>
<variablelist>
<varlistentry>
-
<term><replaceable>loc</replaceable>
+
<term>
+
<replaceable>loc</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><replaceable>defs</replaceable>
+
<term>
+
<replaceable>defs</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>getSubOptions</varname>
+
<term>
+
<varname>getSubOptions</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>getSubModules</varname>
+
<term>
+
<varname>getSubModules</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>substSubModules</varname>
+
<term>
+
<varname>substSubModules</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>typeMerge</varname>
+
<term>
+
<varname>typeMerge</varname>
</term>
<listitem>
<para>
···
</para>
<variablelist>
<varlistentry>
-
<term><replaceable>f</replaceable>
+
<term>
+
<replaceable>f</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>functor</varname>
+
<term>
+
<varname>functor</varname>
</term>
<listitem>
<para>
···
</para>
<variablelist>
<varlistentry>
-
<term><varname>type</varname>
+
<term>
+
<varname>type</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>wrapped</varname>
+
<term>
+
<varname>wrapped</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>payload</varname>
+
<term>
+
<varname>payload</varname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><varname>binOp</varname>
+
<term>
+
<varname>binOp</varname>
</term>
<listitem>
<para>
+54 -27
nixos/doc/manual/development/writing-nixos-tests.xml
···
<!-- FIXME: would be nice to generate this automatically. -->
<variablelist>
<varlistentry>
-
<term><option>virtualisation.memorySize</option>
+
<term>
+
<option>virtualisation.memorySize</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>virtualisation.vlans</option>
+
<term>
+
<option>virtualisation.vlans</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>virtualisation.writableStore</option>
+
<term>
+
<option>virtualisation.writableStore</option>
</term>
<listitem>
<para>
···
The following methods are available on machine objects:
<variablelist>
<varlistentry>
-
<term><methodname>start</methodname>
+
<term>
+
<methodname>start</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>shutdown</methodname>
+
<term>
+
<methodname>shutdown</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>crash</methodname>
+
<term>
+
<methodname>crash</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>block</methodname>
+
<term>
+
<methodname>block</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>unblock</methodname>
+
<term>
+
<methodname>unblock</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>screenshot</methodname>
+
<term>
+
<methodname>screenshot</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>getScreenText</methodname>
+
<term>
+
<methodname>getScreenText</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>sendMonitorCommand</methodname>
+
<term>
+
<methodname>sendMonitorCommand</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>sendKeys</methodname>
+
<term>
+
<methodname>sendKeys</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>sendChars</methodname>
+
<term>
+
<methodname>sendChars</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>execute</methodname>
+
<term>
+
<methodname>execute</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>succeed</methodname>
+
<term>
+
<methodname>succeed</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>fail</methodname>
+
<term>
+
<methodname>fail</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>waitUntilSucceeds</methodname>
+
<term>
+
<methodname>waitUntilSucceeds</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>waitUntilFails</methodname>
+
<term>
+
<methodname>waitUntilFails</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>waitForUnit</methodname>
+
<term>
+
<methodname>waitForUnit</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>waitForFile</methodname>
+
<term>
+
<methodname>waitForFile</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>waitForOpenPort</methodname>
+
<term>
+
<methodname>waitForOpenPort</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>waitForClosedPort</methodname>
+
<term>
+
<methodname>waitForClosedPort</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>waitForX</methodname>
+
<term>
+
<methodname>waitForX</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>waitForText</methodname>
+
<term>
+
<methodname>waitForText</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>waitForWindow</methodname>
+
<term>
+
<methodname>waitForWindow</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>copyFileFromHost</methodname>
+
<term>
+
<methodname>copyFileFromHost</methodname>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><methodname>systemctl</methodname>
+
<term>
+
<methodname>systemctl</methodname>
</term>
<listitem>
<para>
+15 -5
nixos/doc/manual/installation/installing.xml
···
</para>
<variablelist>
<varlistentry>
-
<term>UEFI systems</term>
+
<term>
+
UEFI systems
+
</term>
<listitem>
<para>
You should boot the live CD in UEFI mode (consult your specific
···
<listitem>
<variablelist>
<varlistentry>
-
<term>UEFI systems</term>
+
<term>
+
UEFI systems
+
</term>
<listitem>
<para>
For creating boot partitions: <command>mkfs.fat</command>. Again
···
<listitem>
<variablelist>
<varlistentry>
-
<term>UEFI systems</term>
+
<term>
+
UEFI systems
+
</term>
<listitem>
<para>
Mount the boot file system on <filename>/mnt/boot</filename>, e.g.
···
</para>
<variablelist>
<varlistentry>
-
<term>BIOS systems</term>
+
<term>
+
BIOS systems
+
</term>
<listitem>
<para>
You <emphasis>must</emphasis> set the option
···
</listitem>
</varlistentry>
<varlistentry>
-
<term>UEFI systems</term>
+
<term>
+
UEFI systems
+
</term>
<listitem>
<para>
You <emphasis>must</emphasis> set the option
+19 -8
nixos/doc/manual/man-nixos-build-vms.xml
···
</refname><refpurpose>build a network of virtual machines from a network of NixOS configurations</refpurpose>
</refnamediv>
<refsynopsisdiv>
-
<cmdsynopsis><command>nixos-build-vms</command>
-
<arg><option>--show-trace</option>
+
<cmdsynopsis>
+
<command>nixos-build-vms</command>
+
<arg>
+
<option>--show-trace</option>
</arg>
-
<arg><option>--no-out-link</option>
+
+
<arg>
+
<option>--no-out-link</option>
</arg>
-
<arg><option>--help</option>
+
+
<arg>
+
<option>--help</option>
</arg>
-
<arg choice="plain"><replaceable>network.nix</replaceable>
+
+
<arg choice="plain">
+
<replaceable>network.nix</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
···
</para>
<variablelist>
<varlistentry>
-
<term><option>--show-trace</option>
+
<term>
+
<option>--show-trace</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--no-out-link</option>
+
<term>
+
<option>--no-out-link</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>-h</option>, <option>--help</option>
+
<term>
+
<option>-h</option>, <option>--help</option>
</term>
<listitem>
<para>
+34 -15
nixos/doc/manual/man-nixos-enter.xml
···
</refname><refpurpose>run a command in a NixOS chroot environment</refpurpose>
</refnamediv>
<refsynopsisdiv>
-
<cmdsynopsis><command>nixos-enter</command>
+
<cmdsynopsis>
+
<command>nixos-enter</command>
<arg>
-
<arg choice='plain'><option>--root</option>
-
</arg><replaceable>root</replaceable>
+
<arg choice='plain'>
+
<option>--root</option>
+
</arg>
+
<replaceable>root</replaceable>
</arg>
+
<arg>
-
<arg choice='plain'><option>--system</option>
-
</arg><replaceable>system</replaceable>
+
<arg choice='plain'>
+
<option>--system</option>
+
</arg>
+
<replaceable>system</replaceable>
</arg>
+
<arg>
-
<arg choice='plain'><option>-c</option>
-
</arg><replaceable>shell-command</replaceable>
+
<arg choice='plain'>
+
<option>-c</option>
+
</arg>
+
<replaceable>shell-command</replaceable>
</arg>
+
<arg>
-
<arg choice='plain'><option>--help</option>
+
<arg choice='plain'>
+
<option>--help</option>
</arg>
</arg>
+
<arg>
-
<arg choice='plain'><option>--</option>
-
</arg><replaceable>arguments</replaceable>
+
<arg choice='plain'>
+
<option>--</option>
+
</arg>
+
<replaceable>arguments</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
···
</para>
<variablelist>
<varlistentry>
-
<term><option>--root</option>
+
<term>
+
<option>--root</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--system</option>
+
<term>
+
<option>--system</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--command</option>
+
<term>
+
<option>--command</option>
</term>
-
<term><option>-c</option>
+
<term>
+
<option>-c</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--</option>
+
<term>
+
<option>--</option>
</term>
<listitem>
<para>
+28 -13
nixos/doc/manual/man-nixos-generate-config.xml
···
</refname><refpurpose>generate NixOS configuration modules</refpurpose>
</refnamediv>
<refsynopsisdiv>
-
<cmdsynopsis><command>nixos-generate-config</command>
-
<arg><option>--force</option>
+
<cmdsynopsis>
+
<command>nixos-generate-config</command>
+
<arg>
+
<option>--force</option>
</arg>
+
<arg>
-
<arg choice='plain'><option>--root</option>
-
</arg><replaceable>root</replaceable>
+
<arg choice='plain'>
+
<option>--root</option>
+
</arg>
+
<replaceable>root</replaceable>
</arg>
+
<arg>
-
<arg choice='plain'><option>--dir</option>
-
</arg><replaceable>dir</replaceable>
+
<arg choice='plain'>
+
<option>--dir</option>
+
</arg>
+
<replaceable>dir</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
···
This command writes two NixOS configuration modules:
<variablelist>
<varlistentry>
-
<term><option>/etc/nixos/hardware-configuration.nix</option>
+
<term>
+
<option>/etc/nixos/hardware-configuration.nix</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>/etc/nixos/configuration.nix</option>
+
<term>
+
<option>/etc/nixos/configuration.nix</option>
</term>
<listitem>
<para>
···
</para>
<variablelist>
<varlistentry>
-
<term><option>--root</option>
+
<term>
+
<option>--root</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--dir</option>
+
<term>
+
<option>--dir</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--force</option>
+
<term>
+
<option>--force</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--no-filesystems</option>
+
<term>
+
<option>--no-filesystems</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--show-hardware-config</option>
+
<term>
+
<option>--show-hardware-config</option>
</term>
<listitem>
<para>
+65 -27
nixos/doc/manual/man-nixos-install.xml
···
</refname><refpurpose>install bootloader and NixOS</refpurpose>
</refnamediv>
<refsynopsisdiv>
-
<cmdsynopsis><command>nixos-install</command>
+
<cmdsynopsis>
+
<command>nixos-install</command>
<arg>
-
<arg choice='plain'><option>-I</option>
-
</arg><replaceable>path</replaceable>
+
<arg choice='plain'>
+
<option>-I</option>
+
</arg>
+
<replaceable>path</replaceable>
</arg>
+
<arg>
-
<arg choice='plain'><option>--root</option>
-
</arg><replaceable>root</replaceable>
+
<arg choice='plain'>
+
<option>--root</option>
+
</arg>
+
<replaceable>root</replaceable>
</arg>
+
<arg>
-
<arg choice='plain'><option>--system</option>
-
</arg><replaceable>path</replaceable>
+
<arg choice='plain'>
+
<option>--system</option>
+
</arg>
+
<replaceable>path</replaceable>
</arg>
+
<arg>
-
<arg choice='plain'><option>--no-channel-copy</option>
+
<arg choice='plain'>
+
<option>--no-channel-copy</option>
</arg>
</arg>
+
<arg>
-
<arg choice='plain'><option>--no-root-passwd</option>
+
<arg choice='plain'>
+
<option>--no-root-passwd</option>
</arg>
</arg>
+
<arg>
-
<arg choice='plain'><option>--no-bootloader</option>
+
<arg choice='plain'>
+
<option>--no-bootloader</option>
</arg>
</arg>
-
<arg><group choice='req'>
-
<arg choice='plain'><option>--max-jobs</option>
+
+
<arg>
+
<group choice='req'>
+
<arg choice='plain'>
+
<option>--max-jobs</option>
</arg>
-
<arg choice='plain'><option>-j</option>
-
</arg></group><replaceable>number</replaceable>
+
+
<arg choice='plain'>
+
<option>-j</option>
+
</arg>
+
</group><replaceable>number</replaceable>
</arg>
-
<arg><option>--cores</option><replaceable>number</replaceable>
+
+
<arg>
+
<option>--cores</option><replaceable>number</replaceable>
</arg>
-
<arg><option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable>
+
+
<arg>
+
<option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable>
</arg>
+
<arg>
-
<arg choice='plain'><option>--show-trace</option>
+
<arg choice='plain'>
+
<option>--show-trace</option>
</arg>
</arg>
+
<arg>
-
<arg choice='plain'><option>--help</option>
+
<arg choice='plain'>
+
<option>--help</option>
</arg>
</arg>
</cmdsynopsis>
···
</para>
<variablelist>
<varlistentry>
-
<term><option>--root</option>
+
<term>
+
<option>--root</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--system</option>
+
<term>
+
<option>--system</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>-I</option>
+
<term>
+
<option>-I</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--max-jobs</option>
+
<term>
+
<option>--max-jobs</option>
</term>
-
<term><option>-j</option>
+
<term>
+
<option>-j</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--cores</option>
+
<term>
+
<option>--cores</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable>
+
<term>
+
<option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--show-trace</option>
+
<term>
+
<option>--show-trace</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--help</option>
+
<term>
+
<option>--help</option>
</term>
<listitem>
<para>
+21 -9
nixos/doc/manual/man-nixos-option.xml
···
</refname><refpurpose>inspect a NixOS configuration</refpurpose>
</refnamediv>
<refsynopsisdiv>
-
<cmdsynopsis><command>nixos-option</command>
-
<arg><option>-I</option><replaceable>path</replaceable>
+
<cmdsynopsis>
+
<command>nixos-option</command>
+
<arg>
+
<option>-I</option><replaceable>path</replaceable>
</arg>
-
<arg><option>--verbose</option>
+
+
<arg>
+
<option>--verbose</option>
</arg>
-
<arg><option>--xml</option>
+
+
<arg>
+
<option>--xml</option>
</arg>
-
<arg choice="plain"><replaceable>option.name</replaceable>
+
+
<arg choice="plain">
+
<replaceable>option.name</replaceable>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
···
</para>
<variablelist>
<varlistentry>
-
<term><option>-I</option><replaceable>path</replaceable>
+
<term>
+
<option>-I</option><replaceable>path</replaceable>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--verbose</option>
+
<term>
+
<option>--verbose</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--xml</option>
+
<term>
+
<option>--xml</option>
</term>
<listitem>
<para>
···
<title>Environment</title>
<variablelist>
<varlistentry>
-
<term><envar>NIXOS_CONFIG</envar>
+
<term>
+
<envar>NIXOS_CONFIG</envar>
</term>
<listitem>
<para>
+94 -41
nixos/doc/manual/man-nixos-rebuild.xml
···
</refname><refpurpose>reconfigure a NixOS machine</refpurpose>
</refnamediv>
<refsynopsisdiv>
-
<cmdsynopsis><command>nixos-rebuild</command><group choice='req'>
-
<arg choice='plain'><option>switch</option>
+
<cmdsynopsis>
+
<command>nixos-rebuild</command><group choice='req'>
+
<arg choice='plain'>
+
<option>switch</option>
</arg>
-
<arg choice='plain'><option>boot</option>
+
+
<arg choice='plain'>
+
<option>boot</option>
</arg>
-
<arg choice='plain'><option>test</option>
+
+
<arg choice='plain'>
+
<option>test</option>
</arg>
-
<arg choice='plain'><option>build</option>
+
+
<arg choice='plain'>
+
<option>build</option>
</arg>
-
<arg choice='plain'><option>dry-build</option>
+
+
<arg choice='plain'>
+
<option>dry-build</option>
</arg>
-
<arg choice='plain'><option>dry-activate</option>
+
+
<arg choice='plain'>
+
<option>dry-activate</option>
</arg>
-
<arg choice='plain'><option>build-vm</option>
+
+
<arg choice='plain'>
+
<option>build-vm</option>
</arg>
-
<arg choice='plain'><option>build-vm-with-bootloader</option>
-
</arg></group>
+
+
<arg choice='plain'>
+
<option>build-vm-with-bootloader</option>
+
</arg>
+
</group>
<sbr />
-
<arg><option>--upgrade</option>
+
<arg>
+
<option>--upgrade</option>
</arg>
-
<arg><option>--install-bootloader</option>
+
+
<arg>
+
<option>--install-bootloader</option>
</arg>
-
<arg><option>--no-build-nix</option>
+
+
<arg>
+
<option>--no-build-nix</option>
</arg>
-
<arg><option>--fast</option>
+
+
<arg>
+
<option>--fast</option>
</arg>
-
<arg><option>--rollback</option>
+
+
<arg>
+
<option>--rollback</option>
</arg>
<sbr />
-
<arg><group choice='req'>
-
<arg choice='plain'><option>--profile-name</option>
+
<arg>
+
<group choice='req'>
+
<arg choice='plain'>
+
<option>--profile-name</option>
</arg>
-
<arg choice='plain'><option>-p</option>
-
</arg></group><replaceable>name</replaceable>
+
+
<arg choice='plain'>
+
<option>-p</option>
+
</arg>
+
</group><replaceable>name</replaceable>
</arg>
<sbr />
-
<arg><option>--show-trace</option>
+
<arg>
+
<option>--show-trace</option>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
···
operation. It must be one of the following:
<variablelist>
<varlistentry>
-
<term><option>switch</option>
+
<term>
+
<option>switch</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>boot</option>
+
<term>
+
<option>boot</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>test</option>
+
<term>
+
<option>test</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>build</option>
+
<term>
+
<option>build</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>dry-build</option>
+
<term>
+
<option>dry-build</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>dry-activate</option>
+
<term>
+
<option>dry-activate</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>build-vm</option>
+
<term>
+
<option>build-vm</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>build-vm-with-bootloader</option>
+
<term>
+
<option>build-vm-with-bootloader</option>
</term>
<listitem>
<para>
···
</para>
<variablelist>
<varlistentry>
-
<term><option>--upgrade</option>
+
<term>
+
<option>--upgrade</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--install-bootloader</option>
+
<term>
+
<option>--install-bootloader</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--no-build-nix</option>
+
<term>
+
<option>--no-build-nix</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--fast</option>
+
<term>
+
<option>--fast</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--rollback</option>
+
<term>
+
<option>--rollback</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--profile-name</option>
+
<term>
+
<option>--profile-name</option>
</term>
-
<term><option>-p</option>
+
<term>
+
<option>-p</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--build-host</option>
+
<term>
+
<option>--build-host</option>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>--target-host</option>
+
<term>
+
<option>--target-host</option>
</term>
<listitem>
<para>
···
<title>Environment</title>
<variablelist>
<varlistentry>
-
<term><envar>NIXOS_CONFIG</envar>
+
<term>
+
<envar>NIXOS_CONFIG</envar>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><envar>NIX_SSHOPTS</envar>
+
<term>
+
<envar>NIX_SSHOPTS</envar>
</term>
<listitem>
<para>
···
<title>Files</title>
<variablelist>
<varlistentry>
-
<term><filename>/run/current-system</filename>
+
<term>
+
<filename>/run/current-system</filename>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><filename>/nix/var/nix/profiles/system</filename>
+
<term>
+
<filename>/nix/var/nix/profiles/system</filename>
</term>
<listitem>
<para>
+19 -9
nixos/doc/manual/man-nixos-version.xml
···
</refname><refpurpose>show the NixOS version</refpurpose>
</refnamediv>
<refsynopsisdiv>
-
<cmdsynopsis><command>nixos-version</command>
-
<arg><option>--hash</option>
+
<cmdsynopsis>
+
<command>nixos-version</command>
+
<arg>
+
<option>--hash</option>
</arg>
-
<arg><option>--revision</option>
+
+
<arg>
+
<option>--revision</option>
</arg>
</cmdsynopsis>
</refsynopsisdiv>
···
The version consists of the following elements:
<variablelist>
<varlistentry>
-
<term><literal>16.03</literal>
+
<term>
+
<literal>16.03</literal>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><literal>1011</literal>
+
<term>
+
<literal>1011</literal>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><literal>6317da4</literal>
+
<term>
+
<literal>6317da4</literal>
</term>
<listitem>
<para>
···
</listitem>
</varlistentry>
<varlistentry>
-
<term><literal>Emu</literal>
+
<term>
+
<literal>Emu</literal>
</term>
<listitem>
<para>
···
</para>
<variablelist>
<varlistentry>
-
<term><option>--hash</option>
+
<term>
+
<option>--hash</option>
</term>
-
<term><option>--revision</option>
+
<term>
+
<option>--revision</option>
</term>
<listitem>
<para>
+5 -5
nixos/doc/manual/release-notes/rl-1509.xml
···
<programlisting>
system.nixos.stateVersion = "14.12";
</programlisting>
-
The new option <option>system.nixos.stateVersion</option> ensures that certain
-
configuration changes that could break existing systems (such as the
-
<command>sshd</command> host key setting) will maintain compatibility with
-
the specified NixOS release. NixOps sets the state version of existing
-
deployments automatically.
+
The new option <option>system.nixos.stateVersion</option> ensures that
+
certain configuration changes that could break existing systems (such as
+
the <command>sshd</command> host key setting) will maintain compatibility
+
with the specified NixOS release. NixOps sets the state version of
+
existing deployments automatically.
</para>
</listitem>
<listitem>
+59 -42
nixos/doc/manual/release-notes/rl-1809.xml
···
<itemizedlist>
<listitem>
-
<para>When enabled the <literal>iproute2</literal> will copy the files
-
expected by ip route (e.g., <filename>rt_tables</filename>) in
-
<filename>/run/iproute2</filename>. This allows to write aliases for
-
routing tables for instance.</para>
+
<para>
+
When enabled the <literal>iproute2</literal> will copy the files expected
+
by ip route (e.g., <filename>rt_tables</filename>) in
+
<filename>/run/iproute2</filename>. This allows to write aliases for
+
routing tables for instance.
+
</para>
</listitem>
</itemizedlist>
</section>
···
</listitem>
<listitem>
<para>
-
The <varname>services.docker-registry.extraConfig</varname> object doesn't contain
-
environment variables anymore. Instead it needs to provide an object structure
-
that can be mapped onto the YAML configuration defined in <link xlink:href="https://github.com/docker/distribution/blob/v2.6.2/docs/configuration.md">the <varname>docker/distribution</varname> docs</link>.
+
The <varname>services.docker-registry.extraConfig</varname> object doesn't
+
contain environment variables anymore. Instead it needs to provide an
+
object structure that can be mapped onto the YAML configuration defined in
+
<link xlink:href="https://github.com/docker/distribution/blob/v2.6.2/docs/configuration.md">the
+
<varname>docker/distribution</varname> docs</link>.
</para>
</listitem>
<listitem>
<para>
-
<literal>gnucash</literal> has changed from version 2.4 to 3.x.
-
If you've been using <literal>gnucash</literal> (version 2.4) instead of
-
<literal>gnucash26</literal> (version 2.6) you must open your Gnucash
-
data file(s) with <literal>gnucash26</literal> and then save them to
-
upgrade the file format. Then you may use your data file(s) with
-
Gnucash 3.x. See the upgrade <link xlink:href="https://wiki.gnucash.org/wiki/FAQ#Using_Different_Versions.2C_Up_And_Downgrade">documentation</link>.
-
Gnucash 2.4 is still available under the attribute <literal>gnucash24</literal>.
+
<literal>gnucash</literal> has changed from version 2.4 to 3.x. If you've
+
been using <literal>gnucash</literal> (version 2.4) instead of
+
<literal>gnucash26</literal> (version 2.6) you must open your Gnucash data
+
file(s) with <literal>gnucash26</literal> and then save them to upgrade
+
the file format. Then you may use your data file(s) with Gnucash 3.x. See
+
the upgrade
+
<link xlink:href="https://wiki.gnucash.org/wiki/FAQ#Using_Different_Versions.2C_Up_And_Downgrade">documentation</link>.
+
Gnucash 2.4 is still available under the attribute
+
<literal>gnucash24</literal>.
</para>
</listitem>
</itemizedlist>
···
<itemizedlist>
<listitem>
<para>
-
<literal>dockerTools.pullImage</literal> relies on image digest
-
instead of image tag to download the image. The
-
<literal>sha256</literal> of a pulled image has to be updated.
+
<literal>dockerTools.pullImage</literal> relies on image digest instead of
+
image tag to download the image. The <literal>sha256</literal> of a pulled
+
image has to be updated.
</para>
</listitem>
<listitem>
···
<para>
The module for <option>security.dhparams</option> has two new options now:
</para>
-
<variablelist>
<varlistentry>
-
<term><option>security.dhparams.stateless</option></term>
-
<listitem><para>
-
Puts the generated Diffie-Hellman parameters into the Nix store instead
-
of managing them in a stateful manner in
-
<filename class="directory">/var/lib/dhparams</filename>.
-
</para></listitem>
+
<term>
+
<option>security.dhparams.stateless</option>
+
</term>
+
<listitem>
+
<para>
+
Puts the generated Diffie-Hellman parameters into the Nix store instead
+
of managing them in a stateful manner in
+
<filename class="directory">/var/lib/dhparams</filename>.
+
</para>
+
</listitem>
</varlistentry>
<varlistentry>
-
<term><option>security.dhparams.defaultBitSize</option></term>
-
<listitem><para>
-
The default bit size to use for the generated Diffie-Hellman parameters.
-
</para></listitem>
+
<term>
+
<option>security.dhparams.defaultBitSize</option>
+
</term>
+
<listitem>
+
<para>
+
The default bit size to use for the generated Diffie-Hellman
+
parameters.
+
</para>
+
</listitem>
</varlistentry>
</variablelist>
-
-
<note><para>
-
The path to the actual generated parameter files should now be queried
-
using
-
<literal>config.security.dhparams.params.<replaceable>name</replaceable>.path</literal>
-
because it might be either in the Nix store or in a directory configured
-
by <option>security.dhparams.path</option>.
-
</para></note>
-
+
<note>
+
<para>
+
The path to the actual generated parameter files should now be queried
+
using
+
<literal>config.security.dhparams.params.<replaceable>name</replaceable>.path</literal>
+
because it might be either in the Nix store or in a directory configured
+
by <option>security.dhparams.path</option>.
+
</para>
+
</note>
<note>
<title>For developers:</title>
<para>
···
</listitem>
<listitem>
<para>
-
<literal>networking.networkmanager.useDnsmasq</literal> has been deprecated. Use
-
<literal>networking.networkmanager.dns</literal> instead.
+
<literal>networking.networkmanager.useDnsmasq</literal> has been
+
deprecated. Use <literal>networking.networkmanager.dns</literal> instead.
</para>
</listitem>
<listitem>
<para>
-
The option <varname>services.kubernetes.apiserver.admissionControl</varname>
-
was renamed to <varname>services.kubernetes.apiserver.enableAdmissionPlugins</varname>.
+
The option
+
<varname>services.kubernetes.apiserver.admissionControl</varname> was
+
renamed to
+
<varname>services.kubernetes.apiserver.enableAdmissionPlugins</varname>.
</para>
</listitem>
<listitem>
<para>
Recommented way to access the Kubernetes Dashboard is with HTTPS (TLS)
-
Therefore; public service port for the dashboard has changed to 443 (container port 8443) and scheme to https.
+
Therefore; public service port for the dashboard has changed to 443
+
(container port 8443) and scheme to https.
</para>
</listitem>
</itemizedlist>