Add reference manual

This manual documents how to enable/use various SPICE features when
creating a VM by running QEMU directly, or when using libvirt, or when
using virt-manager.
This is based on work by Lubos Kocman

1 files changed, 54 insertions, 0 deletions

diff --git a/docs/manual/SpiceUserManual-Guest.xml b/docs/manual/SpiceUserManual-Guest.xml
new file mode 100644
index 00000000..6648f831
--- /dev/null
+++ b/docs/manual/SpiceUserManual-Guest.xml
@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?oxygen RNGSchema="http://www.oasis-open.org/docbook/xml/5.0/rng/docbookxi.rng" type="xml"?>
+
+<chapter xmlns="http://docbook.org/ns/docbook" 
+    xmlns:xi="http://www.w3.org/2001/XInclude"
+    xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0">
+    <title>Spice Guest Additions</title>
+
+    <section xml:id="generic-guest">
+        <title>Introduction</title>
+        <para>
+            While you will be able to remotely access your virtual machine
+            through Spice without making any change to the virtual machine
+            configuration, you can get better integration if you tweak it
+            specially for Spice.
+        </para>
+        <para>
+            If your virtual machine has a QXL video device and you install
+            the corrresponding guest driver, your guest will support higher
+            resolutions, multiple monitors, resizing to arbitrary resolutions,
+            ...
+        </para>
+        <para>
+            Installing the Spice vdagent in your guest will let you copy and
+            paste between your guest and client OSes, to drag and drop files
+            between the 2 OSes, ... In order for the agent to work, your
+            virtual machine must have a virtio serial device (and the
+            corresponding guest drivers) as well as a Spice spicevmc channel.
+        </para>
+    </section>
+
+    <section xml:id="windows-guest">
+        <title>Windows Guest</title>
+        <para>
+            The recommended way of getting all the needed drivers installed is
+            to use the all-in-one Spice guest tools installer which can be
+            found <link xlink:href="http://spice-space.org/download/windows/spice-guest-tools/">
+            on spice-space.org</link>.
+        </para>
+        <para>
+            To get USB redirection working on Windows, you need to ...
+        </para>
+        <para>
+            If you want to manually install them, the QXL driver can be downloaded from
+            <link xlink:href="http://spice-space.org/download/windows/qxl/">this location
+            </link>, agent builds can be found
+            <link xlink:href="http://spice-space.org/download/windows/vdagent/">here
+            </link>. You also need the vioserial driver which is distributed with the
+            other <link xlink:href="https://alt.fedoraproject.org/pub/alt/virtio-win/latest/images/bin/">
+            virtio-win drivers</link>.
+        </para>
+    </section>
+
+</chapter>