[PATCH] qemu-options: document -chardev dbus

uchouT posted 1 patch 2 weeks, 2 days ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20260509094801.111103-1-i@uchout.moe
qemu-options.hx | 16 ++++++++++++++--
1 file changed, 14 insertions(+), 2 deletions(-)
[PATCH] qemu-options: document -chardev dbus
Posted by uchouT 2 weeks, 2 days ago
Document the dbus backend introduced in commit 3e301c8d7ef0 ("ui/dbus:
add chardev backend & interface")

Signed-off-by: uchouT <i@uchout.moe>
---
 qemu-options.hx | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/qemu-options.hx b/qemu-options.hx
index 5566da41a3..59ff62aa7b 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -4077,6 +4077,9 @@ DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
 #if defined(CONFIG_SPICE)
     "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
     "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
+#endif
+#if defined(CONFIG_DBUS_DISPLAY)
+    "-chardev dbus,id=id,name=name[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
 #endif
     , QEMU_ARCH_ALL
 )
@@ -4088,8 +4091,8 @@ The general form of a character device option is:
     Backend is one of: ``null``, ``socket``, ``udp``, ``msmouse``, ``hub``,
     ``vc``, ``ringbuf``, ``file``, ``pipe``, ``console``, ``serial``,
     ``pty``, ``stdio``, ``braille``, ``parallel``,
-    ``spicevmc``, ``spiceport``. The specific backend will determine the
-    applicable options.
+    ``spicevmc``, ``spiceport``, ``dbus``. The specific backend will
+    determine the applicable options.
 
     Use ``-chardev help`` to print all available chardev backend types.
 
@@ -4396,6 +4399,15 @@ The available backends are:
 
     Connect to a spice port, allowing a Spice client to handle the
     traffic identified by a name (preferably a fqdn).
+
+``-chardev dbus,id=id,name=name``
+    ``dbus`` is only available when D-Bus display support is built in.
+
+    ``name`` name of the chardev as exported on the D-Bus display
+    interface
+
+    Export the character device on the D-Bus display interface, so that
+    a D-Bus client can connect to it.
 ERST
 
 DEFHEADING()
-- 
2.54.0
Re: [PATCH] qemu-options: document -chardev dbus
Posted by Marc-André Lureau 2 weeks, 2 days ago
On Sat, May 9, 2026 at 1:48 PM uchouT <i@uchout.moe> wrote:
>
> Document the dbus backend introduced in commit 3e301c8d7ef0 ("ui/dbus:
> add chardev backend & interface")
>
> Signed-off-by: uchouT <i@uchout.moe>

Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>

> ---
>  qemu-options.hx | 16 ++++++++++++++--
>  1 file changed, 14 insertions(+), 2 deletions(-)
>
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 5566da41a3..59ff62aa7b 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -4077,6 +4077,9 @@ DEF("chardev", HAS_ARG, QEMU_OPTION_chardev,
>  #if defined(CONFIG_SPICE)
>      "-chardev spicevmc,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
>      "-chardev spiceport,id=id,name=name[,debug=debug][,logfile=PATH][,logappend=on|off]\n"
> +#endif
> +#if defined(CONFIG_DBUS_DISPLAY)
> +    "-chardev dbus,id=id,name=name[,mux=on|off][,logfile=PATH][,logappend=on|off]\n"
>  #endif
>      , QEMU_ARCH_ALL
>  )
> @@ -4088,8 +4091,8 @@ The general form of a character device option is:
>      Backend is one of: ``null``, ``socket``, ``udp``, ``msmouse``, ``hub``,
>      ``vc``, ``ringbuf``, ``file``, ``pipe``, ``console``, ``serial``,
>      ``pty``, ``stdio``, ``braille``, ``parallel``,
> -    ``spicevmc``, ``spiceport``. The specific backend will determine the
> -    applicable options.
> +    ``spicevmc``, ``spiceport``, ``dbus``. The specific backend will
> +    determine the applicable options.
>
>      Use ``-chardev help`` to print all available chardev backend types.
>
> @@ -4396,6 +4399,15 @@ The available backends are:
>
>      Connect to a spice port, allowing a Spice client to handle the
>      traffic identified by a name (preferably a fqdn).
> +
> +``-chardev dbus,id=id,name=name``
> +    ``dbus`` is only available when D-Bus display support is built in.
> +
> +    ``name`` name of the chardev as exported on the D-Bus display
> +    interface
> +
> +    Export the character device on the D-Bus display interface, so that
> +    a D-Bus client can connect to it.
>  ERST
>
>  DEFHEADING()
> --
> 2.54.0
>