root/tcl-8.0/trunk/unix/README @ 1091

Revision 1091, 5.0 KB (checked in by ucaccsp, 16 years ago)

Changes to allow stand-alone operation, with no external references.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1This is the directory where you configure, compile, test, and install
2UNIX versions of Tcl.  This directory also contains source files for Tcl
3that are specific to UNIX.  Some of the files in this directory are
4used on the PC or Mac platform too, but they all depend on UNIX
5(POSIX/ANSI C) interfaces and some of them only make sense under UNIX.
6
7The rest of this file contains instructions on how to do this.  The
8release should compile and run either "out of the box" or with trivial
9changes on any UNIX-like system that approximates POSIX, BSD, or System
10V.  We know that it runs on workstations from Sun, H-P, DEC, IBM, and
11SGI, as well as PCs running Linux, BSDI, and SCO UNIX.  To compile for
12a PC running Windows, see the README file in the directory ../win.  To
13compile for a Macintosh, see the README file in the directory ../mac.
14
15SCCS: @(#) README 1.15 96/12/19 14:02:23
16
17How To Compile And Install Tcl:
18-------------------------------
19
20(a) Check for patches as described in ../README.
21
22(b) If you have already compiled Tcl once in this directory and are now
23    preparing to compile again in the same directory but for a different
24    platform, or if you have applied patches, type "make distclean" to
25    discard all the configuration information computed previously.
26
27(c) Type "./configure".  This runs a configuration script created by GNU
28    autoconf, which configures Tcl for your system and creates a
29    Makefile.  The configure script allows you to customize the Tcl
30    configuration for your site; for details on how you can do this,
31    type "./configure -help" or refer to the autoconf documentation (not
32    included here). 
33
34    Note: be sure to use only absolute path names (those starting with "/")
35    in the --prefix and --exec_prefix options.
36
37(d) Type "make".  This will create a library archive called "libtcl.a"
38    or "libtcl.so" and an interpreter application called "tclsh" that
39    allows you to type Tcl commands interactively or execute script files.
40
41(e) If the make fails then you'll have to personalize the Makefile
42    for your site or possibly modify the distribution in other ways.
43    First check the file "porting.notes" to see if there are hints
44    for compiling on your system.  Then look at the porting Web page
45    described later in this file.  If you need to modify Makefile, there
46    are comments at the beginning of it that describe the things you
47    might want to change and how to change them.
48
49(f) Type "make install" to install Tcl binaries and script files in
50    standard places.  You'll need write permission on the installation
51    directories to do this.  The installation directories are
52    determined by the "configure" script and may be specified with
53    the --prefix and --exec_prefix options to "configure".  See the
54    Makefile for information on what directories were chosen; you
55    can override these choices by modifying the "prefix" and
56    "exec_prefix" variables in the Makefile.
57
58(g) At this point you can play with Tcl by invoking the "tclsh"
59    program and typing Tcl commands.  However, if you haven't installed
60    Tcl then you'll first need to set your TCL_LIBRARY variable to
61    hold the full path name of the "library" subdirectory.  Note that
62    the installed versions of tclsh, libtcl.a, and libtcl.so have a
63    version number in their names, such as "tclsh8.0" or "libtcl8.0.so";
64    to use the installed versions, either specify the version number
65    or create a symbolic link (e.g. from "tclsh" to "tclsh8.0").
66
67If you have trouble compiling Tcl, read through the file" porting.notes".
68It contains information that people have provided about changes they had
69to make to compile Tcl in various environments.  Or, check out the
70following Web URL:
71    http://www.sunlabs.com/cgi-bin/tcl/info.8.0
72This is an on-line database of porting information.  We make no guarantees
73that this information is accurate, complete, or up-to-date, but you may
74find it useful.  If you get Tcl running on a new configuration, we would
75be happy to receive new information to add to "porting.notes".  You can
76also make a new entry into the on-line Web database.  We're also interested
77in hearing how to change the configuration setup so that Tcl compiles out
78of the box on more platforms.
79
80Test suite
81----------
82
83There is a relatively complete test suite for all of the Tcl core in
84the subdirectory "tests".  To use it just type "make test" in this
85directory.  You should then see a printout of the test files processed.
86If any errors occur, you'll see a much more substantial printout for
87each error.  See the README file in the "tests" directory for more
88information on the test suite.  Note: don't run the tests as superuser:
89this will cause several of them to fail.
90
91The Tcl test suite is very sensitive to proper implementation of
92ANSI C library procedures such as sprintf and sscanf.  If the test
93suite generates errors, most likely they are due to non-conformance
94of your system's ANSI C library;  such problems are unlikely to
95affect any real applications so it's probably safe to ignore them.
Note: See TracBrowser for help on using the browser.