diff options
Diffstat (limited to 'nixos/doc/manual/man-nixos-build-vms.xml')
| -rw-r--r-- | nixos/doc/manual/man-nixos-build-vms.xml | 41 |
1 files changed, 12 insertions, 29 deletions
diff --git a/nixos/doc/manual/man-nixos-build-vms.xml b/nixos/doc/manual/man-nixos-build-vms.xml index 7d6e04e0dd90..98f29436b2d7 100644 --- a/nixos/doc/manual/man-nixos-build-vms.xml +++ b/nixos/doc/manual/man-nixos-build-vms.xml @@ -24,14 +24,12 @@ <arg> <option>--help</option> - </arg> - - <arg> - <option>--option</option> - <replaceable>name</replaceable> - <replaceable>value</replaceable> - </arg> - + </arg> + + <arg> + <option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable> + </arg> + <arg choice="plain"> <replaceable>network.nix</replaceable> </arg> @@ -40,11 +38,7 @@ <refsection> <title>Description</title> <para> - This command builds a network of QEMU-KVM virtual machines of a Nix - expression specifying a network of NixOS machines. The virtual network can - be started by executing the <filename>bin/run-vms</filename> shell script - that is generated by this command. By default, a <filename>result</filename> - symlink is produced that points to the generated virtual network. + This command builds a network of QEMU-KVM virtual machines of a Nix expression specifying a network of NixOS machines. The virtual network can be started by executing the <filename>bin/run-vms</filename> shell script that is generated by this command. By default, a <filename>result</filename> symlink is produced that points to the generated virtual network. </para> <para> A network Nix expression has the following structure: @@ -71,18 +65,7 @@ }; } </screen> - Each attribute in the expression represents a machine in the network (e.g. - <varname>test1</varname> and <varname>test2</varname>) referring to a - function defining a NixOS configuration. In each NixOS configuration, two - attributes have a special meaning. The - <varname>deployment.targetHost</varname> specifies the address (domain name - or IP address) of the system which is used by <command>ssh</command> to - perform remote deployment operations. The - <varname>nixpkgs.localSystem.system</varname> attribute can be used to - specify an architecture for the target machine, such as - <varname>i686-linux</varname> which builds a 32-bit NixOS configuration. - Omitting this property will build the configuration for the same - architecture as the host system. + Each attribute in the expression represents a machine in the network (e.g. <varname>test1</varname> and <varname>test2</varname>) referring to a function defining a NixOS configuration. In each NixOS configuration, two attributes have a special meaning. The <varname>deployment.targetHost</varname> specifies the address (domain name or IP address) of the system which is used by <command>ssh</command> to perform remote deployment operations. The <varname>nixpkgs.localSystem.system</varname> attribute can be used to specify an architecture for the target machine, such as <varname>i686-linux</varname> which builds a 32-bit NixOS configuration. Omitting this property will build the configuration for the same architecture as the host system. </para> </refsection> <refsection> @@ -126,10 +109,10 @@ <option>--option</option> <replaceable>name</replaceable> <replaceable>value</replaceable> </term> <listitem> - <para>Set the Nix configuration option - <replaceable>name</replaceable> to <replaceable>value</replaceable>. - This overrides settings in the Nix configuration file (see - <citerefentry><refentrytitle>nix.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>). + <para> + Set the Nix configuration option <replaceable>name</replaceable> to <replaceable>value</replaceable>. This overrides settings in the Nix configuration file (see <citerefentry> + <refentrytitle>nix.conf</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>). </para> </listitem> </varlistentry> |