boot: Allow template to specify custom libvirt XML.

[mclu.git] / mclu.pod

diff --git a/mclu.pod b/mclu.pod
index aeff24b..54bc6f0 100644 (file)
--- a/mclu.pod
+++ b/mclu.pod
@@ -324,6 +324,42 @@ The template MAY print the recommended amount of memory (RAM), used if
 the user does not select any other value.  Abbreviations like C<2G>
 are supported.
 
+=item xml
+
+The template MAY specify custom libvirt XML.  Usually you should
+I<not> specify this.  It is only used when you need very odd guest
+configuration (especially when emulating other architectures).
+
+The following environment variables are passed to the template:
+
+=over 4
+
+=item C<$name>
+
+The guest name.
+
+=item C<$format>
+
+The disk format (eg. C<qcow2>).
+
+=item C<$output>
+
+The disk file name.
+
+=item C<$memory_kb>
+
+The size of the RAM in kilobytes.
+
+=item C<$vcpus>
+
+The number of virtual CPUs.
+
+=item C<$mac_addr>
+
+The MAC address.
+
+=back
+
 =back
 
 =head1 ENVIRONMENT VARIABLES