+----------------------------------------------------------------------------+
|                                                                            |
| Kahn Documentation File                                                    |
| Version 1.0 09/20/97                                                       |
| by Norman Bright                                                           |
| StarGate Networks                                                          |
|                                                                            |
| Revisions:                                                                 |
| 07/09/96 - Created                                                         |
| 07/23/96 - Updated with new PPP information, edit for content.             |
| 10/03/96 - Updated Installation instrutions                                |
| 11/11/96 - Added Whats new for version 0.90                                |
| 11/19/96 - Added Whats new for version 0.91                                |
| 12/23/96 - Added Whats new for version 0.92                                |
| 05/05/97 - Added Whats new for version 0.99                                |
| 09/20/97 - Added Whats new for version 1.0                                 |
| 12/21/97 - Added Whats new for version 1.1                                 |
+----------------------------------------------------------------------------+


Index
~~~~~
0.  Whats New
1.  Introduction
2.  System Requirements
3.  Network Requirements
4.  Installation
5.  Where to Get Kahn
6.  Registration
7.  How it Works
8.  Other Documentation
9.  Support
10. Thanks
11. References
12. Trademarks


0. Whats New
============
Version 1.1
- Added support for DOS IRC chat client (PCON) to run while Kahn is connected
  to a server.
- Included PCON 2.01, which is a fully functional dos IRC chat client that
  will also work without Kahn, for normal IRC.

Version 1.0
- Changed tracker support to use new stargate address
- Updated UDP ports to the Kahn 1.0 version
- Coupla bugs fixes
- This verison of Kahn DOS still uses the PCON chat program. Users of DOS
  must use an IRC client in order to communicate with Win95 1.0  users until 
  we release an IRC client for DOS :). 
  The IRC server address to use is stargatenetworks.com port 6969. Sorry for 
  the inconvenience and this is being addressed. Of course PCON still does 
  work in Win95 and DOS so users of Win95 can still use the old chat program
  in order to talk with DOS users.
  
Version 0.99
- Dos server lookup support, you can now view the servers that are online
- Bug fixes for most games


Version 0.92
- Bug fixes in Kahn driver, all known hangs resolved 
- Bug Fixes in PCON too


Version 0.91

- Better support for starting and stopping games
- PCON uses a LOT less memory, fixes /WHOIS, /USERS
- Bug fixes for Doom games (doom, doomII, heretic etc)


Version 0.90.

- Whois support from the command line (kahn /? for details)

- User subnetting (new servers only)
  Tired of being flooded by other players using the same socket in C&C?
  Wish you had your own private net? Create it with the new subnet command!
  Eliminate all noise from other sockets and players and protect it with a 
  password!

- Support for aliases in the cfg file - ie (kahn @netertainment)

- Bug fixes, support for Su27 Flanker

- New PCON!
  - File transfers, support for new Kahn command line options

- Operator control of server! Tired of the foul mouthed juveniles in chat? 
  They can and will be booted by operator control, and if they continue, 
  they can be banned.

- Server binaries on the FTP site! 

- Look for the new tracker program due out shortly to list the kahn servers
  around the world.
  


1. Introduction
===============

Welcome to the Kahn beta program. This file contains information that can get
you up and playing games across the Internet in no time at all. If you are
familiar with Kali, then you can probably skip right to the installation
section, but please read the FAQ. If you are new to playing network games 
over the Internet, then please read this document carefully and if you still
need more information, consult the Other Documentation section.

Network games (ie. Descent, Descent2, DOOM, Warcraft, Command and Conquer,etc.) 
normally use an IPX driver from Novell and a network adapter driver from 
their network adapter manufacturer, to send packets to one another for 
interactive game play. There is nothing like having a human component to do
virtual battle against. People who have the luxury of having an IPX Local Area 
Network (LAN) at work or maybe even at home have the best environment to play
network games in. Unfortunately not many of us have a LAN yet at home but what
Kahn does, is turn the Internet into a virtual IPX based LAN for you.

2. System Requirements
======================

2.1 Pentium or Pentium Pro Processor Based Machine
Kahn uses some advanced coding techniques that work best on pentium class
machines. A 486 will work, but if you play any of the latest games, you'll 
probably end up with a Pentium machine anyway.


2.2 DOS
Yes Kahn is a DOS based driver. Any version of DOS should work and you can 
load it high. Read the FAQ for information on other operating systems.


3. Network Requirements
=======================

3.1 A connection to the Internet
There are so many ways to connect to the Internet right now, but lets start
with a couple of the most popular. You can connect to the Internet from home 
through a local Internet Service Provider (ISP). There are also some major 
players getting in the Internet Service Providing business such as AT&T and
GTE. 

Below are some of the more common ways to connect to the Internet.

3.1.1 PPP 
Point to Point Protocol is probably one of the most popular ways to connect 
today. Most ISPs are providing this service to their customers today. PPP 
provides a protocol between two communication devices and allows then to 
exchange packets. 


3.1.2 SLIP
Serial Line Internet Protocol is another method used to connect to the 
Internet through a modem. Either this protocol or PPP are probably provided 
by your ISP.


