nixos/doc: ran make format

With visual inspection that nothing got worse.
This commit is contained in:
Samuel Dionne-Riel 2018-05-31 21:03:51 -04:00
parent a45edd9024
commit 88ca2b1ec4
16 changed files with 558 additions and 273 deletions

View File

@ -14,7 +14,8 @@
NixOS boot scripts or by systemd: NixOS boot scripts or by systemd:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><literal>boot.shell_on_fail</literal> <term>
<literal>boot.shell_on_fail</literal>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -25,7 +26,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>boot.debug1</literal> <term>
<literal>boot.debug1</literal>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -37,7 +39,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>boot.trace</literal> <term>
<literal>boot.trace</literal>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -46,7 +49,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>single</literal> <term>
<literal>single</literal>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -59,7 +63,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<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> </term>
<listitem> <listitem>
<para> <para>

View File

@ -80,7 +80,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no
Options have various types of values. The most important are: Options have various types of values. The most important are:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>Strings</term> <term>
Strings
</term>
<listitem> <listitem>
<para> <para>
Strings are enclosed in double quotes, e.g. Strings are enclosed in double quotes, e.g.
@ -112,7 +114,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Booleans</term> <term>
Booleans
</term>
<listitem> <listitem>
<para> <para>
These can be <literal>true</literal> or <literal>false</literal>, e.g. These can be <literal>true</literal> or <literal>false</literal>, e.g.
@ -124,7 +128,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Integers</term> <term>
Integers
</term>
<listitem> <listitem>
<para> <para>
For example, For example,
@ -141,7 +147,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Sets</term> <term>
Sets
</term>
<listitem> <listitem>
<para> <para>
Sets were introduced above. They are name/value pairs enclosed in braces, Sets were introduced above. They are name/value pairs enclosed in braces,
@ -157,7 +165,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Lists</term> <term>
Lists
</term>
<listitem> <listitem>
<para> <para>
The important thing to note about lists is that list elements are The important thing to note about lists is that list elements are
@ -173,7 +183,9 @@ swapDevices = [ { device = "/dev/disk/by-label/swap"; } ];
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>Packages</term> <term>
Packages
</term>
<listitem> <listitem>
<para> <para>
Usually, the packages you need are already part of the Nix Packages Usually, the packages you need are already part of the Nix Packages

View File

@ -15,7 +15,8 @@ $ nix-build -A config.<replaceable>option</replaceable></screen>
include: include:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>system.build.toplevel</varname> <term>
<varname>system.build.toplevel</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -32,7 +33,8 @@ $ nix-build -A system</screen>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>system.build.manual.manual</varname> <term>
<varname>system.build.manual.manual</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -41,7 +43,8 @@ $ nix-build -A system</screen>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>system.build.etc</varname> <term>
<varname>system.build.etc</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -51,9 +54,11 @@ $ nix-build -A system</screen>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>system.build.initialRamdisk</varname> <term>
<varname>system.build.initialRamdisk</varname>
</term> </term>
<term><varname>system.build.kernel</varname> <term>
<varname>system.build.kernel</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -69,11 +74,14 @@ $ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>system.build.nixos-rebuild</varname> <term>
<varname>system.build.nixos-rebuild</varname>
</term> </term>
<term><varname>system.build.nixos-install</varname> <term>
<varname>system.build.nixos-install</varname>
</term> </term>
<term><varname>system.build.nixos-generate-config</varname> <term>
<varname>system.build.nixos-generate-config</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -82,7 +90,8 @@ $ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>systemd.units.<replaceable>unit-name</replaceable>.unit</varname> <term>
<varname>systemd.units.<replaceable>unit-name</replaceable>.unit</varname>
</term> </term>
<listitem> <listitem>
<para> <para>

View File

@ -32,7 +32,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
The function <varname>mkOption</varname> accepts the following arguments. The function <varname>mkOption</varname> accepts the following arguments.
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>type</varname> <term>
<varname>type</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -43,7 +44,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>default</varname> <term>
<varname>default</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -55,7 +57,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>example</varname> <term>
<varname>example</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -64,7 +67,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming">
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>description</varname> <term>
<varname>description</varname>
</term> </term>
<listitem> <listitem>
<para> <para>

View File

