README:  TclPro 1.2

Copyright (c) 1998-1999 by Scriptics Corporation
All rights reserved
-------------------

Contents
========
    1. Introduction to TclPro
    2. Documentation
    3. Starting Up TclPro Tools
    4. Licensing
    5. Upgrading to the Latest TclPro Version
    6. C Development on Windows
    7. Support and bug fixes
    8. Contact Info

1. Introduction to TclPro
=========================

Scriptics' flagship product is TclPro, a development environment for
professional Tcl developers. TclPro boosts your productivity with a
code checker and a powerful graphical debugger.  TclPro also makes it
easy to package and distribute your Tcl applications, and it allows
you to protect your source code.  Lastly, TclPro incorporates the
popular [incr Tcl], Expect (Unix only), and TclX extensions.  You can
use the bundled extensions without having to worry about compiling
them or integrating them with the Tcl core, and the TclPro tools work
with these extensions.

TclPro Debugger
---------------

No more puts statements! Breakpoints, single-stepping, variable/stack
display, and other features help you track down bugs quickly. TclPro
Debugger provides a convenient graphical user interface and allows you
to debug remote and embedded Tcl applications as well as local ones. 

TclPro Checker
--------------

Our static code analyzer helps you find syntax errors and other common
usage errors quickly, without having to run your program. If you are
using older versions of Tcl and Tk (as far back as Tcl 7.3 and Tk
3.6), TclPro Checker helps you upgrade by warning about potential
incompatibilities.

TclPro Compiler
---------------

Do you want to keep your customers from seeing and modifying your
source code? TclPro Compiler allows you to compile a Tcl script into a
byte-code representation for distribution, so that your source code
doesn't leave your site.

TclPro Wrapper
--------------

TclPro Wrapper creates a single executable file containing everything
needed to run a Tcl application. This makes it easy to distribute Tcl
applications to your users and manage upgrades in Tcl versions. 

Tcl/Tk 8.0.5
------------

In addition to the above tools, TclPro 1.2 includes a new release of
the core Tcl and Tk libraries, Tcl 8.0.5 and Tk 8.0.5. These releases
include numerous bug fixes plus additional support for the extensions
bundled in TclPro and for the TclPro tools.  Scriptics has made the
8.0.5 releases freely available on our Web site separately from TclPro
under the traditional open source distribution model for Tcl.

[incr Tcl] 3.0
--------------

TclPro 1.2 incorporates the 3.0 version of [incr Tcl], [incr Tk] and
[incr Widgets], the popular object-oriented extensions written by
Michael McLennan and Mark Ulferts with contributions by many others.

Expect 5.29 on Unix
-------------------

TclPro 1.2 incorporates the 5.29 version of Expect, a Tcl extension
that performs programmed dialogue with other interactive programs.
Expect adds Tcl commands for automating interactive applications such
as telnet, ftp, passwd, fsck, rlogin, tip, etc.  This extension is
written by Don Libes.  Please note that Expect is only supported on
Unix platforms.

TclX 8.0
--------

TclPro 1.2 incorporates the 8.0 version of TclX, a Tcl extension that
brings new data structures and system interfaces to Tcl.  TclX, also
known as Extended Tcl, is designed to make Tcl easier for systems
programming and programming in the large.  TclX provides additional
interfaces to the native operating system, as well as many new
programming constructs and text manipulation commands.  This extension
is written by Mark Diekhans and Karl Lehenbauer.

2. Documentation
================

This release of TclPro includes a user's guide in the PDF format,
called "TclProUsersGuide.pdf" located in the "doc" directory.  To view
or print the TclPro User's Guide, Acrobat Reader 3.0 or later is
required.  You can download a free copy of Acrobat Reader from our Web
site:

      http://www.scriptics.com/support/acrobat.html

To see more information about new features and changes in this version
of TclPro, see the file changes.txt located in the main directory of
this release.

Windows Help
------------

Windows distributions of TclPro include Windows help files (located in
doc\help).  The TclPro installer has added a TclPro entry in the
"Programs" section of your "Start" menu.  The TclPro menu entry
contains a shortcut to the Windows help files.

Unix HTML
---------

Unix distributions of TclPro include man pages for each TclPro
component (located in doc/man) as well as Web-based documentation
(located in doc/html).


3. Starting Up TclPro Tools
===========================

The following executables are located in the "<platform>/bin"
directory, where platform is one of solaris-sparc, hpux-parisc,
irix-mips, linux-ix86, or win32-ix86.

    TclPro tool			Unix executables  Windows executables
    -----------			----------------  -------------------
    TclPro Debugger		prodebug	  prodebug.exe
    TclPro Checker		procheck	  procheck.exe
    TclPro Compiler		procomp		  procomp.exe
    TclPro Wrapper		prowrap		  prowrap.exe
    License Manager		prolicense	  prolicense.exe
       (text-based version)	prolicensetty
    Tcl Shell 8.0.5		protclsh80	  protclsh80.exe
    Wish 8.0.5			prowish80	  prowish80.exe

