aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2021-07-27 21:41:12 +0100
committerPeter Maydell <peter.maydell@linaro.org>2021-08-02 12:55:51 +0100
commit4a64939db76b10d8d41d2af3c6aad8142da55450 (patch)
treea6ddc6a7b5820a2d764a5805cc36416a5efe04fe
parent399a04775e7ac748834bf0431d31fdb0ae30b912 (diff)
downloadqemu-arm-4a64939db76b10d8d41d2af3c6aad8142da55450.tar.gz
docs: Move user-facing barrier docs into system manualpull-target-arm-20210802
The remaining text in docs/barrier.txt is user-facing description of what the device is and how to use it. Move this into the system manual and rstify it. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Paolo Bonzini <pbonzini@redhat.com> Reviewed-by: Laurent Vivier <laurent@vivier.eu> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com> Message-id: 20210727204112.12579-4-peter.maydell@linaro.org
-rw-r--r--docs/barrier.txt48
-rw-r--r--docs/system/barrier.rst44
-rw-r--r--docs/system/index.rst1
3 files changed, 45 insertions, 48 deletions
diff --git a/docs/barrier.txt b/docs/barrier.txt
deleted file mode 100644
index 54cb5fd8ef..0000000000
--- a/docs/barrier.txt
+++ /dev/null
@@ -1,48 +0,0 @@
- QEMU Barrier Client
-
-
-* About
-
- Barrier is a KVM (Keyboard-Video-Mouse) software forked from Symless's
- synergy 1.9 codebase.
-
- See https://github.com/debauchee/barrier
-
-* QEMU usage
-
- Generally, mouse and keyboard are grabbed through the QEMU video
- interface emulation.
-
- But when we want to use a video graphic adapter via a PCI passthrough
- there is no way to provide the keyboard and mouse inputs to the VM
- except by plugging a second set of mouse and keyboard to the host
- or by installing a KVM software in the guest OS.
-
- The QEMU Barrier client avoids this by implementing directly the Barrier
- protocol into QEMU.
-
- This protocol is enabled by adding an input-barrier object to QEMU.
-
- Syntax: input-barrier,id=<object-id>,name=<guest display name>
- [,server=<barrier server address>][,port=<barrier server port>]
- [,x-origin=<x-origin>][,y-origin=<y-origin>]
- [,width=<width>][,height=<height>]
-
- The object can be added on the QEMU command line, for instance with:
-
- ... -object input-barrier,id=barrier0,name=VM-1 ...
-
- where VM-1 is the name the display configured int the Barrier server
- on the host providing the mouse and the keyboard events.
-
- by default <barrier server address> is "localhost", port is 24800,
- <x-origin> and <y-origin> are set to 0, <width> and <height> to
- 1920 and 1080.
-
- If Barrier server is stopped QEMU needs to be reconnected manually,
- by removing and re-adding the input-barrier object, for instance
- with the help of the HMP monitor:
-
- (qemu) object_del barrier0
- (qemu) object_add input-barrier,id=barrier0,name=VM-1
-
diff --git a/docs/system/barrier.rst b/docs/system/barrier.rst
new file mode 100644
index 0000000000..155d7d2901
--- /dev/null
+++ b/docs/system/barrier.rst
@@ -0,0 +1,44 @@
+QEMU Barrier Client
+===================
+
+Generally, mouse and keyboard are grabbed through the QEMU video
+interface emulation.
+
+But when we want to use a video graphic adapter via a PCI passthrough
+there is no way to provide the keyboard and mouse inputs to the VM
+except by plugging a second set of mouse and keyboard to the host
+or by installing a KVM software in the guest OS.
+
+The QEMU Barrier client avoids this by implementing directly the Barrier
+protocol into QEMU.
+
+`Barrier <https://github.com/debauchee/barrier>`__
+is a KVM (Keyboard-Video-Mouse) software forked from Symless's
+synergy 1.9 codebase.
+
+This protocol is enabled by adding an input-barrier object to QEMU.
+
+Syntax::
+
+ input-barrier,id=<object-id>,name=<guest display name>
+ [,server=<barrier server address>][,port=<barrier server port>]
+ [,x-origin=<x-origin>][,y-origin=<y-origin>]
+ [,width=<width>][,height=<height>]
+
+The object can be added on the QEMU command line, for instance with::
+
+ -object input-barrier,id=barrier0,name=VM-1
+
+where VM-1 is the name the display configured in the Barrier server
+on the host providing the mouse and the keyboard events.
+
+by default ``<barrier server address>`` is ``localhost``,
+``<port>`` is ``24800``, ``<x-origin>`` and ``<y-origin>`` are set to ``0``,
+``<width>`` and ``<height>`` to ``1920`` and ``1080``.
+
+If the Barrier server is stopped QEMU needs to be reconnected manually,
+by removing and re-adding the input-barrier object, for instance
+with the help of the HMP monitor::
+
+ (qemu) object_del barrier0
+ (qemu) object_add input-barrier,id=barrier0,name=VM-1
diff --git a/docs/system/index.rst b/docs/system/index.rst
index 650409d156..7b9276c05f 100644
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -20,6 +20,7 @@ or Hypervisor.Framework.
linuxboot
generic-loader
guest-loader
+ barrier
vnc-security
tls
secrets