diff options
author | Eelco Dolstra <eelco.dolstra@logicblox.com> | 2013-10-13 16:57:09 +0200 |
---|---|---|
committer | Eelco Dolstra <eelco.dolstra@logicblox.com> | 2013-10-13 17:35:57 +0200 |
commit | 9b8847eb91bb8f610ac1b2b4c28bafdae875e963 (patch) | |
tree | a6d7d91595b114a7a927d163eb67b4853514ccfc /nixos | |
parent | 00f380dee5c395704b8b83c462d0d735ff0e810e (diff) | |
download | nixlib-9b8847eb91bb8f610ac1b2b4c28bafdae875e963.tar nixlib-9b8847eb91bb8f610ac1b2b4c28bafdae875e963.tar.gz nixlib-9b8847eb91bb8f610ac1b2b4c28bafdae875e963.tar.bz2 nixlib-9b8847eb91bb8f610ac1b2b4c28bafdae875e963.tar.lz nixlib-9b8847eb91bb8f610ac1b2b4c28bafdae875e963.tar.xz nixlib-9b8847eb91bb8f610ac1b2b4c28bafdae875e963.tar.zst nixlib-9b8847eb91bb8f610ac1b2b4c28bafdae875e963.zip |
Document nixos-install
Diffstat (limited to 'nixos')
-rw-r--r-- | nixos/doc/manual/man-nixos-install.xml | 78 | ||||
-rw-r--r-- | nixos/doc/manual/man-pages.xml | 5 |
2 files changed, 81 insertions, 2 deletions
diff --git a/nixos/doc/manual/man-nixos-install.xml b/nixos/doc/manual/man-nixos-install.xml new file mode 100644 index 000000000000..d5157859857b --- /dev/null +++ b/nixos/doc/manual/man-nixos-install.xml @@ -0,0 +1,78 @@ +<refentry xmlns="http://docbook.org/ns/docbook" + xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude"> + +<refmeta> + <refentrytitle><command>nixos-install</command></refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="source">NixOS</refmiscinfo> + <!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> --> +</refmeta> + +<refnamediv> + <refname><command>nixos-install</command></refname> + <refpurpose>install NixOS</refpurpose> +</refnamediv> + +<refsynopsisdiv> + <cmdsynopsis> + <command>nixos-install</command> + </cmdsynopsis> +</refsynopsisdiv> + + +<refsection><title>Description</title> + +<para>This command installs NixOS in the file system mounted on +<filename>/mnt</filename>, based on the NixOS configuration specified +in <filename>/mnt/etc/nixos/configuration.nix</filename>. It performs +the following steps: + +<itemizedlist> + + <listitem><para>It copies Nix and its dependencies to + <filename>/mnt/nix/store</filename>.</para></listitem> + + <listitem><para>It runs Nix in <filename>/mnt</filename> to build + the NixOS configuration specified in + <filename>/mnt/etc/nixos/configuration.nix</filename>.</para></listitem> + + <listitem><para>It installs the GRUB boot loader on the device + specified in the option <option>boot.loader.grub.device</option>, + and generates a GRUB configuration file that boots into the NixOS + configuration just installed.</para></listitem> + +</itemizedlist> + +</para> + +<para>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.</para> + +</refsection> + + +<refsection><title>Examples</title> + +<para>A typical NixOS installation is done by creating and mounting a +file system on <filename>/mnt</filename>, generating a NixOS +configuration in +<filename>/mnt/etc/nixos/configuration.nix</filename>, and running +<command>nixos-install</command>. For instance, if we want to install +NixOS on an <literal>ext4</literal> file system created in +<filename>/dev/sda1</filename>: + +<screen> +$ mkfs.ext4 /dev/sda1 +$ mount /dev/sda1 /mnt +$ nixos-generate-config --root /mnt +$ # edit /mnt/etc/nixos/configuration.nix +$ nixos-install +</screen> + +</para> + +</refsection> + +</refentry> diff --git a/nixos/doc/manual/man-pages.xml b/nixos/doc/manual/man-pages.xml index 5178d595fda6..467864e208bd 100644 --- a/nixos/doc/manual/man-pages.xml +++ b/nixos/doc/manual/man-pages.xml @@ -22,9 +22,10 @@ </info> <xi:include href="man-configuration.xml" /> - <xi:include href="man-nixos-rebuild.xml" /> + <xi:include href="man-nixos-build-vms.xml" /> <xi:include href="man-nixos-generate-config.xml" /> + <xi:include href="man-nixos-install.xml" /> <xi:include href="man-nixos-option.xml" /> - <xi:include href="man-nixos-build-vms.xml" /> + <xi:include href="man-nixos-rebuild.xml" /> </reference> |