diff --git a/nixos/doc/manual/administration/boot-problems.xml b/nixos/doc/manual/administration/boot-problems.xml index 5f05ad261ef..de3d8ac21ae 100644 --- a/nixos/doc/manual/administration/boot-problems.xml +++ b/nixos/doc/manual/administration/boot-problems.xml @@ -14,7 +14,8 @@ NixOS boot scripts or by systemd: - boot.shell_on_fail + + boot.shell_on_fail @@ -25,7 +26,8 @@ - boot.debug1 + + boot.debug1 @@ -37,7 +39,8 @@ - boot.trace + + boot.trace @@ -46,7 +49,8 @@ - single + + single @@ -59,7 +63,8 @@ - systemd.log_level=debug systemd.log_target=console + + systemd.log_level=debug systemd.log_target=console diff --git a/nixos/doc/manual/configuration/config-file.xml b/nixos/doc/manual/configuration/config-file.xml index a9420b3fc92..8a1a39c98c1 100644 --- a/nixos/doc/manual/configuration/config-file.xml +++ b/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: - Strings + + Strings + 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 - Booleans + + Booleans + These can be true or false, e.g. @@ -124,7 +128,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no - Integers + + Integers + For example, @@ -141,7 +147,9 @@ The option value `services.httpd.enable' in `/etc/nixos/configuration.nix' is no - Sets + + Sets + 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 - Lists + + Lists + The important thing to note about lists is that list elements are @@ -173,7 +183,9 @@ swapDevices = [ { device = "/dev/disk/by-label/swap"; } ]; - Packages + + Packages + Usually, the packages you need are already part of the Nix Packages diff --git a/nixos/doc/manual/development/building-parts.xml b/nixos/doc/manual/development/building-parts.xml index 031048aaa37..eaffc0ef47c 100644 --- a/nixos/doc/manual/development/building-parts.xml +++ b/nixos/doc/manual/development/building-parts.xml @@ -15,7 +15,8 @@ $ nix-build -A config.option include: - system.build.toplevel + + system.build.toplevel @@ -32,7 +33,8 @@ $ nix-build -A system - system.build.manual.manual + + system.build.manual.manual @@ -41,7 +43,8 @@ $ nix-build -A system - system.build.etc + + system.build.etc @@ -51,9 +54,11 @@ $ nix-build -A system - system.build.initialRamdisk + + system.build.initialRamdisk - system.build.kernel + + system.build.kernel @@ -69,11 +74,14 @@ $ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/ - system.build.nixos-rebuild + + system.build.nixos-rebuild - system.build.nixos-install + + system.build.nixos-install - system.build.nixos-generate-config + + system.build.nixos-generate-config @@ -82,7 +90,8 @@ $ qemu-system-x86_64 -kernel ./kernel/bzImage -initrd ./initrd/initrd -hda /dev/ - systemd.units.unit-name.unit + + systemd.units.unit-name.unit diff --git a/nixos/doc/manual/development/option-declarations.xml b/nixos/doc/manual/development/option-declarations.xml index a8f528a0a80..eee81bf6426 100644 --- a/nixos/doc/manual/development/option-declarations.xml +++ b/nixos/doc/manual/development/option-declarations.xml @@ -32,7 +32,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> The function mkOption accepts the following arguments. - type + + type @@ -43,7 +44,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> - default + + default @@ -55,7 +57,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> - example + + example @@ -64,7 +67,8 @@ xlink:href="https://nixos.org/nixpkgs/manual/#sec-package-naming"> - description + + description diff --git a/nixos/doc/manual/development/option-types.xml b/nixos/doc/manual/development/option-types.xml index 5cb747e6d9f..bf2e38b4c4d 100644 --- a/nixos/doc/manual/development/option-types.xml +++ b/nixos/doc/manual/development/option-types.xml @@ -22,7 +22,8 @@ - types.attrs + + types.attrs @@ -31,7 +32,8 @@ - types.bool + + types.bool @@ -41,7 +43,8 @@ - types.path + + types.path @@ -52,7 +55,8 @@ - types.package + + types.package @@ -68,7 +72,8 @@ - types.int + + types.int @@ -77,7 +82,8 @@ - types.ints.{s8, s16, s32} + + types.ints.{s8, s16, s32} @@ -91,7 +97,8 @@ - types.ints.unsigned + + types.ints.unsigned @@ -100,7 +107,8 @@ - types.ints.{u8, u16, u32} + + types.ints.{u8, u16, u32} @@ -114,7 +122,8 @@ - types.ints.positive + + types.ints.positive @@ -130,7 +139,8 @@ - types.str + + types.str @@ -139,7 +149,8 @@ - types.lines + + types.lines @@ -149,7 +160,8 @@ - types.commas + + types.commas @@ -159,7 +171,8 @@ - types.envVar + + types.envVar @@ -169,7 +182,8 @@ - types.strMatching + + types.strMatching @@ -191,7 +205,8 @@ - types.enuml + + types.enuml @@ -202,7 +217,8 @@ - types.separatedStringsep + + types.separatedStringsep @@ -212,7 +228,8 @@ - types.ints.betweenlowesthighest + + types.ints.betweenlowesthighest @@ -223,7 +240,8 @@ - types.submoduleo + + types.submoduleo @@ -250,7 +268,8 @@ - types.listOft + + types.listOft @@ -260,7 +279,8 @@ - types.attrsOft + + types.attrsOft @@ -271,7 +291,8 @@ - types.loaOft + + types.loaOft @@ -281,7 +302,8 @@ - types.nullOrt + + types.nullOrt @@ -291,7 +313,8 @@ - types.uniqt + + types.uniqt @@ -301,7 +324,8 @@ - types.eithert1t2 + + types.eithert1t2 @@ -312,7 +336,8 @@ - types.coercedTofromfto + + types.coercedTofromfto @@ -468,7 +493,8 @@ config.mod.two = { foo = 2; bar = "two"; }; - check + + check @@ -501,7 +527,8 @@ nixThings = mkOption { - merge + + merge @@ -534,7 +561,8 @@ nixThings = mkOption { - name + + name @@ -543,7 +571,8 @@ nixThings = mkOption { - definition + + definition @@ -553,7 +582,8 @@ nixThings = mkOption { - check + + check @@ -565,7 +595,8 @@ nixThings = mkOption { - merge + + merge @@ -573,7 +604,8 @@ nixThings = mkOption { - loc + + loc @@ -583,7 +615,8 @@ nixThings = mkOption { - defs + + defs @@ -600,7 +633,8 @@ nixThings = mkOption { - getSubOptions + + getSubOptions @@ -615,7 +649,8 @@ nixThings = mkOption { - getSubModules + + getSubModules @@ -628,7 +663,8 @@ nixThings = mkOption { - substSubModules + + substSubModules @@ -644,7 +680,8 @@ nixThings = mkOption { - typeMerge + + typeMerge @@ -654,7 +691,8 @@ nixThings = mkOption { - f + + f @@ -670,7 +708,8 @@ nixThings = mkOption { - functor + + functor @@ -679,7 +718,8 @@ nixThings = mkOption { - type + + type @@ -688,7 +728,8 @@ nixThings = mkOption { - wrapped + + wrapped @@ -697,7 +738,8 @@ nixThings = mkOption { - payload + + payload @@ -709,7 +751,8 @@ nixThings = mkOption { - binOp + + binOp diff --git a/nixos/doc/manual/development/writing-nixos-tests.xml b/nixos/doc/manual/development/writing-nixos-tests.xml index 89a6a442362..5935fbc049b 100644 --- a/nixos/doc/manual/development/writing-nixos-tests.xml +++ b/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 - + + @@ -63,7 +64,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf - + + @@ -75,7 +77,8 @@ xlink:href="https://github.com/NixOS/nixpkgs/blob/master/nixos/tests/nfs.nix">nf - + + @@ -120,7 +123,8 @@ startAll; The following methods are available on machine objects: - start + + start @@ -130,7 +134,8 @@ startAll; - shutdown + + shutdown @@ -139,7 +144,8 @@ startAll; - crash + + crash @@ -148,7 +154,8 @@ startAll; - block + + block @@ -158,7 +165,8 @@ startAll; - unblock + + unblock @@ -167,7 +175,8 @@ startAll; - screenshot + + screenshot @@ -177,7 +186,8 @@ startAll; - getScreenText + + getScreenText @@ -193,7 +203,8 @@ startAll; - sendMonitorCommand + + sendMonitorCommand @@ -203,7 +214,8 @@ startAll; - sendKeys + + sendKeys @@ -213,7 +225,8 @@ startAll; - sendChars + + sendChars @@ -224,7 +237,8 @@ startAll; - execute + + execute @@ -235,7 +249,8 @@ startAll; - succeed + + succeed @@ -245,7 +260,8 @@ startAll; - fail + + fail @@ -255,7 +271,8 @@ startAll; - waitUntilSucceeds + + waitUntilSucceeds @@ -264,7 +281,8 @@ startAll; - waitUntilFails + + waitUntilFails @@ -273,7 +291,8 @@ startAll; - waitForUnit + + waitForUnit @@ -282,7 +301,8 @@ startAll; - waitForFile + + waitForFile @@ -291,7 +311,8 @@ startAll; - waitForOpenPort + + waitForOpenPort @@ -301,7 +322,8 @@ startAll; - waitForClosedPort + + waitForClosedPort @@ -310,7 +332,8 @@ startAll; - waitForX + + waitForX @@ -319,7 +342,8 @@ startAll; - waitForText + + waitForText @@ -336,7 +360,8 @@ startAll; - waitForWindow + + waitForWindow @@ -346,7 +371,8 @@ startAll; - copyFileFromHost + + copyFileFromHost @@ -361,7 +387,8 @@ startAll; - systemctl + + systemctl diff --git a/nixos/doc/manual/installation/installing.xml b/nixos/doc/manual/installation/installing.xml index 4e1fde662d6..6066d025adb 100644 --- a/nixos/doc/manual/installation/installing.xml +++ b/nixos/doc/manual/installation/installing.xml @@ -16,7 +16,9 @@ - UEFI systems + + UEFI systems + You should boot the live CD in UEFI mode (consult your specific @@ -138,7 +140,9 @@ - UEFI systems + + UEFI systems + For creating boot partitions: mkfs.fat. Again @@ -178,7 +182,9 @@ - UEFI systems + + UEFI systems + Mount the boot file system on /mnt/boot, e.g. @@ -234,7 +240,9 @@ - BIOS systems + + BIOS systems + You must set the option @@ -244,7 +252,9 @@ - UEFI systems + + UEFI systems + You must set the option diff --git a/nixos/doc/manual/man-nixos-build-vms.xml b/nixos/doc/manual/man-nixos-build-vms.xml index 02dad4c548b..87e4f3dae86 100644 --- a/nixos/doc/manual/man-nixos-build-vms.xml +++ b/nixos/doc/manual/man-nixos-build-vms.xml @@ -12,14 +12,22 @@ build a network of virtual machines from a network of NixOS configurations - nixos-build-vms - + + nixos-build-vms + + - + + + - + + + - network.nix + + + network.nix @@ -78,7 +86,8 @@ - + + @@ -87,7 +96,8 @@ - + + @@ -96,7 +106,8 @@ - , + + , diff --git a/nixos/doc/manual/man-nixos-enter.xml b/nixos/doc/manual/man-nixos-enter.xml index 7db4b72ee36..42edaa1ae5b 100644 --- a/nixos/doc/manual/man-nixos-enter.xml +++ b/nixos/doc/manual/man-nixos-enter.xml @@ -12,26 +12,40 @@ run a command in a NixOS chroot environment - nixos-enter + + nixos-enter - - root + + + + root + - - system + + + + system + - - shell-command + + + + shell-command + - + + + - - arguments + + + + arguments @@ -50,7 +64,8 @@ - + + @@ -60,7 +75,8 @@ - + + @@ -72,9 +88,11 @@ - + + - + + @@ -83,7 +101,8 @@ - + + diff --git a/nixos/doc/manual/man-nixos-generate-config.xml b/nixos/doc/manual/man-nixos-generate-config.xml index 8bf90f452db..1227873f578 100644 --- a/nixos/doc/manual/man-nixos-generate-config.xml +++ b/nixos/doc/manual/man-nixos-generate-config.xml @@ -12,16 +12,24 @@ generate NixOS configuration modules - nixos-generate-config - - + + nixos-generate-config - - root + + - - dir + + + + root + + + + + + + dir @@ -31,7 +39,8 @@ This command writes two NixOS configuration modules: - + + @@ -53,7 +62,8 @@ - + + @@ -74,7 +84,8 @@ - + + @@ -88,7 +99,8 @@ - + + @@ -99,7 +111,8 @@ - + + @@ -109,7 +122,8 @@ - + + @@ -119,7 +133,8 @@ - + + diff --git a/nixos/doc/manual/man-nixos-install.xml b/nixos/doc/manual/man-nixos-install.xml index 2d45e83a863..34b3eef8b21 100644 --- a/nixos/doc/manual/man-nixos-install.xml +++ b/nixos/doc/manual/man-nixos-install.xml @@ -12,47 +12,76 @@ install bootloader and NixOS - nixos-install + + nixos-install - - path + + + + path + - - root + + + + root + - - path + + + + path + - + + + - + + + - + + - - - - - number - - number - - namevalue - + - + + + + + + + + + number + + + + number + + + + namevalue + + + + + + - + + @@ -106,7 +135,8 @@ - + + @@ -117,7 +147,8 @@ - + + @@ -135,7 +166,8 @@ - + + @@ -147,9 +179,11 @@ - + + - + + @@ -160,7 +194,8 @@ - + + @@ -177,7 +212,8 @@ - namevalue + + namevalue @@ -187,7 +223,8 @@ - + + @@ -197,7 +234,8 @@ - + + diff --git a/nixos/doc/manual/man-nixos-option.xml b/nixos/doc/manual/man-nixos-option.xml index c22c3811ded..e087a18eba8 100644 --- a/nixos/doc/manual/man-nixos-option.xml +++ b/nixos/doc/manual/man-nixos-option.xml @@ -12,14 +12,22 @@ inspect a NixOS configuration - nixos-option - path + + nixos-option + + path - + + + - + + + - option.name + + + option.name @@ -42,7 +50,8 @@ - path + + path @@ -52,7 +61,8 @@ - + + @@ -62,7 +72,8 @@ - + + @@ -76,7 +87,8 @@ Environment - NIXOS_CONFIG + + NIXOS_CONFIG diff --git a/nixos/doc/manual/man-nixos-rebuild.xml b/nixos/doc/manual/man-nixos-rebuild.xml index e1a2c7108d1..1dbcfd329bc 100644 --- a/nixos/doc/manual/man-nixos-rebuild.xml +++ b/nixos/doc/manual/man-nixos-rebuild.xml @@ -12,43 +12,75 @@ reconfigure a NixOS machine - nixos-rebuild - + + nixos-rebuild + + - + + + - + + + - + + + - + + + - + + + - + + + - - + + + + + - + + - + + + - + + + - + + + - + + + - - + + + + - - name + + + + + name - + + @@ -68,7 +100,8 @@ operation. It must be one of the following: - + + @@ -82,7 +115,8 @@ - + + @@ -94,7 +128,8 @@ - + + @@ -107,7 +142,8 @@ - + + @@ -124,7 +160,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system - + + @@ -134,7 +171,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system - + + @@ -147,7 +185,8 @@ $ nix-build /path/to/nixpkgs/nixos -A system - + + @@ -186,7 +225,8 @@ $ ./result/bin/run-*-vm - + + @@ -213,7 +253,8 @@ $ ./result/bin/run-*-vm - + + @@ -222,7 +263,8 @@ $ ./result/bin/run-*-vm - + + @@ -232,7 +274,8 @@ $ ./result/bin/run-*-vm - + + @@ -246,7 +289,8 @@ $ ./result/bin/run-*-vm - + + @@ -258,7 +302,8 @@ $ ./result/bin/run-*-vm - + + @@ -271,9 +316,11 @@ $ ./result/bin/run-*-vm - + + - + + @@ -299,7 +346,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix - + + @@ -323,7 +371,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix - + + @@ -361,7 +410,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix Environment - NIXOS_CONFIG + + NIXOS_CONFIG @@ -371,7 +421,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix - NIX_SSHOPTS + + NIX_SSHOPTS @@ -386,7 +437,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix Files - /run/current-system + + /run/current-system @@ -395,7 +447,8 @@ $ nixos-rebuild switch -p test -I nixos-config=./test.nix - /nix/var/nix/profiles/system + + /nix/var/nix/profiles/system diff --git a/nixos/doc/manual/man-nixos-version.xml b/nixos/doc/manual/man-nixos-version.xml index c173bce1913..931c4a5ad02 100644 --- a/nixos/doc/manual/man-nixos-version.xml +++ b/nixos/doc/manual/man-nixos-version.xml @@ -11,10 +11,14 @@ show the NixOS version - nixos-version - + + nixos-version + + - + + + @@ -29,7 +33,8 @@ The version consists of the following elements: - 16.03 + + 16.03 @@ -39,7 +44,8 @@ - 1011 + + 1011 @@ -53,7 +59,8 @@ - 6317da4 + + 6317da4 @@ -63,7 +70,8 @@ - Emu + + Emu @@ -83,9 +91,11 @@ - + + - + + diff --git a/nixos/doc/manual/release-notes/rl-1509.xml b/nixos/doc/manual/release-notes/rl-1509.xml index 734bc076b85..2465f370cf1 100644 --- a/nixos/doc/manual/release-notes/rl-1509.xml +++ b/nixos/doc/manual/release-notes/rl-1509.xml @@ -435,11 +435,11 @@ system.autoUpgrade.enable = true; system.nixos.stateVersion = "14.12"; - The new option ensures that certain - configuration changes that could break existing systems (such as the - sshd host key setting) will maintain compatibility with - the specified NixOS release. NixOps sets the state version of existing - deployments automatically. + The new option ensures that + certain configuration changes that could break existing systems (such as + the sshd host key setting) will maintain compatibility + with the specified NixOS release. NixOps sets the state version of + existing deployments automatically. diff --git a/nixos/doc/manual/release-notes/rl-1809.xml b/nixos/doc/manual/release-notes/rl-1809.xml index 35dc69515ff..ae0f35046ff 100644 --- a/nixos/doc/manual/release-notes/rl-1809.xml +++ b/nixos/doc/manual/release-notes/rl-1809.xml @@ -53,10 +53,12 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' - When enabled the iproute2 will copy the files - expected by ip route (e.g., rt_tables) in - /run/iproute2. This allows to write aliases for - routing tables for instance. + + When enabled the iproute2 will copy the files expected + by ip route (e.g., rt_tables) in + /run/iproute2. This allows to write aliases for + routing tables for instance. + @@ -99,20 +101,24 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' - The services.docker-registry.extraConfig 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 the docker/distribution docs. + The services.docker-registry.extraConfig 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 + the + docker/distribution docs. - gnucash has changed from version 2.4 to 3.x. - If you've been using gnucash (version 2.4) instead of - gnucash26 (version 2.6) you must open your Gnucash - data file(s) with gnucash26 and then save them to - upgrade the file format. Then you may use your data file(s) with - Gnucash 3.x. See the upgrade documentation. - Gnucash 2.4 is still available under the attribute gnucash24. + gnucash has changed from version 2.4 to 3.x. If you've + been using gnucash (version 2.4) instead of + gnucash26 (version 2.6) you must open your Gnucash data + file(s) with gnucash26 and then save them to upgrade + the file format. Then you may use your data file(s) with Gnucash 3.x. See + the upgrade + documentation. + Gnucash 2.4 is still available under the attribute + gnucash24. @@ -128,9 +134,9 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' - dockerTools.pullImage relies on image digest - instead of image tag to download the image. The - sha256 of a pulled image has to be updated. + dockerTools.pullImage relies on image digest instead of + image tag to download the image. The sha256 of a pulled + image has to be updated. @@ -187,32 +193,40 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' The module for has two new options now: - - - - Puts the generated Diffie-Hellman parameters into the Nix store instead - of managing them in a stateful manner in - /var/lib/dhparams. - + + + + + + Puts the generated Diffie-Hellman parameters into the Nix store instead + of managing them in a stateful manner in + /var/lib/dhparams. + + - - - The default bit size to use for the generated Diffie-Hellman parameters. - + + + + + + The default bit size to use for the generated Diffie-Hellman + parameters. + + - - - The path to the actual generated parameter files should now be queried - using - config.security.dhparams.params.name.path - because it might be either in the Nix store or in a directory configured - by . - - + + + The path to the actual generated parameter files should now be queried + using + config.security.dhparams.params.name.path + because it might be either in the Nix store or in a directory configured + by . + + For developers: @@ -237,20 +251,23 @@ $ nix-instantiate -E '(import <nixpkgsunstable> {}).gitFull' - networking.networkmanager.useDnsmasq has been deprecated. Use - networking.networkmanager.dns instead. + networking.networkmanager.useDnsmasq has been + deprecated. Use networking.networkmanager.dns instead. - The option services.kubernetes.apiserver.admissionControl - was renamed to services.kubernetes.apiserver.enableAdmissionPlugins. + The option + services.kubernetes.apiserver.admissionControl was + renamed to + services.kubernetes.apiserver.enableAdmissionPlugins. 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.