xref: /qemu/docs/interop/dbus-display.rst (revision ef20c5ba)
1*ef20c5baSMarc-André LureauD-Bus display
2*ef20c5baSMarc-André Lureau=============
3*ef20c5baSMarc-André Lureau
4*ef20c5baSMarc-André LureauQEMU can export the VM display through D-Bus (when started with ``-display
5*ef20c5baSMarc-André Lureaudbus``), to allow out-of-process UIs, remote protocol servers or other
6*ef20c5baSMarc-André Lureauinteractive display usages.
7*ef20c5baSMarc-André Lureau
8*ef20c5baSMarc-André LureauVarious specialized D-Bus interfaces are available on different object paths
9*ef20c5baSMarc-André Lureauunder ``/org/qemu/Display1/``, depending on the VM configuration.
10*ef20c5baSMarc-André Lureau
11*ef20c5baSMarc-André LureauQEMU also implements the standard interfaces, such as
12*ef20c5baSMarc-André Lureau`org.freedesktop.DBus.Introspectable
13*ef20c5baSMarc-André Lureau<https://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces>`_.
14*ef20c5baSMarc-André Lureau
15*ef20c5baSMarc-André Lureau.. contents::
16*ef20c5baSMarc-André Lureau   :local:
17*ef20c5baSMarc-André Lureau   :depth: 1
18*ef20c5baSMarc-André Lureau
19*ef20c5baSMarc-André Lureau.. only:: sphinx4
20*ef20c5baSMarc-André Lureau
21*ef20c5baSMarc-André Lureau   .. dbus-doc:: ui/dbus-display1.xml
22*ef20c5baSMarc-André Lureau
23*ef20c5baSMarc-André Lureau.. only:: not sphinx4
24*ef20c5baSMarc-André Lureau
25*ef20c5baSMarc-André Lureau   .. warning::
26*ef20c5baSMarc-André Lureau      Sphinx 4 is required to build D-Bus documentation.
27*ef20c5baSMarc-André Lureau
28*ef20c5baSMarc-André Lureau      This is the content of ``ui/dbus-display1.xml``:
29*ef20c5baSMarc-André Lureau
30*ef20c5baSMarc-André Lureau   .. literalinclude:: ../../ui/dbus-display1.xml
31*ef20c5baSMarc-André Lureau      :language: xml
32