Browse Source

nixos/doc: ran `make format`

With visual inspection that nothing got worse.
nixos-19.03
Samuel Dionne-Riel 4 years ago
parent
commit
88ca2b1ec4
  1. 15
      nixos/doc/manual/administration/boot-problems.xml
  2. 24
      nixos/doc/manual/configuration/config-file.xml
  3. 27
      nixos/doc/manual/development/building-parts.xml
  4. 12
      nixos/doc/manual/development/option-declarations.xml
  5. 129
      nixos/doc/manual/development/option-types.xml
  6. 81
      nixos/doc/manual/development/writing-nixos-tests.xml
  7. 20
      nixos/doc/manual/installation/installing.xml
  8. 27
      nixos/doc/manual/man-nixos-build-vms.xml
  9. 49
      nixos/doc/manual/man-nixos-enter.xml
  10. 41
      nixos/doc/manual/man-nixos-generate-config.xml
  11. 92
      nixos/doc/manual/man-nixos-install.xml
  12. 30
      nixos/doc/manual/man-nixos-option.xml
  13. 135
      nixos/doc/manual/man-nixos-rebuild.xml
  14. 28
      nixos/doc/manual/man-nixos-version.xml
  15. 10
      nixos/doc/manual/release-notes/rl-1509.xml
  16. 101
      nixos/doc/manual/release-notes/rl-1809.xml

15
nixos/doc/manual/administration/boot-problems.xml

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

24
nixos/doc/manual/configuration/config-file.xml

@ -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:
<variablelist>
<varlistentry>
<term>Strings</term>
<term>
Strings
</term>
<listitem>
<para>
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>
</varlistentry>
<varlistentry>
<term>Booleans</term>
<term>
Booleans
</term>
<listitem>
<para>
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>
</varlistentry>
<varlistentry>
<term>Integers</term>
<term>
Integers
</term>
<listitem>
<para>
For example,
@ -141,7 +147,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no
</listitem>
</varlistentry>
<varlistentry>
<term>Sets</term>
<term>
Sets
</term>
<listitem>
<para>
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>
</varlistentry>
<varlistentry>
<term>Lists</term>
<term>
Lists
</term>
<listitem>
<para>
The important thing to note about lists is that list elements are
@ -173,7 +183,9 @@ swapDevices = [ { device = "/dev/disk/by-label/swap"; } ];
</listitem>
</varlistentry>
<varlistentry>
<term>Packages</term>
<term>
Packages
</term>
<listitem>
<para>
Usually, the packages you need are already part of the Nix Packages

27
nixos/doc/manual/development/building-parts.xml

@ -15,7 +15,8 @@ $ nix-build -A config.<replaceable>option</replaceable></screen>
include:
<variablelist>
<varlistentry>
<term><varname>system.build.toplevel</varname>
<term>
<varname>system.build.toplevel</varname>
</term>
<listitem>
<para>
@ -32,7 +33,8 @@ $ nix-build -A system</screen>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>system.build.manual.manual</varname>
<term>
<varname>system.build.manual.manual</varname>
</term>
<listitem>
<para>
@ -41,7 +43,8 @@ $ nix-build -A system</screen>
</listitem>
</varlistentry>
<varlistentry>
<term><varname>system.build.etc</varname>
<term>
<varname>system.build.etc</varname>
</term>
<listitem>
<para>
@ -51,9 +54,11 @@ $ nix-build -A system</screen>
</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>
@ -69,11 +74,14 @@ $ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/
</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>
@ -82,7 +90,8 @@ $ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/
</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>

12
nixos/doc/manual/development/option-declarations.xml

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

129
nixos/doc/manual/development/option-types.xml

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

81
nixos/doc/manual/development/writing-nixos-tests.xml

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

20
nixos/doc/manual/installation/installing.xml

