summary refs log tree commit diff
path: root/nixos/doc/manual/man-nixos-build-vms.xml
diff options
context:
space:
mode:
authorGraham Christensen <graham@grahamc.com>2018-05-01 19:57:09 -0400
committerGraham Christensen <graham@grahamc.com>2018-05-01 19:57:09 -0400
commiteca5c99bf8a115ffd9513f91decc064a5bb3ff6d (patch)
tree7b49bc123be12ca5344428c6975e4487e69d55e3 /nixos/doc/manual/man-nixos-build-vms.xml
parent77161de4546697f9bf2da6d081eeba4c399b3313 (diff)
downloadnixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.gz
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.bz2
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.lz
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.xz
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.tar.zst
nixpkgs-eca5c99bf8a115ffd9513f91decc064a5bb3ff6d.zip
nixos docs: format =)
Diffstat (limited to 'nixos/doc/manual/man-nixos-build-vms.xml')
-rw-r--r--nixos/doc/manual/man-nixos-build-vms.xml149
1 files changed, 74 insertions, 75 deletions
diff --git a/nixos/doc/manual/man-nixos-build-vms.xml b/nixos/doc/manual/man-nixos-build-vms.xml
index f4b59a7c6d4..02dad4c548b 100644
--- a/nixos/doc/manual/man-nixos-build-vms.xml
+++ b/nixos/doc/manual/man-nixos-build-vms.xml
@@ -1,40 +1,39 @@
 <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-build-vms</command></refentrytitle>
-  <manvolnum>8</manvolnum>
+ <refmeta>
+  <refentrytitle><command>nixos-build-vms</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-build-vms</command></refname>
-  <refpurpose>build a network of virtual machines from a network of NixOS configurations</refpurpose>
-</refnamediv>
-
-<refsynopsisdiv>
-  <cmdsynopsis>
-    <command>nixos-build-vms</command>
-    <arg><option>--show-trace</option></arg>
-    <arg><option>--no-out-link</option></arg>
-    <arg><option>--help</option></arg>
-    <arg choice="plain"><replaceable>network.nix</replaceable></arg>
+<!-- <refmiscinfo class="version"><xi:include href="version.txt" parse="text"/></refmiscinfo> -->
+ </refmeta>
+ <refnamediv>
+  <refname><command>nixos-build-vms</command>
+  </refname><refpurpose>build a network of virtual machines from a network of NixOS configurations</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+  <cmdsynopsis><command>nixos-build-vms</command>
+   <arg><option>--show-trace</option>
+   </arg>
+   <arg><option>--no-out-link</option>
+   </arg>
+   <arg><option>--help</option>
+   </arg>
+   <arg choice="plain"><replaceable>network.nix</replaceable>
+   </arg>
   </cmdsynopsis>
-</refsynopsisdiv>
-
-<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.
-</para>
-
-<para>A network Nix expression has the following structure:
-
+ </refsynopsisdiv>
+ <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.
+  </para>
+  <para>
+   A network Nix expression has the following structure:
 <screen>
 {
   test1 = {pkgs, config, ...}:
@@ -58,53 +57,53 @@ points to the generated virtual network.
     };
 }
 </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.
-</para>
-
-</refsection>
-
-<refsection><title>Options</title>
-
-<para>This command accepts the following options:</para>
-
-<variablelist>
-
-  <varlistentry>
-    <term><option>--show-trace</option></term>
+   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>
+  <title>Options</title>
+  <para>
+   This command accepts the following options:
+  </para>
+  <variablelist>
+   <varlistentry>
+    <term><option>--show-trace</option>
+    </term>
     <listitem>
-      <para>Shows a trace of the output.</para>
+     <para>
+      Shows a trace of the output.
+     </para>
     </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>--no-out-link</option></term>
+   </varlistentry>
+   <varlistentry>
+    <term><option>--no-out-link</option>
+    </term>
     <listitem>
-      <para>Do not create a 'result' symlink.</para>
+     <para>
+      Do not create a 'result' symlink.
+     </para>
     </listitem>
-  </varlistentry>
-
-  <varlistentry>
-    <term><option>-h</option>, <option>--help</option></term>
+   </varlistentry>
+   <varlistentry>
+    <term><option>-h</option>, <option>--help</option>
+    </term>
     <listitem>
-      <para>Shows the usage of this command to the user.</para>
+     <para>
+      Shows the usage of this command to the user.
+     </para>
     </listitem>
-  </varlistentry>
-
-</variablelist>
-
-</refsection>
-
-
+   </varlistentry>
+  </variablelist>
+ </refsection>
 </refentry>