diff options
Diffstat (limited to 'README')
| -rw-r--r-- | README | 290 |
1 files changed, 182 insertions, 108 deletions
@@ -1,29 +1,66 @@ -Tcl - -RCS: @(#) $Id: README,v 1.13 1999/02/09 03:31:55 stanton Exp $ +README: Tcl + + Tcl is maintained, enhanced, and distributed freely as a + service to the Tcl community by Scriptics Corporation. + +RCS: @(#) $Id: README,v 1.14 1999/02/17 02:05:53 hershey Exp $ + +Contents +-------- + 1. Introduction + 2. Documentation + 3. Compiling and installing Tcl + 4. Summary of changes in Tcl 8.0 + 5. Development tools + 6. Tcl newsgroup + 7. Tcl contributed archive + 8. Tcl Resource Center + 9. Mailing lists + 10. Support and bug fixes + 11. Tcl version numbers 1. Introduction --------------- -This directory and its descendants contain the sources and documentation -for Tcl, an embeddable scripting language. The information here -corresponds to release 8.0.5, which is the fifth patch update for Tcl 8.0. -This patch includes many bug fixes; see the "changes" file for a complete -list. Tcl 8.0 is a major new release that replaces the core of the -interpreter with an on-the-fly bytecode compiler to improve execution -speed. It also includes several other new features such as namespaces and -binary I/O, plus many bug fixes. The compiler introduces a few +Tcl provides a powerful platform for creating integration +applications that tie together diverse applications, protocols, +devices, and frameworks. When paired with the Tk toolkit, Tcl +provides the fastest and most powerful way to create GUI applications +that run on PCs, Unix, and the Macintosh. Tcl can also be used for a +variety of web-related tasks and for creating powerful command +languages for applications. + +This directory contains the sources and documentation for Tcl. The +information here corresponds to release 8.0.5, which is the fifth +patch update for Tcl 8.0. This patch provides bug fixes and +incorporates user-contributed patches. Please check the changes file +for details. + +Tcl 8.0 is a major release that replaces the core of the interpreter +with an on-the-fly bytecode compiler to improve execution speed. It +also includes several other new features such as namespaces and binary +I/O, plus many bug fixes. The compiler introduces a few incompatibilities that may affect existing Tcl scripts; the -incompatibilities are relatively obscure but may require modifications to -some old scripts before they can run with this version. The compiler -introduces many new C-level APIs, but the old APIs are still supported. -See below for more details. +incompatibilities are relatively obscure but may require modifications +to some old scripts before they can run with this version. The +compiler introduces many new C-level APIs, but the old APIs are still +supported. See below for more details. + +Tcl is a freely available open source package. You can do virtually +anything you like with it, such as modifying it, redistributing it , +and selling it either in whole or in part. See the file +"license.terms" for complete information. 2. Documentation ---------------- -The best way to get started with Tcl is to read one of the introductory -books on Tcl: +The best way to get started with Tcl is to read about Tcl on the +Scriptics Web site at: + + http://www.scriptics.com/scripting + +Another good way to get started with Tcl is to read one of the +introductory books on Tcl: Practical Programming in Tcl and Tk, 2nd Edition, by Brent Welch, Prentice-Hall, 1997, ISBN 0-13-616830-2 @@ -36,15 +73,27 @@ books on Tcl: Other books are listed at http://www.scriptics.com/resource/doc/books/ -http://www.tclconsortium.org/resources/books.html -The "doc" subdirectory in this release contains a complete set of reference -manual entries for Tcl. Files with extension ".1" are for programs (for -example, tclsh.1); files with extension ".3" are for C library procedures; -and files with extension ".n" describe Tcl commands. The file "doc/Tcl.n" -gives a quick summary of the Tcl language syntax. To print any of the man -pages, cd to the "doc" directory and invoke your favorite variant of -troff using the normal -man macros, for example +There is also an official home for Tcl and Tk on the Scriptics Web site: + + http://www.scriptics.com + +These Web pages include information about the latest releases, products +related to Tcl and Tk, reports on bug fixes and porting issues, HTML +versions of the manual pages, and pointers to many other Tcl/Tk Web +pages at other sites. Check them out! + +2a. Unix Documentation +---------------------- + +The "doc" subdirectory in this release contains a complete set of +reference manual entries for Tcl. Files with extension ".1" are for +programs (for example, tclsh.1); files with extension ".3" are for C +library procedures; and files with extension ".n" describe Tcl +commands. The file "doc/Tcl.n" gives a quick summary of the Tcl +language syntax. To print any of the man pages on Unix, cd to the +"doc" directory and invoke your favorite variant of troff using the +normal -man macros, for example ditroff -man Tcl.n @@ -54,19 +103,22 @@ using the normal "man" mechanisms, such as man Tcl -There is also an official home for Tcl and Tk on the Web: - http://www.scriptics.com -These Web pages include information about the latest releases, products -related to Tcl and Tk, reports on bug fixes and porting issues, HTML -versions of the manual pages, and pointers to many other Tcl/Tk Web -pages at other sites. Check them out! +2b. Windows Documentation +------------------------- + +The "doc/help" subdirectory in this release contains a complete set of +Windows help files for TclPro. Once you install this Tcl release, a +shortcut to the Windows help Tcl documentation will appear in the +"Start" menu: + + Start | Programs | Tcl | Tcl Help 3. Compiling and installing Tcl ------------------------------- This release contains everything you should need to compile and run -Tcl under UNIX, Macintoshes, and PCs (either Windows NT, Windows 95, -or Win 3.1 with Win32s). +Tcl under UNIX, PCs (either Windows NT, Windows 95, or Win 3.1 with +Win32s), and Macintoshes. Before trying to compile Tcl you should do the following things: @@ -84,11 +136,6 @@ Before trying to compile Tcl you should do the following things: if it has been updated with patches. Patch releases fix bugs without changing any features, so you should normally use the latest patch release for the version of Tcl that you want. - Patch releases are available in two forms. A file like - tcl8.0.5.tar.Z is a complete release for patch level 5 of Tcl - version 8.0. If there is a file with a higher patch level than - this release, just fetch the file with the highest patch level - and use it. Once you've done this, change to the "unix" subdirectory if you're compiling under UNIX, "win" if you're compiling under Windows, or @@ -123,7 +170,7 @@ changes, there are several smaller changes and bug fixes. See the file managing objects. See, for example, the manual entries doc/*Obj*.3. 2. Namespaces. There is a new namespace mechanism based on the - namespace implementation by Michael McLennan of Lucent Technologies. + namespace implementation by Michael McLennan of Cadence. This includes new "namespace" and "variable" commands. There are many new C APIs associated with namespaces, but they will not be exported until Tcl 8.1. Note: the syntax of the namespace command @@ -227,23 +274,28 @@ scripts that worked under Tcl 7.6 and earlier releases: specific file handle. Tcl_DriverGetOptionProc procedures now take an additional interp argument. -5. Tcl newsgroup ------------------ +5. Development tools +-------------------- -There is a network news group "comp.lang.tcl" intended for the exchange -of information about Tcl, Tk, and related applications. Feel free to use -the newsgroup both for general information questions and for bug reports. -We read the newsgroup and will attempt to fix bugs and problems reported -to it. +A high quality set of commercial development tools is now available to +accelerate your Tcl application development. Scriptics' TclPro +product provides a debugger, static code checker, packaging utility, +and bytecode compiler. Visit the Scriptics Web site at: -When using comp.lang.tcl, please be sure that your e-mail return address -is correctly set in your postings. This allows people to respond directly -to you, rather than the entire newsgroup, for answers that are not of -general interest. A bad e-mail return address may prevent you from -getting answers to your questions. You may have to reconfigure your news -reading software to ensure that it is supplying valid e-mail addresses. + http://www.scriptics.com/tclpro -6. Tcl contributed archive +for more information on TclPro and for a free 30-day evaluation +download. + +6. Tcl newsgroup +---------------- + +There is a network news group "comp.lang.tcl" intended for the +exchange of information about Tcl, Tk, and related applications. The +newsgroup is a greata place to ask general information questions. For +bug reports, please see the "Support and bug fixes" section below. + +7. Tcl contributed archive -------------------------- Many people have created exciting packages and applications based on Tcl @@ -254,30 +306,30 @@ in the directory "/pub/tcl". The archive also contains several FAQ ("frequently asked questions") documents that provide solutions to problems that are commonly encountered by TCL newcomers. -7. Tcl Resource Center +8. Tcl Resource Center ---------------------- -Visit http://www.scritics.com/resource/ to see an annotated index of + +Visit http://www.scriptics.com/resource/ to see an annotated index of many Tcl resources available on the World Wide Web. This includes -papers, books, and FAQs, as well as extensions, applications, binary -releases, and patches. You can contribute patches by sending them -to <patches@scriptics.com>. You can also recommend more URLs for the -resource center using the forms labeled "Add a Resource". +papers, books, and FAQs, as well as development tools, extensions, +applications, binary releases, and patches. You can also recommend +additional URLs for the resource center using the forms labeled "Add a +Resource". -8. Mailing lists +9. Mailing lists ---------------- A couple of Mailing List have been set up to discuss Macintosh or -Windows related Tcl issues. In order to use these Mailing Lists you -must have access to the internet. To subscribe send a message to: +Windows related Tcl issues. To subscribe send a message to: wintcl-request@tclconsortium.org mactcl-request@tclconsortium.org In the body of the message (the subject will be ignored) put: - subscribe mactcl Joe Blow + subscribe mactcl Joe Smith -Replacing Joe Blow with your real name, of course. (Use wintcl +Replacing Joe Smith with your real name, of course. (Use wintcl instead of mactcl if your interested in the Windows list.) If you would just like to receive more information about the list without subscribing put the line: @@ -286,47 +338,64 @@ subscribing put the line: in the body instead (or wintcl). -9. Support and bug fixes ------------------------- +10. Support and bug fixes +------------------------- + +Scriptics is very interested in receiving bug reports, patches, and +suggestions for improvements. We prefer that you send this +information to us via the bug form on the Scriptics Web site, rather +than emailing us directly. The bug form is at: + + http://www.scriptics.com/support/bugForm.html + +The bug form was designed to give uniform structure to bug reports as +well as to solicit enough information to minimize followup questions. +The bug form also includes an option to automatically post your report +on comp.lang.tcl. We strongly recommend that you select this option +because someone else who reads comp.lang.tcl may be able to offer a +solution. + +When reporting bugs, please provide full information about the Tcl/Tk +version and the platform on which you are running Tcl/Tk. Also, +please include a short tclsh script that we can use to reproduce the +bug. Make sure that the script runs with a bare-bones tclsh and +doesn't depend on any extensions or other programs, particularly those +that exist only at your site. Also, please include three additional +pieces of information with the script: -We're very interested in receiving bug reports and suggestions for -improvements. We prefer that you send this information to the -comp.lang.tcl newsgroup rather than to any of us at Scriptics. We'll see -anything on comp.lang.tcl, and in addition someone else who reads -comp.lang.tcl may be able to offer a solution. The normal turn-around -time for bugs is 3-6 weeks. Enhancements may take longer and may not -happen at all unless there is widespread support for them (we're -trying to slow the rate at which Tcl turns into a kitchen sink). It's -very difficult to make incompatible changes to Tcl at this point, due -to the size of the installed base. - -When reporting bugs, please provide a short tclsh script that we can -use to reproduce the bug. Make sure that the script runs with a -bare-bones tclsh and doesn't depend on any extensions or other -programs, particularly those that exist only at your site. Also, -please include three additional pieces of information with the -script: (a) how do we use the script to make the problem happen (e.g. what things do we click on, in what order)? (b) what happens when you do these things (presumably this is undesirable)? (c) what did you expect to happen instead? +We will log and follow-up on each bug, although we cannot promise a +specific turn-around time. Enhancements may take longer and may not +happen at all unless there is widespread support for them (we're +trying to slow the rate at which Tcl/Tk turns into a kitchen sink). +It's very difficult to make incompatible changes to Tcl/Tk at this +point, due to the size of the installed base. + The Tcl community is too large for us to provide much individual -support for users. If you need help we suggest that you post questions -to comp.lang.tcl. We read the newsgroup and will attempt to answer -esoteric questions for which no-one else is likely to know the answer. -In addition, Tcl support and training are available commercially from -Scriptics (info@scriptics.com), NeoSoft (info@neosoft.com), -Computerized Processes Unlimited (gwl@cpu.com), -and Data Kinetics (education@dkl.com). - -10. Tcl version numbers ----------------------- +support for users. If you need help we suggest that you post +questions to comp.lang.tcl. We read the newsgroup and will attempt to +answer esoteric questions for which no-one else is likely to know the +answer. In addition, Tcl/Tk support and training are available +commercially from Scriptics at: + + http://www.scriptics.com/training + +Also see the following Web site for links to other organizations that +offer Tcl/Tk training: + + http://www.scriptics.com/resource/commercial/training + +11. Tcl version numbers +----------------------- You can test the current version of Tcl by examining the tcl_version and tcl_patchLevel variables. The tcl_patchLevel -variable follows the naming rules outlined below (e.g., 8.0.4). +variable follows the naming rules outlined below (e.g., 8.0.5). The tcl_version just has the major.minor numbers in it (e.g., 8.0) Each Tcl release is identified by two numbers separated by a dot, e.g. @@ -360,17 +429,22 @@ incompatibility. Once the official release is made then there won't be any more incompatibilities until the next release with a new major version number. -(Note: This compatibility is true for Tcl scripts, but historically the Tcl -C APIs have changed enough between releases that you may need to work a bit to -upgrade extensions.) - -Patch releases have a suffix such as p1 or p2. These releases contain -bug fixes only. A patch release (e.g Tcl 7.6p2) should be completely -compatible with the base release from which it is derived (e.g. Tcl -7.6), and you should normally use the highest available patch release. - -As of 8.0.3, the patch releases use a second . instead of 'p'. So, -the 8.0 release went to 8.0p1, 8.0p2, 8.0.3, 8.0.4, and 8.0.5. The -alphas and betas will still use the 'a' and 'b' letters in their -tcl_patchLevel. - +(Note: This compatibility is true for Tcl scripts, but historically +the Tcl C APIs have changed enough between releases that you may need +to work a bit to upgrade extensions.) + +Patch releases now have a suffix such as ".4" or ".5". Prior to +version 8.0.3, patch releases had the suffix "p1" or "p2". So, the +8.0 release went to 8.0p1, 8.0p2, 8.0.3, 8.0.4, and 8.0.5. The alphas +and betas continue to use the 'a' and 'b' letters in their +tcl_patchLevel. Patch releases normally contain bug fixes only. A +patch release (e.g Tcl 8.0.5) should be completely compatible with the +base release from which it is derived (e.g. Tcl 8.0), and you should +normally use the highest available patch release. + +12. Thank You +------------- + +We'd like to express our thanks to the Tcl community for all the +helpful suggestions, bug reports, and patches we have received. +Tcl/Tk has improved vastly and will continue to do so with your help. |