1README: Tcl
2 This is the Tcl 8.5.19 source distribution.
3 http://sourceforge.net/projects/tcl/files/Tcl/
4 You can get any source release of Tcl from the URL above.
5
6Contents
7--------
8 1. Introduction
9 2. Documentation
10 3. Compiling and installing Tcl
11 4. Development tools
12 5. Tcl newsgroup
13 6. The Tcler's Wiki
14 7. Mailing lists
15 8. Support and Training
16 9. Tracking Development
17 10. Thank You
18
191. Introduction
20---------------
21Tcl provides a powerful platform for creating integration applications that
22tie together diverse applications, protocols, devices, and frameworks.
23When paired with the Tk toolkit, Tcl provides the fastest and most powerful
24way to create GUI applications that run on PCs, Unix, and Mac OS X.
25Tcl can also be used for a variety of web-related tasks and for creating
26powerful command languages for applications.
27
28Tcl is maintained, enhanced, and distributed freely by the Tcl community.
29Source code development and tracking of bug reports and feature requests
30takes place at:
31
32 http://core.tcl.tk/
33
34Tcl/Tk release and mailing list services are hosted by SourceForge:
35
36 http://sourceforge.net/projects/tcl/
37
38with the Tcl Developer Xchange hosted at:
39
40 http://www.tcl.tk/
41
42Tcl is a freely available open source package. You can do virtually
43anything you like with it, such as modifying it, redistributing it,
44and selling it either in whole or in part. See the file
45"license.terms" for complete information.
46
472. Documentation
48----------------
49
50Extensive documentation is available at our website.
51The home page for this release, including new features, is
52 http://www.tcl.tk/software/tcltk/8.5.html
53
54Detailed release notes can be found at the file distributions page
55by clicking on the relevant version.
56 http://sourceforge.net/projects/tcl/files/Tcl/
57
58Information about Tcl itself can be found at
59 http://www.tcl.tk/about/
60
61There have been many Tcl books on the market. Many are mentioned in the Wiki:
62 http://wiki.tcl.tk/_/ref?N=25206
63
64To view the complete set of reference manual entries for Tcl 8.5 online,
65visit the URL:
66 http://www.tcl.tk/man/tcl8.5/
67
682a. Unix Documentation
69----------------------
70
71The "doc" subdirectory in this release contains a complete set of
72reference manual entries for Tcl. Files with extension ".1" are for
73programs (for example, tclsh.1); files with extension ".3" are for C
74library procedures; and files with extension ".n" describe Tcl
75commands. The file "doc/Tcl.n" gives a quick summary of the Tcl
76language syntax. To print any of the man pages on Unix, cd to the
77"doc" directory and invoke your favorite variant of troff using the
78normal -man macros, for example
79
80 ditroff -man Tcl.n
81
82to print Tcl.n. If Tcl has been installed correctly and your "man" program
83supports it, you should be able to access the Tcl manual entries using the
84normal "man" mechanisms, such as
85
86 man Tcl
87
882b. Windows Documentation
89-------------------------
90
91The "doc" subdirectory in this release contains a complete set of Windows
92help files for Tcl. Once you install this Tcl release, a shortcut to the
93Windows help Tcl documentation will appear in the "Start" menu:
94
95 Start | Programs | Tcl | Tcl Help
96
973. Compiling and installing Tcl
98-------------------------------
99
100There are brief notes in the unix/README, win/README, and macosx/README about
101compiling on these different platforms. There is additional information
102about building Tcl from sources at
103
104 http://www.tcl.tk/doc/howto/compile.html
105
1064. Development tools
107---------------------------
108
109ActiveState produces a high quality set of commercial quality development
110tools that is available to accelerate your Tcl application development.
111Tcl Dev Kit builds on the earlier TclPro toolset and provides a debugger,
112static code checker, single-file wrapping utility, bytecode compiler and
113more. More information can be found at
114
115 http://www.ActiveState.com/Tcl
116
1175. Tcl newsgroup
118----------------
119
120There is a USENET news group, "comp.lang.tcl", intended for the exchange of
121information about Tcl, Tk, and related applications. The newsgroup is a
122great place to ask general information questions. For bug reports, please
123see the "Support and bug fixes" section below.
124
1256. Tcl'ers Wiki
126---------------
127
128A Wiki-based open community site covering all aspects of Tcl/Tk is at:
129
130 http://wiki.tcl.tk/
131
132It is dedicated to the Tcl programming language and its extensions. A
133wealth of useful information can be found there. It contains code
134snippets, references to papers, books, and FAQs, as well as pointers to
135development tools, extensions, and applications. You can also recommend
136additional URLs by editing the wiki yourself.
137
1387. Mailing lists
139----------------
140
141Several mailing lists are hosted at SourceForge to discuss development or
142use issues (like Macintosh and Windows topics). For more information and
143to subscribe, visit:
144
145 http://sourceforge.net/projects/tcl/
146
147and go to the Mailing Lists page.
148
1498. Support and Training
150------------------------
151
152We are very interested in receiving bug reports, patches, and suggestions
153for improvements. We prefer that you send this information to us as
154tickets entered into our tracker at:
155
156 http://core.tcl.tk/tcl/reportlist
157
158We will log and follow-up on each bug, although we cannot promise a
159specific turn-around time. Enhancements may take longer and may not happen
160at all unless there is widespread support for them (we're trying to
161slow the rate at which Tcl/Tk turns into a kitchen sink). It's very
162difficult to make incompatible changes to Tcl/Tk at this point, due to
163the size of the installed base.
164
165The Tcl community is too large for us to provide much individual support
166for users. If you need help we suggest that you post questions to
167comp.lang.tcl. We read the newsgroup and will attempt to answer esoteric
168questions for which no one else is likely to know the answer. In addition,
169see the following Web site for links to other organizations that offer
170Tcl/Tk training:
171
172 http://wiki.tcl.tk/training
173
1749. Tracking Development
175-----------------------
176
177Tcl is developed in public. To keep an eye on how Tcl is changing, see
178 http://core.tcl.tk/
179
18010. Thank You
181-------------
182
183We'd like to express our thanks to the Tcl community for all the
184helpful suggestions, bug reports, and patches we have received.
185Tcl/Tk has improved vastly and will continue to do so with your help.
186