vncproto: simplify keyboard and mouse handling
[fbvnc.git] / README
blobc235817cbde4ac73ca2d04089049bf666fc7ac32
1 FBVNC
2 =====
4 Fbvnc is a small linux framebuffer vnc viewer.  It is a clone of Milan
5 Pikula's vt52vnc.
7 VT52VNC README
8 ==============
10 README file for vt52 vnc viewer, (c) 1999 Milan Pikula
12 0. About
13 1. License
14 2. Installation & running
15 3. Bugs & features
16 4. Contact
18 0. About
20         vt52vnc is a VNC ( http://www.uk.research.att.com/vnc ) viewer,
21 which can be used on old, green, monochromatic, prehistoric terminals
22 labeled vdt52s, which are capable of vector graphics. The software is
23 functional, but incomplete: it does not support compression,
24 passwords and there are many ways to optimize the output.
26 1. License
28         This software is distributed under the terms of GNU GPL license, see
29 `COPYING' file.
31 2. Installation & running
33         1) edit Makefile to adjust some parameters,
34                 vi Makefile
35         2) run `make'
36                 make
37         3) optionally install:
38                 cp vt52vnc /usr/local/bin
40 3. Bugs & features
42         Mouse:
44         As vdt52s does not have the mouse or any other pointing device,
45 one of three unlabeled buttons near the numeric keypad have been used to
46 act as mouse-lock. When you depress it, you can use the numeric keypad to
47 move the mouse, and `+', `-', `.', `enter', `0', and `5' as button
48 1,2,3 toggle and button 1,2,3 click.
50         Speed:
52         Based on my own experiences, I recommend the speeds 38400 and
53 higher for "real work". The screen is drawn by rectangles. This is done
54 to improve the reaction times, when the screen changes very often.
56         The software uses the XOR mode to actually draw the image,
57 which can be improved using AND and OR mode in some cases. One can
58 also imagine another optimizations for particular shapes. I will not
59 add those optimizations, as the decisions are very memory-consumptive
60 and after all, I don't want to implement some kind of prolog just to
61 choose the right one. If you want to improve it, let me know.
63         Colors:
65         The monochromatic translation is done by some bit of green
66 color, which can be changed at the beginning of vncproto.c. If you
67 want to make it better (implement some dithering or (better) the
68 shape finding algorithm), let me know.
70         Why and how:
72         The work was inspired by mine never-ending desire for an X
73 display on the "frog". Display drawings are based on the graphics
74 library by Marek Zelem, which is, in turn, based on the documentation
75 for vdt52s, as my work is based on vnc protocol documentation. Coded,
76 of course, on vdt52s terminal with wrong Enter and Control. The sources
77 are written to be easily extended.
79 4. Contact
81         Milan Pikula, <www@terminus.sk> or <www@fornax.sk>