-------------------------------------------------------------------------
uka_ppp 1.51 (c) by khweis@mvmpc9.ciw.uni-karlsruhe.de (Karl-Heinz Weiss)
-------------------------------------------------------------------------

                     Quick-Start
                     -----------
1. Copy the selfextracting "uka_ppp.exe" to a directory of your
choice. uka_ppp explodes to "setup.bat", "ukappp.exe", "yarn.exe"
"setup.ger (a short installation guide for german users) and this
document "setup.txt" 

2. Run "setup.bat" now. Some directories are created:

.\uka_ppp\   
.\uka_ppp\spool\
.\uka_ppp\docs\
.\yarn\
.\home\
.\home\yarn\

.\uka_ppp\ contains all the slip/ppp stuff while .\yarn\ 
contains (a stripped down version) of Chin Huang's offlinereader
YARN. YARN's config file is in \home\yarn\. If you have a newer
version of YARN, you should overwrite the executables in the 
.\yarn\ dir with your own version before you run setup.

A setup script ("1install") is executed now. Answer all questions.
Hit ESCAPE if something goes wrong. Calling ".\uka_pp\setup.bat"
restarts the setup program. The mainprogram is started with "go.bat". 
You can change all settings from the main menu too (item "Setup").

                      Creating an autolog file
                      ------------------------
An "autolog" script is created automatically during setup. You should 
repeat the learnprogram later on from the mainmenu (item "Setup/Learn")
if it fails for the first time. After startup, the autodial script is
executed and connects you to your internet provider. You are in terminal-
mode now. Enter login/password and if needed, the startup commands
to start the transport program (cslip/slip/ppp) on the terminal server. 
Now quit the terminal session with ALT-X. You are asked for your current
IP address which should be shown up on the screen. Enter this IP *exactly* 
as shown or enter the static IP which your ISP told you. If you have a PPP 
account, you need not enter an IP. The IP should be transfered as part of
the Link Access Protocol and is written to a local file named "IP". 
If this is not the case, you'll get a warning and you should enter the
IP manually. The learnprogram now creates a file "autolog" which is derived
from a protocol file "x_script.log" which contains all your keypresses
and the answers from your server. At the next login this "autolog"
script (to be more exactly: the copy of the autolog script, named *.$lg) is 
used instead of the manual login. If this doesn't work for you, you have
to edit the "*.$lg" script and possibly some settings in the main
configuration file "wattcp.cfg". Then try "Learn Logfile" again 
or dial up in mnaual mode (item "D" in the main menu).

                     Startup of UKA_PPP
                     ------------------
Change to the .\uka_ppp dir and run "go.bat" from the comandline.
It's ipmortant to do this from the DOS commandline, because
3 environment variables are defined in go.bat. If DOS complains
about too less environment space, copy these variables to your
autoexec.bat, remove them from go.bat and restart your computer.

The dialer is started automatically on startup of item "C" (Check
Mail and News), "F" (FTP), "T" (Telnet) or "D" (Dial)

Note the documents in .\uka_ppp\doc\ if you are looking for more
information and copyrights.
                   
                    Customizing UKA_PPP
                    -------------------
All work is done by a script interpreter named "x_script.exe".
This tool is called with the name of a scriptfile as an argument.
If no argument is given, the script "x_script.cfg" is used (if present).
Before the interpreter begins his job, "wattcp.cfg" is read.
As a result, the variables defined in wattcp.cfg are known
later on within all other scripts which are "called".
The scriptlanguage is self documenting (as I hope ;-)). Most 
capabilities are shown up in the various scripts which are part
of UKA_PPP. Before you start UKA_PPP you should have a look
to the "getnews.$do" script and modify or comment the lines which are
related to services you don't have or you don't want to have.

                  Configuration file WATTCP.CFG
                  -----------------------------
This file is the main configuration file which is used by the tcpip kernal
(tcport.exe) and by all x_* applications. Normally, you should not
change anything in this file manually, unless you know what you are doing ;-)
Most variables are selfdocumenting. Note also the comments. The variable
'$com_int' is the software interrupt, used for the communication 
between the INT14 redirector tcpport.exe and my x_* programs.
If INT14 is already in use by another program (e.g. a fossil driver for
an ISDN card) you may modify $com_int to > 61 and < ff. A good
value is 62. Don't confuse $com_int with $vec! The latter one is the
software interrupt used by the packetdriver. The default value of 61
should work fine on all systems. (Note: OS2 needs INT 60 for it's own
tcp/ip support!). The variable 'onlinesum' contains the total online
time in seconds counted by the uka_ppp mainprogram. Separated by a
colon is the date when the counting was started for the first time.
"onlinsum=0" resets the counter. The date is added automatically if
you go online the next time.

                     Multiple configurations
                     -----------------------
It's possible with UKA_PPP to save and recall different configurations.
This is useful if you have more then one internet service provider. 
If you select a configuration, the files "*.$cf" and "*.$do" are copied to 
wattcp.cfg and getnews.$do. If you change the settings, these changes
are made to the copies, not to the original files. You must save 
these files ("save configuration"), before you select another Provider,
or your changes are lost.

                    Multiple Newsservers
                    --------------------
It's possible with uka_ppp to handle an arbitrary number of Newsservers.
Select "Setup,Servers...", then "Add or select Newsserver". The
server you've seleceted becomes the default server (the server used
when you select item "C Check mail and news" from the main menu) if you
save the current configuration with "P Put (save) current configuration"
from the Setup menu.

                     Script & Files
                     --------------
