summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorSamuel Thibault <samuel.thibault@ens-lyon.org>2022-09-06 00:09:50 +0200
committerSamuel Thibault <samuel.thibault@ens-lyon.org>2022-09-06 00:09:50 +0200
commit3e01455edd5fce06c14e2926b6ef408d9a94c9fb (patch)
tree06d24c525e132b7763fa74be7d823155c89df7e6
parent61fd710b8da8aedcea9b4f197283dc38638e4b60 (diff)
downloadfocaccia-qemu-3e01455edd5fce06c14e2926b6ef408d9a94c9fb.tar.gz
focaccia-qemu-3e01455edd5fce06c14e2926b6ef408d9a94c9fb.zip
usb-braille: Better explain that one also has to create a chardev backend
Users have reported not to understand the documentation. This completes
it to give an explicit example how one is supposed to set up a virtual
braille USB device.

Signed-off-by: Samuel Thibault <samuel.thibault@ens-lyon.org>
-rw-r--r--docs/system/devices/usb.rst16
1 files changed, 14 insertions, 2 deletions
diff --git a/docs/system/devices/usb.rst b/docs/system/devices/usb.rst
index f39a88f080..37cb9b33ae 100644
--- a/docs/system/devices/usb.rst
+++ b/docs/system/devices/usb.rst
@@ -178,8 +178,20 @@ option or the ``device_add`` monitor command. Available devices are:
    host character device id.
 
 ``usb-braille,chardev=id``
-   Braille device. This will use BrlAPI to display the braille output on
-   a real or fake device referenced by id.
+   Braille device. This emulates a Baum Braille device USB port. id has to
+   specify a character device defined with ``-chardev …,id=id``.  One will
+   normally use BrlAPI to display the braille output on a BRLTTY-supported
+   device with
+
+   .. parsed-literal::
+
+      |qemu_system| [...] -chardev braille,id=brl -device usb-braille,chardev=brl
+
+   or alternatively, use the following equivalent shortcut:
+
+   .. parsed-literal::
+
+      |qemu_system| [...] -usbdevice braille
 
 ``usb-net[,netdev=id]``
    Network adapter that supports CDC ethernet and RNDIS protocols. id