@ -22,7 +22,8 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>types.attrs</varname> <term>
<varname>types.attrs</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -31,7 +32,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.bool</varname> <term>
<varname>types.bool</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -41,7 +43,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.path</varname> <term>
<varname>types.path</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -52,7 +55,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.package</varname> <term>
<varname>types.package</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -68,7 +72,8 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>types.int</varname> <term>
<varname>types.int</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -77,7 +82,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.ints.{s8, s16, s32}</varname> <term>
<varname>types.ints.{s8, s16, s32}</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -91,7 +97,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.ints.unsigned</varname> <term>
<varname>types.ints.unsigned</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -100,7 +107,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.ints.{u8, u16, u32}</varname> <term>
<varname>types.ints.{u8, u16, u32}</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -114,7 +122,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.ints.positive</varname> <term>
<varname>types.ints.positive</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -130,7 +139,8 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>types.str</varname> <term>
<varname>types.str</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -139,7 +149,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.lines</varname> <term>
<varname>types.lines</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -149,7 +160,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.commas</varname> <term>
<varname>types.commas</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -159,7 +171,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.envVar</varname> <term>
<varname>types.envVar</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -169,7 +182,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.strMatching</varname> <term>
<varname>types.strMatching</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -191,7 +205,8 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>types.enum</varname><replaceable>l</replaceable> <term>
<varname>types.enum</varname><replaceable>l</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -202,7 +217,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.separatedString</varname><replaceable>sep</replaceable> <term>
<varname>types.separatedString</varname><replaceable>sep</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -212,7 +228,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<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> </term>
<listitem> <listitem>
<para> <para>
@ -223,7 +240,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.submodule</varname><replaceable>o</replaceable> <term>
<varname>types.submodule</varname><replaceable>o</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -250,7 +268,8 @@
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>types.listOf</varname><replaceable>t</replaceable> <term>
<varname>types.listOf</varname><replaceable>t</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -260,7 +279,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.attrsOf</varname><replaceable>t</replaceable> <term>
<varname>types.attrsOf</varname><replaceable>t</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -271,7 +291,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.loaOf</varname><replaceable>t</replaceable> <term>
<varname>types.loaOf</varname><replaceable>t</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -281,7 +302,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.nullOr</varname><replaceable>t</replaceable> <term>
<varname>types.nullOr</varname><replaceable>t</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -291,7 +313,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>types.uniq</varname><replaceable>t</replaceable> <term>
<varname>types.uniq</varname><replaceable>t</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -301,7 +324,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<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> </term>
<listitem> <listitem>
<para> <para>
@ -312,7 +336,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<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> </term>
<listitem> <listitem>
<para> <para>
@ -468,7 +493,8 @@ config.mod.two = { foo = 2; bar = "two"; };</screen>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>check</varname> <term>
<varname>check</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -501,7 +527,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>merge</varname> <term>
<varname>merge</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -534,7 +561,8 @@ nixThings = mkOption {
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>name</varname> <term>
<varname>name</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -543,7 +571,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>definition</varname> <term>
<varname>definition</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -553,7 +582,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>check</varname> <term>
<varname>check</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -565,7 +595,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>merge</varname> <term>
<varname>merge</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -573,7 +604,8 @@ nixThings = mkOption {
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><replaceable>loc</replaceable> <term>
<replaceable>loc</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -583,7 +615,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><replaceable>defs</replaceable> <term>
<replaceable>defs</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -600,7 +633,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>getSubOptions</varname> <term>
<varname>getSubOptions</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -615,7 +649,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>getSubModules</varname> <term>
<varname>getSubModules</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -628,7 +663,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>substSubModules</varname> <term>
<varname>substSubModules</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -644,7 +680,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>typeMerge</varname> <term>
<varname>typeMerge</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -654,7 +691,8 @@ nixThings = mkOption {
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><replaceable>f</replaceable> <term>
<replaceable>f</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -670,7 +708,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>functor</varname> <term>
<varname>functor</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -679,7 +718,8 @@ nixThings = mkOption {
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><varname>type</varname> <term>
<varname>type</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -688,7 +728,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>wrapped</varname> <term>
<varname>wrapped</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -697,7 +738,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>payload</varname> <term>
<varname>payload</varname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -709,7 +751,8 @@ nixThings = mkOption {
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><varname>binOp</varname> <term>
<varname>binOp</varname>
</term> </term>
<listitem> <listitem>
<para> <para>

View File

@ -54,7 +54,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf
<!-- FIXME: would be nice to generate this automatically. --> <!-- FIXME: would be nice to generate this automatically. -->
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>virtualisation.memorySize</option> <term>
<option>virtualisation.memorySize</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -63,7 +64,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>virtualisation.vlans</option> <term>
<option>virtualisation.vlans</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -75,7 +77,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>virtualisation.writableStore</option> <term>
<option>virtualisation.writableStore</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -120,7 +123,8 @@ startAll;
The following methods are available on machine objects: The following methods are available on machine objects:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><methodname>start</methodname> <term>
<methodname>start</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -130,7 +134,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>shutdown</methodname> <term>
<methodname>shutdown</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -139,7 +144,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>crash</methodname> <term>
<methodname>crash</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -148,7 +154,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>block</methodname> <term>
<methodname>block</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -158,7 +165,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>unblock</methodname> <term>
<methodname>unblock</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -167,7 +175,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>screenshot</methodname> <term>
<methodname>screenshot</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -177,7 +186,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>getScreenText</methodname> <term>
<methodname>getScreenText</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -193,7 +203,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>sendMonitorCommand</methodname> <term>
<methodname>sendMonitorCommand</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -203,7 +214,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>sendKeys</methodname> <term>
<methodname>sendKeys</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -213,7 +225,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>sendChars</methodname> <term>
<methodname>sendChars</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -224,7 +237,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>execute</methodname> <term>
<methodname>execute</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -235,7 +249,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>succeed</methodname> <term>
<methodname>succeed</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -245,7 +260,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>fail</methodname> <term>
<methodname>fail</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -255,7 +271,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>waitUntilSucceeds</methodname> <term>
<methodname>waitUntilSucceeds</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -264,7 +281,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>waitUntilFails</methodname> <term>
<methodname>waitUntilFails</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -273,7 +291,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>waitForUnit</methodname> <term>
<methodname>waitForUnit</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -282,7 +301,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>waitForFile</methodname> <term>
<methodname>waitForFile</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -291,7 +311,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>waitForOpenPort</methodname> <term>
<methodname>waitForOpenPort</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -301,7 +322,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>waitForClosedPort</methodname> <term>
<methodname>waitForClosedPort</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -310,7 +332,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>waitForX</methodname> <term>
<methodname>waitForX</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -319,7 +342,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>waitForText</methodname> <term>
<methodname>waitForText</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -336,7 +360,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>waitForWindow</methodname> <term>
<methodname>waitForWindow</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -346,7 +371,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>copyFileFromHost</methodname> <term>
<methodname>copyFileFromHost</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -361,7 +387,8 @@ startAll;
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><methodname>systemctl</methodname> <term>
<methodname>systemctl</methodname>
</term> </term>
<listitem> <listitem>
<para> <para>

View File

@ -16,7 +16,9 @@
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>UEFI systems</term> <term>
UEFI systems
</term>
<listitem> <listitem>
<para> <para>
You should boot the live CD in UEFI mode (consult your specific You should boot the live CD in UEFI mode (consult your specific
@ -138,7 +140,9 @@
<listitem> <listitem>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>UEFI systems</term> <term>
UEFI systems
</term>
<listitem> <listitem>
<para> <para>
For creating boot partitions: <command>mkfs.fat</command>. Again For creating boot partitions: <command>mkfs.fat</command>. Again
@ -178,7 +182,9 @@
<listitem> <listitem>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>UEFI systems</term> <term>
UEFI systems
</term>
<listitem> <listitem>
<para> <para>
Mount the boot file system on <filename>/mnt/boot</filename>, e.g. Mount the boot file system on <filename>/mnt/boot</filename>, e.g.
@ -234,7 +240,9 @@
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term>BIOS systems</term> <term>
BIOS systems
</term>
<listitem> <listitem>
<para> <para>
You <emphasis>must</emphasis> set the option You <emphasis>must</emphasis> set the option
@ -244,7 +252,9 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term>UEFI systems</term> <term>
UEFI systems
</term>
<listitem> <listitem>
<para> <para>
You <emphasis>must</emphasis> set the option You <emphasis>must</emphasis> set the option

View File

@ -12,14 +12,22 @@
</refname><refpurpose>build a network of virtual machines from a network of NixOS configurations</refpurpose> </refname><refpurpose>build a network of virtual machines from a network of NixOS configurations</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis><command>nixos-build-vms</command> <cmdsynopsis>
<arg><option>--show-trace</option> <command>nixos-build-vms</command>
<arg>
<option>--show-trace</option>
</arg> </arg>
<arg><option>--no-out-link</option>
<arg>
<option>--no-out-link</option>
</arg> </arg>
<arg><option>--help</option>
<arg>
<option>--help</option>
</arg> </arg>
<arg choice="plain"><replaceable>network.nix</replaceable>
<arg choice="plain">
<replaceable>network.nix</replaceable>
</arg> </arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -78,7 +86,8 @@
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>--show-trace</option> <term>
<option>--show-trace</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -87,7 +96,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--no-out-link</option> <term>
<option>--no-out-link</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -96,7 +106,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-h</option>, <option>--help</option> <term>
<option>-h</option>, <option>--help</option>
</term> </term>
<listitem> <listitem>
<para> <para>

View File

@ -12,26 +12,40 @@
</refname><refpurpose>run a command in a NixOS chroot environment</refpurpose> </refname><refpurpose>run a command in a NixOS chroot environment</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis><command>nixos-enter</command> <cmdsynopsis>
<command>nixos-enter</command>
<arg> <arg>
<arg choice='plain'><option>--root</option> <arg choice='plain'>
</arg><replaceable>root</replaceable> <option>--root</option>
</arg> </arg>
<arg> <replaceable>root</replaceable>
<arg choice='plain'><option>--system</option>
</arg><replaceable>system</replaceable>
</arg> </arg>
<arg> <arg>
<arg choice='plain'><option>-c</option> <arg choice='plain'>
</arg><replaceable>shell-command</replaceable> <option>--system</option>
</arg> </arg>
<replaceable>system</replaceable>
</arg>
<arg> <arg>
<arg choice='plain'><option>--help</option> <arg choice='plain'>
<option>-c</option>
</arg>
<replaceable>shell-command</replaceable>
</arg>
<arg>
<arg choice='plain'>
<option>--help</option>
</arg> </arg>
</arg> </arg>
<arg> <arg>
<arg choice='plain'><option>--</option> <arg choice='plain'>
</arg><replaceable>arguments</replaceable> <option>--</option>
</arg>
<replaceable>arguments</replaceable>
</arg> </arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -50,7 +64,8 @@
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>--root</option> <term>
<option>--root</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -60,7 +75,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--system</option> <term>
<option>--system</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -72,9 +88,11 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--command</option> <term>
<option>--command</option>
</term> </term>
<term><option>-c</option> <term>
<option>-c</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -83,7 +101,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--</option> <term>
<option>--</option>
</term> </term>
<listitem> <listitem>
<para> <para>

View File

@ -12,16 +12,24 @@
</refname><refpurpose>generate NixOS configuration modules</refpurpose> </refname><refpurpose>generate NixOS configuration modules</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis><command>nixos-generate-config</command> <cmdsynopsis>
<arg><option>--force</option> <command>nixos-generate-config</command>
</arg>
<arg> <arg>
<arg choice='plain'><option>--root</option> <option>--force</option>
</arg><replaceable>root</replaceable>
</arg> </arg>
<arg> <arg>
<arg choice='plain'><option>--dir</option> <arg choice='plain'>
</arg><replaceable>dir</replaceable> <option>--root</option>
</arg>
<replaceable>root</replaceable>
</arg>
<arg>
<arg choice='plain'>
<option>--dir</option>
</arg>
<replaceable>dir</replaceable>
</arg> </arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -31,7 +39,8 @@
This command writes two NixOS configuration modules: This command writes two NixOS configuration modules:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>/etc/nixos/hardware-configuration.nix</option> <term>
<option>/etc/nixos/hardware-configuration.nix</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -53,7 +62,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>/etc/nixos/configuration.nix</option> <term>
<option>/etc/nixos/configuration.nix</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -74,7 +84,8 @@
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>--root</option> <term>
<option>--root</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -88,7 +99,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--dir</option> <term>
<option>--dir</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -99,7 +111,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--force</option> <term>
<option>--force</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -109,7 +122,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--no-filesystems</option> <term>
<option>--no-filesystems</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -119,7 +133,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--show-hardware-config</option> <term>
<option>--show-hardware-config</option>
</term> </term>
<listitem> <listitem>
<para> <para>

View File

@ -12,47 +12,76 @@
</refname><refpurpose>install bootloader and NixOS</refpurpose> </refname><refpurpose>install bootloader and NixOS</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis><command>nixos-install</command> <cmdsynopsis>
<command>nixos-install</command>
<arg> <arg>
<arg choice='plain'><option>-I</option> <arg choice='plain'>
</arg><replaceable>path</replaceable> <option>-I</option>
</arg> </arg>
<replaceable>path</replaceable>
</arg>
<arg> <arg>
<arg choice='plain'><option>--root</option> <arg choice='plain'>
</arg><replaceable>root</replaceable> <option>--root</option>
</arg> </arg>
<replaceable>root</replaceable>
</arg>
<arg> <arg>
<arg choice='plain'><option>--system</option> <arg choice='plain'>
</arg><replaceable>path</replaceable> <option>--system</option>
</arg> </arg>
<replaceable>path</replaceable>
</arg>
<arg> <arg>
<arg choice='plain'><option>--no-channel-copy</option> <arg choice='plain'>
<option>--no-channel-copy</option>
</arg> </arg>
</arg> </arg>
<arg> <arg>
<arg choice='plain'><option>--no-root-passwd</option> <arg choice='plain'>
<option>--no-root-passwd</option>
</arg> </arg>
</arg> </arg>
<arg> <arg>
<arg choice='plain'><option>--no-bootloader</option> <arg choice='plain'>
<option>--no-bootloader</option>
</arg> </arg>
</arg> </arg>
<arg><group choice='req'>
<arg choice='plain'><option>--max-jobs</option>
</arg>
<arg choice='plain'><option>-j</option>
</arg></group><replaceable>number</replaceable>
</arg>
<arg><option>--cores</option><replaceable>number</replaceable>
</arg>
<arg><option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable>
</arg>
<arg> <arg>
<arg choice='plain'><option>--show-trace</option> <group choice='req'>
<arg choice='plain'>
<option>--max-jobs</option>
</arg> </arg>
<arg choice='plain'>
<option>-j</option>
</arg> </arg>
</group><replaceable>number</replaceable>
</arg>
<arg> <arg>
<arg choice='plain'><option>--help</option> <option>--cores</option><replaceable>number</replaceable>
</arg>
<arg>
<option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable>
</arg>
<arg>
<arg choice='plain'>
<option>--show-trace</option>
</arg>
</arg>
<arg>
<arg choice='plain'>
<option>--help</option>
</arg> </arg>
</arg> </arg>
</cmdsynopsis> </cmdsynopsis>
@ -106,7 +135,8 @@
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>--root</option> <term>
<option>--root</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -117,7 +147,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--system</option> <term>
<option>--system</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -135,7 +166,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-I</option> <term>
<option>-I</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -147,9 +179,11 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--max-jobs</option> <term>
<option>--max-jobs</option>
</term> </term>
<term><option>-j</option> <term>
<option>-j</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -160,7 +194,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--cores</option> <term>
<option>--cores</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -177,7 +212,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable> <term>
<option>--option</option><replaceable>name</replaceable><replaceable>value</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -187,7 +223,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--show-trace</option> <term>
<option>--show-trace</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -197,7 +234,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--help</option> <term>
<option>--help</option>
</term> </term>
<listitem> <listitem>
<para> <para>

View File

@ -12,14 +12,22 @@
</refname><refpurpose>inspect a NixOS configuration</refpurpose> </refname><refpurpose>inspect a NixOS configuration</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis><command>nixos-option</command> <cmdsynopsis>
<arg><option>-I</option><replaceable>path</replaceable> <command>nixos-option</command>
<arg>
<option>-I</option><replaceable>path</replaceable>
</arg> </arg>
<arg><option>--verbose</option>
<arg>
<option>--verbose</option>
</arg> </arg>
<arg><option>--xml</option>
<arg>
<option>--xml</option>
</arg> </arg>
<arg choice="plain"><replaceable>option.name</replaceable>
<arg choice="plain">
<replaceable>option.name</replaceable>
</arg> </arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -42,7 +50,8 @@
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>-I</option><replaceable>path</replaceable> <term>
<option>-I</option><replaceable>path</replaceable>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -52,7 +61,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--verbose</option> <term>
<option>--verbose</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -62,7 +72,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--xml</option> <term>
<option>--xml</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -76,7 +87,8 @@
<title>Environment</title> <title>Environment</title>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><envar>NIXOS_CONFIG</envar> <term>
<envar>NIXOS_CONFIG</envar>
</term> </term>
<listitem> <listitem>
<para> <para>

View File

@ -12,43 +12,75 @@
</refname><refpurpose>reconfigure a NixOS machine</refpurpose> </refname><refpurpose>reconfigure a NixOS machine</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis><command>nixos-rebuild</command><group choice='req'> <cmdsynopsis>
<arg choice='plain'><option>switch</option> <command>nixos-rebuild</command><group choice='req'>
<arg choice='plain'>
<option>switch</option>
</arg> </arg>
<arg choice='plain'><option>boot</option>
<arg choice='plain'>
<option>boot</option>
</arg> </arg>
<arg choice='plain'><option>test</option>
<arg choice='plain'>
<option>test</option>
</arg> </arg>
<arg choice='plain'><option>build</option>
<arg choice='plain'>
<option>build</option>
</arg> </arg>
<arg choice='plain'><option>dry-build</option>
<arg choice='plain'>
<option>dry-build</option>
</arg> </arg>
<arg choice='plain'><option>dry-activate</option>
<arg choice='plain'>
<option>dry-activate</option>
</arg> </arg>
<arg choice='plain'><option>build-vm</option>
<arg choice='plain'>
<option>build-vm</option>
</arg> </arg>
<arg choice='plain'><option>build-vm-with-bootloader</option>
</arg></group> <arg choice='plain'>
<option>build-vm-with-bootloader</option>
</arg>
</group>
<sbr /> <sbr />
<arg><option>--upgrade</option> <arg>
<option>--upgrade</option>
</arg> </arg>
<arg><option>--install-bootloader</option>
<arg>
<option>--install-bootloader</option>
</arg> </arg>
<arg><option>--no-build-nix</option>
<arg>
<option>--no-build-nix</option>
</arg> </arg>
<arg><option>--fast</option>
<arg>
<option>--fast</option>
</arg> </arg>
<arg><option>--rollback</option>
<arg>
<option>--rollback</option>
</arg> </arg>
<sbr /> <sbr />
<arg><group choice='req'> <arg>
<arg choice='plain'><option>--profile-name</option> <group choice='req'>
<arg choice='plain'>
<option>--profile-name</option>
</arg> </arg>
<arg choice='plain'><option>-p</option>
</arg></group><replaceable>name</replaceable> <arg choice='plain'>
<option>-p</option>
</arg>
</group><replaceable>name</replaceable>
</arg> </arg>
<sbr /> <sbr />
<arg><option>--show-trace</option> <arg>
<option>--show-trace</option>
</arg> </arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -68,7 +100,8 @@
operation. It must be one of the following: operation. It must be one of the following:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>switch</option> <term>
<option>switch</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -82,7 +115,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>boot</option> <term>
<option>boot</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -94,7 +128,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>test</option> <term>
<option>test</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -107,7 +142,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>build</option> <term>
<option>build</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -124,7 +160,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>dry-build</option> <term>
<option>dry-build</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -134,7 +171,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>dry-activate</option> <term>
<option>dry-activate</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -147,7 +185,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>build-vm</option> <term>
<option>build-vm</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -186,7 +225,8 @@ $ ./result/bin/run-*-vm
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>build-vm-with-bootloader</option> <term>
<option>build-vm-with-bootloader</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -213,7 +253,8 @@ $ ./result/bin/run-*-vm
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>--upgrade</option> <term>
<option>--upgrade</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -222,7 +263,8 @@ $ ./result/bin/run-*-vm
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--install-bootloader</option> <term>
<option>--install-bootloader</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -232,7 +274,8 @@ $ ./result/bin/run-*-vm
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--no-build-nix</option> <term>
<option>--no-build-nix</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -246,7 +289,8 @@ $ ./result/bin/run-*-vm
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--fast</option> <term>
<option>--fast</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -258,7 +302,8 @@ $ ./result/bin/run-*-vm
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--rollback</option> <term>
<option>--rollback</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -271,9 +316,11 @@ $ ./result/bin/run-*-vm
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--profile-name</option> <term>
<option>--profile-name</option>
</term> </term>
<term><option>-p</option> <term>
<option>-p</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -299,7 +346,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--build-host</option> <term>
<option>--build-host</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -323,7 +371,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--target-host</option> <term>
<option>--target-host</option>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -361,7 +410,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix
<title>Environment</title> <title>Environment</title>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><envar>NIXOS_CONFIG</envar> <term>
<envar>NIXOS_CONFIG</envar>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -371,7 +421,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><envar>NIX_SSHOPTS</envar> <term>
<envar>NIX_SSHOPTS</envar>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -386,7 +437,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix
<title>Files</title> <title>Files</title>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><filename>/run/current-system</filename> <term>
<filename>/run/current-system</filename>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -395,7 +447,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><filename>/nix/var/nix/profiles/system</filename> <term>
<filename>/nix/var/nix/profiles/system</filename>
</term> </term>
<listitem> <listitem>
<para> <para>

View File

@ -11,10 +11,14 @@
</refname><refpurpose>show the NixOS version</refpurpose> </refname><refpurpose>show the NixOS version</refpurpose>
</refnamediv> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis><command>nixos-version</command> <cmdsynopsis>
<arg><option>--hash</option> <command>nixos-version</command>
<arg>
<option>--hash</option>
</arg> </arg>
<arg><option>--revision</option>
<arg>
<option>--revision</option>
</arg> </arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -29,7 +33,8 @@
The version consists of the following elements: The version consists of the following elements:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><literal>16.03</literal> <term>
<literal>16.03</literal>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -39,7 +44,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>1011</literal> <term>
<literal>1011</literal>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -53,7 +59,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>6317da4</literal> <term>
<literal>6317da4</literal>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -63,7 +70,8 @@
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><literal>Emu</literal> <term>
<literal>Emu</literal>
</term> </term>
<listitem> <listitem>
<para> <para>
@ -83,9 +91,11 @@
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>--hash</option> <term>
<option>--hash</option>
</term> </term>
<term><option>--revision</option> <term>
<option>--revision</option>
</term> </term>
<listitem> <listitem>
<para> <para>

View File

@ -435,11 +435,11 @@ system.autoUpgrade.enable = true;
<programlisting> <programlisting>
system.nixos.stateVersion = "14.12"; system.nixos.stateVersion = "14.12";
</programlisting> </programlisting>
The new option <option>system.nixos.stateVersion</option> ensures that certain The new option <option>system.nixos.stateVersion</option> ensures that
configuration changes that could break existing systems (such as the certain configuration changes that could break existing systems (such as
<command>sshd</command> host key setting) will maintain compatibility with the <command>sshd</command> host key setting) will maintain compatibility
the specified NixOS release. NixOps sets the state version of existing with the specified NixOS release. NixOps sets the state version of
deployments automatically. existing deployments automatically.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>

View File

@ -53,10 +53,12 @@ $ nix-instantiate -E '(import &lt;nixpkgsunstable&gt; {}).gitFull'
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>When enabled the <literal>iproute2</literal> will copy the files <para>
expected by ip route (e.g., <filename>rt_tables</filename>) in 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 <filename>/run/iproute2</filename>. This allows to write aliases for
routing tables for instance.</para> routing tables for instance.
</para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
</section> </section>
@ -99,20 +101,24 @@ $ nix-instantiate -E '(import &lt;nixpkgsunstable&gt; {}).gitFull'
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The <varname>services.docker-registry.extraConfig</varname> object doesn't contain The <varname>services.docker-registry.extraConfig</varname> object doesn't
environment variables anymore. Instead it needs to provide an object structure contain environment variables anymore. Instead it needs to provide an
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>. 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> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<literal>gnucash</literal> has changed from version 2.4 to 3.x. <literal>gnucash</literal> has changed from version 2.4 to 3.x. If you've
If you've been using <literal>gnucash</literal> (version 2.4) instead of been using <literal>gnucash</literal> (version 2.4) instead of
<literal>gnucash26</literal> (version 2.6) you must open your Gnucash <literal>gnucash26</literal> (version 2.6) you must open your Gnucash data
data file(s) with <literal>gnucash26</literal> and then save them to file(s) with <literal>gnucash26</literal> and then save them to upgrade
upgrade the file format. Then you may use your data file(s) with the file format. Then you may use your data file(s) with Gnucash 3.x. See
Gnucash 3.x. See the upgrade <link xlink:href="https://wiki.gnucash.org/wiki/FAQ#Using_Different_Versions.2C_Up_And_Downgrade">documentation</link>. the upgrade
Gnucash 2.4 is still available under the attribute <literal>gnucash24</literal>. <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> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -128,9 +134,9 @@ $ nix-instantiate -E '(import &lt;nixpkgsunstable&gt; {}).gitFull'
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para> <para>
<literal>dockerTools.pullImage</literal> relies on image digest <literal>dockerTools.pullImage</literal> relies on image digest instead of
instead of image tag to download the image. The image tag to download the image. The <literal>sha256</literal> of a pulled
<literal>sha256</literal> of a pulled image has to be updated. image has to be updated.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
@ -187,32 +193,40 @@ $ nix-instantiate -E '(import &lt;nixpkgsunstable&gt; {}).gitFull'
<para> <para>
The module for <option>security.dhparams</option> has two new options now: The module for <option>security.dhparams</option> has two new options now:
</para> </para>
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>security.dhparams.stateless</option></term> <term>
<listitem><para> <option>security.dhparams.stateless</option>
</term>
<listitem>
<para>
Puts the generated Diffie-Hellman parameters into the Nix store instead Puts the generated Diffie-Hellman parameters into the Nix store instead
of managing them in a stateful manner in of managing them in a stateful manner in
<filename class="directory">/var/lib/dhparams</filename>. <filename class="directory">/var/lib/dhparams</filename>.
</para></listitem> </para>
</listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>security.dhparams.defaultBitSize</option></term> <term>
<listitem><para> <option>security.dhparams.defaultBitSize</option>
The default bit size to use for the generated Diffie-Hellman parameters. </term>
</para></listitem> <listitem>
<para>
The default bit size to use for the generated Diffie-Hellman
parameters.
</para>
</listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
<note>
<note><para> <para>
The path to the actual generated parameter files should now be queried The path to the actual generated parameter files should now be queried
using using
<literal>config.security.dhparams.params.<replaceable>name</replaceable>.path</literal> <literal>config.security.dhparams.params.<replaceable>name</replaceable>.path</literal>
because it might be either in the Nix store or in a directory configured because it might be either in the Nix store or in a directory configured
by <option>security.dhparams.path</option>. by <option>security.dhparams.path</option>.
</para></note> </para>
</note>
<note> <note>
<title>For developers:</title> <title>For developers:</title>
<para> <para>
@ -237,20 +251,23 @@ $ nix-instantiate -E '(import &lt;nixpkgsunstable&gt; {}).gitFull'
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
<literal>networking.networkmanager.useDnsmasq</literal> has been deprecated. Use <literal>networking.networkmanager.useDnsmasq</literal> has been
<literal>networking.networkmanager.dns</literal> instead. deprecated. Use <literal>networking.networkmanager.dns</literal> instead.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
The option <varname>services.kubernetes.apiserver.admissionControl</varname> The option
was renamed to <varname>services.kubernetes.apiserver.enableAdmissionPlugins</varname>. <varname>services.kubernetes.apiserver.admissionControl</varname> was
renamed to
<varname>services.kubernetes.apiserver.enableAdmissionPlugins</varname>.
</para> </para>
</listitem> </listitem>
<listitem> <listitem>
<para> <para>
Recommented way to access the Kubernetes Dashboard is with HTTPS (TLS) 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> </para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>