1VNC LED state Pseudo-encoding
2=============================
3
4Introduction
5------------
6
7This document describes the Pseudo-encoding of LED state for RFB which
8is the protocol used in VNC as reference link below:
9
10http://tigervnc.svn.sourceforge.net/viewvc/tigervnc/rfbproto/rfbproto.rst?content-type=text/plain
11
12When accessing a guest by console through VNC, there might be mismatch
13between the lock keys notification LED on the computer running the VNC
14client session and the current status of the lock keys on the guest
15machine.
16
17To solve this problem it attempts to add LED state Pseudo-encoding
18extension to VNC protocol to deal with setting LED state.
19
20Pseudo-encoding
21---------------
22
23This Pseudo-encoding requested by client declares to server that it supports
24LED state extensions to the protocol.
25
26The Pseudo-encoding number for LED state defined as:
27
28======= ===============================================================
29Number  Name
30======= ===============================================================
31-261    'LED state Pseudo-encoding'
32======= ===============================================================
33
34LED state Pseudo-encoding
35--------------------------
36
37The LED state Pseudo-encoding describes the encoding of LED state which
38consists of 3 bits, from left to right each bit represents the Caps, Num,
39and Scroll lock key respectively. '1' indicates that the LED should be
40on and '0' should be off.
41
42Some example encodings for it as following:
43
44======= ===============================================================
45Code    Description
46======= ===============================================================
47100     CapsLock is on, NumLock and ScrollLock are off
48010     NumLock is on, CapsLock and ScrollLock are off
49111     CapsLock, NumLock and ScrollLock are on
50======= ===============================================================
51