[Spice-devel] [PATCH] README: Add qemu commandline options for vdagent

[Christophe Fergeau]

It's not obvious how qemu should be started so that vdagentd can
find its com.redhat.spice.0 virtio device. It's explained at
http://spice-space.org/page/Whiteboard/AgentProtocol but is easier
to find if it's explained in README too.
---
 README |   17 +++++++++++++++++
 1 files changed, 17 insertions(+), 0 deletions(-)

diff --git a/README b/README
index ad40b3a..3f58ebe 100644
--- a/README
+++ b/README
@@ -22,6 +22,23 @@ Features:
 
 Not handled: multiple displays.
 
+
+All vdagent communications on the guest side run over a single pipe which
+gets presented to the guest os as a virtio serial port.
+
+Under windows this virtio serial port has the following name:
+\\\\.\\Global\\com.redhat.spice.0
+
+Under Linux this virtio serial port has the following name:
+/dev/virtio-ports/com.redhat.spice.0
+
+Qemu will enable the virtio serial port when using the following params:
+
+-device virtio-serial-pci,id=virtio-serial0,max_ports=16,bus=pci.0,addr=0x5 \
+-chardev spicevmc,name=vdagent,id=vdagent \
+-device \
+virtserialport,nr=1,bus=virtio-serial0.0,chardev=vdagent,name=com.redhat.spice.0
+
 Enjoy,
   Gerd & Hans
 
-- 
1.7.4.2