diff options
author | Domen Kožar <domen@dev.si> | 2015-01-06 14:49:18 +0100 |
---|---|---|
committer | Domen Kožar <domen@dev.si> | 2015-01-06 14:49:24 +0100 |
commit | c876f7a25dd3437f27628cad3b1168909ab86461 (patch) | |
tree | 818ea8d00b70ba68c83ed74e0980ba16d020f481 /nixos/doc/manual | |
parent | 0b8ac6b791ce13d841aebb8b42d0f6817fe14448 (diff) |
document options to nixos-install script
Diffstat (limited to 'nixos/doc/manual')
-rw-r--r-- | nixos/doc/manual/man-nixos-install.xml | 70 | ||||
-rw-r--r-- | nixos/doc/manual/man-pages.xml | 2 |
2 files changed, 70 insertions, 2 deletions
diff --git a/nixos/doc/manual/man-nixos-install.xml b/nixos/doc/manual/man-nixos-install.xml index 0ebee7d23f9b..06e7b4a98470 100644 --- a/nixos/doc/manual/man-nixos-install.xml +++ b/nixos/doc/manual/man-nixos-install.xml @@ -11,12 +11,29 @@ <refnamediv> <refname><command>nixos-install</command></refname> - <refpurpose>install NixOS</refpurpose> + <refpurpose>install bootloader and NixOS</refpurpose> </refnamediv> <refsynopsisdiv> <cmdsynopsis> <command>nixos-install</command> + <arg> + <arg choice='plain'><option>-I</option></arg> + <replaceable>path</replaceable> + </arg> + <arg> + <arg choice='plain'><option>--root</option></arg> + <replaceable>root</replaceable> + </arg> + <arg> + <arg choice='plain'><option>--show-trace</option></arg> + </arg> + <arg> + <arg choice='plain'><option>--chroot</option></arg> + </arg> + <arg> + <arg choice='plain'><option>--help</option></arg> + </arg> </cmdsynopsis> </refsynopsisdiv> @@ -55,6 +72,56 @@ it.</para> </refsection> +<refsection><title>Options</title> + +<para>This command accepts the following options:</para> + +<variablelist> + + <varlistentry> + <term><option>--root</option></term> + <listitem> + <para>Defaults to <filename>/mnt</filename>. If this option is given, treat the directory + <replaceable>root</replaceable> as the root of the NixOS installation. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-I</option></term> + <listitem> + <para>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 <replaceable>-I</replaceable> take precedence over NIX_PATH.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--show-trace</option></term> + <listitem> + <para>Causes Nix to print out a stack trace in case of Nix expression evaluation errors.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--chroot</option></term> + <listitem> + <para>Chroot into given installation. Any additional arguments passed are going to be executed inside the chroot. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--help</option></term> + <listitem> + <para>Synonym for <command>man nixos-install</command>.</para> + </listitem> + </varlistentry> + +</variablelist> + +</refsection> + <refsection><title>Examples</title> @@ -72,6 +139,7 @@ $ mount /dev/sda1 /mnt $ nixos-generate-config --root /mnt $ # edit /mnt/etc/nixos/configuration.nix $ nixos-install +$ reboot </screen> </para> diff --git a/nixos/doc/manual/man-pages.xml b/nixos/doc/manual/man-pages.xml index 467864e208bd..97a2c16d406e 100644 --- a/nixos/doc/manual/man-pages.xml +++ b/nixos/doc/manual/man-pages.xml @@ -15,7 +15,7 @@ </author> <copyright> - <year>2007-2013</year> + <year>2007-2015</year> <holder>Eelco Dolstra</holder> </copyright> |