Initial import from FreeBSD RELENG_4:
[dragonfly.git] / usr.sbin / pcvt / Misc / README.FIRST
1 ================================================================================
2 |                                                                              |
3 |                  P C V T  -  VT220 Terminal Emulation Driver                 |
4 |                  -------------------------------------------                 |
5 |                                                                              |
6 |                         NetBSD   0.9, 1.0                                    |
7 |                         FreeBSD  1.0, 1.1, 1.1.5.1, 2.0                      |
8 |                                                                              |
9 |                          Release 3.20    April 1995                          |
10 |                                                                              |
11 |                         ----------------------------                         |
12 |                         ========>> BETA 24 <<=======                         |
13 |                         ----------------------------                         |
14 |                                                                              |
15 |                       (c) Copyright 1992,1993,1994,1995 by                   |
16 |                                                                              |
17 |                              Hellmuth Michaelis                              |
18 |                              Eggerstedtstrasse 28                            |
19 |                              22765 Hamburg                                   |
20 |                              Europe                                          |
21 |                                                                              |
22 |       For the contributors copyrights which apply to parts of the source     |
23 |            see the header sections of the respective source files.           |
24 |                                                                              |
25 ================================================================================
26
27 Written by:                 Hellmuth Michaelis                       (hm@hcs.de)
28
29 The major contributors to pcvt are Brian and Joerg, pcvt would not be what it
30 is without the help, the support and the code from Joerg:
31
32                             Brian Dunford-Shore           (brian@athe.wustl.edu)
33
34                             wrote parts of the EGA/VGA hardware handling and
35                             some of the more ugly aspects of the VT220.
36
37                             Joerg Wunsch        (joerg_wunsch@uriah.heep.sax.de)
38
39                             added ALL support for XFree86, the screensaver sub-
40                             system and support for FreeBSD (and much more ...).
41
42
43 I have to thank the following people for their help, for beta-testing, bugfixes,
44 code, keymaps, suggestions, hints, patience and too much more to mention:
45
46                             Scott Turner                 (scotty@gagetalker.com)
47                             Peter Galbavy                 (peter@wonderland.org)
48                             Michael Havemester              (tik@abqhh.hanse.de)
49                             Gordon L. Burditt       (gordon@sneaky.lonestar.org)
50                             Bruce Evans                         (bde@runx.oz.au)
51                             Heiko W. Rupp               (hwr@pilhuhn.ka.sub.org)
52                             Carsten Lutz                   (clu@malihh.hanse.de)
53                             Christian Rohrmueller (internal@doitcr.doit.sub.org)
54                             Andy Duplain                  (duplain@rtf.bt.co.uk)
55                             Marko Karppinen              (dreamer@purkki.apu.fi)
56                             Onno van der Linden           (c/o frank@fwi.uva.nl)
57                             Dave Nelson              (dcn@ignatz.acs.depaul.edu)
58                             Mark Weaver                  (Mark_Weaver@brown.edu)
59                             John Brezak                   (brezak@apollo.hp.com)
60                             Jan-Oliver Neumann              (jan@encap.hanse.de)
61                             Kim Andersen                            (kim@dde.dk)
62                             Michael Graff                 (explorer@iastate.edu)
63                             Randy Terbush                   (randyt@cse.unl.edu)
64                             Benjamin Lewis           (blewis@vet.vet.purdue.edu)
65                             Daniel Harris           (daniel@reubio.apana.org.au)
66                             Alistair G. Crooks              (agc@uts.amdahl.com)
67                             Szabolcs Szigeti            (pink@bagira.fsz.bme.hu)
68                             Charles Hannum              (mycroft@gnu.ai.mit.edu)
69                             Thomas Gellekum    (thomas@ghpc8.ihf.rwth-aachen.de)
70                             Matthieu Herrb                    (matthieu@laas.fr)
71                             John A. Perry                     (perry@jpunix.com)
72                             John Kohl                    (jtk@kolvir.blrc.ma.us)
73                             Brian Moore                    (ziff@eecs.umich.edu)
74                             Martin Husemann              (martin@euterpe.owl.de)
75                             Lon Willett                  (willett@math.utah.edu)
76                             Mark Willey               (mwilley@mipos2.intel.com)
77                             Bill Sommerfeld   (sommerfeld@orchard.medford.ma.us)
78                             Rafal Boni                         (r-boni@uiuc.edu)
79                             Thomas Eberhardt   (thomas@mathematik.uni-bremen.de)
80
81
82 History                                                 (see also Doc/ChangeLog)
83 --------------------------------------------------------------------------------
84
85 Release         Changes/Features
86 -------------   ----------------------------------------------------------------
87 1.00  (08/92)   Released as "pccons_vga" to alt.sources, VT100 emulation
88
89 2.00  (01/93)   VT220 emulation, many bugfixes and enhancements
90
91 2.10  (03/93)   Fixed bugs, monochrome environments, configuration changes
92
93 2.20  (10/93)   never released (experimental internal release)
94
95 3.00  (03/94)   Support for XFree86 >= 1.2, support for XFree86 2.0's 
96                 syscons/USL model for multiple X servers and/or terminal
97                 sessions from Joerg Wunsch (Thank You, Joerg !!!), fixed
98                 bugs, (n)curses-based EGA/VGA font editor, memory mapped 
99                 screens, full MDA/CGA virtual screen support, 132 columns
100                 on some super VGA chipsets, support for NetBSD >= 0.9,
101                 support for FreeBSD >= 1.0 and much more ....
102                 (posted to comp.sources.misc, Volume 41, Issue 140-152)
103
104 3.10  (08/94)   never released (experimental internal release)
105
106 3.20            Fast forward/backward scrolling from Michael Havemester,
107                 further optimization by Charles Hannum. Keyboard queueing
108                 for silo overflow minimization also from Michael.
109                 Many bugfixes, cleanups and enhancements.
110                 Support for NetBSD 1.0 and FreeBSD 2.0.
111
112
113 Features
114 --------------------------------------------------------------------------------
115
116 The 'pcvt' VT220 emulator driver has:
117
118         - Almost full DEC VT220 (VT100/VT102) Terminal functionality
119         - support for XFree86 >= 1.2 using the pccons model
120         - full multiple virtual screen / multiple X-server support
121           for XFree86 >= 2.0 using the USL-VT/syscons model
122         - Full Support for MDA, CGA, EGA and VGA display adaptors
123         - configurable number of virtual screens on any video board
124         - completely independent virtual terminals for any video board
125         - (24), 25, 28, 40, or 50 lines for each virtual screen on VGA's
126         - (24), 25, 35, or 43 lines for each virtual screen on EGA's
127         - Fully remappable keyboard to support national keyboards
128         - All VT220 character sets plus ISO Latin-1 and DEC Technical supported 
129         - VT220 downloadable character set supported when run on EGA/VGA
130         - VT220 user defined keys for each virtual terminal
131         - Optional function key label support a 'la Hewlett-Packard
132         - Display function codes (0x00-0x1f/0x90-0xaf) functionality
133         - Optional screen-saving feature
134         - 132 column operation on several VGA chipsets:
135                 o        Tseng Labs ET3000 and ET4000
136                 o        Western Digital WD90C11
137                 o        Trident TVGA9000, TVGA8900B, TVGA8900C, TVGA8900CL
138                 o        Video 7 1024i
139                 o        S3 80C928 (board dependent)
140                 o        Cirrus Logic GD542x (board dependent)
141
142 What it cannot:
143
144         - No double wide/high characters
145         - No softscroll
146         - No inverse background
147         - No VT220 printer output support
148         - No VT52 support at all
149         - No 8-bit controls
150         - Only limited AT-keyboard (84 keys) support
151         - Help you to make money ....
152
153
154 The entire pcvt package consists of:
155
156         - the VT220 emulating driver itself
157         - complete documentation for installation and operation
158         - termcap/terminfo, pcvt.el, rc.local, /etc/ttys, xmodmap examples
159         - cursor: utility to set the cursor size and shape
160         - fed: curses-based EGA/VGA character set editor
161         - fontedit: utility to edit the vt220 downloadable character set
162         - ispcvt: utility to display the drivers compile time configuration
163         - kcon: utility to setup national keyboard layouts and remap keys
164         - keycap: keyboard mapping database library similar to termcap
165         - loadfont: utility to load up to 4/8 fonts into an EGA/VGA board
166         - mcon: utility to control/configure a keyboard based mouse emulator
167         - scon: utility to runtime configure the video part of pcvt
168         - userkeys: utility to set the VT220 user programmable function keys
169         - vttest: VT100 compatibility torture test program
170         - some color- characterset- and attribute demos
171         - vga and keyboard register-level debugging utilities
172         
173
174 Tested Operating Systems
175 --------------------------------------------------------------------------------
176
177         NetBSD 0.9                      pcvt release 3.20-b2 tested
178
179         NetBSD 1.0                      pcvt release 3.20-b24 tested
180
181         NetBSD-current (post 1.0)       reported to run (end of March '95)
182
183
184         FreeBSD 1.1R                    pcvt release 3.20-b7 tested
185
186         FreeBSD 1.1.5.1R                pcvt release 3.20-b24 tested
187
188         FreeBSD 2.0                     pcvt release 3.20-b24 tested
189
190         FreeBSD-current (post 2.0)      reported to run (end of March '95)
191
192
193
194 Installation / Upgrade
195 --------------------------------------------------------------------------------
196
197   R E A D (!!!) THE INSTRUCTIONS IN THE Doc/INSTALL.xxxBSD FILES CAREFULLY !
198   ==========================================================================
199
200         Again:  PLEASE  R E A D   T H E M  !!!!!             (Thank You! ;-)
201         ========================================
202
203   If you read them, you should have NO problems installing pcvt on your
204   system, if you don't read them, you'll probably run into problems ...
205
206   If you run into any difficulties, please read Doc/NotesAndHints !
207
208 NOTE 1:
209 -------
210   It is highly recommended in order to configure the driver into the system,
211   that you remove (and/or backup) your previous kernel compile directory and
212   do a fresh "config" with the new pcvt configuration. This has to be done
213   because the chain "config/make depend/make" obviously does not resolve ALL
214   dependencies!
215
216 NOTE 2:
217 -------
218   You MUST copy or link the Util/Makefile.inc.X for your flavour of xxx(x)BSD
219   to Util/Makefile.inc . This is because FreeBSD handles manual pages
220   in a differnet way than NetBSD. Also you have to edit Doc/Makefile
221   to make this changes for the pcvt(4) manpage.
222
223 NOTE 3:
224 -------
225   The driver now (from 2.10 on) DEPENDS on the BIOS video display setting 
226   stored in the RTC CMOS Ram - verify your configuration setting!
227
228 NOTE 4:
229 -------
230   If you are using the pcvt termcap entry from Etc/Termcap, please reinstall
231   this into /usr/share/misc/termcap if you are upgrading, the entry had bugs
232   in release 3.10 and all earlier releases.
233
234   After doing that, you may need to generate a new termcap database for newer
235   FreeBSD (2.0 and up) and NetBSD (1.0 and up) Releases: 
236              cd to /usr/share/misc and execute 'cap_mkdb termcap'.
237
238 NOTE 5:
239 -------
240   The default keyboard layout is documented in Doc/Keyboard.HP unless you
241   compiled with PCVT_VT220KEY which is described in Doc/Keyboard.VT. Please
242   note that PCVT_VT220KEYB is not much supported, because i don't use it.
243
244 NOTE 6:
245 -------
246   When upgrading from a previous version of the driver, you can remove now
247   the directory /usr/share/misc/vgafonts. It was moved in release 3.20 to
248   /usr/share/misc/pcvtfonts.
249
250 NOTE 7:
251 -------
252   In case you don't like pcvt's white on red kernel messages, have a look at
253   the end of pcvt_conf.h, this is the place to change them.
254
255
256 WYSIWYG - What You Share Is What You Get
257 --------------------------------------------------------------------------------
258
259 PLEASE, if you fix bugs, add features, hack this driver to work on your
260 hardware or simply don't get it up and running, get in contact with me!
261
262      Help us to avoid reinventing the wheel over and over again!
263      -----------------------------------------------------------
264
265 The code is far from being perfect, YOU are very welcome to enhance it !
266 Please mail bug reports/fixes, suggestions, enhancements & diffs to 
267
268                         hm@hcs.de              or
269                         hm@altona.hamburg.com
270
271 I will support this driver as my time permits it, feel free to contact me!
272
273 Have fun!
274
275 Hellmuth
276
277
278 @home
279 -----
280 e-mail:  hm@altona.hamburg.com
281    tel:  +49 / 40 / 384298
282 s-mail:  Eggerstedtstr. 28, 22765 Hamburg, Europe
283
284
285 @work
286 -----
287 e-mail:  hm@hcs.de
288    tel:  +49 / 40 / 55903-170
289    fax:  +49 / 40 / 5591486
290 s-mail:  GFKT HCS Computertechnik GmbH, Oldesloer Str. 97-99,
291          22457 Hamburg, Europe