filename	: README
Jan 19, 1994
updated Mar 3 1994

Randy Wright
rw@rwsys.wimsey.bc.ca

Installation:

Su to root to do the installation.

Run script Install.sh in order to install the files
and build a startup configuration file. This script
puts the pre-built binaries in /usr/bin, makes a
directory called /usr/net where your configuration files
are stored, then it builds a file called startup.new,
which is used to initialize net at run time. The script
will take you through this stuff step by step in order
to get you started without having to tear your hair out
or read for two days.

Install.sh also adds the environmental variables
NETHOME and NETSPOOL to /etc/profile in order to
set a system wide environment.

If you are going to use this package with ethernet,
you'll need to install the board and the ne ethernet
driver before you run the network.

More will be explained by the installation procedure
as you go along. There is a subdirectory of this
package called doc. It has extensive documentation
of the tcp/ip package.

----

This package is aimed at people who want to log into
the internet via slip and who wish to use ethernet
among local machines rather than sneakernet. It is
not (and cannot be) a high performance networking system
because the protocols are on the user level rather than
on the kernel level. However it is a much faster performer
than the KA9Q/K5JB code for Coherent. I was able to get
5 to 10 kb /sec file transfer speeds over the ethernet
with K5JB-k29. This very slow speed seemed to "eat up"
the cpu. So rebuilt the flow control systems in a
different style more suited to coherent (and unix).

Now I can get it produce 50 - 100 kb /sec without
using up all the cpu time. The cost of this move is
that the code cannot be run on dos machines anymore.
In addition, I converted all the 16 bit-isms in the
lower level protocols to 32 bit-isms and removed all
code that I could not test from these levels. The
result is a simpler, greatly faster implementation,
suitable for LAN useage.

Cohulip can be compiled using cc or gcc. Edit the Makefile
accordingly. This package supports ONLY slip or ethernet
for media. I have removed the code I could not test. This
includes ax25 and netrom as well as a number of packet radio
media support files.

The ethernet support is designed to work with the ne r2.x
CON device driver.

Two additional sample startup files are copied to the
directory /usr/net and can be used to help you see how
to configure cohulip. They are commented so that you
can edit them to suite your situation.

If you do not specify a startup configuation file on
the commandline as an argument to net command, it will
search for a file called $NETHOME/startup.net and if it
finds that file, it will execute it before showing the
net screens. So once you have a startup file that you
like, rename it startup.net.

The telunix login server will seem to "see double" unless
you handle the pty's correctly. First, ensure that there is
an entry in /etc/ttys for a pty (or several) and use the
enable command to enable logins. Ensure that the telnet
at both machines is set to eol unix and echo refuse.
When you have logged in you can eliminate the double
prompts by issuing the following shell command:
	stty -icanon -echo min1

There is a help file on telunix availble from the net>
prompt to remind you how to do this.

-- Randy

-----------------------
March 4 1994,

	I have found this project to be a very large
one, and I am unable to proceed with much further
with it due to a lack of funding. Since I can't seem
to locate a source of funding, I'm going to distribute
it as is, in the hopes that someone else can carry on
with it.

	I began a socket driver in order to facilitate
porting code to be usable on this, and intended to
move the cohulip project into a streams device driver.
This is quite feasible for a reasonably competent
programmer, with enough time to do it, and I encourage
you, if you are such a person to do so.

	I regret that this package is not really up
to the level of user friendlines that a neophyte to
tcp/ip would find workable. I have simplified the package
as much as possible, but I cannot offer the level of support
and documentation needed for widespread usage of this
package by neophytes to tcp/ip.

	However, the package runs well enough to support
ethernet and to use on the internet.

--Randy
--------------------------------------------------------

Documentation
=============

Directory ./doc contains the cohulip documentation. This documentation
is based on the original KA9Q documentation, but is heavily rewritten,
completely reorganized, and contains much original material.

All documentation is two forms:  PostScript and nroff.  All files are in
directory "doc".  Files with suffix ".p" were generated by nroff, and can
be viewed on your screen.  Files with the suffix ".ps" are in PostScript
format.  We urge you to print them if you can, as they contain helpful
diagrams that simply cannot be reproduced in the viewable forms.  For
information on how to print the documentation (either the nroff or the
PostScript forms), see the Lexicon entry for "printer".

File ./doc/intro.p introduces the documentation; file ./doc/install.p
describes how to install "cohulip" onto your system.  We *strongly* urge
you to read these chapters before you attempt to install "cohulip" on your
system - doing so probably will save you much grief.

Directory doc/doc.k5jb contains the original K5JB documentation, should you
need it.

We hope you find this documentation helpful.  Please report errors and
problems with this manual to Fred Butzen (fred@mwc.com).