3a. Starting Up TclPro Tools on Windows
---------------------------------------

The TclPro installer adds a TclPro entry in the "Programs" section of
your "Start" menu.  The TclPro menu entry contains shortcuts to TclPro
Debugger, the License Manager, prowish, and protclsh.  The remaining
applications, including TclPro Checker, TclPro Compiler, and TclPro
Wrapper, are command-line applications, so they cannot be run from the
start menu.  The TclPro installer adds <installDir>/win32-ix86/bin to
your PATH environment variable, so you can run these command-line
applications by starting any available shell (e.g., MS-DOS Command
Prompt), and typing procheck, procomp, or prowrap.  The following is
an example of how to use TclPro Checker to check a file called
"C:\myPrograms\foo.tcl":

	procheck "C:\myPrograms\foo.tcl"


3b. Starting Up TclPro Tools in Unix
------------------------------------

All of the TclPro applications can be run from any shell (e.g., sh) by
typing the full path and executable name on the command line (see
section 3 above for the executable names).  To avoid typing the full
path of each TclPro tool, we recommend that you add the TclPro bin
directory to your PATH environment variable.  The following is an
example of how to do so in the "sh" shell:

	PATH="/opt/scriptics/TclPro<version>/<platform>/bin:$PATH"

TclPro Debugger and the License Manager program have a graphical user
interface.  TclPro Checker, TclPro Compiler, TclPro Wrapper, are
command-line applications.  Once you have modified your PATH variable,
you can use the following command to invoke TclPro Checker to check
all files matching the "~/foo/*.tcl" glob pattern:

	procheck ~/foo/*.tcl


4. Licensing
============

TclPro customers now can choose which license works best for them: a
Named User License, or a Shared Network License. As before, a Named
User License for TclPro allows one named developer to use TclPro on
any of the platforms we support; the license cannot be used by other
developers. Scriptics' new Shared Network License allows groups or
departments to install TclPro and share a license pack; the minimum
size is a 5-license pack, which allows up to 5 developers to use
TclPro at the same time.

When you download TclPro to evaluate it, an evaluation license key
with a 30-day limit is emailed to you. When you purchase TclPro, a
permanent license key is emailed to you and shipped with your TclPro
CD-ROM distribution. You must choose at the time of evaluation
download or purchase what kind of license key to get: Named User
License or Shared Network License.  Visit our Web site for more
information on licensing:

	http://www.scriptics.com/tclpro/aboutLicenses.html

4a. Existing TclPro Customers
-----------------------------

Your existing license key for TclPro 1.0 or 1.1 will not work with the
1.2 release. However, you can safely install the 1.2 license key and
use TclPro 1.2 without losing your existing key and the ability to use
an earlier version of TclPro. This applies to both a 30-day evaluation
key or a permanent key for TclPro 1.2.

For TclPro update customers, there is an upgrade Web form you can use
to upgrade your permanent 1.0 or 1.1 key to a permanent 1.2 key:

	http://www.scriptics.com/tclpro/upgrade/autolicense.html

Also, we are offering TclPro customers who have previously purchased
TclPro and Upgrade Service an opportunity to "trade-in" their Named
User Licenses for TclPro 1.2 Shared Network Licenses.  Visit our Web
site for more information:

	http://www.scriptics.com/tclpro/aboutLicenses.html

Or call or email our sales department:

	sales@scriptics.com
	650-210-0119

4b. Using a Named User License Key
----------------------------------

With a Named User License, each TclPro developer must obtain and enter
a license key.  A Named User License is valid on all supported
platforms used by a particular developer.  For example, if a single
developer uses several platforms, he or she is permitted to use a
single Named User License on all platforms he or she uses. Of course,
more than one developer cannot share the same license.

After choosing to evaluate and download this release of TclPro, you
will receive an email containing a 30 day evaluation license key to
unlock this release of TclPro.  You may choose to enter the key during
the TclPro installation or enter the key later by using the License
Manager. See the "Starting Up TclPro Tools" section above for details
on running the License Manager.

TclPro tools will not work unless a valid license key has been
entered, and the evaluation license key is only valid for 30 days from
the day you registered for the evaluation.  If you are planning on
purchasing TclPro, please do so before the 30 days are up and you can
upgrade your 30-day license to a permanent one.

4c. Using a Shared Network License Key
--------------------------------------

A Shared Network License can replace several Named User License keys,
provide easy TclPro access to a larger number of developers, and
eliminate the need for users to manage and install their own license
keys.

The Shared Network Licenses are implemented by Scriptics License
Server. To use TclPro with a Shared Network License, a developer needs
to be able to access Scriptics License Server via a TCP/IP
network. The Scriptics License Server must be installed on a Unix
platform, but developers can use the TclPro tools on all the supported
Unix and Windows platforms. A copy of Scriptics License Server is
included in the UNIX versions of the TclPro distribution.

Scriptics License Server is configured for a particular number of
concurrent users. A user is determined by their user account. The same
user account on different hosts still counts as one user. A single
user can be using more than one TclPro application at the same time,
and this still counts as one user.

The management and reporting interface of Scriptics License Server is
Web based. Once installed, your site administrator just uses their Web
browser to add and remove licenses, monitor use, and generate
reports. The site administration pages are password protected.

After downloading this release of TclPro, you will receive an email
containing a 30 day evaluation license key to unlock this release of
TclPro.  To enter a Shared Network License key, you must install,
launch, and set up Scriptics License Server.  For instructions on how
to do this, see the INSTALL.TXT file.  Once your Scriptics License
Server is set up, you can add your license key at the following Web site:

	http://<hostname>:<port>

If you are running Scriptics License Server on the machine
"mars.mycompany.com" at the port 2577, your URL should look like the
following:

	http://mars.mycompany.com:2577

where mars.mycompany.com is the machine on which Scriptics License
Server is running, and 2577 is the port number you entered during
installation of Scriptics License Server.

5. Upgrading to the Latest TclPro Version
========================================-

This version of TclPro includes a major rework of the user preferences
and projects.  Because of these changes, the preferences and projects
from previous TclPro versions cannot be brought over to the new
release.

If you are upgrading from a prior version of TclPro (1.1 or earlier),
we recommend that you install and use the new version before
uninstalling the prior version.

If you are upgrading from an alpha or beta version of TclPro 1.2, we
recommend the following: on Windows you should uninstall the prior
version before installing the final 1.2 release (see the "Upgrading
TclPro on Windows" section for instructions); on Unix, you should
remove the TclPro Debugger preference files that match ~/.TclPro/1.2/*
from your filesystem.

5a. Upgrading TclPro on Windows
-------------------------------

We recommend that you use the Wise uninstaller to uninstall a prior
TclPro version.  You can do so by selecting the following:

	Start Menu | Settings | Control Panel | Add/Remove Programs

select the TclPro version you are uninstalling, and press
"Add/Remove".  All Windows users should remove references to previous
installations of TclPro from your PATH environment variable, so the
current executables will not be overshadowed by previously installed
ones.  To edit your PATH on Windows 95, edit the C:\autoexec.bat file.
On Windows NT, select the following:

	Start Menu | Settings | Control Panel | System | Environment

scroll to the Path variable and double click on it.

5b. Upgrading TclPro on Unix
----------------------------

To uninstall a prior TclPro version, recursively remove the target
directory of the installation, for example:

	/usr/bin/rm -rf /opt/scriptics/TclPro<version>

5c. Upgrading Scriptics License Server
--------------------------------------

If you have installed an alpha or beta version of Scriptics License
Server, you can uninstall it by doing the following:

   i.	Terminate the server's process if it is still running.  Note
	that the server doesn't run as "root" but rather as the user
	specified in the "<installDir>/prolserver.conf" file.

   ii.	Remove the following files.  Note that logDir is specified
	in the file "<installDir>/prolserver.conf", and "/etc" was
	the default installDir.

		<logDir>/prolserver*
		<installDir>/prolserver*
		<installDir>/INSTALL.LOG

6. C Development on Windows
===========================

If you are using the Web download of TclPro on Windows, and you wish
to do C program development or create custom shells for TclPro
Wrapper, you will need the tclprodev<version>.zip file.  This file can
be downloaded from the same location where you downloaded the rest of
TclPro.

The tclprodev<version>.zip file is an optional component which
contains the libraries and header files necessary for C program
development and creating custom shells for TclPro Wrapper.  You can
extract this zip file into the installation directory of TclPro.

7. Support and bug fixes
========================

A list of known bugs in TclPro can be found at

    http://www.scriptics.com/support/knownbugs.html

A list of frequently asked questions (FAQ) can be found at

    http://www.scriptics.com/support/faq.html

We're very interested in receiving your comments, including bug
reports and requests for enhancements.  We prefer that you report bugs
and feature enhancement requests by filling in the form at

    http://www.scriptics.com/support/bugForm.html

If you were unable to complete installation of TclPro, please check
the INSTALL.LOG file in the target installation directory, and use our
Web form to report the problem (you can paste the INSTALL.LOG file
into your report).


8. Contact Info
===============
If you have any questions or comments, please contact:

    sales@scriptics.com

	   or

    support@scriptics.com

Thank you very much for working with Scriptics and TclPro!

Sincerely,
The Scriptics Team

2593 Coast Ave.
Mountain View,  CA 94043
Phone: 650-210-0100
URL: http://www.scriptics.com/
