aboutsummaryrefslogtreecommitdiff
path: root/docs/interop
diff options
context:
space:
mode:
authorMarc-André Lureau <marcandre.lureau@redhat.com>2021-10-06 01:41:01 +0400
committerMarc-André Lureau <marcandre.lureau@redhat.com>2021-12-21 10:50:21 +0400
commitef20c5ba0805a8f16fa86c62fb07d01cac6a2216 (patch)
tree008dae0d53d809f23051d14cf7a6a59b6d2b3270 /docs/interop
parentd2f25776ca4044ce4f19a4065cc0e4d2566f32ec (diff)
downloadqemu-ef20c5ba0805a8f16fa86c62fb07d01cac6a2216.zip
qemu-ef20c5ba0805a8f16fa86c62fb07d01cac6a2216.tar.gz
qemu-ef20c5ba0805a8f16fa86c62fb07d01cac6a2216.tar.bz2
docs: add dbus-display documentation
Wire up the dbus-display documentation. The interface and feature is implemented next. Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> Acked-by: Gerd Hoffmann <kraxel@redhat.com>
Diffstat (limited to 'docs/interop')
-rw-r--r--docs/interop/dbus-display.rst31
-rw-r--r--docs/interop/dbus.rst2
-rw-r--r--docs/interop/index.rst1
3 files changed, 34 insertions, 0 deletions
diff --git a/docs/interop/dbus-display.rst b/docs/interop/dbus-display.rst
new file mode 100644
index 0000000..8c6e8e0
--- /dev/null
+++ b/docs/interop/dbus-display.rst
@@ -0,0 +1,31 @@
+D-Bus display
+=============
+
+QEMU can export the VM display through D-Bus (when started with ``-display
+dbus``), to allow out-of-process UIs, remote protocol servers or other
+interactive display usages.
+
+Various specialized D-Bus interfaces are available on different object paths
+under ``/org/qemu/Display1/``, depending on the VM configuration.
+
+QEMU also implements the standard interfaces, such as
+`org.freedesktop.DBus.Introspectable
+<https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces>`_.
+
+.. contents::
+ :local:
+ :depth: 1
+
+.. only:: sphinx4
+
+ .. dbus-doc:: ui/dbus-display1.xml
+
+.. only:: not sphinx4
+
+ .. warning::
+ Sphinx 4 is required to build D-Bus documentation.
+
+ This is the content of ``ui/dbus-display1.xml``:
+
+ .. literalinclude:: ../../ui/dbus-display1.xml
+ :language: xml
diff --git a/docs/interop/dbus.rst b/docs/interop/dbus.rst
index be596d3..427debc 100644
--- a/docs/interop/dbus.rst
+++ b/docs/interop/dbus.rst
@@ -108,3 +108,5 @@ QEMU Interfaces
===============
:doc:`dbus-vmstate`
+
+:doc:`dbus-display`
diff --git a/docs/interop/index.rst b/docs/interop/index.rst
index 47b9ed8..c59bac9 100644
--- a/docs/interop/index.rst
+++ b/docs/interop/index.rst
@@ -12,6 +12,7 @@ are useful for making QEMU interoperate with other software.
bitmaps
dbus
dbus-vmstate
+ dbus-display
live-block-operations
pr-helper
qemu-ga