3.1.3 High Speed/Direct Connect
Direct connects are normally done through Ethernet. If you have a direct 
connect then you are very lucky, and are probably playing from work. Other
home types of high speed connections include ADSL/SDSL/ISDN or even cable 
modems.


3.2 A Packet Driver
This is normally another TSR program that provides an interface or connection
between applications and the communications hardware in your PC. Packet 
drivers are available for all type of communications devices from modems to
almost every kind of network adapter. Kahn ships with a PPP stack and 
packet driver from Klos technologies for you to use.


4. Installation
===============

Follow these step by step instructions to get Kahn up and running quickly. For
Kali DOS users that use the Klos PPP stack already, see the FastPath 
section. If this is your first PPP DOS installation, follow this steps 
carefully.

0) What you will need:
   - The KLOS PPP stack from www.klos.com
   - The number of the COM port your modem is attached to
   - The phone number of your ISP
   - The login and password you use to setup a PPP session with your ISP
   - Your modem manual
   - The Kahn distribution file (you got it if you are reading this)

1) Create a directory on your Hard disk called c:\kahn.

2) Copy the PPPSHARE.EXE file into this directory and run it.

3) Copy the Kahn distribution file into the same directory and unzip it.
   Answer yes to any files that running this will overwrite.

4) Run SETUP.BAT. This starts the PPPMENU program where you setup the COM port 
   and the Interrupt for your modem. 

3) Read the Klos Welcome screen and wait for it to dismiss itself or dismiss
   it with the ESC key.

4) You are then presented with a Profile List. The Current Profile is preset 
   for COM1, IRQ4, and 115200 baud rate. If these settings are acceptable for 
   your computer, then press ESC and go to section 4.3.

5) Configure the Current Profile for your PC. Normal settings for COM ports
   are:

   COM1 or COM3 uses IRQ4
   COM2 or COM4 uses IRQ3

   Baudrates are set depending on the UART in your PC. The following table 
   should be used as a reference:

   UART     Modem       Baudrate
   ----     -----       --------
   16550    28.8        115,200
   16550    14.4        57,600
   other    any         38,400 or less

   *** If your PC hangs when using the highest baudrate settings, try slowing
   it down to 57,600 or less. 
       
6) Set the phone number of your ISP in Modem Settings | Phone Number

7) Set the modem initialization string to allow your modem to use:

      - data compression
      - error correction
      - RTS/CTS flow control

   These settings can be found in your modem manual, but if you can't find 
   your manual then your modem defaults should work ok.

8) Exit the PPPMENU program and save the Profile file when prompted. You are
   now ready to try connecting to your ISP. Goto section 4.3.

These are the only things you should need to change. Klos has a very
feature rich PPP stack, you can tinker with other settings, especially the
scripting stuff. Scripting will allow you to automatically log into your ISP,
the main thing to remember about script responses is to add the "\r" carriage
return so PPPSHARE will type and enter it for you.


4.1 FastPath for Existing Klos Users
====================================

Being the veteran gamer that you are, you are probably anxious to try this 
out. Copy the KAHN.EXE and KAHN.CFG file into your current PPP directory. 

You probably have a .BAT file called LOAD.BAT that looks something like this:

@echo off
lsl
ppp
pppmenu
pppstate wait ip
pppwat
ipstub

Add another line that executes pppwat again but points to the KAHN config 
file. When you are done it will look like this:

@echo off
lsl
ppp
pppmenu
pppstate wait ip
pppwat
pppwat C:\PPP\KAHN.CFG
ipstub

What this does is update the KAHN.CFG file with the IP address used for PPP.
It still changes the WATTCP.CFG file, so if you have any other WATTCP based
applications they will still work (PING, FTP etc).


4.2 FastPath for Existing DOS Kali Users
============================================

Since both Kahn and DOS Kali work with packet drivers, Kahn is a drop in 
replacement for Kali. If you have DOS Kali working, then simply copy the
KAHN.EXE and KAHN.CFG file to your Kali driectory. Edit the KAHN.CFG file
with the my_ip, netmask, and gateway parameters as you do when you use 
KALI and KAHN will work automatically.


4.3 Configure KAHN.CFG
======================
The KAHN.CFG file should be configured before you test your Internet
connection. The file contains the following parameters, comments are prefaced
by # character, equal signs are optional:

--------------------------------KAHN.CFG-------------------------------------
nickname Crusher             # any old name will do
compress yes                 # advanced option, read FAQ for details
my_ip   = xxx.xxx.xxx.xxx    # IP address - this will be configured by PPPWAT 
gateway = xxx.xxx.xxx.xxx    # Gateway address - also configured by PPPWAT
netmask = xxx.xxx.xxx.xxx    # Network Mask - also configured by PPPWAT
ppp yes                      # set PPP to yes if you use PPP

#serial = xxxxxxxxxxxxxxx    # registered users
#name   = xxxxxxxxxxxxxxx    # registered users
#authcode = xxxxxxxxxxxxxxxx # registered users

----------------------------End KAHN.CFG-------------------------------------

For the purposes of this Beta test you should only need to change the
nickname parameter. The compress option should be left to yes but you might
need to change it. Please read the How It Works section and the FAQ.

