qemu-options.hx: document -chardev vc backend-specific behavior
The -chardev vc documentation only mentioned the built-in console with optional size parameters, but the actual behavior depends on the display backend. Document the GTK (libvte), D-Bus and spice-app cases. Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Marc-André Lureau committed
Apr 20, 2026 at 15:50 UTC
f031490790018e0ba8e620f704fd6645d6fdf8b1
1 file changed
+11
-2
qemu-options.hx
+11
-2
@@ -4286,8 +4286,17 @@ The available backends are:
4286
and hub devices is not supported as well.
4287
4288
``-chardev vc,id=id[[,width=width][,height=height]][[,cols=cols][,rows=rows]]``
4289
- Connect to a QEMU text console. ``vc`` may optionally be given a
4290
- specific size.
4289
+ Connect to a QEMU text console. The implementation and supported feature
4290
+ set depend on the selected display backend.
4291
+
4292
+ - The GTK backend uses libvte for the emulation and display (when available).
4293
+
4294
+ - The D-Bus backend exports the character device as a Chardev object.
4295
+
4296
+ - spice-app backend exports it as a Spice port.
4297
+
4298
+ In other cases, QEMU uses its own emulated VT100, and ``vc`` may optionally be
4299
+ given a specific size.
4300
4301
``width`` and ``height`` specify the width and height respectively
4302
of the console, in pixels.