From d88ce91299053c437f42d22ab5b9e7adbd2cc2a7 Mon Sep 17 00:00:00 2001 From: Thomas Huth Date: Tue, 13 Dec 2022 11:18:06 +0100 Subject: docs/interop: Change the vnc-ledstate-Pseudo-encoding doc into .rst The file seems to contain perfectly valid rst syntax already, so rename it to .rst and wire it up in the index. Message-Id: <20221213101806.46640-1-thuth@redhat.com> Signed-off-by: Thomas Huth --- docs/interop/index.rst | 1 + docs/interop/vnc-ledstate-Pseudo-encoding.txt | 50 --------------------------- docs/interop/vnc-ledstate-pseudo-encoding.rst | 50 +++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 50 deletions(-) delete mode 100644 docs/interop/vnc-ledstate-Pseudo-encoding.txt create mode 100644 docs/interop/vnc-ledstate-pseudo-encoding.rst (limited to 'docs') diff --git a/docs/interop/index.rst b/docs/interop/index.rst index b7632acb7b..6351ff9ba6 100644 --- a/docs/interop/index.rst +++ b/docs/interop/index.rst @@ -23,3 +23,4 @@ are useful for making QEMU interoperate with other software. vhost-user-gpu vhost-vdpa virtio-balloon-stats + vnc-ledstate-pseudo-encoding diff --git a/docs/interop/vnc-ledstate-Pseudo-encoding.txt b/docs/interop/vnc-ledstate-Pseudo-encoding.txt deleted file mode 100644 index 0f124f68b1..0000000000 --- a/docs/interop/vnc-ledstate-Pseudo-encoding.txt +++ /dev/null @@ -1,50 +0,0 @@ -VNC LED state Pseudo-encoding -============================= - -Introduction ------------- - -This document describes the Pseudo-encoding of LED state for RFB which -is the protocol used in VNC as reference link below: - -http://tigervnc.svn.sourceforge.net/viewvc/tigervnc/rfbproto/rfbproto.rst?content-type=text/plain - -When accessing a guest by console through VNC, there might be mismatch -between the lock keys notification LED on the computer running the VNC -client session and the current status of the lock keys on the guest -machine. - -To solve this problem it attempts to add LED state Pseudo-encoding -extension to VNC protocol to deal with setting LED state. - -Pseudo-encoding ---------------- - -This Pseudo-encoding requested by client declares to server that it supports -LED state extensions to the protocol. - -The Pseudo-encoding number for LED state defined as: - -======= =============================================================== -Number Name -======= =============================================================== --261 'LED state Pseudo-encoding' -======= =============================================================== - -LED state Pseudo-encoding --------------------------- - -The LED state Pseudo-encoding describes the encoding of LED state which -consists of 3 bits, from left to right each bit represents the Caps, Num, -and Scroll lock key respectively. '1' indicates that the LED should be -on and '0' should be off. - -Some example encodings for it as following: - -======= =============================================================== -Code Description -======= =============================================================== -100 CapsLock is on, NumLock and ScrollLock are off -010 NumLock is on, CapsLock and ScrollLock are off -111 CapsLock, NumLock and ScrollLock are on -======= =============================================================== diff --git a/docs/interop/vnc-ledstate-pseudo-encoding.rst b/docs/interop/vnc-ledstate-pseudo-encoding.rst new file mode 100644 index 0000000000..0f124f68b1 --- /dev/null +++ b/docs/interop/vnc-ledstate-pseudo-encoding.rst @@ -0,0 +1,50 @@ +VNC LED state Pseudo-encoding +============================= + +Introduction +------------ + +This document describes the Pseudo-encoding of LED state for RFB which +is the protocol used in VNC as reference link below: + +http://tigervnc.svn.sourceforge.net/viewvc/tigervnc/rfbproto/rfbproto.rst?content-type=text/plain + +When accessing a guest by console through VNC, there might be mismatch +between the lock keys notification LED on the computer running the VNC +client session and the current status of the lock keys on the guest +machine. + +To solve this problem it attempts to add LED state Pseudo-encoding +extension to VNC protocol to deal with setting LED state. + +Pseudo-encoding +--------------- + +This Pseudo-encoding requested by client declares to server that it supports +LED state extensions to the protocol. + +The Pseudo-encoding number for LED state defined as: + +======= =============================================================== +Number Name +======= =============================================================== +-261 'LED state Pseudo-encoding' +======= =============================================================== + +LED state Pseudo-encoding +-------------------------- + +The LED state Pseudo-encoding describes the encoding of LED state which +consists of 3 bits, from left to right each bit represents the Caps, Num, +and Scroll lock key respectively. '1' indicates that the LED should be +on and '0' should be off. + +Some example encodings for it as following: + +======= =============================================================== +Code Description +======= =============================================================== +100 CapsLock is on, NumLock and ScrollLock are off +010 NumLock is on, CapsLock and ScrollLock are off +111 CapsLock, NumLock and ScrollLock are on +======= =============================================================== -- cgit v1.2.3