4.3 Testing
===========

Once you have configured the PPP driver, you are ready to test your 
connection. The GO.BAT file has been configured to load the PPP files and 
KAHN to get you up and running on the Kahn server. The contents of the GO.BAT
file are documented below:

-----------------------------GO.BAT-----------------------------------------
@echo off
REM KAHN.BAT file used to connect to the Kahn Server
if exist lsl.com goto start

@echo You are missing the LSL.COM file necessary to use Kahn. This file is 
@echo distributed freely with the KLOS PPP stack. Please obtain this 
@echo file from www.klos.com
goto end

:start
lsl
ppp
pppmenu
pppstate wait ip
pppwat kahn.cfg
ipstub
kahn @neter
:end
---------------------------END GO.BAT---------------------------------------


If everything is working, you will be back in the PPPMENU program again.

1. Select the "Connect" option with Enter and select the "Current" profile 
   we set up previously. If the "Current" profile is correct, your modem will
   dial your ISP and you should get your normal login prompt.

2. Login into your ISP as you normally do to get a PPP session. For some 
   users they might need to prefix their username or password with special
   characters. Please consult your ISP for this information.

3. Once you have entered your password, press "ALT-S" to start the PPP 
   protocol. If you have entered your userid and password correctly PPP 
   should return to its main menu.

4. If you are connected to your ISP then you can test your connection using 
   the new menu items on the main menu. You can run the ECHO and Performance
   test to see if your PPP connection is working.

5. Exit PPPMENU and the final programs in the GO.BAT file will run.

6. PPPWAT will configure the IP addresses in the WATTCP.CFG and the KAHN.CFG
   file. Kahn does not support domain name service so no nameserver address
   is necessary.

7. The last line loads Kahn and connects it to the Kahn server. 



4. Where to Get Kahn
====================
Kahn is available on http://www.stargatenetworks.com. The Klos PPP stack 
is available on http://www.klos.com.

5. Registration
===============
Kahn is shareware not freeware, but there are no timeout or restrictions in 
this beta release. This may change in future releases. To support and 
continue the development of Kahn you should register your copy if you find 
it meets your gaming addictions. Please fill out the REGISTER.TXT file and 
email it to:

norm@stargatenetworks.com

or by regular mail, you can send it and your check or money order to:

StarGate Networks
PO Box 7292
Beaverton, OR. 97007-7292

or online at:

http://www.stargatenetworks.com


7. How it Works
===============
Kahn is a DOS TSR that emulates the IPX protocol and sends network game 
information over the Internet in UDP/IP packets. Kahn should work with any
game that requires an IPX protocol stack for network game play.

Kahn also goes out of its way to minimize the sizes and amount of data sent
over the network in a game. Kahn uses proprietary algorithms to optimize 
network traffic. This is controlled by the compress parameter in the KAHN.CFG
file. When set to 'yes', Kahn switches to optimization mode and you will 
experience better game play for games like Descent and Quake. All players
must use this parameter to play in the same game. You cannot mixed optimized
and non-optimized versions of the driver in the same game.

If you plan on having more than 8 players in a game, you set Compress to No in
the Kahn,CFG file. This is due to the current buffer restrictions in the 
driver and it should change in future versions.

If you turn off optimizations, Kahn will still perform very well due to its
custom high performance IP stack and low memory overhead. 


7.1 Kahn Servers
================
Kahn server binaries are on the FTP site and there are version for most 
popular OS's. You can donwload and try these at your own risk. If you need
another flovor of the server, email me at norm@stargatenetworks.com.

The Kahn client driver also contains a local server. There is not restriction
to the number of clients you can connect to the local server, because you 
will probably run out of bandwidth before you run out of Kahn resources. The
local server can be started by simply running KAHN with no arguments. 


8. Other Documentation
======================
Packet driver documentation abounds on the Internet. If we didn't cover it in
this simple file, and you need more information we will add it. Please send 
comments and criticisms to norm@stargatenetworks.com.


9. Support
==========
If you experience problems, please send a detailed problem description and
information about your system including but not limited to:

AUTOEXEC.BAT file
CONFIG.SYS file
KAHN.CFG file
DOS version
File versions (EMM386.EXE, HIMEM.SYS, etc)
packet driver information
Game and version information
Detailed Problem description

Send this to support@stargatenetworks.comleport.com and put "Help Me" in the 
title for fastest attention. Registered users get the fastest support...


10. Thanks
==========
My wife for the idea and then tolerating the development of this product 
and cracking the whip.

DID for making EF2000 and motivating me to write a low memory IPX driver.

Klos Technologies for a fine PPP stack.

Kevin Bentley for cranking out and enhancing (re-writing) my simple Win95 
chat client. And kudos for the work on PCON DOS.

Pooterman and Ignorance for all their help and abuse ;).


11. References
==============

www.klos.com   - PPP protocol stack information
www.kali.net   - Great reference for Internet connection setup
www.crynwr.com - Packet driver heaven

12. Trademarks
==============

*Kali is a Registered Trademark of Kali, Inc. 

All other trademarks are property of their respective owners and are used 
here for informational purposes only.
