README: basic introduction
[fbvnc.git] / README
blob731aafcc2707928c6cd0c1d898b859838b74f33d
1 FBVNC
2 =====
4 Fbvnc is a small VNC client for Linux framebuffer.  It can be invoked
5 as follows.
7   $ fbvnc host port
9 Without arguments, it connects to port 5900 of 127.0.0.1.  Once
10 connected, it sends keyboard and mouse inputs to the VNC server and
11 updates the screen when necessary.  The following keys are not sent to
12 the server.
14 ==============  ===================================
15 KEY             ACTION
16 ==============  ===================================
17 ctrl-space      Stop/continue updating the screen
18 ctrl-alt-c      Exit fbvnc
19 ==============  ===================================
21 The zlib branch supports zlib compression.