From eca5c99bf8a115ffd9513f91decc064a5bb3ff6d Mon Sep 17 00:00:00 2001 From: Graham Christensen Date: Tue, 1 May 2018 19:57:09 -0400 Subject: nixos docs: format =) --- nixos/doc/manual/man-nixos-install.xml | 381 +++++++++++++++++---------------- 1 file changed, 199 insertions(+), 182 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 d6e70d16098b..2d45e83a863f 100644 --- a/nixos/doc/manual/man-nixos-install.xml +++ b/nixos/doc/manual/man-nixos-install.xml @@ -1,201 +1,221 @@ - - - nixos-install - 8 + + nixos-install + 8 NixOS - - - - - nixos-install - install bootloader and NixOS - - - - - nixos-install - - - path + + + + nixos-install + install bootloader and NixOS + + + nixos-install + + + path + + + + root + + + + path + + + - - - root + + + - - - path + + + - - + + + - - + + number + + number + + namevalue + + + - - - - - - - - - number - - - - number - - - - name - value - - - - - - + + + + - - - -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: - - - - 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 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). - - - - - -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. - - - -Options - -This command accepts the following options: - - - - - + + + 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: + + + + 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 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). + + + + + + 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. + + + + Options + + This command accepts the following options: + + + + + + + + Defaults to /mnt. If this option is given, treat the + directory root as the root of the NixOS + installation. + + + + + + + + + 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 + + + + + + + + + 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. + + + + + + + + - Defaults to /mnt. If this option is given, treat the directory - root as the root of the NixOS installation. - + + 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. + - - - - + + + + - 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 - + + 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. + - - - - + + + namevalue + - 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. + + Set the Nix configuration option name to + value. + - - - - - - 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 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. - - - - name value - - Set the Nix configuration option - name to value. - - - - - + + + + - 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. + - - - - + + + + - Synonym for man nixos-install. + + Synonym for man nixos-install. + - - - - - - - -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: - + + + + + 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: $ mkfs.ext4 /dev/sda1 $ mount /dev/sda1 /mnt @@ -204,9 +224,6 @@ $ # edit /mnt/etc/nixos/configuration.nix $ nixos-install $ reboot - - - - - + + -- cgit 1.4.1