diff options
author | Thomas Huth <thuth@redhat.com> | 2022-12-13 11:18:06 +0100 |
---|---|---|
committer | Thomas Huth <thuth@redhat.com> | 2023-01-09 13:50:47 +0100 |
commit | d88ce91299053c437f42d22ab5b9e7adbd2cc2a7 (patch) | |
tree | 4da486392cb2d9aaa653d4e568abe9fad71f9773 /docs/interop/vnc-ledstate-pseudo-encoding.rst | |
parent | df37330c05fbc4bff26c28588d60c302332db0b1 (diff) |
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 <thuth@redhat.com>
Diffstat (limited to 'docs/interop/vnc-ledstate-pseudo-encoding.rst')
-rw-r--r-- | docs/interop/vnc-ledstate-pseudo-encoding.rst | 50 |
1 files changed, 50 insertions, 0 deletions
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 +======= =============================================================== |