All scripts and configuration files are ordinary ASCI textfiles. You
may edit this files with an texteditor. 

(Note: the character '*' denotes a name of a configuration, e.g. 'default'.) 

Scripts:
--------
wattcp.cfg    This is the main configuration file
config.ppp    Configuration file used by ppp.exe. (See .\uka_ppp\docs\ppp.txt)
*.$cf         This file overwrites wattcp.cfg if you load a configuration
*.$lg         This is a script which performs login and authentification.
              You should edit this file if autologin doesn't work properly.
*.$do         This script is executed when you select "Check News and Mail"  
              from the main menu or if you start a "Netcall" from Crosspoint.
              This file overwrites "getnews.$do" if you load a configuration.
*.rc          This file contains the newsgroups you are subscribed to and
              some control variables.

Information files:
autolog       A login script created during login when in learnmode. Copied
              to *.$lg if you save a configuration.
*.gr          This file contains the list of avaialable newsgroups.
              *.gr is updated on every login. This file is not alpha-
              betically sorted. It's a good idea to sort this file from
              time to time with the sort utility 
              (/Setup../Server../sort List).
*.grn         If new groups arrived at your server, they are listed here.
x_script.log  A logfile which contains a trace of your login. Trace starts        
              after the command "log=on" was executed in a script. The 
              special ASCI characters 01 and 02 separates modem input from
              modem output. Tracing is only active during terminal mode,
              not during tcp/ip mode. 
online.log    A list with your online times.
x_news.log    A lists of activities created by x_news during download of news

           Installation of a SOUP compliant offline reader
           -----------------------------------------------
The basic setup expects soup compliant files packed with 'pkzip' in the
uka_ppp directory. The names are 'outfile.zip' for outgoing messages
(generated by the soup reader) and 'infile.zip' for incoming messages
(messages consumed by the reader). If other names or directories 
should be used for some reason, or other compression utilities then 
pkzip/pkunzip, you have to edit the import/export batchfiles. You need
not edit anything, if you like the YARN offlinereader which uka_ppp 
installed for you. If you want to customize YARN, you should have a 
look to the file .\home\yarn\config. A description of YARN and 
copyright notes are in .\uka_ppp\doc\yarn.txt.

              Installation for crosspoint users
              ---------------------------------

If you don't have crosspoint:

1. Get the latest Crosspoint distribution (e.g. from my site).
   Create a directory of your choice, copy the xp*-files
   to this directory and unpack the (self extracting) *.exe files.

2. Start crosspoint ('xp').
   Select eDit/Servers/, add new server.
   Select servertype: 'Zconnect'. 
   Enter servername: name of your server machine
   Enter username: your email name  
   Example: 
   if your emailadress is 'khweis@mvmpc9.ciw.uni-karlsruhe.de',
   the servername is 'mvmpc9' and the username is 'khweis'

3. Select /eDit/Servers/Edit/Point
   Pointname: your user id

4. Select /eDit/Servers/Edit/Names 
   enter your Real name and the domainname. 
   (example is 'ciw.uni-karlsruhe.de')
   Select submenu 'Misc'
   Enter Inputfilter: c:\slip\uka_ppp\x_script.exe xpnews
   Select submenu 'Sysopmode'
   Enter Inputfile: c:\ppp\uka_ppp\infile.z
   Enter Outputfile: c:\ppp\uka_ppp\outfile.z
   (Of course you have to write another pathname,
   if the uka_ppp stuff is not in c:\ppp\uka_ppp\
 
5. If everything is done, start 'Netcall'. "x_script" is launched,
   connects you to your ISP and do whatever else you have 
   programmed within the xpnews script.
---------------------------------------------------------------------------

                      COPYRIGHT
                      ---------
I included some helper applications in UKA_PPP.EXE. As far as I 
know, these applications are free for noncommercial use. Please
note the copyrights of the individual authors! All docs and notes
are in .\uka_ppp\docs.

'tcpport' and "ftp.exe" is (c) by Erik Engelke. It's part of his great
'waterloo tcp/ip' package.
- copyright is in 'wattcp.txt' and 'ftp.txt'

'slipper' and 'cslipper' are (c) by Peter Tattam
- copyright is in slipper.txt

'ppp.exe" is part of "etherppp.zip" which I found on ftp.merit.edu.
- copyright notes are in ppp.txt

'Crosspoint'-package is (c) by Peter Mandrella
- copyright is in licenz.doc and within his program

"Conex" is (c) by Erhard Hilbig
- copyright is in conex.doc

termin.com is (c) by Russ Nelson, Crynwr Software
- russ <nelson@crynwr.com>     http://www.crynwr.com/crynwr/nelson.html
  Source of termin.com is available from pktd11[ab].zip found on 
  mvmpc9.ciw.uni-karlsruhe.de in /gopher/public/pktdrvr/

rpsort.com is (c) by Robrt Pirko
- copyright notes are in in rpsort.txt
----------------------------------------------------------------------------
All other programs are my own and free for noncommercial use.
If you are interested in the sources, have a look to the SRC directory.
You may obtain the most recent version of uka_ppp from:

http://mvmpc9.ciw.uni-karlsruhe.de/public/uka_ppp/uka_ppp.exe

Questions should be addressed to: khweis@mvmpc9.ciw.uni-karlsruhe.de
----
UKA_PPP is (c) by Karl-Heinz Weiss                           12MAY96
