[PATCH 17/32] docs: formatdomain-devices: Split out <input>

Signed-off-by: Peter Krempa <pkrempa(a)redhat.com&gt; --- docs/formatdomain-devices-input.rst | 46 +++++++++++++++++++++++++++ docs/formatdomain-devices.rst | 48 +---------------------------- docs/meson.build | 1 + 3 files changed, 48 insertions(+), 47 deletions(-) create mode 100644 docs/formatdomain-devices-input.rst diff --git a/docs/formatdomain-devices-input.rst b/docs/formatdomain-devices-input.rst new file mode 100644 index 0000000000..7430a118fe --- /dev/null +++ b/docs/formatdomain-devices-input.rst @@ -0,0 +1,46 @@ +:anchor:`<a id="elementsInput"/>` + +Input devices +~~~~~~~~~~~~~ + +Input devices allow interaction with the graphical framebuffer in the guest +virtual machine. When enabling the framebuffer, an input device is automatically +provided. It may be possible to add additional devices explicitly, for example, +to provide a graphics tablet for absolute cursor movement. + +:: + + ... + <devices> + <input type='mouse' bus='usb'/> + <input type='keyboard' bus='usb'/> + <input type='mouse' bus='virtio'/> + <input type='keyboard' bus='virtio'/> + <input type='tablet' bus='virtio'/> + <input type='passthrough' bus='virtio'> + <source evdev='/dev/input/event1'/> + </input> + </devices> + ... + +``input`` + The ``input`` element has one mandatory attribute, the ``type`` whose value + can be 'mouse', 'tablet', ( :since:`since 1.2.2` ) 'keyboard' or ( + :since:`since 1.3.0` ) 'passthrough'. The tablet provides absolute cursor + movement, while the mouse uses relative movement. The optional ``bus`` + attribute can be used to refine the exact device type. It takes values "xen" + (paravirtualized), "ps2" and "usb" or ( :since:`since 1.3.0` ) "virtio". + +The ``input`` element has an optional sub-element ``<address>`` which can tie +the device to a particular PCI slot, `documented above <#elementsAddress>`__. On +S390, ``address`` can be used to provide a CCW address for an input device ( +:since:`since 4.2.0` ). For type ``passthrough``, the mandatory sub-element +``source`` must have an ``evdev`` attribute containing the absolute path to the +event device passed through to guests. (KVM only) :since:`Since 5.2.0` , the +``input`` element accepts a ``model`` attribute which has the values 'virtio', +'virtio-transitional' and 'virtio-non-transitional'. See `Virtio transitional +devices <#elementsVirtioTransitional>`__ for more details. + +The subelement ``driver`` can be used to tune the virtio options of the device: +`Virtio-specific options <#elementsVirtio>`__ can also be set. ( :since:`Since +3.5.0` ) diff --git a/docs/formatdomain-devices.rst b/docs/formatdomain-devices.rst index 4334feb428..5c210ffe09 100644 --- a/docs/formatdomain-devices.rst +++ b/docs/formatdomain-devices.rst @@ -49,53 +49,7 @@ following characters: ``[a-zA-Z0-9_-]``. :since:`Since 3.9.0` .. include:: formatdomain-devices-redirdev.rst .. include:: formatdomain-devices-smartcard.rst .. include:: formatdomain-devices-interface.rst - -:anchor:`<a id="elementsInput"/>` - -Input devices -~~~~~~~~~~~~~ - -Input devices allow interaction with the graphical framebuffer in the guest -virtual machine. When enabling the framebuffer, an input device is automatically -provided. It may be possible to add additional devices explicitly, for example, -to provide a graphics tablet for absolute cursor movement. - -:: - - ... - <devices> - <input type='mouse' bus='usb'/> - <input type='keyboard' bus='usb'/> - <input type='mouse' bus='virtio'/> - <input type='keyboard' bus='virtio'/> - <input type='tablet' bus='virtio'/> - <input type='passthrough' bus='virtio'> - <source evdev='/dev/input/event1'/> - </input> - </devices> - ... - -``input`` - The ``input`` element has one mandatory attribute, the ``type`` whose value - can be 'mouse', 'tablet', ( :since:`since 1.2.2` ) 'keyboard' or ( - :since:`since 1.3.0` ) 'passthrough'. The tablet provides absolute cursor - movement, while the mouse uses relative movement. The optional ``bus`` - attribute can be used to refine the exact device type. It takes values "xen" - (paravirtualized), "ps2" and "usb" or ( :since:`since 1.3.0` ) "virtio". - -The ``input`` element has an optional sub-element ``<address>`` which can tie -the device to a particular PCI slot, `documented above <#elementsAddress>`__. On -S390, ``address`` can be used to provide a CCW address for an input device ( -:since:`since 4.2.0` ). For type ``passthrough``, the mandatory sub-element -``source`` must have an ``evdev`` attribute containing the absolute path to the -event device passed through to guests. (KVM only) :since:`Since 5.2.0` , the -``input`` element accepts a ``model`` attribute which has the values 'virtio', -'virtio-transitional' and 'virtio-non-transitional'. See `Virtio transitional -devices <#elementsVirtioTransitional>`__ for more details. - -The subelement ``driver`` can be used to tune the virtio options of the device: -`Virtio-specific options <#elementsVirtio>`__ can also be set. ( :since:`Since -3.5.0` ) +.. include:: formatdomain-devices-input.rst :anchor:`<a id="elementsHub"/>` diff --git a/docs/meson.build b/docs/meson.build index 9846b3e7df..1484be45df 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -134,6 +134,7 @@ docs_rst_files = [ 'formatdomain-devices-redirdev.rst', 'formatdomain-devices-smartcard.rst', 'formatdomain-devices-interface.rst', + 'formatdomain-devices-input.rst', ] }, { 'name': 'hacking' }, -- 2.26.2