######   #####  ##     #####    ###    #####    #####  ######
######  ###     ##     ######   ###    ######  ###     ##
  ##    ##      ##     ######  #####   ######   ####   #####
  ##    ##      ##     #####   #####   #####      ###  #####
  ##    ###     ##     ##     ##   ##  ## ##      ###  ##
  ##     #####  #####  ##     ##   ##  ##  ##  #####   ######

                 V2.00 from 14. March 1997

A program package for parsing Tcl and Tk program files.
This version 'knows' the commands of Tcl 7.6 and Tk 4.1.

In the file 'README.files' there is an index of all files that
should be in the package.


CONTENTS
--------

   1. INSTALLATION
   2. HOW THE PROGRAMS WORK TOGETHER
   3. ABOUT US AND THE PROGRAMS
   4. HISTORY


1. INSTALLATION
---------------

(1)	Untar the file:

		tar -xzf tclparse.tar.gz
	or
		tar -xzf tclparse.tgz

	(I think you did that already)


(2)	
        You should check the Makefile to see if the configuration are
        valid for your system. 

	Then execute

                make 

        this should compile the sources. If successful, run

		make install

        and the following will (should) happen:

	  1. The information files '.options.tclparse' and
	     '.vars.tclparse' are generated by 'wish', and stored in
	     the current directory.

	  2. The information files are copied to your home-directory.

	  3. The executables 'tclscan', 'tclmerge' and 'tclparse' are
	     copied to the destination specified by 'BINDIR' in the
	     makefile.

	  4. The manual pages for the programs are copied to the
	     destination specified by 'MANDIR'.

	If no errors occured, the programs are ready for work. For
	specific information about the programs you should read	the
	manual pages. A short description is found in the next
	chapter.

	Try

	        make testtclparse

	to run a test with tclscan and tclparse.
		

(3)	The programs were originally compiled with the GNU project C++
	Compiler on an intel-based linux-system (ELF). If you want to
	use another system and errors occurs while compiling, feel
	free to help yourself. 

	Although we don't have a support line yet, you may want to send a
	mail describing on what kind of system the problem
	occured. For the adresses see the end of the file.



2. HOW THE PROGRAMS WORK TOGETHER
---------------------------------

The main program is TCLPARSE. It is used to parse a tcl program
file. Since in most programs there are procedure definitions and the
procedure names are used as new commands, the program needs to know
these new commands before it can start.

To provide this information the program TCLSCAN is used. It scans a
tcl program file for procedure definitions and also for definitions of
global variables. This information is saved in an information file. The
name of this information file is build by appending the suffix '.ini'
to the name of the corresponding tcl program file. TCLPARSE tries to load
this file automatically at startup time.

For programs with many modules you might want to have one big
information file so you can parse each module with all the commands
and variables used in the whole program. The program TCLMERGE allows
you to melt several information files into one. To tell TCLPARSE not
to load the standard information file but the one created with
TCLMERGE, you can use the -infofile option with TCLPARSE (see manual page).

3. ABOUT US AND THE PROGRAMS
----------------------------

The authors are Stephan Weiss and Heiko Grossmann. We are both
students of computer science at the University of Stuttgart, Germany.
The program is a project as part of our studies and is directed by
Stefan Schreyjak, software lab. Here are the email adresses for
feedback, bugs and constructive criticism. In the latest release of
the package there should always be the latest email adresses:


Stephan Weiss:

	primary adress (home):	07031760536-002@t-online.de
	secondary adress:	snweiss@tick.informatik.uni-stuttgart.de


Heiko Grossmann:

	grossmho@tick.informatik.uni-stuttgart.de


Stefan Schreyjak:

	Stefan.Schreyjak@informatik.uni-stuttgart.de


Homepage of tclparse

http://www.informatik.uni-stuttgart.de/ipvr/swlab/sopra/tclsyntax/tclparseHome.html


4. HISTORY
----------

V1.00  Version of tclparse written in Tcl/Tk
       never released

V2.00  C++ Version of tclparse
       released at 14. March 1997