diff options
Diffstat (limited to 'nixos/doc/manual/man-nixos-install.xml')
| -rw-r--r-- | nixos/doc/manual/man-nixos-install.xml | 117 |
1 files changed, 116 insertions, 1 deletions
diff --git a/nixos/doc/manual/man-nixos-install.xml b/nixos/doc/manual/man-nixos-install.xml index 0ebee7d23f9..7ad1be1ec10 100644 --- a/nixos/doc/manual/man-nixos-install.xml +++ b/nixos/doc/manual/man-nixos-install.xml @@ -11,12 +11,45 @@ <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> + <group choice='req'> + <arg choice='plain'><option>--max-jobs</option></arg> + <arg choice='plain'><option>-j</option></arg> + </group> + <replaceable>number</replaceable> + </arg> + <arg> + <option>--cores</option> + <replaceable>number</replaceable> + </arg> + <arg> + <option>--option</option> + <replaceable>name</replaceable> + <replaceable>value</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 +88,87 @@ 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>--max-jobs</option></term> + <term><option>-j</option></term> + + <listitem><para>Sets the maximum number of build jobs that Nix will + perform in parallel to the specified number. The default is <literal>1</literal>. + A higher value is useful on SMP systems or to exploit I/O latency.</para></listitem> + + </varlistentry> + + + <varlistentry><term><option>--cores</option></term> + + <listitem><para>Sets the value of the <envar>NIX_BUILD_CORES</envar> + 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 <varname>enableParallelBuilding</varname> is set to + <literal>true</literal>, the builder passes the + <option>-j<replaceable>N</replaceable></option> flag to GNU Make. + The value <literal>0</literal> means that the builder should use all + available CPU cores in the system.</para></listitem> + + </varlistentry> + + <varlistentry><term><option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable></term> + + <listitem><para>Set the Nix configuration option + <replaceable>name</replaceable> to <replaceable>value</replaceable>.</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 +186,7 @@ $ mount /dev/sda1 /mnt $ nixos-generate-config --root /mnt $ # edit /mnt/etc/nixos/configuration.nix $ nixos-install +$ reboot </screen> </para> |