From ea6e8775bd69e4676c623a85c39f1da540d29ad1 Mon Sep 17 00:00:00 2001 From: Jan Tojnar Date: Wed, 18 Sep 2019 22:13:35 +0200 Subject: nixos/doc: re-format --- nixos/doc/manual/man-nixos-install.xml | 95 ++++++++++------------------------ 1 file changed, 28 insertions(+), 67 deletions(-) (limited to 'nixos/doc/manual/man-nixos-install.xml') diff --git a/nixos/doc/manual/man-nixos-install.xml b/nixos/doc/manual/man-nixos-install.xml index 4fb94ee7494..aec01b0ee3b 100644 --- a/nixos/doc/manual/man-nixos-install.xml +++ b/nixos/doc/manual/man-nixos-install.xml @@ -13,72 +13,72 @@ - nixos-install + nixos-install path - + root - + path - + - + - + - + - + - + number - + number - + name value - + - + @@ -89,43 +89,32 @@ Description - This command installs NixOS in the file system mounted on - /mnt, based on the NixOS configuration specified in - /mnt/etc/nixos/configuration.nix. It performs the - following steps: + This command installs NixOS in the file system mounted on /mnt, based on the NixOS configuration specified in /mnt/etc/nixos/configuration.nix. It performs the following steps: - It copies Nix and its dependencies to - /mnt/nix/store. + It copies Nix and its dependencies to /mnt/nix/store. - It runs Nix in /mnt to build the NixOS configuration - specified in /mnt/etc/nixos/configuration.nix. + It runs Nix in /mnt to build the NixOS configuration specified in /mnt/etc/nixos/configuration.nix. - It installs the GRUB boot loader on the device specified in the option - (unless - is specified), and generates a GRUB - configuration file that boots into the NixOS configuration just - installed. + It installs the GRUB boot loader on the device specified in the option (unless is specified), and generates a GRUB configuration file that boots into the NixOS configuration just installed. - It prompts you for a password for the root account (unless - is specified). + It prompts you for a password for the root account (unless is specified). - This command is idempotent: if it is interrupted or fails due to a temporary - problem (e.g. a network issue), you can safely re-run it. + This command is idempotent: if it is interrupted or fails due to a temporary problem (e.g. a network issue), you can safely re-run it. @@ -140,9 +129,7 @@ - Defaults to /mnt. If this option is given, treat the - directory root as the root of the NixOS - installation. + Defaults to /mnt. If this option is given, treat the directory root as the root of the NixOS installation. @@ -152,16 +139,10 @@ - If this option is provided, nixos-install will install - the specified closure rather than attempt to build one from - /mnt/etc/nixos/configuration.nix. + If this option is provided, nixos-install will install the specified closure rather than attempt to build one from /mnt/etc/nixos/configuration.nix. - The closure must be an appropriately configured NixOS system, with boot - loader and partition configuration that fits the target host. Such a - closure is typically obtained with a command such as nix-build - -I nixos-config=./configuration.nix '<nixos>' -A system - --no-out-link + The closure must be an appropriately configured NixOS system, with boot loader and partition configuration that fits the target host. Such a closure is typically obtained with a command such as nix-build -I nixos-config=./configuration.nix '<nixos>' -A system --no-out-link @@ -171,10 +152,7 @@ - Add a path to the Nix expression search path. This option may be given - multiple times. See the NIX_PATH environment variable for information on - the semantics of the Nix search path. Paths added through - -I take precedence over NIX_PATH. + Add a path to the Nix expression search path. This option may be given multiple times. See the NIX_PATH environment variable for information on the semantics of the Nix search path. Paths added through -I take precedence over NIX_PATH. @@ -187,9 +165,7 @@ - Sets the maximum number of build jobs that Nix will perform in parallel - to the specified number. The default is 1. A higher - value is useful on SMP systems or to exploit I/O latency. + Sets the maximum number of build jobs that Nix will perform in parallel to the specified number. The default is 1. A higher value is useful on SMP systems or to exploit I/O latency. @@ -199,15 +175,7 @@ - Sets the value of the NIX_BUILD_CORES environment variable - in the invocation of builders. Builders can use this variable at their - discretion to control the maximum amount of parallelism. For instance, in - Nixpkgs, if the derivation attribute - enableParallelBuilding is set to - true, the builder passes the - flag to GNU Make. The - value 0 means that the builder should use all - available CPU cores in the system. + Sets the value of the NIX_BUILD_CORES environment variable in the invocation of builders. Builders can use this variable at their discretion to control the maximum amount of parallelism. For instance, in Nixpkgs, if the derivation attribute enableParallelBuilding is set to true, the builder passes the flag to GNU Make. The value 0 means that the builder should use all available CPU cores in the system. @@ -217,8 +185,7 @@ - Set the Nix configuration option name to - value. + Set the Nix configuration option name to value. @@ -228,8 +195,7 @@ - Causes Nix to print out a stack trace in case of Nix expression - evaluation errors. + Causes Nix to print out a stack trace in case of Nix expression evaluation errors. @@ -248,12 +214,7 @@ Examples - A typical NixOS installation is done by creating and mounting a file system - on /mnt, generating a NixOS configuration in - /mnt/etc/nixos/configuration.nix, and running - nixos-install. For instance, if we want to install NixOS - on an ext4 file system created in - /dev/sda1: + A typical NixOS installation is done by creating and mounting a file system on /mnt, generating a NixOS configuration in /mnt/etc/nixos/configuration.nix, and running nixos-install. For instance, if we want to install NixOS on an ext4 file system created in /dev/sda1: $ mkfs.ext4 /dev/sda1 $ mount /dev/sda1 /mnt -- cgit 1.4.1