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