README

   1 Spice agent for Linux
   2 =====================
   3
   4 The spice agent for Linux consists of 2 parts, a daemon spice-vdagentd and
   5 a per X-session process spice-vdagent. The daemon gets automatically started
   6 in Spice guests through a udev rule. The per X-session gets automatically
   7 started in desktop environments which honor /etc/xdg/autostart, and under
   8 gdm.
   9
  10 The main daemon needs to know which X-session daemon is the currently
  11 active X-session (think switch user functionality) for this console kit is
  12 used. spice-vdagent will not work without console kit.
  13
  14 Features:
  15 * Client mouse mode (no need to grab mouse by client, no mouse lag)
  16   this is handled by the daemon by feeding mouse events into the kernel
  17   via uinput. This will only work if the active X-session is running a
  18   spice-vdagent process so that its resolution can be determined.
  19 * Automatic adjustment of the X-session resolution to the client resolution
  20 * Support of copy and paste (text and images) between the active X-session
  21   and the client
  22
  23 Not handled: multiple displays.
  24
  25
  26 All vdagent communications on the guest side run over a single pipe which
  27 gets presented to the guest os as a virtio serial port.
  28
  29 Under windows this virtio serial port has the following name:
  30 \\\\.\\Global\\com.redhat.spice.0
  31
  32 Under Linux this virtio serial port has the following name:
  33 /dev/virtio-ports/com.redhat.spice.0
  34
  35 To enable the virtio serial port you need to pass the following params on
  36 the qemu cmdline:
  37
  38 For qemu < 0.14.0:
  39 -device spicevmc
  40
  41 For qemu >= 0.14.0:
  42 -device virtio-serial-pci,id=virtio-serial0,max_ports=16,bus=pci.0,addr=0x5 \
  43 -chardev spicevmc,name=vdagent,id=vdagent \
  44 -device \
  45 virtserialport,nr=1,bus=virtio-serial0.0,chardev=vdagent,name=com.redhat.spice.0
  46
  47 Enjoy,
  48   Gerd & Hans
  49
  50 --
  51 Gerd Hoffmann <kraxel@redhat.com>
  52 Hans de Goede <hdegoede@redhat.com>