[unix-history] / usr / src / usr.bin / tn3270 / distribution / README

Welcome to the new tn3270 - version 4.1.

This version consists entirely of bug fixes to the August 1987 beta release
of tn3270.  This version will now deal with CICS and VM/XA on the IBM
side, and with SunOS 4.0 on Sun 3's and Sun 4's.

This version has been tested on various versions of BSD Unix, including
4.2 and 4.3 (but there are never vanilla versions) and the post-4.3 systems
running at Berkeley.  It has been tested on CCI's, Vaxen, Sun 3's and Sun 4's.
However, it doesn't necessarily work on all systems (nor has the testing
been as intensive as one might like).

This version should build on any Berkeley-derived system.

There are two alternate make files:  ./makefile_4.2 and telnet/Makefile_ultrix.

****    Try ./makefile_4.2 if you get compile-time errors, or get
	"multiply defined" messages for "_putchar" from the loader.

****    Try telnet/Makefile_ultrix if your make(1) utility doesn't
	support VPATH.  Also try this makefile if your ld(1) doesn't
	support the -r flag correctly.

The bad news is that I've had to drop MS-DOS support.  The good news here is
that there are various versions available for MS-DOS (from FTP Software in
Cambridge, Mass.; from IBM; from Excelan; and probably from others).  The
hooks are still there, as well as some code to update the screen.  However,
I just haven't had the time to produce a fully integrated version that would
"just make".  I suspect that a future release may have MS-DOS support back
in it.

There is no Mac support.  Contact Peter DiCamillo at Brown University if
you need a Mac tn3270.

The main code change in this version is to what used to be called "telnet.c".
This is now replaced with a version of telnet (substantially what appeared
in the "4.3tahoe" release from CSRG) which is broken into separate files.

Here is an overview of the directory structure:

    api/		General library of function needed by API
			(and, to some extent, by the rest of tn3270).

    arpa/		Location of "telnet.h" (for non-4.3 systems).

    ascii/		Routines necessary to handle the case of running
			from an ASCII-oriented system (ie: unix).

    ctlr/		The main part of the emulator.  Handles 3270 scan
			codes, 3270 data stream, 3270 display codes,
			and EBCDIC.  Also, the internal API function
			lives here.

    general/		Some general subroutines and data structures of
			interest to the emulator only.

    sys_curses/		System-dependent code for a curses-based environment.

    sys_dos/		System-dependent code for an MS-DOS-base environment.
			Remember that this is included for your developmental
			needs (ie: it doesn't work).

    telnet/		Where the telnet portion of tn3720 is built.

    tools/		Various tools.  Most of these are used during the
			build process.  One (prt3270) is a debugging tool.
			One (mkmake.y) is quite horrible, and attempts to
			transform Unix makefiles into PC makefiles.

    utilities/		The source for tnrecv, which receives files
			(fairly slowly) from an IBM host.  We don't
			include the IBM side, because we really aren't
			happy with very much of it (except that it does,
			sometimes, work).  Hopefully, when we get past
			the beta stage we will have more robust (and
			complete) code to share.

The fact that system dependancies are isolated should make it easy
to port to other systems.  I would like to hear about problems porting
to new areas.

In the August, 1987 README file, the following appeared:

> WHAT IS NOT IN THIS VERSION (sigh):

> 1)	We don't have a native X version yet.  I am waiting for X version 11
> 	(though this is mostly an excuse; I could have done version 10,
> 	but I haven't had the time).

> 2)	We don't process structured fields.

> 3)	We don't do 3270-style graphics (ala 3193, say).

> The above three items WILL be in the next version, which should come
> along "any day now" (say 6 months) (but, they WON'T be in the production
> release of this version).

The next piece of bad news is that none of the above have happened yet,
and I don't know when they might occur.
Commit	Line	Data
d43d1075	1	Welcome to the new tn3270 - version 4.1.
f84ab966	2
e6cacf3a GM	3	This version consists entirely of bug fixes to the August 1987 beta release
	4	of tn3270. This version will now deal with CICS and VM/XA on the IBM
	5	side, and with SunOS 4.0 on Sun 3's and Sun 4's.
