Re: [Qemu-devel] [PATCH 3/3] doc: document the Pseudo-encoding of LED state

[Anthony Liguori <aliguori@us.ibm.com>]

Lei Li <lilei@linux.vnet.ibm.com> writes:

> Signed-off-by: Lei Li <lilei@linux.vnet.ibm.com>
> ---
>  docs/vnc-ledstate-Pseudo-encoding.txt |   33 +++++++++++++++++++++++++++++++++
>  1 files changed, 33 insertions(+), 0 deletions(-)
>  create mode 100644 docs/vnc-ledstate-Pseudo-encoding.txt
>
> diff --git a/docs/vnc-ledstate-Pseudo-encoding.txt b/docs/vnc-ledstate-Pseudo-encoding.txt
> new file mode 100644
> index 0000000..3f3fd15
> --- /dev/null
> +++ b/docs/vnc-ledstate-Pseudo-encoding.txt
> @@ -0,0 +1,33 @@
> +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.
> +
> +Example
> +-------
> +
> +The example psuedo-encodings for LED state defined as following:
> +
> +======= ===============================================================
> +Code    Description
> +======= ===============================================================
> +100     CapsLock is set
> +010     NumLock is set
> +001     ScrollLock is set
> +110     CapsLock and NumLock are set
> +111     CapsLock, NumLock and ScrollLock are set
> +=======
> ===============================================================

You can just describe that each bit represents the Caps, Num, and Scroll
lock key respectively and that '1' indicates that the LED should be on
and '0' should be off.

You should also list the psuedo-encoding number somewhere in this document.

Regards,

Anthony Liguori

> -- 
> 1.7.7.6