update manual from spice server repo20160422

1 files changed, 75 insertions, 12 deletions

diff --git a/content/pages/spice-user-manual.asc b/content/pages/spice-user-manual.asc
index 8d06aa2..5b31b3d 100644
--- a/content/pages/spice-user-manual.asc
+++ b/content/pages/spice-user-manual.asc
@@ -240,7 +240,7 @@ population. I assume that you have a locally stored ISO of your
 favourite operating system so you can use it for installation.
 
 [source,sh]
-host$ sudo qemu-kvm -boot order=dc -vga qxl \
+host$ qemu-kvm -boot order=dc -vga qxl \
         -spice port=3001,disable-ticketing -soundhw ac97 \
         -device virtio-serial -chardev spicevmc,id=vdagent,debug=0,name=vdagent \
         -device virtserialport,chardev=vdagent,name=com.redhat.spice.0 \
@@ -351,10 +351,6 @@ the machine which is running our qemu instance.
 [source,sh]
 client$ remote-viewer spice://myhost:3001
 
-.Established connection to Windows 2008 guest
-image::images/spicec01.png[]
-
-
 Ticketing
 =========
 
@@ -656,9 +652,8 @@ that is already there:
 Client
 ------
 
-You can enable additional displays either from the "Display/Displays"
-menu in remote-viewer, or from your guest OS display configuration
-tool.
+You can enable additional displays from the "View -> Displays"
+menu in remote-viewer.
 
 TLS
 ===
@@ -901,6 +896,70 @@ folder will show up in GNOME Files network places (or Nautilus). It
 can then be mounted and browsed in traditional applications thanks to
 `gvfs-fuse`.
 
+GL acceleration (virgl)
+=======================
+
+OpenGL acceleration is currently local only (it has to go through a Unix socket)
+and it needs guest support. It's currently limited to recent linux
+distributions (for example, as a guest, you need an up to date Fedora 23 +
+updated mesa packages from
+https://copr.fedorainfracloud.org/coprs/kraxel/virgl/[copr:kraxel]).
+
+Host-side, you need qemu 2.6, libvirt 1.3.3 and spice 0.13.1, as well as a 4.4
+Linux kernel and Mesa 11.1.
+
+Client-side, you need spice-gtk 0.31.
+
+Guest-side, you need Mesa 11.1 and a 4.4 Linux kernel.
+
+Configuration
+-------------
+
+.Using libvirt
+
+You need to add a virtio-gpu video device to your virtual machine instead of QXL.
+[source,xml]
+<video>
+  <model type='virtio' heads='1'>
+    <acceleration accel3d='yes'/>
+  </model>
+</video>
+
+Then you need to enable OpenGL on your SPICE graphics node:
+[source,xml]
+<graphics type='spice' autoport='no'>
+  <gl enable='yes'/>
+</graphics>
+
+You don't need any port/address as they won't be usable with
+GL.
+
+.Using QEMU
+
+You need to add a virtio-gpu device on QEMU command line,
+as well as enable GL with SPICE. port/tls-port/addr arguments
+won't be used in this setup. You need to configure a Unix socket to
+connect to the VM display.
+
+[source,sh]
+-device virtio-vga,virgl=on -spice gl=on,unix,addr=/run/user/1000/spice.sock
+
+Connecting to the guest
+-----------------------
+
+Connecting to the guest when virgl is in use is slightly different
+than usual
+
+.If libvirt is being used
+
+[source,sh]
+client$ virt-viewer -a $vmname
+
+.If a Unix socket has been set on QEMU command line
+
+[source,sh]
+client$ remote-viewer spice+unix:///run/user/1000/spice.sock
+
 QEMU Spice reference
 ====================
 
@@ -963,8 +1022,8 @@ 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 on
 http://spice-space.org/download/windows/spice-guest-tools/[spice-space.org].
 
-To get USB redirection working on Windows, you need to install USB
-Clerk (TODO: add link)
+To get USB redirection working on Windows, you need to install
+http://www.spice-space.org/download/windows/usbdk/[UsbDk]
 
 If you want to manually install them, the QXL driver can be downloaded
 from http://spice-space.org/download/windows/qxl/[this location] ,
@@ -1134,7 +1193,7 @@ The corresponding libvirt XML is:
 -------------------------------------------------
 
 (don't forget to add the
-xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0' attribute to the
+`xmlns:qemu='http://libvirt.org/schemas/domain/qemu/1.0'` attribute to the
 toplevel `<domain>` node)
 
 
@@ -1142,7 +1201,7 @@ You can go up to 12 (or more, look for DEBUG_PRINT in the driver), you get reall
 
   * 3 - will give you all the highlevel commands (DrvCopyBits, DrvBitBlt, etc.)
   * 6 - will also show QXLGetBitMap
-  * 11 - will show caching of images (this is a driver cache, not to be confused with the server<->client shared cache).
+  * 11 - will show caching of images (this is a driver cache, not to be confused with the cache shared between server and client).
 
 
 .qxl.cmdlog QEMU parameter
@@ -1159,6 +1218,10 @@ Agent
 On Linux, `journalctl -t spice-vdagentd -t spice-vdagent` will display the agent log messages.
 spice-vdagent can also be restarted by hand with the `-d` argument in order to display more logs.
 
+On Windows, the agent logs can be found in `C:\WINDOWS\TEMP\VDAGENT.LOG` and
+`C:\WINDOWS\TEMP\VDSERVICE.LOG`
+
+
 Recording/replaying SPICE server traffic
 ----------------------------------------