f84ab966	6
e6cacf3a GM	7	This version has been tested on various versions of BSD Unix, including
	8	4.2 and 4.3 (but there are never vanilla versions) and the post-4.3 systems
	9	running at Berkeley. It has been tested on CCI's, Vaxen, Sun 3's and Sun 4's.
	10	However, it doesn't necessarily work on all systems (nor has the testing
	11	been as intensive as one might like).
ff3120a7	12
e6cacf3a GM	13	This version should build on any Berkeley-derived system.
	14
	15	There are two alternate make files: ./makefile_4.2 and telnet/Makefile_ultrix.
	16
	17	**** Try ./makefile_4.2 if you get compile-time errors, or get
	18	"multiply defined" messages for "_putchar" from the loader.
	19
	20	**** Try telnet/Makefile_ultrix if your make(1) utility doesn't
	21	support VPATH. Also try this makefile if your ld(1) doesn't
	22	support the -r flag correctly.
	23
	24	The bad news is that I've had to drop MS-DOS support. The good news here is
	25	that there are various versions available for MS-DOS (from FTP Software in
	26	Cambridge, Mass.; from IBM; from Excelan; and probably from others). The
	27	hooks are still there, as well as some code to update the screen. However,
	28	I just haven't had the time to produce a fully integrated version that would
	29	"just make". I suspect that a future release may have MS-DOS support back
	30	in it.
	31
	32	There is no Mac support. Contact Peter DiCamillo at Brown University if
	33	you need a Mac tn3270.
	34
	35	The main code change in this version is to what used to be called "telnet.c".
	36	This is now replaced with a version of telnet (substantially what appeared
	37	in the "4.3tahoe" release from CSRG) which is broken into separate files.
	38
	39	Here is an overview of the directory structure:
ff3120a7 GM	40
	41	api/ General library of function needed by API
	42	(and, to some extent, by the rest of tn3270).
	43
	44	arpa/ Location of "telnet.h" (for non-4.3 systems).
	45
	46	ascii/ Routines necessary to handle the case of running
	47	from an ASCII-oriented system (ie: unix).
	48
	49	ctlr/ The main part of the emulator. Handles 3270 scan
	50	codes, 3270 data stream, 3270 display codes,
	51	and EBCDIC. Also, the internal API function
	52	lives here.
	53
	54	general/ Some general subroutines and data structures of
	55	interest to the emulator only.
	56
	57	sys_curses/ System-dependent code for a curses-based environment.
	58
	59	sys_dos/ System-dependent code for an MS-DOS-base environment.
e6cacf3a GM	60	Remember that this is included for your developmental
	61	needs (ie: it doesn't work).
	62
	63	telnet/ Where the telnet portion of tn3720 is built.
ff3120a7 GM	64
	65	tools/ Various tools. Most of these are used during the
	66	build process. One (prt3270) is a debugging tool.
	67	One (mkmake.y) is quite horrible, and attempts to
	68	transform Unix makefiles into PC makefiles.
	69
	70	utilities/ The source for tnrecv, which receives files
	71	(fairly slowly) from an IBM host. We don't
	72	include the IBM side, because we really aren't
	73	happy with very much of it (except that it does,
	74	sometimes, work). Hopefully, when we get past
	75	the beta stage we will have more robust (and
	76	complete) code to share.
	77
	78	The fact that system dependancies are isolated should make it easy
	79	to port to other systems. I would like to hear about problems porting
	80	to new areas.
	81
e6cacf3a	82	In the August, 1987 README file, the following appeared:
ff3120a7	83
e6cacf3a	84	> WHAT IS NOT IN THIS VERSION (sigh):
ff3120a7	85
e6cacf3a GM	86	> 1) We don't have a native X version yet. I am waiting for X version 11
	87	> (though this is mostly an excuse; I could have done version 10,
	88	> but I haven't had the time).
ff3120a7	89
e6cacf3a	90	> 2) We don't process structured fields.
ff3120a7	91
e6cacf3a	92	> 3) We don't do 3270-style graphics (ala 3193, say).
ff3120a7	93
e6cacf3a GM	94	> The above three items WILL be in the next version, which should come
	95	> along "any day now" (say 6 months) (but, they WON'T be in the production
	96	> release of this version).
1d6c2d5c	97
e6cacf3a GM	98	The next piece of bad news is that none of the above have happened yet,
e6cacf3a GM	99	and I don't know when they might occur.