@ -16,7 +16,9 @@
</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
@ -138,7 +140,9 @@
<listitem>
<variablelist>
<varlistentry>
<term>UEFI systems</term>
<term>
UEFI systems
</term>
<listitem>
<para>
For creating boot partitions: <command>mkfs.fat</command>. Again
@ -178,7 +182,9 @@
<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.
@ -234,7 +240,9 @@
</para>
<variablelist>
<varlistentry>
<term>BIOS systems</term>
<term>
BIOS systems
</term>
<listitem>
<para>
You <emphasis>must</emphasis> set the option
@ -244,7 +252,9 @@
</listitem>
</varlistentry>
<varlistentry>
<term>UEFI systems</term>
<term>
UEFI systems
</term>
<listitem>
<para>
You <emphasis>must</emphasis> set the option

27
nixos/doc/manual/man-nixos-build-vms.xml

@ -12,14 +12,22 @@
</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>
@ -78,7 +86,8 @@
</para>
<variablelist>
<varlistentry>
<term><option>--show-trace</option>
<term>
<option>--show-trace</option>
</term>
<listitem>
<para>
@ -87,7 +96,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-out-link</option>
<term>
<option>--no-out-link</option>
</term>
<listitem>
<para>
@ -96,7 +106,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>-h</option>, <option>--help</option>
<term>
<option>-h</option>, <option>--help</option>
</term>
<listitem>
<para>

49
nixos/doc/manual/man-nixos-enter.xml

@ -12,26 +12,40 @@
</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>
@ -50,7 +64,8 @@
</para>
<variablelist>
<varlistentry>
<term><option>--root</option>
<term>
<option>--root</option>
</term>
<listitem>
<para>
@ -60,7 +75,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option>
<term>
<option>--system</option>
</term>
<listitem>
<para>
@ -72,9 +88,11 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--command</option>
<term>
<option>--command</option>
</term>
<term><option>-c</option>
<term>
<option>-c</option>
</term>
<listitem>
<para>
@ -83,7 +101,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--</option>
<term>
<option>--</option>
</term>
<listitem>
<para>

41
nixos/doc/manual/man-nixos-generate-config.xml

@ -12,16 +12,24 @@
</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>
@ -31,7 +39,8 @@
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>
@ -53,7 +62,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>/etc/nixos/configuration.nix</option>
<term>
<option>/etc/nixos/configuration.nix</option>
</term>
<listitem>
<para>
@ -74,7 +84,8 @@
</para>
<variablelist>
<varlistentry>
<term><option>--root</option>
<term>
<option>--root</option>
</term>
<listitem>
<para>
@ -88,7 +99,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--dir</option>
<term>
<option>--dir</option>
</term>
<listitem>
<para>
@ -99,7 +111,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--force</option>
<term>
<option>--force</option>
</term>
<listitem>
<para>
@ -109,7 +122,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--no-filesystems</option>
<term>
<option>--no-filesystems</option>
</term>
<listitem>
<para>
@ -119,7 +133,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-hardware-config</option>
<term>
<option>--show-hardware-config</option>
</term>
<listitem>
<para>

92
nixos/doc/manual/man-nixos-install.xml

@ -12,47 +12,76 @@
</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>
@ -106,7 +135,8 @@
</para>
<variablelist>
<varlistentry>
<term><option>--root</option>
<term>
<option>--root</option>
</term>
<listitem>
<para>
@ -117,7 +147,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--system</option>
<term>
<option>--system</option>
</term>
<listitem>
<para>
@ -135,7 +166,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>-I</option>
<term>
<option>-I</option>
</term>
<listitem>
<para>
@ -147,9 +179,11 @@
</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>
@ -160,7 +194,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--cores</option>
<term>
<option>--cores</option>
</term>
<listitem>
<para>
@ -177,7 +212,8 @@
</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>
@ -187,7 +223,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--show-trace</option>
<term>
<option>--show-trace</option>
</term>
<listitem>
<para>
@ -197,7 +234,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--help</option>
<term>
<option>--help</option>
</term>
<listitem>
<para>

30
nixos/doc/manual/man-nixos-option.xml

@ -12,14 +12,22 @@
</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>
@ -42,7 +50,8 @@
</para>
<variablelist>
<varlistentry>
<term><option>-I</option><replaceable>path</replaceable>
<term>
<option>-I</option><replaceable>path</replaceable>
</term>
<listitem>
<para>
@ -52,7 +61,8 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>--verbose</option>
<term>
<option>--verbose</option>