[libvirt PATCH v2 15/15] docs: document <graphics> type dbus
From: Marc-André Lureau <marcandre.lureau(a)redhat.com>
Signed-off-by: Marc-André Lureau <marcandre.lureau(a)redhat.com>
---
docs/formatdomain.rst | 43 ++++++++++++++++++++++++++++++++++++++++++-
1 file changed, 42 insertions(+), 1 deletion(-)
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index eb8c973cf1fc..ac298fbafa7f 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -6060,6 +6060,39 @@ interaction with the admin.
<gl rendernode='/dev/dri/renderD128'/>
</graphics>
+ ``dbus``:since:`Since X.X.X`
+ Export the display over D-Bus. By default, it will use a private bus,
+ except when ``p2p`` or ``address`` are specified.
+
+ ::
+
+ <graphics type='dbus'/>
+
+ ``p2p`` (accepts ``on`` or ``off``) enables peer-to-peer connections,
+ established through virDomainOpenGraphics() APIs.
+
+ ``address`` (accepts a `D-Bus address
+ <https://dbus.freedesktop.org/doc/dbus-specification.html#addresses>`_),
+ will connect to the specified bus address.
+
+ This element accepts a ``<gl/>`` sub-element with an optional attribute
+ ``rendernode`` which can be used to specify an absolute path to a host's
+ DRI device to be used for OpenGL rendering.
+
+ Copy & Paste functionality (via Spice agent) is set by the ``clipboard``
+ element. It is disabled by default, and can be disabled by setting the
+ ``copypaste`` property to ``yes``.
+
+ D-Bus can export an audio backend using the ``<audio>`` sub-element:
+
+ ::
+
+ <graphics type='dbus' ...>
+ <audio id='1'>
+ </graphics>
+
+ Where ``1`` is an id of the `audio device <#elementsAudio>`__.
+
Graphics device uses a ``<listen>`` to set up where the device should listen for
clients. It has a mandatory attribute ``type`` which specifies the listen type.
Only ``vnc``, ``spice`` and ``rdp`` supports ``<listen>`` element. :since:`Since
@@ -6973,7 +7006,7 @@ to the guest sound device.
``type``
The required ``type`` attribute specifies audio backend type.
Currently, the supported values are 'none', 'alsa',
'coreaudio',
- 'jack', 'oss', 'pulseaudio', 'sdl', 'spice',
'file'.
+ 'dbus', jack', 'oss', 'pulseaudio', 'sdl',
'spice', 'file'.
``id``
Integer id of the audio device. Must be greater than 0.
@@ -7100,6 +7133,14 @@ and ``<output>`` elements
:since:`Since 7.2.0, qemu`
+D-Bus audio backend
+^^^^^^^^^^^^^^^^^^^
+
+The 'dbus' audio backend does not connect to any host audio framework. It
+exports a D-Bus interface when associated with a D-Bus display.
+
+:since:`Since X.X.X, qemu`
+
Jack audio backend
^^^^^^^^^^^^^^^^^^
--
2.34.1.8.g35151cf07204